Rename SampleXXX -> ExampleXXX

devlights · devlights · commit dbb6b60495ab · 2020-02-19T20:15:13.000+09:00
diff --git a/advanced/examples.go b/advanced/examples.go
@@ -21,7 +21,7 @@ func NewRegister() interfaces.Register {
 	return r
 }
 
-func (r *advancedExampleRegister) Regist(m interfaces.SampleMapping) {
+func (r *advancedExampleRegister) Regist(m interfaces.ExampleMapping) {
 	m["async01"] = async.Async01
 	m["async_producer_consumer"] = async.ProducerConsumer
 	m["closure01"] = closure.Closure01
diff --git a/basic/examples.go b/basic/examples.go
@@ -45,7 +45,7 @@ func NewRegister() interfaces.Register {
 	return r
 }
 
-func (r *basicExampleRegister) Regist(m interfaces.SampleMapping) {
+func (r *basicExampleRegister) Regist(m interfaces.ExampleMapping) {
 	m["builtin_print"] = builtin_.PrintFunc
 	m["error_basic"] = error_.Basic
 	m["error_sentinel"] = error_.Sentinel
diff --git a/books/examples.go b/books/examples.go
@@ -15,5 +15,5 @@ func NewRegister() interfaces.Register {
 }
 
 //noinspection GoUnusedParameter
-func (r *booksExampleRegister) Regist(m interfaces.SampleMapping) {
+func (r *booksExampleRegister) Regist(m interfaces.ExampleMapping) {
 }
diff --git a/cmd/trygolang/errs.go b/cmd/trygolang/errs.go
@@ -7,7 +7,7 @@ import (
 
 type (
 	ExecError struct {
-		Name interfaces.SampleKey
+		Name interfaces.ExampleKey
 		Err  error
 	}
 )
diff --git a/cmd/trygolang/exec.go b/cmd/trygolang/exec.go
@@ -12,11 +12,11 @@ type (
 
 	ExecArgs struct {
 		Target  string
-		Mapping interfaces.SampleMapping
+		Mapping interfaces.ExampleMapping
 	}
 )
 
-func NewExecArgs(target string, mapping interfaces.SampleMapping) *ExecArgs {
+func NewExecArgs(target string, mapping interfaces.ExampleMapping) *ExecArgs {
 	a := new(ExecArgs)
 	a.Target = target
 	a.Mapping = mapping
@@ -31,7 +31,7 @@ func NewExecCommand(args *ExecArgs) *ExecCommand {
 
 func (c *ExecCommand) Run() error {
 	var (
-		target  = interfaces.SampleKey(c.Args.Target)
+		target  = interfaces.ExampleKey(c.Args.Target)
 		mapping = c.Args.Mapping
 	)
 
diff --git a/cmd/trygolang/main.go b/cmd/trygolang/main.go
@@ -11,7 +11,7 @@ import (
 func main() {
 	var (
 		args    *Args
-		mapping interfaces.SampleMapping
+		mapping interfaces.ExampleMapping
 	)
 
 	args = NewArgs()
diff --git a/cmd/trygolang/runloop.go b/cmd/trygolang/runloop.go
@@ -16,11 +16,11 @@ type (
 
 	RunLoopArgs struct {
 		MainArgs *Args
-		Mapping  interfaces.SampleMapping
+		Mapping  interfaces.ExampleMapping
 	}
 )
 
-func NewRunLoopArgs(mainArgs *Args, mapping interfaces.SampleMapping) *RunLoopArgs {
+func NewRunLoopArgs(mainArgs *Args, mapping interfaces.ExampleMapping) *RunLoopArgs {
 	a := new(RunLoopArgs)
 	a.MainArgs = mainArgs
 	a.Mapping = mapping
@@ -110,7 +110,7 @@ func (c *RunLoopCommand) Run() error {
 	return nil
 }
 
-func (c *RunLoopCommand) exec(target string, mapping interfaces.SampleMapping) error {
+func (c *RunLoopCommand) exec(target string, mapping interfaces.ExampleMapping) error {
 	execArgs := NewExecArgs(target, mapping)
 	execCmd := NewExecCommand(execArgs)
 
@@ -121,7 +121,7 @@ func (c *RunLoopCommand) exec(target string, mapping interfaces.SampleMapping) e
 	return nil
 }
 
-func (c *RunLoopCommand) makeCandidates(userInput string, mapping interfaces.SampleMapping) []string {
+func (c *RunLoopCommand) makeCandidates(userInput string, mapping interfaces.ExampleMapping) []string {
 	candidates := make([]string, 0, len(mapping))
 	for k := range mapping {
 		key := string(k)
diff --git a/cmd/trygolang/runonce.go b/cmd/trygolang/runonce.go
@@ -14,7 +14,7 @@ type (
 	}
 )
 
-func NewRunOnceArgs(target string, mapping interfaces.SampleMapping) *RunOnceArgs {
+func NewRunOnceArgs(target string, mapping interfaces.ExampleMapping) *RunOnceArgs {
 	a := new(RunOnceArgs)
 	a.Target = target
 	a.Mapping = mapping
diff --git a/cmd/trygolang/utils.go b/cmd/trygolang/utils.go
@@ -6,7 +6,7 @@ import (
 	"sort"
 )
 
-func printAllExampleNames(mapping interfaces.SampleMapping) {
+func printAllExampleNames(mapping interfaces.ExampleMapping) {
 	names := make([]string, 0, len(mapping))
 
 	for k := range mapping {
diff --git a/effectivego/examples.go b/effectivego/examples.go
@@ -14,7 +14,7 @@ func NewRegister() interfaces.Register {
 	return r
 }
 
-func (r *effectivegoExampleRegister) Regist(m interfaces.SampleMapping) {
+func (r *effectivegoExampleRegister) Regist(m interfaces.ExampleMapping) {
 	m["effective_go_intro"] = Introduction
 	m["effective_go_formatting"] = Formatting
 	m["effective_go_comment"] = Commentary
diff --git a/interfaces/register.go b/interfaces/register.go
@@ -4,6 +4,6 @@ type (
 	// Register は、各パッケージ毎のサンプルを登録するためのインターフェースです.
 	Register interface {
 		// 指定されたマッピングに自身のサンプル情報を登録します.
-		Regist(m SampleMapping)
+		Regist(m ExampleMapping)
 	}
 )
diff --git a/interfaces/types.go b/interfaces/types.go
@@ -2,22 +2,22 @@ package interfaces
 
 type (
 	// SampleKeyは、サンプル名を表すキーを表します
-	SampleKey string
+	ExampleKey string
 
 	// SampleFuncは、実行するサンプル処理を表します
-	SampleFunc func() error
+	ExampleFunc func() error
 
 	// SampleMappingは、サンプルのマッピング定義を表します
-	SampleMapping map[SampleKey]SampleFunc
+	ExampleMapping map[ExampleKey]ExampleFunc
 )
 
 // NewSampleMapping は、SampleMappingのコンストラクタ関数です
-func NewSampleMapping() SampleMapping {
-	return make(SampleMapping)
+func NewSampleMapping() ExampleMapping {
+	return make(ExampleMapping)
 }
 
 // MakeMapping は、マッピングを生成します
-func (m SampleMapping) MakeMapping(registers ...Register) {
+func (m ExampleMapping) MakeMapping(registers ...Register) {
 	for _, register := range registers {
 		register.Regist(m)
 	}
diff --git a/lib/mapping.go b/lib/mapping.go
@@ -10,7 +10,7 @@ import (
 )
 
 // MakeMapping は、サンプル実行のためのマッピング情報を生成します.
-func MakeMapping() interfaces.SampleMapping {
+func MakeMapping() interfaces.ExampleMapping {
 	mapping := interfaces.NewSampleMapping()
 
 	mapping.MakeMapping(
diff --git a/tutorial/examples.go b/tutorial/examples.go
@@ -14,7 +14,7 @@ func NewRegister() interfaces.Register {
 	return r
 }
 
-func (r *tutorialExampleRegister) Regist(m interfaces.SampleMapping) {
+func (r *tutorialExampleRegister) Regist(m interfaces.ExampleMapping) {
 	m["tutorial_gotour_helloworld"] = HelloWorld
 	m["tutorial_gotour_import"] = Import
 	m["tutorial_gotour_scope"] = Scope

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ func NewRegister() interfaces.Register {`
`21`	`21`	`return r`
`22`	`22`	`}`
`23`	`23`
`24`		`-func (r *advancedExampleRegister) Regist(m interfaces.SampleMapping) {`
	`24`	`+func (r *advancedExampleRegister) Regist(m interfaces.ExampleMapping) {`
`25`	`25`	`m["async01"] = async.Async01`
`26`	`26`	`m["async_producer_consumer"] = async.ProducerConsumer`
`27`	`27`	`m["closure01"] = closure.Closure01`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ func NewRegister() interfaces.Register {`
`45`	`45`	`return r`
`46`	`46`	`}`
`47`	`47`
`48`		`-func (r *basicExampleRegister) Regist(m interfaces.SampleMapping) {`
	`48`	`+func (r *basicExampleRegister) Regist(m interfaces.ExampleMapping) {`
`49`	`49`	`m["builtin_print"] = builtin_.PrintFunc`
`50`	`50`	`m["error_basic"] = error_.Basic`
`51`	`51`	`m["error_sentinel"] = error_.Sentinel`
Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,5 @@ func NewRegister() interfaces.Register {`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`//noinspection GoUnusedParameter`
`18`		`-func (r *booksExampleRegister) Regist(m interfaces.SampleMapping) {`
	`18`	`+func (r *booksExampleRegister) Regist(m interfaces.ExampleMapping) {`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import (`
`7`	`7`
`8`	`8`	`type (`
`9`	`9`	`ExecError struct {`
`10`		`- Name interfaces.SampleKey`
	`10`	`+ Name interfaces.ExampleKey`
`11`	`11`	`Err error`
`12`	`12`	`}`
`13`	`13`	`)`
Original file line number	Diff line number	Diff line change
`@@ -12,11 +12,11 @@ type (`
`12`	`12`
`13`	`13`	`ExecArgs struct {`
`14`	`14`	`Target string`
`15`		`- Mapping interfaces.SampleMapping`
	`15`	`+ Mapping interfaces.ExampleMapping`
`16`	`16`	`}`
`17`	`17`	`)`
`18`	`18`
`19`		`-func NewExecArgs(target string, mapping interfaces.SampleMapping) *ExecArgs {`
	`19`	`+func NewExecArgs(target string, mapping interfaces.ExampleMapping) *ExecArgs {`
`20`	`20`	`a := new(ExecArgs)`
`21`	`21`	`a.Target = target`
`22`	`22`	`a.Mapping = mapping`
`@@ -31,7 +31,7 @@ func NewExecCommand(args ExecArgs) ExecCommand {`
`31`	`31`
`32`	`32`	`func (c *ExecCommand) Run() error {`
`33`	`33`	`var (`
`34`		`- target = interfaces.SampleKey(c.Args.Target)`
	`34`	`+ target = interfaces.ExampleKey(c.Args.Target)`
`35`	`35`	`mapping = c.Args.Mapping`
`36`	`36`	`)`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import (`
`11`	`11`	`func main() {`
`12`	`12`	`var (`
`13`	`13`	`args *Args`
`14`		`- mapping interfaces.SampleMapping`
	`14`	`+ mapping interfaces.ExampleMapping`
`15`	`15`	`)`
`16`	`16`
`17`	`17`	`args = NewArgs()`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ type (`
`14`	`14`	`}`
`15`	`15`	`)`
`16`	`16`
`17`		`-func NewRunOnceArgs(target string, mapping interfaces.SampleMapping) *RunOnceArgs {`
	`17`	`+func NewRunOnceArgs(target string, mapping interfaces.ExampleMapping) *RunOnceArgs {`
`18`	`18`	`a := new(RunOnceArgs)`
`19`	`19`	`a.Target = target`
`20`	`20`	`a.Mapping = mapping`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import (`
`6`	`6`	`"sort"`
`7`	`7`	`)`
`8`	`8`
`9`		`-func printAllExampleNames(mapping interfaces.SampleMapping) {`
	`9`	`+func printAllExampleNames(mapping interfaces.ExampleMapping) {`
`10`	`10`	`names := make([]string, 0, len(mapping))`
`11`	`11`
`12`	`12`	`for k := range mapping {`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ func NewRegister() interfaces.Register {`
`14`	`14`	`return r`
`15`	`15`	`}`
`16`	`16`
`17`		`-func (r *effectivegoExampleRegister) Regist(m interfaces.SampleMapping) {`
	`17`	`+func (r *effectivegoExampleRegister) Regist(m interfaces.ExampleMapping) {`
`18`	`18`	`m["effective_go_intro"] = Introduction`
`19`	`19`	`m["effective_go_formatting"] = Formatting`
`20`	`20`	`m["effective_go_comment"] = Commentary`