trackler 2.1.0.24 → 2.1.0.25

data/common/exercises/scale-generator/description.md

@@ -1,5 +1,3 @@
-Generate musical scales, given a starting note and a set of intervals.
-
 Given a tonic, or starting note, and a set of intervals, generate
 the musical scale starting with the tonic and following the
 specified interval pattern.

data/common/exercises/secret-handshake/description.md

@@ -1,5 +1,3 @@
-Given a decimal number, convert it to the appropriate sequence of events for a secret handshake.
-
 > There are 10 types of people in the world: Those who understand
 > binary, and those who don't.
 
@@ -16,6 +14,8 @@ binary decide to come up with a secret "handshake".
 10000 = Reverse the order of the operations in the secret handshake.
 ```
 
+Given a decimal number, convert it to the appropriate sequence of events for a secret handshake.
+
 Here's a couple of examples:
 
 Given the input 3, the function would return the array

data/common/exercises/series/description.md

@@ -1,4 +1,5 @@
-Given a string of digits, output all the contiguous substrings of length `n` in that string.
+Given a string of digits, output all the contiguous substrings of length `n` in
+that string.
 
 For example, the string "49142" has the following 3-digit series:
 

data/common/exercises/sieve/description.md

@@ -1,4 +1,5 @@
-Use the Sieve of Eratosthenes to find all the primes from 2 up to a given number.
+Use the Sieve of Eratosthenes to find all the primes from 2 up to a given
+number.
 
 The Sieve of Eratosthenes is a simple, ancient algorithm for finding all
 prime numbers up to any given limit. It does so by iteratively marking as

data/common/exercises/space-age/description.md

@@ -1,5 +1,3 @@
-Given an age in seconds, calculate how old someone is in terms of a given planet's solar years.
-
 Given an age in seconds, calculate how old someone would be on:
 
    - Earth: orbital period 365.25 Earth days, or 31557600 seconds

data/common/exercises/strain/description.md

@@ -1,8 +1,7 @@
-Implement the `keep` and `discard` operation on collections. Given a collection and a predicate on the collection's elements, `keep` returns a new collection containing those elements where the predicate is true, while `discard` returns a new collection containing those elements where the predicate is false.
-
-Write two functions that each take a function and a list.  One of them will
-return the list of items for which the passed in function is true, and the
-other will return the items for which it is false.
+Implement the `keep` and `discard` operation on collections. Given a collection
+and a predicate on the collection's elements, `keep` returns a new collection
+containing those elements where the predicate is true, while `discard` returns
+a new collection containing those elements where the predicate is false.
 
 For example, given the collection of numbers:
 

data/common/exercises/sublist/description.md

@@ -1,9 +1,6 @@
-Write a function to determine if a list is a sublist of another list.
-
-Write a function that given two lists determines if the first list is
-contained within the second list, if the second list is contained within
-the first list, if both lists are contained within each other or if none
-of these are true.
+Given two lists determine if the first list is contained within the second
+list, if the second list is contained within the first list, if both lists are
+contained within each other or if none of these are true.
 
 Specifically, a list A is a sublist of list B if by dropping 0 or more elements
 from the front of B and 0 or more elements from the back of B you get a list

data/common/exercises/sum-of-multiples/description.md

@@ -1,4 +1,5 @@
-Given a number, find the sum of all the multiples of particular numbers up to but not including that number.
+Given a number, find the sum of all the multiples of particular numbers up to
+but not including that number.
 
 If we list all the natural numbers up to but not including 20 that are
 multiples of either 3 or 5, we get 3, 5, 6 and 9, 10, 12, 15, and 18.

data/common/exercises/tournament/description.md

@@ -1,6 +1,7 @@
-Tally the results of a small football competition. Based on an input file
-containing which team played against which and what the outcome was
-create a file with a table like this:
+Tally the results of a small football competition.
+
+Based on an input file containing which team played against which and what the
+outcome was, create a file with a table like this:
 
 ```
 Team                           | MP |  W |  D |  L |  P

data/common/exercises/transpose/description.md

@@ -1,5 +1,3 @@
-Take input text and output it transposed.
-
 Given an input text output it transposed.
 
 Roughly explained, the transpose of a matrix:
