trackler 2.1.0.18 → 2.1.0.19

data/lib/trackler/implementation.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'forwardable'
 require_relative 'file_bundle'
 
 module Trackler
@@ -10,14 +11,22 @@ module Trackler
       "/\.meta/"
     ]
 
-    attr_reader :track, :problem
+    extend Forwardable
+    def_delegators :@problem, :name, :blurb, :description, :source_markdown, :slug, :source, :metadata, :root, :active?, :deprecated?, :source_url, :description_url, :canonical_data_url, :metadata_url
+
     def initialize(track, problem)
       @track = track
       @problem = problem
     end
 
-    def file_bundle
-      @file_bundle ||= FileBundle.new(implementation_dir, regexes_to_ignore)
+    def initialize_copy(original)
+      super
+      @files = original.files.dup
+    end
+
+    def problem
+      warn "DEPRECATION WARNING: The `problem` method is deprecated, Implementation can do everything that Problem can, so call the method directly."
+      @problem
     end
 
     def exists?
@@ -63,52 +72,44 @@ module Trackler
 
     private
 
+    attr_reader :track
+
     def regexes_to_ignore
-      (IGNORE_PATTERNS + [@track.ignore_pattern]).map do |pattern|
+      (IGNORE_PATTERNS + [track.ignore_pattern]).map do |pattern|
         Regexp.new(pattern, Regexp::IGNORECASE)
       end
     end
 
+    def file_bundle
+      @file_bundle ||= FileBundle.new(implementation_dir, regexes_to_ignore)
+    end
+
     def implementation_dir
       @implementation_dir ||= track.dir.join(exercise_dir)
     end
 
     def exercise_dir
-      if File.exist?(track.dir.join('exercises'))
-        File.join('exercises', problem.slug)
-      else
-        problem.slug
-      end
+      File.join('exercises', slug)
     end
 
     def assemble_readme
       <<-README
-# #{readme_title}
-
-#{problem.blurb}
+# #{name}
 
 #{readme_body}
 
-#{readme_source}
+#{source_markdown}
 
 #{incomplete_solutions_body}
       README
     end
 
-    def readme_title
-      problem.name
-    end
-
     def readme_body
-      [
-        problem.description,
-        implementation_hints,
-        track.hints,
-      ].reject(&:empty?).join("\n").strip
-    end
-
-    def readme_source
-      problem.source_markdown
+        [
+          description,
+          implementation_hints,
+          track.hints,
+        ].reject(&:empty?).join("\n").strip
     end
 
     def incomplete_solutions_body
@@ -119,15 +120,8 @@ It's possible to submit an incomplete solution so you can see how others have co
     end
 
     def implementation_hints
-      read File.join(implementation_dir, 'HINTS.md')
-    end
-
-    def read(f)
-      if File.exist?(f)
-        File.read(f)
-      else
-        ""
-      end
+      hints_file = File.join(implementation_dir, 'HINTS.md')
+      File.exist?(hints_file) ? File.read(hints_file) : ''
     end
   end
 end

data/lib/trackler/implementations.rb

@@ -21,6 +21,12 @@ module Trackler
       by_slug[slug]
     end
 
+    def length
+      all.length
+    end
+
+    alias_method :size, :length
+
     private
 
     def all
@@ -38,7 +44,7 @@ module Trackler
         Implementation.new(track, Problem.new(k, root, track))
       }
       all.each do |impl|
-        hash[impl.problem.slug] = impl
+        hash[impl.slug] = impl
       end
       hash
     end

data/lib/trackler/track.rb

@@ -36,11 +36,11 @@ module Trackler
     end
 
     def upcoming?
-      !active? && problems.length > 0
+      !active? && implementations.length > 0
     end
 
     def planned?
-      !active? && problems.length.zero?
+      !active? && implementations.length.zero?
     end
 
     def implementations
@@ -48,7 +48,8 @@ module Trackler
     end
 
     def problems
-      @problems ||= implementations.map(&:problem)
+      warn "DEPRECATION WARNING: A track only has implementations, call track.implementations instead"
+      implementations
     end
 
     def checklist_issue

data/lib/trackler/version.rb

@@ -1,3 +1,3 @@
 module Trackler
-  VERSION = "2.1.0.18"
+  VERSION = "2.1.0.19"
 end

data/lib/trackler.rb

@@ -38,7 +38,7 @@ module Trackler
     @implementations = Hash.new { |h, k| h[k] = [] }
     tracks.each do |track|
       track.implementations.each do |implementation|
-        @implementations[implementation.problem.slug] << implementation
+        @implementations[implementation.slug] << implementation
       end
     end
     @implementations

