Move from tenntenn/gohandson

Author: tenntenn

.gitignore

@@ -0,0 +1 @@
+*.out

README.md

@@ -0,0 +1,72 @@
+# 分かるゴールーチンとチャネル
+
+## はじめに
+
+このハンズオンでは、コーヒーを淹れるという作業を例にゴールーチンを扱います。
+基本的な文法などは、このハンズオンでは扱いません。
+そのため、ハンズオンを始める前に、[A Tour of Go](https://go-tour-jp.appspot.com)を終わらせると良いでしょう。
+また、文法や周辺ツール、`GOPATH`などの詳しい説明は[公式ドキュメント](https://golang.org/doc/)の「Learning Go」の項目を読んでください。
+特に他のオブジェクト指向言語などを学習されている方は、「FAQ」に目を通すとよいでしょう。
+
+英語が辛い方は、有志によって[翻訳されたドキュメント](http://golang-jp.org/doc/)の「Goを学ぶ」を読んで下さい。
+すべてが翻訳されているわけではありませんが、役に立つでしょう。
+また、[はじめてのGo](http://gihyo.jp/dev/feature/01/go_4beginners)も日本語で書かれていて分かりやすいのでぜひ読んで下さい。
+
+標準パッケージについては、[パッケージドキュメント](https://golang.org/pkg/)を見ると、使い方が説明されています。
+
+## 学べることと学べないこと
+
+このハンズオンを行うと以下のことが学べます。
+
+* ゴールーチンとチャネルの基本
+* トレースの方法
+* `sync`パッケージの使い方
+* ゴールーチンとエラー処理
+* コンテキストとキャンセル処理
+
+一方、学べないことは以下のとおりです。
+
+* Goの開発環境のインストール方法
+* IDEやエディタの設定
+* 基本的な文法
+* コマンドラインツールの作り方
+* net/httpパッケージ
+
+## ハンズオンのやりかた
+
+`skeleton`ディレクトリ以下に問題があり、6つのステップに分けられています。
+STEP 1からSTEP 6までステップごとに進めていくことで、並行処理に関する知識が学べます。
+
+各ステップに、READMEが用意されていますので、まずは`README`を読みます。
+`README`には、そのステップを理解するための解説が書かれています。
+
+`README`を読んだら、ソースコードを開き`TODO`コメントが書かれている箇所をコメントに従って修正して行きます。
+`TODO`コメントをすべて修正し終わったら、`README`に書かれた実行例に従ってプログラムをコンパイルして実行します。
+
+途中でわからなくなった場合は、`solution`ディレクトリ以下に解答例を用意していますので、そちらをご覧ください。
+
+`Mac`と`Windows`で動作確認をしていますが、解説は`Mac`の動作結果をもとに解説しています。
+`Windows`の方は、パスの区切り文字等を適宜読み替えてください。
+
+## 目次
+
+* STEP 1: [ゴールーチンを使わずに処理する](./skeleton/step01)（[解答例](./solution/step01)）
+* STEP 2: [ボトルネックを探す](./skeleton/step02)（[解答例](./solution/step02)）
+* STEP 3: [ゴールーチンとチャネル](./skeleton/step03)（[解答例](./solution/step03)）
+* STEP 4: [syncパッケージを使う](./skeleton/step04)（[解答例](./solution/step04)）
+* STEP 5: [ゴールーチンとエラー処理](./skeleton/step05)（[解答例](./solution/step05)）
+* STEP 6: [コンテキストとキャンセル処理](./skeleton/step06)（[解答例](./solution/step06)）
+
+## ハンズオンの開催や資料の扱いについて
+この資料を元にハンズオンを開催するために@tenntennの許可などはいりません。
+好きに開催してください。
+@tenntennの行ける範囲であれば、開催するから解説して欲しいという依頼もウェルカムです。
+
+なお、forkして変更してもらっても構いませんが、できればPRをいただけると嬉しいです。
+資料に間違えを発見した方もissueやPRを頂ければ対応します。
+
+## ライセンス
+
+<a href="https://creativecommons.org/licenses/by-nc/4.0/legalcode.ja">
+	<img width="200" src="by-nc.eu.png">
+</a>

by-nc.eu.png

@@ -0,0 +1,160 @@
+# STEP 1: ゴールーチンを使わずに処理する
+
+## コーヒーを淹れるプログラムを作ろう
+
+このハンズオンでは、題材としてコーヒーを淹れるプログラムを作ります。
+実際にはコーヒーを淹れるわけではありませんが、一連の手順をいかに並行処理で効率化していくかということを学ぶことができます。
+
+コーヒーを淹れるには次の手順が必要でしょう。
+
+* お湯を沸かす
+* 豆を挽く
+* コーヒーを淹れる
+
+## データ型を定義しよう
+
+コーヒーを淹れるには、お湯と挽かれたコーヒー豆の粉が必要になります。
+お湯を沸かすには水が必要になり、コーヒー豆の粉を手に入れるには、コーヒー豆が必要です。
+つまり、各手順で次のデータの変換が行われます。
+
+* お湯を沸かす: 水 -> お湯
+* 豆を挽く: コーヒー豆 -> 挽かれたコーヒー豆の粉
+* コーヒーを淹れる: お湯, 挽かれたコーヒー豆の粉 -> コーヒー
+
+このプログラムには、水、お湯、豆、挽かれた豆、コーヒーの5つの種類のデータが存在することがわかります。
+これらのデータを表すために、データ型を作成しましょう。
+データ型は`type`を用いて定義することができます。
+
+```go
+type (
+	Bean       int // 豆
+	GroundBean int // 挽かれた豆
+	Water      int // 水
+	HotWater   int // お湯
+	Coffee     int // コーヒー
+)
+```
+
+また、利便性のために次のようにいくつか定数も用意しておきます。
+こうすることで、`10 * GramBeans`のように記述することができます。
+
+```go
+const (
+	GramBeans          Bean       = 1
+	GramGroundBeans    GroundBean = 1
+	MilliLiterWater    Water      = 1
+	MilliLiterHotWater HotWater   = 1
+	CupsCoffee         Coffee     = 1
+)
+```
+
+つぎに、N杯のコーヒーを淹れるために必要な材料の分量を返すメソッドを用意します。
+メソッドは、`Coffee`型のメソッドとして設けます。
+こうすることで、2杯のコーヒーに必要な水の分量を`(2 * Cupscoffee).Water()`のように取得することができます。
+
+```go
+// 1カップのコーヒーを淹れるのに必要な水の量
+func (cups Coffee) Water() Water {
+        return Water(180*cups) / MilliLiterWater
+}
+
+// 1カップのコーヒーを淹れるのに必要なお湯の量
+func (cups Coffee) HotWater() HotWater {
+        return HotWater(180*cups) / MilliLiterHotWater
+}
+
+// 1カップのコーヒーを淹れるのに必要な豆の量
+func (cups Coffee) Beans() Bean {
+        return Bean(20*cups) / GramBeans
+}
+
+// 1カップのコーヒーを淹れるのに必要な粉の量
+func (cups Coffee) GroundBeans() GroundBean {
+        return GroundBean(20*cups) / GramGroundBeans
+}
+```
+
+## お湯を沸かす
+
+お湯を沸かす関数`boil`を作成します。
+`boil`は一定時間立つと、引数で与えた分量と同じ量のお湯を返します。
+
+```go
+// お湯を沸かす
+func boil(water Water) HotWater {
+	time.Sleep(400 * time.Millisecond)
+	return HotWater(water)
+}
+```
+
+## コーヒー豆を挽く
+
+コーヒー豆を挽く関数`grind`を作ります。
+`grind`は引数にコーヒー豆を受け取り、一定時間後に挽いた豆を返します。
+
+```go
+// コーヒー豆を挽く
+func grind(beans Bean) GroundBean {
+	time.Sleep(200 * time.Millisecond)
+	return GroundBean(beans)
+}
+```
+
+## コーヒーを淹れる
+
+コーヒーを淹れる関数`brew`を作ります。
+`brew`は引数にお湯と挽いた豆を受け取り、一定時間後にコーヒーを返します。
+
+```go
+// コーヒーを淹れる
+func brew(hotWater HotWater, groundBeans GroundBean) Coffee {
+	time.Sleep(1 * time.Second)
+	// 少ない方を優先する
+	cups1 := Coffee(hotWater / (1 * CupsCoffee).HotWater())
+	cups2 := Coffee(groundBeans / (1 * CupsCoffee).GroundBeans())
+	if cups1 < cups2 {
+		return cups1
+	}
+	return cups2
+}
+```
+
+## 処理をまとめる
+
+`main`関数から、`boil`関数、`grind`関数、`brew`関数を順に呼び、コーヒーを淹れます。
+材料は次のように20杯分のコーヒーとしてます。
+
+```go
+// 作るコーヒーの数
+const amountCoffee = 20 * CupsCoffee
+
+// 材料
+water := amountCoffee.Water()
+beans := amountCoffee.Beans()
+```
+
+一度に沸かせるお湯の量や挽ける豆の量、淹れれるコーヒーの量は次のように決まっているものとします。
+
+* 一度に沸かせるお湯の量: 600[ml]
+* 一度に挽ける豆の量: 20[g]
+* 一度に淹れれるコーヒー: 4杯
+
+`boil`関数、`grind`関数、`brew`関数を複数回呼び出すことで、20杯のコーヒーを淹れることができます。
+
+## 実行
+
+`TODO`を埋めると次のコマンドで実行することができます。
+
+```
+$ go run main.go
+```
+
+次のように表示されれば成功です。
+
+```
+3600[ml] water
+400[g] beans
+3600[ml] hot water
+400[g] ground beans
+20 cup(s) coffee
+```

skeleton/step01/README.md

@@ -0,0 +1,3 @@
+module github.com/gohandson/goroutine-ja/solution/step01
+
+go 1.14

skeleton/step01/go.mod

@@ -0,0 +1,125 @@
+package main
+
+import (
+	"fmt"
+	"time"
+)
+
+type (
+	Bean       int
+	GroundBean int
+	Water      int
+	HotWater   int
+	Coffee     int
+)
+
+const (
+	GramBeans          Bean       = 1
+	GramGroundBeans    GroundBean = 1
+	MilliLiterWater    Water      = 1
+	MilliLiterHotWater HotWater   = 1
+	CupsCoffee         Coffee     = 1
+)
+
+func (w Water) String() string {
+	return fmt.Sprintf("%d[ml] water", int(w))
+}
+
+func (hw HotWater) String() string {
+	return fmt.Sprintf("%d[ml] hot water", int(hw))
+}
+
+func (b Bean) String() string {
+	return fmt.Sprintf("%d[g] beans", int(b))
+}
+
+func (gb GroundBean) String() string {
+	return fmt.Sprintf("%d[g] ground beans", int(gb))
+}
+
+func (cups Coffee) String() string {
+	return fmt.Sprintf("%d cup(s) coffee", int(cups))
+}
+
+// 1カップのコーヒーを淹れるのに必要な水の量
+func (cups Coffee) Water() Water {
+	return Water(180*cups) / MilliLiterWater
+}
+
+// 1カップのコーヒーを淹れるのに必要なお湯の量
+func (cups Coffee) HotWater() HotWater {
+	return HotWater(180*cups) / MilliLiterHotWater
+}
+
+// 1カップのコーヒーを淹れるのに必要な豆の量
+func (cups Coffee) Beans() Bean {
+	return Bean(20*cups) / GramBeans
+}
+
+// 1カップのコーヒーを淹れるのに必要な粉の量
+func (cups Coffee) GroundBeans() GroundBean {
+	return GroundBean(20*cups) / GramGroundBeans
+}
+
+// お湯を沸かす
+func boil(water Water) HotWater {
+	time.Sleep(400 * time.Millisecond)
+	return HotWater(water)
+}
+
+// コーヒー豆を挽く
+func grind(beans Bean) GroundBean {
+	time.Sleep(200 * time.Millisecond)
+	return GroundBean(beans)
+}
+
+// コーヒーを淹れる
+func brew(hotWater HotWater, groundBeans GroundBean) Coffee {
+	time.Sleep(1 * time.Second)
+	// 少ない方を優先する
+	cups1 := Coffee(hotWater / (1 * CupsCoffee).HotWater())
+	cups2 := Coffee(groundBeans / (1 * CupsCoffee).GroundBeans())
+	if cups1 < cups2 {
+		return cups1
+	}
+	return cups2
+}
+
+func main() {
+	// 作るコーヒーの数
+	const amountCoffee = 20 * CupsCoffee
+
+	// 材料
+	water := amountCoffee.Water()
+	beans := amountCoffee.Beans()
+
+	fmt.Println(water)
+	fmt.Println(beans)
+
+	// お湯を沸かす
+	var hotWater HotWater
+	for water > 0 {
+		// TODO: 関数水を600[ml]減らす
+		// TODO: お湯をboil関数で600[ml]沸かして増やす
+	}
+	fmt.Println(hotWater)
+
+	// 豆を挽く
+	var groundBeans GroundBean
+	for beans > 0 {
+		// TODO: 豆を20[g]減らす
+		// TODO: 挽いた豆をgrind関数で20[g]挽いて増やす
+	}
+	fmt.Println(groundBeans)
+
+	// コーヒーを淹れる
+	var coffee Coffee
+	cups := 4 * CupsCoffee
+	for hotWater >= cups.HotWater() && groundBeans >= cups.GroundBeans() {
+		// TODO: お湯を4杯に必要な分量だけ減らす
+		// TODO: 挽いた豆を4杯に必要な分量だけ減らす
+		// TODO: 4杯分の材料でbrew関数でコーヒーを淹れて増やす
+	}
+
+	fmt.Println(coffee)
+}