@@ -56,4 +54,4 @@ BE
 
 In general, all characters from the input should also be present in the transposed output.
 That means that if a column in the input text contains only spaces on its bottom-most row(s), 
-the corresponding output row should contain the spaces in its right-most column(s).
+the corresponding output row should contain the spaces in its right-most column(s).

data/common/exercises/trinary/description.md

@@ -1,4 +1,5 @@
-Convert a trinary number, represented as a string (e.g. '102012'), to its decimal equivalent using first principles.
+Convert a trinary number, represented as a string (e.g. '102012'), to its
+decimal equivalent using first principles.
 
 The program should consider strings specifying an invalid trinary as the
 value 0.

data/common/exercises/two-bucket/description.md

@@ -1,5 +1,3 @@
-Given two buckets of different size, demonstrate how to measure an exact number of liters.
-
 Given two buckets of different size, demonstrate how to measure an exact number of liters by strategically transferring liters of fluid between the buckets.
 
 Since this mathematical problem is fairly subject to interpretation / individual approach, the tests have been written specifically to expect one overarching solution.
@@ -27,4 +25,4 @@ To conclude, the only valid moves are:
 - emptying one bucket and doing nothing to the other
 - filling one bucket and doing nothing to the other
 
-Written with <3 at [Fullstack Academy](http://www.fullstackacademy.com/) by [Lindsay](http://lindsaylevine.com).
+Written with <3 at [Fullstack Academy](http://www.fullstackacademy.com/) by [Lindsay](http://lindsaylevine.com).

data/common/exercises/two-fer/canonical-data.json

@@ -0,0 +1,24 @@
+{
+  "exercise": "two-fer",
+  "version": "1.0.0",
+  "cases": [
+    {
+      "description": "no name given",
+      "property": "twoFer",
+      "input": null,
+      "expected": "One for you, one for me."
+    },
+    {
+      "description": "a name given",
+      "property": "twoFer",
+      "input": "Alice",
+      "expected": "One for Alice, one for me."
+    },
+    {
+      "description": "another name given",
+      "property": "twoFer",
+      "input": "Bob",
+      "expected": "One for Bob, one for me."
+    }
+  ]
+}

data/common/exercises/two-fer/description.md

@@ -0,0 +1,40 @@
+`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.

data/common/exercises/two-fer/metadata.yml

@@ -0,0 +1,4 @@
+---
+blurb: 'Create a sentence of the form "One for X, one for me."'
+source: "This is an exercise to introduce users to basic programming constructs, just after hello World."
+source_url: "https://en.wikipedia.org/wiki/Two-fer"

data/common/exercises/word-search/description.md

@@ -1,5 +1,3 @@
-Create a program to solve a word search puzzle.
-
 In word search puzzles you get a square of letters and have to find specific
 words in them.
 
@@ -23,5 +21,5 @@ There are several programming languages hidden in the above square.
 Words can be hidden in all kinds of directions: left-to-right, right-to-left,
 vertical and diagonal.
 
-Create a program that given a puzzle and a list of words returns the location
-of the first and last letter of each word.
+Given a puzzle and a list of words return the location of the first and last
+letter of each word.

data/common/exercises/zebra-puzzle/description.md

@@ -18,7 +18,7 @@ Solve the zebra puzzle.
 
 Each of the five houses is painted a different color, and their
 inhabitants are of different national extractions, own different pets,
-drink different beverages and smoke different brands of cigarets.
+drink different beverages and smoke different brands of cigarettes.
 
 Which of the residents drinks water?
 Who owns the zebra?

data/lib/trackler.rb

@@ -6,6 +6,7 @@ module Trackler
     @path = nil
     @implementations = nil
     @problems = nil
+    @specifications = nil
     @tracks = nil
     @todos = nil
   end
@@ -24,6 +25,10 @@ module Trackler
     @path = Trackler::Path.fixtures
   end
 
+  def self.specifications
+    @specifications ||= Specifications.new(path)
+  end
+
   def self.problems
     @problems ||= Problems.new(path)
   end
@@ -47,15 +52,15 @@ module Trackler
   def self.todos
     return @todos if !!@todos
 
-    slugs = problems.map(&:slug)
+    slugs = specifications.map(&:slug)
 
     @todos = Hash.new { |h, k| h[k] = [] }
     tracks.each do |track|
       todos = slugs - track.slugs
-      @todos[track.id] = problems.select { |problem|
-        todos.include?(problem.slug)
-      }.sort_by { |problem|
-        [implementations[problem.slug].count * -1, problem.name]
+      @todos[track.id] = specifications.select { |specification|
+        todos.include?(specification.slug)
+      }.sort_by { |specification|
+        [implementations[specification.slug].count * -1, specification.name]
       }
     end
     @todos

data/lib/trackler/description.rb

@@ -2,8 +2,8 @@ require_relative 'guaranteed_file'
 
 module Trackler
   class Description
-    def self.for(problem:, track: )
-      new(GuaranteedFile.for(problem: problem, track: track, filename: 'description.md'))
+    def self.for(specification:, track: )
+      new(GuaranteedFile.for(specification: specification, track: track, filename: 'description.md'))
     end
 
     def initialize(description_file)

data/lib/trackler/guaranteed_file.rb

@@ -2,47 +2,47 @@ module Trackler
   class GuaranteedFile
     attr_accessor :content
 
-    def self.for(problem:, track:, filename:)
+    def self.for(specification:, track:, filename:)
       [TrackFile, CommonFile].detect(-> {NullFile}) do |d|
-        d.send(:exists?, problem: problem, track: track, filename: filename)
-      end.send(:new, problem: problem, track: track, filename: filename)
+        d.send(:exists?, specification: specification, track: track, filename: filename)
+      end.send(:new, specification: specification, track: track, filename: filename)
     end
 
     private
 
-    attr_accessor :problem, :track, :filename
+    attr_accessor :track, :filename, :specification
 
-    def self.exists?(problem:, track:, filename:)
-      File.exists?(location(problem: problem, track: track, filename: filename))
+    def self.exists?(specification:, track:, filename:)
+      File.exists?(location(specification: specification, track: track, filename: filename))
     end
     private_class_method :exists?
 
-    def initialize(problem:, track:, filename:)
-      self.problem = problem
+    def initialize(specification:, track:, filename:)
+      self.specification = specification
       self.track = track
       self.filename = filename
-      self.content = File.read(self.class.location(problem: problem, track: track, filename: filename))
+      self.content = File.read(self.class.location(specification: specification, track: track, filename: filename))
     end
     private_class_method :new
   end
 
   class TrackFile < GuaranteedFile
-    def self.location(problem:, track:, filename:)
-      File.join(problem.root, 'tracks', track.id, 'exercises', problem.slug, '.meta', filename)
+    def self.location(specification:, track:, filename:)
+      File.join(specification.root, 'tracks', track.id, 'exercises', specification.slug, '.meta', filename)
     end
 
     def url
-      "#{track.repository}/blob/master/exercises/%s/.meta/#{filename}" % problem.slug
+      "#{track.repository}/blob/master/exercises/%s/.meta/#{filename}" % specification.slug
     end
   end
 
   class CommonFile < GuaranteedFile
-    def self.location(problem:, filename:, **_track)
-      File.join(problem.root, 'common', 'exercises', problem.slug, filename)
+    def self.location(specification:, filename:, **_track)
+      File.join(specification.root, 'common', 'exercises', specification.slug, filename)
     end
 
     def url
-      "https://github.com/exercism/x-common/blob/master/exercises/%s/#{filename}" % problem.slug
+      "https://github.com/exercism/x-common/blob/master/exercises/%s/#{filename}" % specification.slug
     end
   end
 

data/lib/trackler/implementation.rb

@@ -12,12 +12,12 @@ module Trackler
     ]
 
     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_delegators :@specification, :name, :blurb, :description, :source_markdown, :slug, :source, :metadata, :root, :active?, :deprecated?, :source_url, :description_url, :canonical_data_url, :metadata_url
     def_delegators :@track, :language
 
-    def initialize(track, problem)
+    def initialize(track, specification)
       @track = track
-      @problem = problem
+      @specification = specification
     end
 
     def initialize_copy(original)
@@ -27,7 +27,7 @@ module Trackler
 
     def problem
       warn "DEPRECATION WARNING: The `problem` method is deprecated, Implementation can do everything that Problem can, so call the method directly."
-      @problem
+      @specification
     end
 
     def exists?
@@ -106,7 +106,7 @@ module Trackler
 
     def incomplete_solutions_body
       <<-README
-## Submitting Incomplete Problems
+## Submitting Incomplete Solutions
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
       README
     end

data/lib/trackler/implementations.rb

@@ -31,7 +31,7 @@ module Trackler
 
     def all
       @all ||= slugs.map { |slug|
-        Implementation.new(track, Problem.new(slug, root, track))
+        Implementation.new(track, Specification.new(slug, root, track))
       }
     end
 
@@ -41,7 +41,7 @@ module Trackler
 
     def implementation_map
       hash = Hash.new { |_, k|
-        Implementation.new(track, Problem.new(k, root, track))
+        Implementation.new(track, Specification.new(k, root, track))
       }
       all.each do |impl|
         hash[impl.slug] = impl

data/lib/trackler/metadata.rb

@@ -2,8 +2,8 @@ require_relative 'guaranteed_file'
 
 module Trackler
   class Metadata
-    def self.for(problem:, track: )
-      new(GuaranteedFile.for(problem: problem, track: track, filename: 'metadata.yml'))
+    def self.for(specification: , track: )
+      new(GuaranteedFile.for(specification: specification, track: track, filename: 'metadata.yml'))
     end
 
     attr_accessor :blurb, :source, :source_url

data/lib/trackler/problem.rb

@@ -1,101 +1,7 @@
-require 'yaml'
-require_relative 'metadata'
-require_relative 'description'
-require_relative 'null_track'
+require_relative 'specification'
 
 module Trackler
   # Problem is a language-independent definition of an exercise.
-  class Problem
-    attr_reader :slug, :root, :metadata
-    def initialize(slug, root, track = NullTrack.new)
-      @slug = slug
-      @root = root
-      @file_root = File.join(root, 'common', 'exercises', self.slug)
-      @repo_root = "https://github.com/exercism/x-common/blob/master/exercises/%s/" % self.slug
-
-      @metadata = Metadata.for(problem: self, track: track)
-      self.description_object = Description.for(problem: self, track: track)
-    end
-
-    def exists?
-      description_object.exists? && metadata.exists?
-    end
-
-    def deprecated?
-      @deprecated ||= File.exists?(file_path(deprecation_file_name, @file_root))
-    end
-
-    def active?
-      exists? && !deprecated?
-    end
-
-    def name
-      slug.split('-').map(&:capitalize).join(' ')
-    end
-
-    def description
-      description_object.to_s
-    end
-
-    def source_markdown
-      text = [source, markdown_link(source_url)].reject(&:empty?).join(" ")
-      text.empty? ? text : "## Source\n\n#{text}"
-    end
-
-    def description_url
-      description_object.url
-    end
-
-    def canonical_data_url
-      repo_url(canonical_data_file_name) if File.exists?(file_path(canonical_data_file_name, @file_root))
-    end
-
-    def metadata_url
-      metadata.url
-    end
-
-    def blurb
-      metadata.blurb
-    end
-
-    def source
-      metadata.source
-    end
-
-    def source_url
-      metadata.source_url
-    end
-
-    private
-
-    attr_accessor :description_object
-
-    def canonical_data_file_name
-      "canonical-data.json"
-    end
-
-    def description_file_name
-      "description.md"
-    end
-
-    def metadata_file_name
-      "metadata.yml"
-    end
-
-    def deprecation_file_name
-      ".deprecated"
-    end
-
-    def repo_url(filename)
-      @repo_root + filename
-    end
-
-    def file_path(filename, root = @file_root)
-      File.join(root, filename)
-    end
-
-    def markdown_link(url)
-      url.empty? ? url : format("[%s](%s)", url, url)
-    end
+  class Problem < Trackler::Specification
   end
 end