All generators use common interface

README.md

@@ -108,6 +108,16 @@ then additional inputs/outputs should be submitted to the x-common repository.
 Changes to the test suite (style, boilerplate, etc) will probably have to be made to
 `example.tt`.
 
+### Exercise Generators
+
+If you wish to create a new generator, or edit an existing one, the generators currently live in the lib directory and are named `$PROBLEM_cases.rb`.  For example, the hamming generator is `lib/hamming_cases.rb`.  
+
+All generators currently adhere to a common public interface, and must define the following three methods:
+
+- `test_name` - Output the name of the test
+- `workload` - Output the body of the test
+- `skipped` - Output skip syntax
+
 ## Pull Requests
 
 We welcome pull requests that provide fixes to existing test suites (missing

exercises/acronym/example.tt

@@ -6,9 +6,9 @@ require_relative 'acronym'
 # Test data version:
 # <%= sha1 %>
 class AcronymTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %>
-    assert_equal '<%= test_case.expected %>', <%= test_case.assertion %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/alphametics/example.tt

@@ -8,9 +8,7 @@ require_relative 'alphametics'
 class AlphameticsTest < Minitest::Test<% test_cases.each do |test_case| %>
   def <%= test_case.test_name %>
     <%= test_case.skipped %>
-    expect = <%= test_case.expect %>
-    actual = <%= test_case.work_load %>
-    assert_equal(expect, actual)
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/anagram/example.tt

@@ -8,7 +8,7 @@ require_relative 'anagram'
 class AnagramTest < Minitest::Test<% test_cases.each do |test_case| %>
   def <%= test_case.test_name %>
     <%= test_case.skipped %>
-    <%= test_case.work_load %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/binary/example.tt

@@ -7,9 +7,9 @@ require_relative 'binary'
 # Test data version:
 # <%= sha1 %>
 class BinaryTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %>
+  def <%= test_case.test_name %>
     <%= test_case.skipped %>
-    <%= test_case.assertion %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/bracket-push/example.tt

@@ -6,9 +6,9 @@ require_relative 'bracket_push'
 # Test data version:
 # <%= sha1 %>
 class BracketsTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %>
+  def <%= test_case.test_name %>
     <%= test_case.skipped %>
-    <%= test_case.test_body %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/clock/example.tt

@@ -6,9 +6,9 @@ require_relative 'clock'
 # Test data version:
 # <%= sha1 %>
 class ClockTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %>
+  def <%= test_case.test_name %>
     <%= test_case.skipped %>
-    <%= test_case.test_body %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/connect/example.tt

@@ -4,15 +4,16 @@ require 'minitest/autorun'
 require_relative 'connect'
 
 # Test data version commit id: <%= sha1 %>
-class ConnectTest < Minitest::Test<% test_cases.each do |test_case| %>
-  <%= test_case.ignore_method_length%>def <%= test_case.name %>
-    <%= test_case.skipped %><% test_case.test_body.each do |line| %>
-    <%= line %><% end %>
+class ConnectTest < Minitest::Test
+<% test_cases.each do |test_case| %>
+  <%= test_case.ignore_method_length%>def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>
   def test_bookkeeping
     skip
-    assert_equal <%= version %>, BookKeeping::VERSION
+    assert_equal <%= version.next %>, BookKeeping::VERSION
   end
 end

exercises/custom-set/example.tt

@@ -6,9 +6,9 @@ require_relative 'custom_set'
 # Test data version:
 # <%= sha1 %>
 class CustomSetTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %>
+  def <%= test_case.test_name %>
     <%= test_case.skipped %>
-    <%= test_case.test_body %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/difference-of-squares/example.tt

@@ -6,9 +6,9 @@ require_relative 'difference_of_squares'
 # Test data version:
 # <%= sha1 %>
 class DifferenceOfSquaresTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.test_name %><% if test_case.skipped? %>
-    skip<% end %>
-    assert_equal <%= test_case.expected_formatted %>, <%= test_case.do %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
   def test_consistent_difference

exercises/gigasecond/example.tt

@@ -1,22 +1,19 @@
+#!/usr/bin/env ruby
+gem 'minitest', '>= 5.0.0'
 require 'minitest/autorun'
 require_relative 'gigasecond'
 
-# Test data version: <%= sha1 %>
-
-class GigasecondTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %>
-    result = Gigasecond.from(<%= test_case.got %>)
-    assert_equal <%= test_case.want %>, result
+# Test data version commit id: <%= sha1 %>
+class GigasecondTest < Minitest::Test
+<% test_cases.each do |test_case| %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
-  # Test your 1Gs anniversary
-  def test_with_your_birthday
-    skip
-  end
-
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>
   def test_bookkeeping
+    skip
     assert_equal <%= version.next %>, BookKeeping::VERSION
   end
 end

exercises/hamming/example.tt

@@ -6,10 +6,9 @@ require_relative 'hamming'
 # Test data version:
 # <%= sha1 %>
 class HammingTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %>
-    <%= test_case.skipped %><% if test_case.raises_error? %>
-    assert_raises(ArgumentError) { <%= test_case.work_load %> }<% else %>
-    assert_equal <%= test_case.expected %>, <%= test_case.work_load %><% end %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/hello-world/example.tt

@@ -15,9 +15,9 @@ end
 # Test data version:
 # <%= sha1 %>
 class HelloWorldTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.test_name %><% if test_case.skipped? %>
-    skip<% end %>
-    assert_equal '<%= test_case.expected %>', <%= test_case.do %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>end
 

exercises/largest-series-product/example.tt

@@ -10,10 +10,9 @@ require_relative 'largest_series_product'
 # rubocop:disable Metrics/LineLength
 #
 class Seriestest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %><% if test_case.raises_error? %>
-    assert_raises(ArgumentError) { <%= test_case.do %> }<% else %>
-    assert_equal <%= test_case.expected %>, <%= test_case.do %><% end %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/leap/example.tt

@@ -15,10 +15,9 @@ class Date
 end
 
 class YearTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %><% if test_case.expected%>
-    assert <%= test_case.do %>, "<%= test_case.failure_message%>"<% else %>
-    refute <%= test_case.do %>, "<%= test_case.failure_message%>"<% end%>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/nth-prime/example.tt

@@ -9,10 +9,9 @@ require_relative 'nth_prime'
 # rubocop:disable Style/NumericLiterals
 #
 class NthPrimeTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %><% if test_case.raises_error? %>
-    assert_raises(ArgumentError) { <%= test_case.actual %> }<% else %>
-    assert_equal <%= test_case.expected %>, <%= test_case.actual %><% end %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/pangram/example.tt

@@ -7,11 +7,9 @@ require_relative 'pangram'
 # Test data version:
 # <%= sha1 %>
 class PangramTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %>
-    str = '<%= test_case.input %>'<% if test_case.expected %>
-    assert<% else %>
-    refute<% end %> <%= test_case.do %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/raindrops/example.tt

@@ -6,9 +6,9 @@ require_relative 'raindrops'
 # Test data version:
 # <%= sha1 %>
 class RaindropsTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %>
-    assert_equal '<%= test_case.expected %>', <%= test_case.do %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/rna-transcription/example.tt

@@ -8,7 +8,7 @@ require_relative 'rna_transcription'
 class ComplementTest < Minitest::Test<% test_cases.each do |test_case| %>
   def <%= test_case.test_name %>
     <%= test_case.skipped %>
-    assert_equal '<%= test_case.expected %>', <%= test_case.work_load %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/roman-numerals/example.tt

@@ -6,9 +6,9 @@ require_relative 'roman_numerals'
 # Test data version:
 # <%= sha1 %>
 class RomanNumeralsTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %>
-    assert_equal '<%= test_case.expected %>', <%= test_case.do %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/run-length-encoding/example.tt

@@ -7,11 +7,9 @@ require_relative 'run_length_encoding'
 # Test data version:
 # <%= sha1 %>
 class RunLengthEncodingTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %>
-    <%= test_case.assign_input %>
-    <%= test_case.assign_output %>
-    <%= test_case.assertion %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/sieve/example.tt

@@ -7,10 +7,9 @@ require_relative 'sieve'
 # <%= sha1 %>
 
 class SieveTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %>
+  def <%= test_case.test_name %>
     <%= test_case.skipped %>
-    expected = <%= test_case.expected_string %>
-    assert_equal expected, Sieve.new(<%= test_case.limit %>).primes
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/two-bucket/example.tt

@@ -6,9 +6,9 @@ require_relative 'two_bucket'
 # Test data version:
 # <%= sha1 %>
 class TwoBucketTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.test_name %><% if test_case.skipped? %>
-    skip<% end %>
-    <%= test_case.test_body %>
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>

exercises/word-count/.version

@@ -1 +1 @@
-1
+4

exercises/word-count/example.tt

@@ -6,11 +6,9 @@ require_relative 'word_count'
 # Test data version:
 # <%= sha1 %>
 class PhraseTest < Minitest::Test<% test_cases.each do |test_case| %>
-  def <%= test_case.name %><% if test_case.skipped? %>
-    skip<% end %>
-    phrase = <%= test_case.object_under_test %>
-    counts = <%= test_case.expected %>
-    assert_equal counts, phrase.word_count
+  def <%= test_case.test_name %>
+    <%= test_case.skipped %>
+    <%= test_case.workload %>
   end
 <% end %>
 <%= IO.read(XRUBY_LIB + '/bookkeeping.md') %>
@@ -19,4 +17,3 @@ class PhraseTest < Minitest::Test<% test_cases.each do |test_case| %>
     assert_equal <%= version.next %>, BookKeeping::VERSION
   end
 end
-

lib/acronym_cases.rb

@@ -1,14 +1,14 @@
 class AcronymCase < OpenStruct
-  def name
+  def test_name
     'test_%s' % description.tr(' ', '_')
   end
 
-  def assertion
-    "Acronym.abbreviate('#{phrase}')"
+  def workload
+    "assert_equal '#{expected}', Acronym.abbreviate('#{phrase}')"
   end
 
-  def skipped?
-    index > 0
+  def skipped
+    index.zero? ? '# skip' : 'skip'
   end
 end
 

lib/alphametics_cases.rb

@@ -6,8 +6,12 @@ def test_name
     "test_#{description.tr(' ', '_')}"
   end
 
-  def work_load
-    "Alphametics.new.solve('#{puzzle}')"
+  def workload
+    <<-WL.chomp
+expect = #{expect}
+    actual = Alphametics.new.solve('#{puzzle}')
+    assert_equal(expect, actual)
+    WL
   end
 
   def expect

lib/anagram_cases.rb

@@ -3,7 +3,7 @@ def test_name
     'test_%s' % description.gsub(/[ -]/, '_')
   end
 
-  def work_load
+  def workload
     indent_lines([show_comment, detector, anagram, assert].compact)
   end