# Wataru / boru 課題1 #2

wataboru · 2020-07-05T13:33:44Z

課題1のPRになります。レビューをお願いいたします。

以下README.mdより転記

課題 1 【TRY】画像変換コマンドを作ろう

次の仕様を満たすコマンドを作って下さい

ディレクトリを指定する
指定したディレクトリ以下の JPG ファイルを PNG に変換（デフォルト）
ディレクトリ以下は再帰的に処理する
変換前と変換後の画像形式を指定できる（オプション）

以下を満たすように開発してください

main パッケージと分離する
自作パッケージと標準パッケージと準標準パッケージのみ使う
準標準パッケージ：golang.org/x 以下のパッケージ
ユーザ定義型を作ってみる
GoDoc を生成してみる
Go Modules を使ってみる

実行手順

$ go build -o imageconverter
$ ./imgconv -h 
Usage of ./imgconv:
  -a string
    	Input extension after conversion. (short) (default "png")
  -after --after=jpg
    	Input extension after conversion.
    	  ex) --after=jpg (default "png")
  -b string
    	Input extension before conversion. (short) (default "jpg")
  -before --before=png
    	Input extension before conversion.
    	  ex) --before=png (default "jpg")
  -d string
    	Input target Directory. (short)
  -dir --dir=./convert_image
    	Input target Directory.
    	  ex) --dir=./convert_image
$ ./imgconv -d ./image 
  or
$ ./imgconv -d ./image -b png -a gif
  or
$ ./imgconv -d ./image -b jpeg -a tiff

前提として、@tenntennさんの公開されているhandsonプロジェクトと似ている内容でして、以前やったことがありました。
- そちらに無い部分として、tiff変換やbmp変換の追加などを行いました。
mainパッケージと自作パッケージの切り分けは上記のプロジェクトを参考にしました。
flagの扱い方は、改訂2版みんなのGo言語を参考にしました
GoModulesを利用したく、golang.org/x/imageを導入しました
様々なソースをみていると、変数名やコマンド名が自分は冗長かな？と感じています。Go話者の方は短く記載するものなのでしょうか。

tenntenn

レビューしました！

tenntenn · 2020-07-05T23:43:34Z

kadai1/wataboru/.gitignore

@@ -0,0 +1,3 @@
+.idea
+.DS_Store
+go.sum


ignoreする必要はないですね

tenntenn · 2020-07-05T23:44:04Z

kadai1/wataboru/commands/imageconverter/main.go

+package main
+
+import (
+	"dojo8/kadai1/wataboru/imageconverter"


github.comからのパスの方が好ましいです。

tenntenn · 2020-07-05T23:45:33Z

kadai1/wataboru/commands/imageconverter/main.go

+
+const (
+	// ExitCodeSuccess is the exit code on success
+	ExitCodeSuccess int = iota


終了コードは外部に伝えるものなので iota は使わない方が安全です。
iota を使う値は区別さえできればOKで値として意味がないものに限ります。
終了コードは0が成功、それ以外が失敗という値に意味を持っているので使わないほうがが良いです。
DBに入れる値なんかも同様です。

tenntenn · 2020-07-05T23:47:43Z

kadai1/wataboru/README.md

+    	  ex) --dir=./convert_image
+$ ./imgconv -d ./image 
+  or
+$ ./imgconv -d ./image -b png -a gif


テスト用の画像は testdata というディレクトリを作ってその下に入れましょう。
testdata という名前のディレクトリはGoにパッケージとして認識されません。
同様に_で始まるディレクトリ（よく_exampleとして使用される）や.で始まるディレクトリも無視されます。

tenntenn · 2020-07-05T23:47:58Z

kadai1/wataboru/README.md

+
+- 前提として、@tenntennさんの公開されている[handsonプロジェクト](https://github.com/tenntenn/gohandson/tree/master/imgconv/ja)と似ている内容でして、以前やったことがありました。
+  - そちらに無い部分として、tiff変換やbmp変換の追加などを行いました。
+- GoModulesを利用したく、`golang.org/x/image`を導入しました


tenntenn · 2020-07-05T23:48:15Z

kadai1/wataboru/imageconverter/ImageConverter.go

+	"strings"
+
+	"golang.org/x/image/tiff"
+


tenntenn · 2020-07-05T23:48:47Z

kadai1/wataboru/imageconverter/ImageConverter.go

+	if err != nil {
+		return fmt.Errorf("image file could not be created. target: %s", dest)
+	}
+	defer destFile.Close()


Create は書き込みの処理なので、Close する際にもエラー処理をする。

tenntenn · 2020-07-05T23:50:40Z

kadai1/wataboru/imageconverter/ImageConverter.go

+func Convert(args Args) error {
+	return filepath.Walk(args.Directory, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			fmt.Printf("prevent panic by handling failure accessing a path %q: %v\n", path, err)


エラーをreturnするならログを出さない。
ログを出すならエラーを返さない。
エラーログの出力もエラーハンドリングの1つでエラーハンドリングは1度だけにする。
出すとしても標準エラー出力の方が好ましそう。

- Modify import statement in main.go. - Add error handling to defer of imageconverter.convertImage.

wataboru · 2020-07-08T07:44:32Z

kadai1/wataboru/imageconverter/ImageConverter.go

+
+	defer func(returnErr error) {
+		if returnErr == nil {
+			err = destFile.Close()


@tenntenn
こちら、分かる限り修正してみました。
一点質問がありまして、defer内で呼び出し元にエラーを返す処理を実現するため、名前付き戻り値を使ってしまっています。

他の方のレビューの中で、「何をreturnしたか追いづらいので、名前付き戻り値はできるだけ使わない。」とあったので、名前付き戻り値を使わずにどのように呼び出し元にエラーを返したら良いか教えていただきたいです。

このパターンのみ使わないとどうにもならないので使っても大丈夫です！

@tenntenn
なるほど！そうなんですね。
一応その他の場所は明示的にreturnに渡す様にしました。

wataboru added 2 commits July 5, 2020 22:16

Initial commit.

9a08ed3

Add README.md

9e68451

wataboru changed the title ~~# wataboru 課題1~~ # Wataru / boru 課題1 Jul 5, 2020

tenntenn reviewed Jul 5, 2020

View reviewed changes

- Change example directory name "image" to "testdata"

350ed73

- Modify import statement in main.go. - Add error handling to defer of imageconverter.convertImage.

wataboru commented Jul 8, 2020

View reviewed changes

tenntenn added kadai1 課題1 reviewed レビュー済 labels Jul 9, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

# Wataru / boru 課題1 #2

# Wataru / boru 課題1 #2

wataboru commented Jul 5, 2020 •

edited

Loading

tenntenn left a comment

tenntenn Jul 5, 2020

tenntenn Jul 5, 2020

tenntenn Jul 5, 2020

tenntenn Jul 5, 2020

tenntenn Jul 5, 2020

tenntenn Jul 5, 2020

tenntenn Jul 5, 2020

tenntenn Jul 5, 2020

wataboru Jul 8, 2020

tenntenn Jul 8, 2020

wataboru Jul 8, 2020

# Wataru / boru 課題1 #2

Are you sure you want to change the base?

# Wataru / boru 課題1 #2

Conversation

wataboru commented Jul 5, 2020 • edited Loading

以下README.mdより転記

課題 1 【TRY】画像変換コマンドを作ろう

次の仕様を満たすコマンドを作って下さい

以下を満たすように開発してください

実行手順

コメント

tenntenn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wataboru commented Jul 5, 2020 •

edited

Loading