trackler 2.1.0.11 → 2.1.0.12

data/tracks/ruby/lib/tasks/exercise_tests_runner.rb

@@ -12,7 +12,7 @@ class ExerciseTestsRunner
   def run
     puts "\n\n#{'-' * 64}\nrunning tests for: #{@exercise}"
 
-    Dir.mktmpdir(@exercise.name) do |dir|
+    Dir.mktmpdir(@exercise.slug) do |dir|
       setup_exercise_files_in(dir)
       run_exercise_tests_in(dir)
     end

data/tracks/ruby/test/fixtures/xruby/exercises/{beta/example.tt → alpha-beta/.meta/generator/test_template.erb}

@@ -1,14 +1,12 @@
 #!/usr/bin/env ruby
 require 'minitest/autorun'
-require_relative '<%= exercise_name %>'
-
-# Hi. I am a custom comment
+require_relative 'alpha_beta'
 
 # Common test data version: <%= abbreviated_commit_hash %>
-class <%= exercise_name_camel %>Test < Minitest::Test
-<% test_cases.each do |test_case| %>
+class AlphaBetaTest < Minitest::Test
+<% test_cases.each_with_index do |test_case, idx| %>
   def <%= test_case.name %>
-    <%= test_case.skipped %>
+    <%= test_case.skipped(idx) %>
     <%= test_case.workload %>
   end
 

data/tracks/ruby/test/fixtures/xruby/exercises/alpha/.meta/generator/alpha_case.rb

@@ -0,0 +1,9 @@
+class AlphaCase < Generator::ExerciseCase
+  def name
+    format('test_%s', description.downcase.gsub(/[ -]/, '_'))
+  end
+
+  def workload
+    "assert true"
+  end
+end

data/tracks/ruby/test/fixtures/xruby/exercises/alpha/.meta/generator/test_template.erb

@@ -6,9 +6,9 @@ require_relative '<%= exercise_name %>'
 
 # Common test data version: <%= abbreviated_commit_hash %>
 class <%= exercise_name_camel %>Test < Minitest::Test
-<% test_cases.each do |test_case| %>
+<% test_cases.each_with_index do |test_case, idx| %>
   def <%= test_case.name %>
-    <%= test_case.skipped %>
+    <%= test_case.skipped(idx) %>
     <%= test_case.workload %>
   end
 

data/tracks/ruby/test/fixtures/xruby/exercises/alpha/.meta/solutions/alpha.rb

@@ -1,5 +1,5 @@
 # This is the example
 
 class BookKeeping
-  VERSION = 1
+  VERSION = 0
 end

data/tracks/ruby/test/fixtures/xruby/lib/generator/test_template.erb

@@ -4,9 +4,9 @@ require_relative 'acronym'
 
 # Common test data version: <%= abbreviated_commit_hash %>
 class AcronymTest < Minitest::Test
-<% test_cases.each do |test_case| %>
+<% test_cases.each_with_index do |test_case, idx| %>
   def <%= test_case.name %>
-    <%= test_case.skipped %>
+    <%= test_case.skipped(idx) %>
     <%= test_case.workload %>
   end
 

data/tracks/ruby/test/generator/case_values_test.rb

@@ -17,11 +17,11 @@ module Generator
 
         expected = [
           ComplexCase.new(description: 'first generic verse', property: 'verse', number: 99,
-                          expected: '99 bottles of beer on the wall, YAAAR', index: 0),
+                          expected: '99 bottles of beer on the wall, YAAAR'),
           ComplexCase.new(description: 'last generic verse', property: 'verse', number: 3,
-                          expected: '3 bottles of beer on the wall, YAAAR', index: 1),
+                          expected: '3 bottles of beer on the wall, YAAAR'),
           ComplexCase.new(description: 'first two verses', property: 'verses', beginning: 99, end: 98,
-                          expected: "99 bottles of beer on the wall, YAR, PIRATES CAN'T COUNT", index: 2)
+                          expected: "99 bottles of beer on the wall, YAR, PIRATES CAN'T COUNT")
         ]
         assert_equal expected, cases
       end

data/tracks/ruby/test/generator/command_line/generator_optparser_test.rb

