trackler 2.1.0.11 → 2.1.0.12

data/tracks/ruby/lib/generator/command_line/generator_optparser.rb

@@ -0,0 +1,90 @@
+require 'optparse'
+
+module Generator
+  class GeneratorOptparser
+    DEFAULT_OPTIONS = {
+      freeze: false,
+      all: false,
+      verbose: false,
+      slug: nil
+    }.freeze
+
+    attr_reader :options
+
+    def initialize(args, paths)
+      @args = args
+      @paths = paths
+      @options = parse_options
+    end
+
+    def options_valid?
+      validate_paths && validate_options &&
+        (options[:all] || (validate_exercise && validate_cases))
+    end
+
+    private
+
+    def parse_options
+      @options = DEFAULT_OPTIONS.dup
+      option_parser.parse!(@args)
+      options.tap { |opts| opts[:slug] = @args.shift unless opts[:all] }
+    end
+
+    def option_parser
+      @option_parser ||= OptionParser.new do |parser|
+        parser.banner = "Usage: #{$PROGRAM_NAME} [options] exercise-generator"
+        parser.on('-f', '--freeze', 'Don\'t update test version') { |value| options[:freeze] = value }
+        parser.on('-a', '--all', 'Regenerate all available test suites (implies freeze)') do |value|
+          options[:all] = value
+        end
+        parser.on('-h', '--help', 'Displays this help message') { |value| options[:help] = value }
+        parser.on('-v', '--verbose', 'Display progress messages') { |value| options[:verbose] = value }
+      end
+    end
+
+    def usage
+      option_parser.help <<
+        "\nAvailable exercise generators:\n" <<
+        available_generators.sort.join(' ')
+    end
+
+    def available_generators
+      Files::GeneratorCases.available(@paths.track)
+    end
+
+    def validate_paths
+      return true if File.directory?(@paths.metadata)
+      $stderr.puts metadata_repository_missing_message(@paths.metadata)
+      false
+    end
+
+    def metadata_repository_missing_message(repository)
+      <<-EOM.gsub(/^ {6}/, '')
+
+      'x-common' repository not found.
+      Try running the command:
+        git clone https://github.com/exercism/x-common.git "#{repository}"
+
+      EOM
+    end
+
+    def validate_options
+      return true unless options[:help]
+      $stdout.puts usage
+      false
+    end
+
+    def validate_exercise
+      return true if options[:slug]
+      $stderr.puts "Exercise name required!\n"
+      $stdout.puts usage
+      false
+    end
+
+    def validate_cases
+      return true if available_generators.include?(options[:slug])
+      $stderr.puts "A generator does not currently exist for #{options[:slug]}!"
+      false
+    end
+  end
+end

data/tracks/ruby/lib/generator/exercise_case.rb

@@ -10,8 +10,8 @@ module Generator
       'test_%s' % description.underscore
     end
 
-    def skipped
-      index.zero? ? '# skip' : 'skip'
+    def skipped(idx)
+      idx.zero? ? '# skip' : 'skip'
     end
 
     protected

data/tracks/ruby/lib/generator/files.rb

@@ -46,17 +46,5 @@ module Generator
         end
       end
     end
-
-    # An Exercise is used as part of a Repository
-    # so expects :paths and :exercise_name to be defined.
-    module Exercise
-      def paths
-        fail NotImplementedError, 'Should return a Generator::Paths object'
-      end
-
-      def exercise_name
-        fail NotImplementedError, 'Should return a String object'
-      end
-    end
   end
 end

data/tracks/ruby/lib/generator/files/generator_cases.rb

@@ -1,28 +1,39 @@
 module Generator
   module Files
     module GeneratorCases
-      module_function
+      class << self
+        def available(track_path)
+          cases_filepaths(track_path).map { |filepath| slugify(filepath) }.sort
+        end
 
-      def available(track_path)
-        generator_glob = File.join(track_path, "{lib,exercises}", '**', '*_cases.rb')
-        Dir.glob(generator_glob, File::FNM_DOTMATCH).sort.map { |filename| exercise_name(filename) }
-      end
+        def class_name(exercise_name_or_slug)
+          filename(exercise_name_or_slug).split('_').map(&:capitalize).join
+        end
 
-      def filename(exercise_name)
-        "#{exercise_name.tr('-', '_')}_cases"
-      end
+        def source_filepath(track_path, slug)
+          path = meta_generator_path(track_path, slug)
+          filename = filename(slug) + '.rb'
+          File.join(path, filename)
+        end
 
