trackler 2.2.1.14 → 2.2.1.15

data/tracks/go/config/maintainers.json

@@ -1,78 +1,78 @@
 {
+  "docs_url": "https://github.com/exercism/docs/blob/master/maintaining-a-track/maintainer-configuration.md",
   "maintainers": [
     {
-      "github_username": "bmatsuo",
-      "show_on_website": false,
       "alumnus": false,
-      "name": null,
+      "avatar_url": null,
       "bio": null,
+      "github_username": "bmatsuo",
       "link_text": null,
       "link_url": null,
-      "avatar_url": null
+      "name": null,
+      "show_on_website": false
     },
     {
-      "github_username": "kytrinyx",
       "alumnus": true,
-      "name": "Katrina Owen",
-      "bio": "I love Go for its simplicity and consistency. I also appreciate how hard the Go project is working to make the ecosystem welcoming to newcomers. I no longer maintain the Go track, but still maintain the Go tooling on Exercism."
+      "bio": "I love Go for its simplicity and consistency. I also appreciate how hard the Go project is working to make the ecosystem welcoming to newcomers. I no longer maintain the Go track, but still maintain the Go tooling on Exercism.",
+      "github_username": "kytrinyx",
+      "name": "Katrina Owen"
     },
     {
-      "github_username": "petertseng",
-      "show_on_website": false,
       "alumnus": false,
-      "name": null,
+      "avatar_url": null,
       "bio": null,
+      "github_username": "petertseng",
       "link_text": null,
       "link_url": null,
-      "avatar_url": null
+      "name": null,
+      "show_on_website": false
     },
     {
-      "github_username": "ferhatelmas",
-      "show_on_website": false,
       "alumnus": false,
-      "name": null,
+      "avatar_url": null,
       "bio": null,
+      "github_username": "ferhatelmas",
       "link_text": null,
       "link_url": null,
-      "avatar_url": null
+      "name": null,
+      "show_on_website": false
     },
     {
       "github_username": "tleen",
-      "show_on_website": true,
-      "name": "Tom Leen",
       "link_text": "thomasleen.com",
-      "link_url": "http://www.thomasleen.com"
+      "link_url": "http://www.thomasleen.com",
+      "name": "Tom Leen",
+      "show_on_website": true
     },
     {
-      "github_username": "soniakeys",
-      "show_on_website": false,
       "alumnus": false,
-      "name": null,
+      "avatar_url": null,
       "bio": null,
+      "github_username": "soniakeys",
       "link_text": null,
       "link_url": null,
-      "avatar_url": null
+      "name": null,
+      "show_on_website": false
     },
     {
-      "github_username": "robphoenix",
-      "show_on_website": true,
       "alumnus": false,
-      "name": "Rob Phoenix",
+      "avatar_url": null,
       "bio": "I used to be an artist, and am now a software engineer, using Go to build tools for network engineers. Maintaining Exercism's Go track has opened up the world of open source to me.",
+      "github_username": "robphoenix",
       "link_text": "robphoenix.com",
       "link_url": "https://blog.robphoenix.com/",
-      "avatar_url": null
+      "name": "Rob Phoenix",
+      "show_on_website": true
     },
     {
-      "github_username": "leenipper",
-      "show_on_website": true,
       "alumnus": false,
-      "name": "Lee Nipper",
+      "avatar_url": null,
       "bio": "Firmware Engineer by day. I like Go a lot, and I'm optimistic about its adoption. Helping on Exercism track allows me to learn more. My focus is adding exercise solutions and test case generators.",
+      "github_username": "leenipper",
       "link_text": null,
       "link_url": null,
-      "avatar_url": null
+      "name": "Lee Nipper",
+      "show_on_website": true
     }
-  ],
-  "docs_url": "https://github.com/exercism/docs/blob/master/maintaining-a-track/maintainer-configuration.md"
-}
+  ]
+}

data/tracks/go/exercises/accumulate/README.md

@@ -25,9 +25,6 @@ Keep your hands off that collect/map/fmap/whatchamacallit functionality
 provided by your standard library!
 Solve this one yourself using other basic tools instead.
 
-Lisp specific: it's perfectly fine to use `MAPCAR` or the equivalent,
-as this is idiomatic Lisp, not a library function.
-
 ## Running the tests
 
 To run the tests run the command `go test` from within the exercise directory.