data/tracks/ecmascript/.github/stale.yml

@@ -0,0 +1,6 @@
+# Issues or Pull Requests with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - good first patch
+  - first-timers only

data/tracks/ecmascript/README.md

@@ -4,24 +4,33 @@
 
 Exercism exercises in ECMAScript 6
 
+
 ## Running the Unit Test Suite
 
-[Node.js](https://nodejs.org) must be installed.  We recommend using the latest stable version (v7 at the moment.)
+[Node.js](https://nodejs.org) must be installed. Follow [these instructions](http://exercism.io/languages/ecmascript/installing) for installing nodejs.
+We recommend using the latest stable version (v7 at the moment).
 
-    % npm install
+Use `npm` to install all required dependencies:
 
-Then, the `make` command will install other dependencies as needed.
+    % npm install
 
-### Linting Your Code
-This project uses [eslint](https://github.com/eslint/eslint) to help you write quality JavaScript code by checking for common formatting errors, enforcing style rules, and suggesting changes that conform to best practices.  
+#### Linting Your Code
+This project uses [eslint](https://github.com/eslint/eslint) to help you write quality
+ECMAScript code by checking for common formatting errors, enforcing style rules,
+and suggesting changes that conform to best practices.
 
     % npm run lint-test
 
+#### Test All Assignments
+The make script will test all exercises:
 
-### All Assignments
-The make script will build and test all exercises.
+    % make test
+
+#### Test Specific Assignment
+Pass the exercise name to make script to run the tests for a specific exercise:
+
+    % make test-assignment ASSIGNMENT=hello-world
 
-    % make
 
 ## Contributing Guide
 
@@ -32,4 +41,3 @@ Please see the [contributing guide](https://github.com/exercism/x-api/blob/maste
 The MIT License (MIT)
 
 Copyright (c) 2014 Katrina Owen, _@kytrinyx.com
-

data/tracks/go/README.md

@@ -138,10 +138,13 @@ are useful if they let the solver try a change and see a performance effect.
 
 ### Testable examples
 
-Some exercises can contain [Example tests](https://blog.golang.org/examples) that document the exercise API. These
-examples are run alongside the standard exercise tests and will verify that the
-exercise API is working as expected. They are not required by all exercises and
-are most useful when clarifying the API of the exercise.
+Some exercises can contain [Example tests](https://blog.golang.org/examples)
+that document the exercise API. These examples are run alongside the standard
+exercise tests and will verify that the exercise API is working as expected.
+They are not required by all exercises and are not intended to replace the
+data-driven tests. They are most useful for providing examples of how an
+exercise's API is used. Have a look at the example tests in the [clock exercise](https://github.com/exercism/xgo/blob/master/exercises/clock/example_clock_test.go)
+to see them in action.
 
 ### Stub files
 

data/tracks/go/config.json

@@ -222,9 +222,12 @@
       ]
     },
     {
-      "difficulty": 1,
+      "difficulty": 5,
       "slug": "sum-of-multiples",
-      "topics": []
+      "topics": [
+	"Control-flow (loops)",
+	"Mathematics"
+      ]
     },
     {
       "difficulty": 1,

data/tracks/go/exercises/atbash-cipher/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/bob/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/bowling/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/bracket-push/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/change/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/clock/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/clock/example_clock_test.go

@@ -2,39 +2,53 @@ package clock
 
 import "fmt"
 
-func ExampleClock() {
-	// Create a clock
+func ExampleClock_new() {
+	// a new clock
 	clock1 := New(10, 30)
 	fmt.Println(clock1.String())
 
-	// Add 30 minutes to it
-	clock1 = clock1.Add(30)
-	fmt.Println(clock1.String())
+	// Output: 10:30
+}
 
-	// Subtract an hour and a half from it
-	clock1 = clock1.Add(-90)
-	fmt.Println(clock1.String())
+func ExampleClock_Add_add() {
+	// create a clock
+	clock := New(10, 30)
+
+	// add 30 minutes to it
+	clock = clock.Add(30)
+	fmt.Println(clock.String())
+
+	// Output: 11:00
+}
+
+func ExampleClock_Add_subtract() {
+	// create a clock
+	clock := New(10, 30)
+
+	// subtract an hour and a half from it
+	clock = clock.Add(-90)
+	fmt.Println(clock.String())
+
+	// Output: 09:00
+}
+
+func ExampleClock_compare() {
+	// a new clock
+	clock1 := New(10, 30)
 
-	// Create a second clock
-	clock2 := New(9, 30)
-	fmt.Println(clock2.String())
+	// a second clock, same as the first
+	clock2 := New(10, 30)
 
-	// Are the clocks equal?
+	// are the clocks equal?
 	fmt.Println(clock2 == clock1)
 
-	// Change the second clock
+	// change the second clock
 	clock2 = clock2.Add(30)
-	fmt.Println(clock2.String())
 
-	// Are the clocks equal now?
+	// are the clocks equal now?
 	fmt.Println(clock2 == clock1)
 
 	// Output:
-	// 10:30
-	// 11:00
-	// 09:30
-	// 09:30
 	// true
-	// 10:00
 	// false
 }

data/tracks/go/exercises/connect/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/custom-set/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/forth/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/gigasecond/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/hamming/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/largest-series-product/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/leap/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/luhn/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/meetup/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/phone-number/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/raindrops/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/rna-transcription/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/roman-numerals/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/scrabble-score/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/transpose/.meta/gen.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package main
 
 import (

data/tracks/go/exercises/variable-length-quantity/.meta/gen.go

@@ -0,0 +1,113 @@
+package main
+
+import (
+	"log"
+	"text/template"
+
+	"../../../gen"
+)
+
+func main() {
+	t := template.New("").Funcs(template.FuncMap{
+		"GroupComment": GroupComment,
+		"byteSlice":    byteSlice,
+		"lengthSlice":  lengthSlice,
+	})
+	t, err := t.Parse(tmpl)
+	if err != nil {
+		log.Fatal(err)
+	}
+	var j js
+	if err := gen.Gen("variable-length-quantity", &j, t); err != nil {
+		log.Fatal(err)
+	}
+}
+
+// byteSlice converts a slice of uint32 to a byte slice.
+func byteSlice(ns []uint32) []byte {
+	b := make([]byte, len(ns))
+	for i, n := range ns {
+		b[i] = byte(n)
+	}
+	return b
+}
+
+// lengthSlice returns the length of given slice.
+func lengthSlice(ns []uint32) int {
+	return len(ns)
+}
+
+// The JSON structure we expect to be able to unmarshal into
+type js struct {
+	Groups []TestGroup `json:"Cases"`
+}
+
+type TestGroup struct {
+	Description string
+	Cases       []OneCase
+}
+
+type OneCase struct {
+	Description string
+	Property    string   // "encode" or "decode"
+	Input       []uint32 // supports both []byte and []uint32 in JSON.
+	Expected    []uint32 // supports []byte, []uint32, or null in JSON.
+}
+
+// PropertyMatch returns true when given test case c has .Property field matching property;
+// this serves as a filter to put test cases with "like" property into the same group.
+func (c OneCase) PropertyMatch(property string) bool { return c.Property == property }
+
+// GroupComment looks in each of the test case groups to find the
+// group for which every test case has the .Property matching given property;
+// it returns the .Description field for the matching property group,
+// or a 'Note: ...' if no test group consistently matches given property.
+func GroupComment(groups []TestGroup, property string) string {
+	for _, group := range groups {
+		propertyGroupMatch := true
+		for _, testcase := range group.Cases {
+			if !testcase.PropertyMatch(property) {
+				propertyGroupMatch = false
+				break
+			}
+		}
+		if propertyGroupMatch {
+			return group.Description
+		}
+	}
+	return "Note: Apparent inconsistent use of \"property\": \"" + property + "\" within test case group!"
+}
+
+// template applied to above data structure generates the Go test cases
+var tmpl = `package variablelengthquantity
+
+{{.Header}}
+
+// {{GroupComment .J.Groups "encode"}}
+var encodeTestCases = []struct {
+	description string
+	input	[]uint32
+	output	[]byte
+}{ {{range .J.Groups}} {{range .Cases}}
+	{{if .PropertyMatch "encode"}} {
+		{{printf "%q" .Description}},
+		{{printf "%#v" .Input }},
+		{{byteSlice .Expected | printf "%#v" }},
+	},{{- end}}{{end}}{{end}}
+}
+
+// {{GroupComment .J.Groups "decode"}}
+var decodeTestCases = []struct {
+	description string
+	input	[]byte
+	output	[]uint32 // nil slice indicates error expected.
+	size int
+}{ {{range .J.Groups}} {{range .Cases}}
+	{{if .PropertyMatch "decode"}} {
+		{{printf "%q" .Description}},
+		{{byteSlice .Input | printf "%#v" }},
+		{{printf "%#v" .Expected }},
+		{{lengthSlice .Input}},
+	},{{- end}}{{end}}{{end}}
+}
+`