-      def class_name(exercise_name)
-        filename(exercise_name)[0..-2].split('_').map(&:capitalize).join
-      end
+        private
 
-      def exercise_name(filename)
-        %r{([^/]*)_cases\.rb$}.match(filename).captures[0].tr('_', '-')
-      end
+        def cases_filepaths(track_path)
+          generator_glob = File.join(meta_generator_path(track_path, '*'), '*_case.rb')
+          Dir.glob(generator_glob, File::FNM_DOTMATCH)
+        end
+
+        def slugify(filepath)
+          File.basename(filepath, '_case.rb').tr('_', '-')
+        end
+
+        def filename(exercise_name_or_slug)
+          "#{exercise_name_or_slug.tr('-', '_')}_case"
+        end
 
-      def load_filename(track_path, exercise_name)
-        "%s.rb" % File.join(track_path, 'exercises', exercise_name, '.meta', 'generator',
-                            filename(exercise_name))
+        def meta_generator_path(track_path, slug)
+          File.join(track_path, 'exercises', slug, '.meta', 'generator')
+        end
       end
     end
   end

data/tracks/ruby/lib/generator/files/metadata_files.rb

@@ -1,8 +1,6 @@
 module Generator
   module Files
     module MetadataFiles
-      include Exercise
-
       def canonical_data
         CanonicalDataFile.new(
           filename: File.join(exercise_metadata_path, 'canonical-data.json'),
@@ -12,7 +10,7 @@ module Generator
       private
 
       def exercise_metadata_path
-        File.join(paths.metadata, 'exercises', exercise_name)
+        File.join(paths.metadata, 'exercises', slug)
       end
     end
 

data/tracks/ruby/lib/generator/files/track_files.rb

@@ -3,18 +3,16 @@ require 'erb'
 module Generator
   module Files
     module TrackFiles
-      include Exercise
+      def minitest_tests
+        MinitestTestsFile.new(filename: File.join(exercise_path, minitest_tests_filename))
+      end
 
       def tests_version
-        TestsVersionFile.new(filename: File.join(meta_path, '.version'))
+        TestsVersionFile.new(filename: File.join(meta_path, version_filename))
       end
 
       def example_solution
-        ExampleSolutionFile.new(filename: File.join(exercise_path, example_file))
-      end
-
-      def minitest_tests
-        MinitestTestsFile.new(filename: File.join(exercise_path, minitest_tests_filename))
+        ExampleSolutionFile.new(filename: File.join(solutions_path, example_filename))
       end
 
       def tests_template
@@ -24,13 +22,29 @@ module Generator
       private
 
       def exercise_path
-        File.join(paths.track, 'exercises', exercise_name)
+        File.join(paths.track, 'exercises', slug)
       end
 
       def meta_path
         File.join(exercise_path, '.meta')
       end
 
+      def solutions_path
+        File.join(meta_path, 'solutions')
+      end
+
+      def minitest_tests_filename
+        "#{exercise_name}_test.rb"
+      end
+
+      def version_filename
+        '.version'
+      end
+
+      def example_filename
+        "#{exercise_name}.rb"
+      end
+
       def tests_template_absolute_filename
         File.exist?(track_tests_template_filename) ? track_tests_template_filename :
           default_tests_template_filename
@@ -47,22 +61,6 @@ module Generator
       def tests_template_filename
         'test_template.erb'
       end
-
-      def example_file
-        File.exist?(File.join(exercise_path, example_filename)) ? example_filename : legacy_example_filename
-      end
-
-      def example_filename
-        File.join('.meta', 'solutions', "#{exercise_name}.rb")
-      end
-
-      def legacy_example_filename
-        'example.rb'
-      end
-
-      def minitest_tests_filename
-        "#{exercise_name.gsub(/[ -]/, '_')}_test.rb"
-      end
     end
 
     class TestsVersionFile < Writable

data/tracks/ruby/lib/generator/{repository.rb → implementation.rb}

@@ -1,17 +1,17 @@
 require 'delegate'
 
 module Generator
-  class Repository
+  class Implementation
     include Files::TrackFiles
     include Files::MetadataFiles
     include TemplateValuesFactory
 
-    def initialize(paths:, exercise_name:)
+    def initialize(paths:, slug:)
       @paths = paths
-      @exercise_name = exercise_name
+      @slug = slug
     end
 
-    attr_reader :paths, :exercise_name
+    attr_reader :paths, :slug
 
     def version
       tests_version.to_i
@@ -31,32 +31,36 @@ module Generator
         values: template_values
       )
     end
+
+    def exercise_name
+      @exercise_name ||= slug.tr('-', '_')
+    end
   end
 
   # This exists to give us a clue as to what we are delegating to.