data/tracks/go/exercises/hello-world/example.go

@@ -1,7 +1,5 @@
 package greeting
 
-const testVersion = 4
-
 // HelloWorld greets the world.
 func HelloWorld() string {
 	return "Hello, World!"

data/tracks/go/exercises/hello-world/hello_test.go

@@ -6,26 +6,6 @@ import "testing"
 // and returns a string.
 // In other words, define a function with the following signature:
 // HelloWorld() string
-//
-// In any exercise solution using the following tests you must also define a
-// "testVersion" constant with a value that matches the targetTestVersion
-// here. See how it is done in the the ./hello_world.go file provided.
-// This is a common convention for ensuring test consistency throughout the
-// Exercism Go language track.
-//
-// See TestTestVersion function below for how this and the testVersion
-// constants are used.
-const targetTestVersion = 4
-
-// TestTestVersion is used to ensure the exercise solution is considered
-// compatible with the rest of the tests. It should be the initial testing
-// function in any test suite. If there is an incompatibility the tests can
-// be considered unreliable therefore this function will abort the testing.
-func TestTestVersion(t *testing.T) {
-	if testVersion != targetTestVersion {
-		t.Fatalf("Found testVersion = %v, want %v", testVersion, targetTestVersion)
-	}
-}
 
 func TestHelloWorld(t *testing.T) {
 	expected := "Hello, World!"

data/tracks/go/exercises/hello-world/hello_world.go

@@ -1,42 +1,7 @@
-// This is a "stub" file.  It's a little start on your solution.
-// It's not a complete solution though; you have to write some code.
-
-// Package greeting should have a package comment that summarizes what it's about.
-// https://golang.org/doc/effective_go.html#commentary
-// While documentation is taken very seriously in Go, and tools like golint will
-// complain if you don't include it, these comments are not required to make
-// the test suite pass. It is up to you whether to include them in your submitted
-// exercises.
-// You can read more about the importance of documentation in Go here:
-// https://blog.golang.org/godoc-documenting-go-code
 package greeting
 
-// testVersion identifies the version of the test program that you are
-// writing your code to. If the test program changes in the future --
-// after you have posted this code to the Exercism site -- reviewers
-// will see that your code can't necessarily be expected to pass the
-// current test suite because it was written to an earlier test version.
-//
-// This is a convention done for Exercism exercises in the Go language track,
-// it is not a requirement of the Go programming language.
-//
-// This test versioning setup will be common to all the exercises in the
-// Go language track. When crafting your own solution file from scratch you
-// will be expected to add this constant or the initial test will fail.
-// The version number you should use will be found in the constant
-// "targetTestVersion" in the test file, see ./hello_test.go for more
-// information.
-const testVersion = 4
-
-// HelloWorld should have a comment documenting it, beginning with the name of
-// the function. It is recommended good practice, but, as we mention above, it's
-// not necessary for making your solutions pass.
-// https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
 func HelloWorld() string {
 	// Write some code here to pass the test suite.
-
-	// When you have a working solution, REMOVE ALL THE STOCK COMMENTS.
-	// They're here to help you get started but they only clutter a finished solution.
-	// If you leave them in, reviewers will protest!
+	// Then delete this comment stub.
 	return ""
 }

data/tracks/go/exercises/leap/leap.go

@@ -3,5 +3,4 @@ package leap
 const testVersion = 3
 
 func IsLeapYear(int) bool {
-	// Write some code here to pass the test suite.
 }

data/tracks/go/exercises/leap/leap_test.go

@@ -2,11 +2,15 @@ package leap
 
 import "testing"
 
-// Define a function with the following signature:
-// IsLeapYear(int) bool
-
+// targetTestVersion is used to ensure that a solution is only evaluated
+// against the correct version of the test suite.
 const targetTestVersion = 3
 
+// TestTestVersion compares the targetTestVersion defined above with
+// a testVersion value.
+// This is a common convention throughout the Go Exercism track.
+// To make a test like this test pass, define 'testVersion' in your solution.
+// We've done this for you in the ./leap.go file provided.
 func TestTestVersion(t *testing.T) {
 	if testVersion != targetTestVersion {
 		t.Fatalf("Found testVersion = %v, want %v", testVersion, targetTestVersion)

data/tracks/go/exercises/two-fer/README.md

@@ -0,0 +1,66 @@
+# Two Fer
+
+`Two-fer` or `2-fer` is short for two for one. One for you and one for me.
+
+```
+"One for X, one for me."
+```
+
+When X is a name or "you".
+
+If the given name is "Alice", the result should be "One for Alice, one for me."
+If no name is given, the result should be "One for you, one for me."
+
+
+## Test-Driven Development
+
+As programmers mature, they eventually want to test their code.
+
+Here at Exercism we simulate [Test-Driven
+Development](http://en.wikipedia.org/wiki/Test-driven_development) (TDD), where
+you write your tests before writing any functionality. The simulation comes in
+the form of a pre-written test suite, which will signal that you have solved
+the problem.
+
+It will also provide you with a safety net to explore other solutions without
+breaking the functionality.
+
+### A typical TDD workflow on Exercism:
+
+1. Run the test file and pick one test that's failing.
+2. Write some code to fix the test you picked.
+3. Re-run the tests to confirm the test is now passing.
+4. Repeat from step 1.
+5. Submit your solution (`exercism submit /path/to/file`)
+
+## Instructions
+
+Submissions are encouraged to be general, within reason. Having said that, it's
+also important not to over-engineer a solution.
+
+It's important to remember that the goal is to make code as expressive and
+readable as we can.
+
+## Running the tests
+
+To run the tests run the command `go test` from within the exercise directory.
+
+If the test suite contains benchmarks, you can run these with the `-bench`
+flag:
+
+    go test -bench .
+
+Keep in mind that each reviewer will run benchmarks on a different machine, with
+different specs, so the results from these benchmark tests may vary.
+
+## Further information
+
+For more detailed information about the Go track, including how to get help if
+you're having trouble, please visit the exercism.io [Go language page](http://exercism.io/languages/go/about).
+
+## Source
+
+This is an exercise to introduce users to basic programming constructs, just after hello World. [https://en.wikipedia.org/wiki/Two-fer](https://en.wikipedia.org/wiki/Two-fer)
+
+## Submitting Incomplete Solutions
+It's possible to submit an incomplete solution so you can see how others have completed the exercise.

data/tracks/go/exercises/two-fer/example.go

@@ -0,0 +1,9 @@
+package twofer
+
+// ShareWith apportions the goods between two people.
+func ShareWith(name string) string {
+	if name == "" {
+		name = "you"
+	}
+	return "One for " + name + ", one for me."
+}

data/tracks/go/exercises/{hello-world/example_helloworld_test.go → two-fer/example_two_fer_test.go}

@@ -1,20 +1,20 @@
-package greeting
+package twofer
 
 import "fmt"
 
-// ExampleHelloWorld() is an Example function. Examples are testable snippets of
-// Go code that are used for documenting, and verifying, the package API.
+// ExampleShareWith() is an Example function. Examples are testable snippets of
+// Go code that are used for documenting and verifying the package API.
 // They may be present in some exercises to demonstrate the expected use of the
-// exercise API and can be run as part of a package's test suite
+// exercise API and can be run as part of a package's test suite.
 //
 // When an Example test is run the data that is written to standard output is
 // compared to the data that comes after the "Output: " comment.
 //
-// So, below, the result of HelloWorld() is passed to standard output
-// using fmt.Println, and this is compared against the expected output; Hello, World!
+// Below the result of ShareWith() is passed to standard output
+// using fmt.Println, and this is compared against the expected output.
 // If they are equal, the test passes.
-func ExampleHelloWorld() {
-	h := HelloWorld()
+func ExampleShareWith() {
+	h := ShareWith("")
 	fmt.Println(h)
-	// Output: Hello, World!
+	// Output: One for you, one for me.
 }

data/tracks/go/exercises/two-fer/two_fer.go

@@ -0,0 +1,15 @@
+// This is a "stub" file.  It's a little start on your solution.
+// It's not a complete solution though; you have to write some code.
+
+// Package twofer should have a package comment that summarizes what it's about.
+// https://golang.org/doc/effective_go.html#commentary
+package twofer
+
+// ShareWith needs a comment documenting it.
+func ShareWith(string) string {
+	// Write some code here to pass the test suite.
+	// Then remove all the stock comments.
+	// They're here to help you get started but they only clutter a finished solution.
+	// If you leave them in, reviewers will protest!
+	return ""
+}

data/tracks/go/exercises/two-fer/two_fer_test.go

@@ -0,0 +1,20 @@
+package twofer
+
+import "testing"
+
+// Define a function ShareWith(string) string.
+
+func TestShareWith(t *testing.T) {
+	tests := []struct {
+		name, expected string
+	}{
+		{"", "One for you, one for me."},
+		{"Alice", "One for Alice, one for me."},
+		{"Bob", "One for Bob, one for me."},
+	}
+	for _, test := range tests {
+		if observed := ShareWith(test.name); observed != test.expected {
+			t.Fatalf("ShareWith(%s) = %v, want %v", test.name, observed, test.expected)
+		}
+	}
+}

data/tracks/go/gen/gen.go

@@ -17,15 +17,16 @@ import (
 	"time"
 )
 
-// dirMetadata is the location of the x-common repository on the filesystem.
-// We're making the assumption that the x-common repository has been cloned to
+// dirMetadata is the location of the problem-specifications repository on the filesystem.
+// We're making the assumption that the problem-specifications repository has been cloned to
 // the same parent directory as the Exercism Go track repository.
 // E.g.
 //
 //     $ tree -L 1 .
 //     .
-//     ├── x-common
+//     ├── problem-specifications
 //     └── go
+//
 var dirMetadata string
 
 // dirExercise is the location that the test cases should be generated to.
@@ -40,10 +41,10 @@ var genClient = &http.Client{Timeout: 10 * time.Second}
 const (
 	// canonicalDataURL is the URL for the raw canonical-data.json data,
 	// requires exercise name.
-	canonicalDataURL = "https://raw.githubusercontent.com/exercism/x-common/master/exercises/%s/canonical-data.json"
+	canonicalDataURL = "https://raw.githubusercontent.com/exercism/problem-specifications/master/exercises/%s/canonical-data.json"
 	// commitsURL is the GitHub api endpoint for the canonical-data.json
 	// file commit history, requires exercise name.
-	commitsURL = "https://api.github.com/repos/exercism/x-common/commits?path=exercises/%s/canonical-data.json"
+	commitsURL = "https://api.github.com/repos/exercism/problem-specifications/commits?path=exercises/%s/canonical-data.json"
 )
 
 // Header tells how the test data was generated, for display in the header of
@@ -60,14 +61,14 @@ func (h Header) String() string {
 		s += fmt.Sprintf("// Commit: %s\n", h.Commit)
 	}
 	if h.Version != "" {
-		s += fmt.Sprintf("// x-common version: %s\n", h.Version)
+		s += fmt.Sprintf("// Problem Specifications Version: %s\n", h.Version)
 	}
 	return s
 }
 
 func init() {
 	if _, path, _, ok := runtime.Caller(0); ok {
-		dirMetadata = filepath.Join(path, "..", "..", "..", "x-common")
+		dirMetadata = filepath.Join(path, "..", "..", "..", "problem-specifications")
 	}
 	if _, path, _, ok := runtime.Caller(2); ok {
 		dirExercise = filepath.Join(path, "..", "..")
@@ -171,7 +172,7 @@ func Gen(exercise string, j interface{}, t *template.Template) error {
 }
 
 func getLocal(jFile string) (jPath, jOrigin, jCommit string) {
-	// Ideally draw from a .json which is pulled from the official x-common
+	// Ideally draw from a .json which is pulled from the official problem-specifications
 	// repository.  For development however, accept a file in current directory
 	// if there is no .json in source control.  Also allow an override in any
 	// case by environment variable.
@@ -188,7 +189,7 @@ func getLocal(jFile string) (jPath, jOrigin, jCommit string) {
 		return "", "local file", "" // not in source control
 	}
 	// good.  return source control dir and commit.
-	return c.Dir, "exercism/x-common", string(bytes.TrimSpace(origin))
+	return c.Dir, "exercism/problem-specifications", string(bytes.TrimSpace(origin))
 }
 
 func getRemote(exercise string) (body []byte, jOrigin string, jCommit string, err error) {
@@ -212,7 +213,7 @@ func getRemote(exercise string) (body []byte, jOrigin string, jCommit string, er
 		return []byte{}, "", "", err
 	}
 	log.Printf("[REMOTE] source: %s\n", url)
-	return body, "exercism/x-common", c, nil
+	return body, "exercism/problem-specifications", c, nil
 }
 
 func getRemoteCommit(exercise string) (string, error) {