@@ -0,0 +1,122 @@
+require_relative '../../test_helper'
+
+module Generator
+  class GeneratorOptparserTest < Minitest::Test
+    FixturePaths = Paths.new(
+      metadata: 'test/fixtures/metadata',
+      track: 'test/fixtures/xruby'
+    )
+
+    def default_options
+      {
+        freeze: false,
+        all: false,
+        verbose: false,
+        slug: nil
+      }
+    end
+
+    def test_default_options
+      args = %w(beta)
+      Files::GeneratorCases.stub :available, %w(beta) do
+        assert_equal(
+          default_options.merge(slug: 'beta'),
+          GeneratorOptparser.new(args, FixturePaths).options
+        )
+      end
+    end
+
+    def test_frozen_option
+      args = %w(-f beta)
+      Files::GeneratorCases.stub :available, %w(beta) do
+        assert_equal(
+          default_options.merge(slug: 'beta', freeze: true),
+          GeneratorOptparser.new(args, FixturePaths).options
+        )
+      end
+    end
+
+    def test_all_option
+      args = %w(-a)
+      assert_equal(
+        default_options.merge(all: true),
+        GeneratorOptparser.new(args, FixturePaths).options
+      )
+    end
+
+    def test_help_option
+      args = %w(-h)
+      assert_equal(
+        default_options.merge(help: true),
+        GeneratorOptparser.new(args, FixturePaths).options
+      )
+    end
+
+    def test_verbose_option
+      args = %w(-v beta)
+      Files::GeneratorCases.stub :available, %w(beta) do
+        assert_equal(
+          default_options.merge(slug: 'beta', verbose: true),
+          GeneratorOptparser.new(args, FixturePaths).options
+        )
+      end
+    end
+
+    def test_usage_help
+      args = %w(-h)
+      assert_output(/Usage:/, nil) do
+        refute GeneratorOptparser.new(args, FixturePaths).options_valid?
+      end
+    end
+
+    def test_usage_help_with_exercise
+      args = %w(-h beta)
+      assert_output(/Usage:/, nil) do
+        refute GeneratorOptparser.new(args, FixturePaths).options_valid?
+      end
+    end
+
+    def test_usage_help_includes_available_generators
+      args = %w(-h)
+      fake_generators = %w(some fake generator names also-hyphen-ated)
+      Files::GeneratorCases.stub :available, fake_generators do
+        assert_output(/#{fake_generators.sort.join(' ')}/, nil) do
+          refute GeneratorOptparser.new(args, FixturePaths).options_valid?
+        end
+      end
+    end
+
+    def test_invalid_metadata_repository_outputs_message_to_stderr
+      paths = Paths.new(metadata: 'test/fixtures/nonexistent', track: nil)
+      expected_stderr = <<-MESSAGE.gsub(/^ {6}/, '')
+      'x-common' repository not found.
+      Try running the command:
+        git clone https://github.com/exercism/x-common.git "test/fixtures/nonexistent"
+      MESSAGE
+      assert_output nil, /#{expected_stderr}/ do
+        refute GeneratorOptparser.new([], paths).options_valid?
+      end
+    end
+
+    def test_validate_generate_all
+      args = ['--all']
+      assert GeneratorOptparser.new(args, FixturePaths).options_valid?
+    end
+
+    def test_validate_slug
+      expected_stderr = 'Exercise name required'
+      assert_output(/Usage:/, /#{expected_stderr}/) do
+        refute GeneratorOptparser.new([], FixturePaths).options_valid?
+      end
+    end
+
+    def test_validate_missing_generator
+      args = %w(nonexistent)
+      Files::GeneratorCases.stub :available, [] do
+        assert_output(nil, /A generator does not currently exist fo/) do
+          refute GeneratorOptparser.new(args, FixturePaths).options_valid?
+        end
+      end
+    end
+  end
+end

data/tracks/ruby/test/generator/command_line_test.rb

@@ -62,21 +62,31 @@ module Generator
     def test_default_options
       args = %w(beta)
       Files::GeneratorCases.stub :available, %w(beta) do
-        assert_instance_of UpdateVersionAndGenerateTests, CommandLine.new(FixturePaths).parse(args)
+        assert_instance_of UpdateVersionAndGenerateTests, CommandLine.new(FixturePaths).parse(args).first
       end
     end
 
     def test_frozen_option
       args = %w(-f beta)
       Files::GeneratorCases.stub :available, %w(beta) do
-        assert_instance_of GenerateTests, CommandLine.new(FixturePaths).parse(args)
+        assert_instance_of GenerateTests, CommandLine.new(FixturePaths).parse(args).first
+      end
+    end
+
+    def test_all_option
+      args = %w(--all)
+      fake_generators = %w(some fake generator names also-hyphen-ated)
+      Files::GeneratorCases.stub :available, fake_generators do
+        generators = CommandLine.new(FixturePaths).parse(args)
+        assert_equal fake_generators.size, generators.size
+        assert_instance_of GenerateTests, generators.first
       end
     end
 
     def test_verbose_option
       args = %w(-v beta)
       Files::GeneratorCases.stub :available, %w(beta) do
-        assert_instance_of UpdateVersionAndGenerateTests, CommandLine.new(FixturePaths).parse(args)
+        assert_instance_of UpdateVersionAndGenerateTests, CommandLine.new(FixturePaths).parse(args).first
       end
     end
   end

data/tracks/ruby/test/generator/exercise_case_test.rb

@@ -7,11 +7,11 @@ module Generator
     end
 
     def test_skipped_index_zero
-      assert_equal '# skip', ExerciseCase.new(index: 0).skipped
+      assert_equal '# skip', ExerciseCase.new.skipped(0)
     end
 
     def test_skipped_index_nonzero
-      assert_equal 'skip', ExerciseCase.new(index: 12).skipped
+      assert_equal 'skip', ExerciseCase.new.skipped(1)
     end
 
     class MultiLineCase < ExerciseCase

data/tracks/ruby/test/generator/files/generate_cases_test.rb

@@ -3,42 +3,34 @@ require_relative '../../test_helper.rb'
 module Generator
   module Files
     class GeneratorCasesTest < Minitest::Test
-      def test_no_cases_found
-        track_path = 'test/fixtures/nonexistant'
-        assert_equal [], GeneratorCases.available(track_path)
-      end
-
-      def test_cases_found
-        track_path = 'test/fixtures/xruby'
-        assert_equal %w(alpha beta), GeneratorCases.available(track_path).sort
-      end
-
-      def test_available_returns_exercise_names
-        track_path = 'test/fixtures/xruby'
-        Dir.stub :glob, %w(/alpha_cases.rb hy_phen_ated_cases.rb) do
+      def test_available
+        track_path = '/track'
+        fake_filenames = %w(/track/zzz/alpha_case.rb /track/aaa/hy_phen_ated_case.rb)
+        Dir.stub :glob, fake_filenames do
           assert_equal %w(alpha hy-phen-ated), GeneratorCases.available(track_path)
         end
       end
 
-      def test_filename
-        exercise_name = 'two-parter'
-        assert_equal 'two_parter_cases', GeneratorCases.filename(exercise_name)
+      def test_available_calls_glob_with_the_right_arguments
+        track_path = '/track'
+        expected_glob = "#{track_path}/exercises/*/.meta/generator/*_case.rb"
+        mock_glob_call = Minitest::Mock.new
+        mock_glob_call.expect :call, [], [expected_glob, File::FNM_DOTMATCH]
+        Dir.stub :glob, mock_glob_call do
+          GeneratorCases.available(track_path)
+        end
+        mock_glob_call.verify
       end
 
       def test_class_name
         assert_equal 'TwoParterCase', GeneratorCases.class_name('two-parter')
       end
 
-      def test_load_filename # test the cases_filename alternative
-        track_path = 'test/fixtures/xruby'
-        exercise_name = 'foo'
-        expected_filename = track_path + '/exercises/foo/.meta/generator/foo_cases.rb'
-        File.stub(:exist?, true) do
-          assert_equal(
-            expected_filename,
-            GeneratorCases.load_filename(track_path, exercise_name)
-          )
-        end
+      def test_source_filepath
+        track_path = '/track'
+        slug = 'slug'
+        expected_filename = track_path + '/exercises/slug/.meta/generator/slug_case.rb'
+        assert_equal expected_filename, GeneratorCases.source_filepath(track_path, slug)
       end
     end
   end

data/tracks/ruby/test/generator/files/metadata_files_test.rb

@@ -10,9 +10,9 @@ module Generator
       class TestMetadataFiles
         def initialize
           @paths = FixturePaths
-          @exercise_name = 'alpha'
+          @slug = 'alpha'
         end
-        attr_reader :paths, :exercise_name
+        attr_reader :paths, :slug
         include MetadataFiles
       end
 

data/tracks/ruby/test/generator/files/track_files_test.rb

@@ -11,9 +11,10 @@ module Generator
       class TestTrackFiles
         def initialize
           @paths = FixturePaths
-          @exercise_name = 'alpha'
+          @slug = 'alpha-beta'
+          @exercise_name = 'alpha_beta'
         end
-        attr_accessor :paths, :exercise_name
+        attr_accessor :paths, :slug, :exercise_name
         include TrackFiles
       end
 
@@ -24,14 +25,7 @@ module Generator
 
       def test_example_solution
         subject = TestTrackFiles.new
-        expected_filename = FixturePaths.track + '/exercises/alpha/.meta/solutions/alpha.rb'
-        assert_equal expected_filename, subject.example_solution.filename
-      end
-
-      def test_legacy_example_solution
-        subject = TestTrackFiles.new
-        subject.exercise_name = 'beta'
-        expected_filename = FixturePaths.track + '/exercises/beta/example.rb'
+        expected_filename = FixturePaths.track + '/exercises/alpha-beta/.meta/solutions/alpha_beta.rb'
         assert_equal expected_filename, subject.example_solution.filename
       end
 
@@ -42,7 +36,7 @@ module Generator
 
       def test_tests_template
         subject = TestTrackFiles.new
-        expected_filename = FixturePaths.track + '/exercises/alpha/.meta/generator/test_template.erb'
+        expected_filename = FixturePaths.track + '/exercises/alpha-beta/.meta/generator/test_template.erb'
         assert_equal expected_filename, subject.tests_template.filename
       end
 
@@ -50,9 +44,9 @@ module Generator
       class TestTrackFilesUseDefault
         def initialize
           @paths = FixturePaths
-          @exercise_name = 'notemplate'
+          @slug = 'notemplate'
         end
-        attr_reader :paths, :exercise_name
+        attr_reader :paths, :slug
         include TrackFiles
       end
 
@@ -98,7 +92,7 @@ module Generator
         end
       end
 
-      def test_update_version
+      def test_generate
         mock_template = Minitest::Mock.new
         mock_values = Minitest::Mock.new
         mock_values.expect :get_binding, 'mock binding'

data/tracks/ruby/test/generator/files_test.rb

@@ -57,25 +57,5 @@ module Generator
         mock_writer.verify
       end
     end
-
-    class ExerciseTest < Minitest::Test
-      class TestNotImplementedTrackFiles
-        include Exercise
-      end
-
-      def test_paths_not_implemented
-        subject = TestNotImplementedTrackFiles.new
-        assert_raises NotImplementedError do
-          subject.paths
-        end
-      end
-
-      def test_exercise_name_not_implemented
-        subject = TestNotImplementedTrackFiles.new
-        assert_raises NotImplementedError do
-          subject.exercise_name
-        end
-      end
-    end
   end
 end

data/tracks/ruby/test/generator/implementation_test.rb

@@ -0,0 +1,145 @@
+require_relative '../test_helper'
+
+module Generator
+  class ImplementationTest < Minitest::Test
+    FixturePaths = Paths.new(
+      metadata: 'test/fixtures/metadata',
+      track: 'test/fixtures/xruby'
+    )
+
+    def test_version
+      subject = Implementation.new(paths: FixturePaths, slug: 'alpha')
+      assert_equal 1, subject.version
+    end
+
+    def test_slug
+      subject = Implementation.new(paths: FixturePaths, slug: 'alpha')
+      assert_equal 'alpha', subject.slug
+    end
+
+    def test_update_tests_version
+      mock_file = Minitest::Mock.new.expect :write, '2'.length, [2]
+      subject = Implementation.new(paths: FixturePaths, slug: 'alpha')
+      # Verify iniital condition from fixture file
+      assert_equal 1, subject.tests_version.to_i
+      File.stub(:open, true, mock_file) do
+        assert_equal 2, subject.update_tests_version
+      end
+      mock_file.verify
+    end
+
+    def test_update_example_solution
+      expected_content = "# This is the example\n\nclass BookKeeping\n  VERSION = 1\nend\n"
+      mock_file = Minitest::Mock.new.expect :write, expected_content.length, [expected_content]
+      subject = Implementation.new(paths: FixturePaths, slug: 'alpha')
+      File.stub(:open, true, mock_file) do
+        assert_equal expected_content, subject.update_example_solution
+      end
+      mock_file.verify
+    end
+
+    def test_create_tests_file
+      # Q: Is the pain here caused by:
+      # a) Implementation `including` everything rather than using composition?
+      # b) Trying to verify the expected content.
+      # c) The expected content being too long
+      #
+      # Q: Where in the call stack should the testing logically stop?
+      # A: It should be able to stop when minitest_tests is called with the correct arguments.
+     expected_content =<<TESTS_FILE
+#!/usr/bin/env ruby
+require 'minitest/autorun'
+require_relative 'alpha'
+
+# Hi. I am a custom comment
+
+# Common test data version: 123456789
+class AlphaTest < Minitest::Test
+  def test_add_2_numbers
+    # skip
+    assert true
+  end
+
+  # Problems in exercism evolve over time, as we find better ways to ask
+  # questions.
+  # The version number refers to the version of the problem you solved,
+  # not your solution.
+  #
+  # Define a constant named VERSION inside of the top level BookKeeping
+  # module, which may be placed near the end of your file.
+  #
+  # In your file, it will look like this:
+  #
+  # module BookKeeping
+  #   VERSION = 1 # Where the version number matches the one in the test.
+  # end
+  #
+  # If you are curious, read more about constants on RubyDoc:
+  # http://ruby-doc.org/docs/ruby-doc-bundle/UsersGuide/rg/constants.html
+
+  def test_bookkeeping
+    skip
+    assert_equal 1, BookKeeping::VERSION
+  end
+end
+TESTS_FILE
+      mock_file = Minitest::Mock.new.expect :write, expected_content.length, [expected_content]
+      subject = Implementation.new(paths: FixturePaths, slug: 'alpha')
+      GitCommand.stub(:abbreviated_commit_hash, '123456789') do
+        File.stub(:open, true, mock_file) do
+          assert_equal expected_content, subject.create_tests_file
+        end
+      end
+      mock_file.verify
+      # Don't pollute the namespace
+      Object.send(:remove_const, :AlphaCase)
+    end
+
+    def test_exercise_name
+      subject = Implementation.new(paths: FixturePaths, slug: 'alpha-beta')
+      assert_equal 'alpha_beta', subject.exercise_name
+    end
+  end
+
+  class LoggingImplementationTest < Minitest::Test
+    def test_create_tests_file
+      mock_implementation = Minitest::Mock.new
+      mock_implementation.expect :create_tests_file, nil
+      mock_implementation.expect :slug, 'alpha'
+      mock_implementation.expect :version, 2
+      mock_logger = Minitest::Mock.new
+      mock_logger.expect :info, nil, ['Generated alpha tests version 2']
+
+      subject = LoggingImplementation.new(implementation: mock_implementation, logger: mock_logger)
+      subject.create_tests_file
+
+      mock_implementation.verify
+    end
+
+    def test_update_tests_version
+      mock_implementation = Minitest::Mock.new
+      mock_implementation.expect :update_tests_version, nil
+      mock_implementation.expect :version, 2
+      mock_logger = Minitest::Mock.new
+      mock_logger.expect :debug, nil, ['Incremented tests version to 2']
+
+      subject = LoggingImplementation.new(implementation: mock_implementation, logger: mock_logger)
+      subject.update_tests_version
+
+      mock_implementation.verify
+    end
+
+    def test_update_example_solution
+      mock_implementation = Minitest::Mock.new
+      mock_implementation.expect :update_example_solution, nil
+      mock_implementation.expect :version, 2
+      mock_logger = Minitest::Mock.new
+      mock_logger.expect :debug, nil, ['Updated version in example solution to 2']
+
+      subject = LoggingImplementation.new(implementation: mock_implementation, logger: mock_logger)
+      subject.update_example_solution
+
+      mock_implementation.verify
+    end
+  end
+end