-  class RepositoryDelegator < SimpleDelegator
+  class ImplementationDelegator < SimpleDelegator
   end
 
-  # A repository that also logs its progress.
-  class LoggingRepository < RepositoryDelegator
-    def initialize(repository:, logger:)
-      __setobj__ @repository = repository
+  # A implementation that also logs its progress.
+  class LoggingImplementation < ImplementationDelegator
+    def initialize(implementation:, logger:)
+      __setobj__ @implementation = implementation
       @logger = logger
     end
 
     def update_tests_version
-      @repository.update_tests_version
+      @implementation.update_tests_version
       @logger.debug "Incremented tests version to #{version}"
     end
 
     def update_example_solution
-      @repository.update_example_solution
+      @implementation.update_example_solution
       @logger.debug "Updated version in example solution to #{version}"
     end
 
     def create_tests_file
-      @repository.create_tests_file
-      @logger.info "Generated #{exercise_name} tests version #{version}"
+      @implementation.create_tests_file
+      @logger.info "Generated #{slug} tests version #{version}"
     end
   end
 end

data/tracks/ruby/lib/generator/template_values.rb

@@ -6,7 +6,7 @@ module Generator
     def initialize(abbreviated_commit_hash:, version:, exercise_name:, test_cases:, canonical_data_version: nil)
       @abbreviated_commit_hash = abbreviated_commit_hash
       @version = version
-      @exercise_name = exercise_name ? exercise_name.tr('-_', '_') : ''
+      @exercise_name = exercise_name
       @test_cases = test_cases
       @canonical_data_version = canonical_data_version
     end
@@ -16,7 +16,7 @@ module Generator
     end
 
     def exercise_name_camel
-      exercise_name.split(/[-_]/).map(&:capitalize).join
+      exercise_name.split('_').map(&:capitalize).join
     end
   end
 
@@ -26,13 +26,17 @@ module Generator
         abbreviated_commit_hash: canonical_data.abbreviated_commit_hash,
         canonical_data_version: canonical_data.version,
         version: version,
-        exercise_name: exercise_name,
+        exercise_name: slug_underscore,
         test_cases: extract
       )
     end
 
     private
 
+    def slug_underscore
+      slug ? slug.tr('-_', '_') : ''
+    end
+
     def extract
       load cases_load_name
       extractor.cases(canonical_data.to_s)
@@ -40,12 +44,12 @@ module Generator
 
     def extractor
         CaseValues::Extractor.new(
-          case_class: Object.const_get(Files::GeneratorCases.class_name(exercise_name))
+          case_class: Object.const_get(Files::GeneratorCases.class_name(slug))
         )
     end
 
     def cases_load_name
-      Files::GeneratorCases.load_filename(paths.track, exercise_name)
+      Files::GeneratorCases.source_filepath(paths.track, slug)
     end
   end
 end

data/tracks/ruby/lib/generator/test_template.erb

@@ -4,9 +4,9 @@ require_relative '<%= exercise_name %>'
 
 # Common test data version: <%= canonical_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/lib/tasks/exercise.rb

@@ -1,50 +1,42 @@
 class Exercise
   class << self
     def all
-      exercise_names.map { |e| new(e) }
+      slugs.map { |e| new(e) }
     end
 
     private
 
-    def exercise_names
+    def slugs
       FileList['exercises/*'].pathmap('%f').exclude('TRACK_HINTS.md')
     end
   end
 
-  attr_reader :name
-  alias :to_s :name
+  attr_reader :slug
+  alias :to_s :slug
 
-  def initialize(name)
-    @name = name
+  def initialize(slug)
+    @slug = slug
   end
 
   def directory
-    "exercises/#{name}/."
+    "exercises/#{slug}/."
   end
 
   def example_file
-    File.exist?(File.join(directory, example_filename)) ? example_filename : legacy_example_filename
+    File.join('.meta', 'solutions', "#{exercise_name}.rb")
   end
 
   def testable_example_file
-    "#{base_file_name}.rb"
+    "#{exercise_name}.rb"
   end
 
   def test_file
-    "#{base_file_name}_test.rb"
+    "#{exercise_name}_test.rb"
   end
 
   private
 
-  def example_filename
-    File.join('.meta', 'solutions', "#{name}.rb")
-  end
-
-  def legacy_example_filename
-    'example.rb'
-  end
-
-  def base_file_name
-    @_base_file_name ||= name.tr('-', '_')
+  def exercise_name
+    @exercise_name ||= slug.tr('-', '_')
   end
 end