cucumber 3.0.0.pre.1 → 3.0.0.pre.2

data/lib/cucumber/formatter/legacy_api/ast.rb

@@ -23,7 +23,7 @@ module Cucumber
         # ExampleTableRow#keyword is never called on them,
         # but this will pass silently if it happens anyway
         class NullLanguage
-          def method_missing(*args, &block)
+          def method_missing(*_args, &_block)
             self
           end
 
@@ -80,17 +80,15 @@ module Cucumber
           end
 
           def send_output_to(formatter)
-            unless @already_accepted
-              @messages.each { |message| formatter.puts(message) }
-              @embeddings.each { |embedding| embedding.send_to_formatter(formatter) }
-            end
+            return if @already_accepted
+            @messages.each { |message| formatter.puts(message) }
+            @embeddings.each { |embedding| embedding.send_to_formatter(formatter) }
           end
 
           def describe_exception_to(formatter)
-            unless @already_accepted
-              @result.describe_exception_to(formatter)
-              @already_accepted = true
-            end
+            return if @already_accepted
+            @result.describe_exception_to(formatter)
+            @already_accepted = true
           end
         end
 
@@ -112,20 +110,20 @@ module Cucumber
             Ast::Comments.new(step.comments).accept(formatter)
             messages.each { |message| formatter.puts(message) }
             embeddings.each { |embedding| embedding.send_to_formatter(formatter) }
-            formatter.before_step_result *step_result_attributes
+            formatter.before_step_result(*step_result_attributes)
             print_step_name(formatter)
             Ast::MultilineArg.for(multiline_arg).accept(formatter)
             print_exception(formatter)
-            formatter.after_step_result *step_result_attributes
+            formatter.after_step_result(*step_result_attributes)
             formatter.after_step(self)
           end
 
           def step_result_attributes
             legacy_multiline_arg = if multiline_arg.kind_of?(Core::Ast::EmptyMultilineArgument)
-              nil
-            else
-              step.multiline_arg
-            end
+                                     nil
+                                   else
+                                     step.multiline_arg
+                                   end
             [keyword, step_match, legacy_multiline_arg, status, exception, source_indent, background, file_colon_line]
           end
 
@@ -280,7 +278,7 @@ module Cucumber
         end
 
         Scenario = Struct.new(:status, :name, :location) do
-          def backtrace_line(step_name = "#{name}", line = self.location.line)
+          def backtrace_line(step_name = name.to_s, line = self.location.line)
             "#{location.on_line(line)}:in `#{step_name}'"
           end
 
@@ -294,7 +292,7 @@ module Cucumber
         end
 
         ScenarioOutline = Struct.new(:status, :name, :location) do
-          def backtrace_line(step_name = "#{name}", line = self.location.line)
+          def backtrace_line(step_name = name.to_s, line = self.location.line)
             "#{location.on_line(line)}:in `#{step_name}'"
           end
 
@@ -379,9 +377,7 @@ module Cucumber
             @feature = feature
           end
 
-          def feature
-            @feature
-          end
+          attr_reader :feature
         end
 
       end

data/lib/cucumber/formatter/legacy_api/results.rb

@@ -13,19 +13,17 @@ module Cucumber
         def step_visited(step) #:nodoc:
           step_id = step.object_id
 
-          unless @inserted_steps.has_key?(step_id)
-            @inserted_steps[step_id] = step
-            steps.push(step)
-          end
+          return if @inserted_steps.key?(step_id)
+          @inserted_steps[step_id] = step
+          steps.push(step)
         end
 
         def scenario_visited(scenario) #:nodoc:
           scenario_id = scenario.object_id
 
-          unless @inserted_scenarios.has_key?(scenario_id)
-            @inserted_scenarios[scenario_id] = scenario
-            scenarios.push(scenario)
-          end
+          return if @inserted_scenarios.key?(scenario_id)
+          @inserted_scenarios[scenario_id] = scenario
+          scenarios.push(scenario)
         end
 
         def steps(status = nil) #:nodoc:

data/lib/cucumber/formatter/pretty.rb

@@ -36,7 +36,7 @@ module Cucumber
         @issues = ConsoleIssues.new(runtime.configuration)
       end
 
-      def before_features(features)
+      def before_features(_features)
         print_profile_information
       end
 
@@ -44,7 +44,7 @@ module Cucumber
         print_summary(features)
       end
 
-      def before_feature(feature)
+      def before_feature(_feature)
         @exceptions = []
         @indent = 0
       end
@@ -54,7 +54,7 @@ module Cucumber
         @io.flush
       end
 
-      def after_tags(tags)
+      def after_tags(_tags)
         if @indent == 1
           @io.puts
           @io.flush
@@ -74,24 +74,24 @@ module Cucumber
         @io.flush
       end
 
-      def before_feature_element(feature_element)
+      def before_feature_element(_feature_element)
         @indent = 2
         @scenario_indent = 2
       end
 
-      def after_feature_element(feature_element)
+      def after_feature_element(_feature_element)
         print_messages
         @io.puts
         @io.flush
       end
 
-      def before_background(background)
+      def before_background(_background)
         @indent = 2
         @scenario_indent = 2
         @in_background = true
       end
 
-      def after_background(background)
+      def after_background(_background)
         print_messages
         @in_background = nil
         @io.puts
@@ -102,7 +102,7 @@ module Cucumber
         print_feature_element_name(keyword, name, file_colon_line, source_indent)
       end
 
-      def before_examples_array(examples_array)
+      def before_examples_array(_examples_array)
         @indent = 4
         @io.puts
         @visiting_first_example_name = true
@@ -121,7 +121,7 @@ module Cucumber
         @table = outline_table
       end
 
-      def after_outline_table(outline_table)
+      def after_outline_table(_outline_table)
         @table = nil
         @indent = 4
       end
@@ -136,7 +136,7 @@ module Cucumber
         print_messages
       end
 
-      def before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line)
+      def before_step_result(_keyword, _step_match, _multiline_arg, status, exception, _source_indent, background, _file_colon_line)
         @hide_this_step = false
         if exception
           if @exceptions.include?(exception)
@@ -152,7 +152,7 @@ module Cucumber
         @status = status
       end
 
-      def step_name(keyword, step_match, status, source_indent, background, file_colon_line)
+      def step_name(keyword, step_match, status, source_indent, _background, _file_colon_line)
         return if @hide_this_step
         source_indent = nil unless @options[:source]
         name_to_report = format_step(keyword, step_match, status, source_indent)
@@ -180,11 +180,11 @@ module Cucumber
         @table = multiline_arg
       end
 
-      def after_multiline_arg(multiline_arg)
+      def after_multiline_arg(_multiline_arg)
         @table = nil
       end
 
-      def before_table_row(table_row)
+      def before_table_row(_table_row)
         return if !@table || @hide_this_step
         @col_index = 0
         @io.print '  |'.indent(@indent-2)
@@ -199,7 +199,7 @@ module Cucumber
         end
       end
 
-      def after_table_cell(cell)
+      def after_table_cell(_cell)
         return unless @table
         @col_index += 1
       end
@@ -211,11 +211,11 @@ module Cucumber
         cell_text = escape_cell(value.to_s || '')
         padded = cell_text + (' ' * (width - cell_text.unpack('U*').length))
         prefix = cell_prefix(status)
-        @io.print(' ' + format_string("#{prefix}#{padded}", status) + ::Cucumber::Term::ANSIColor.reset(" |"))
+        @io.print(' ' + format_string("#{prefix}#{padded}", status) + ::Cucumber::Term::ANSIColor.reset(' |'))
         @io.flush
       end
 
-      def before_test_case(test_case)
+      def before_test_case(_test_case)
         @previous_step_keyword = nil
       end
 
@@ -235,7 +235,7 @@ module Cucumber
           @io.print(format_string(line_comment, :comment))
         end
         @io.puts
-        names[1..-1].each {|s| @io.puts "#{s}"}
+        names[1..-1].each {|s| @io.puts s.to_s}
         @io.flush
       end
 

data/lib/cucumber/formatter/progress.rb

@@ -30,14 +30,14 @@ module Cucumber
         @passed_test_cases = []
         @counts = ConsoleCounts.new(config)
         @issues = ConsoleIssues.new(config)
-        config.on_event :step_match, &method(:on_step_match)
+        config.on_event :step_activated, &method(:on_step_activated)
         config.on_event :test_case_starting, &method(:on_test_case_starting)
         config.on_event :test_step_finished, &method(:on_test_step_finished)
         config.on_event :test_case_finished, &method(:on_test_case_finished)
         config.on_event :test_run_finished, &method(:on_test_run_finished)
       end
 
-      def on_step_match(event)
+      def on_step_activated(event)
         @matches[event.test_step.source] = event.step_match
       end
 
@@ -53,11 +53,11 @@ module Cucumber
         test_step = event.test_step
         result = event.result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
         progress(result.to_sym) if !HookQueryVisitor.new(test_step).hook? || result.failed?
-        unless HookQueryVisitor.new(test_step).hook?
-          collect_snippet_data(test_step, result)
-          @pending_step_matches << @matches[test_step.source] if result.pending?
-          @failed_results << result if result.failed?
-        end
+
+        return if HookQueryVisitor.new(test_step).hook?
+        collect_snippet_data(test_step, result)
+        @pending_step_matches << @matches[test_step.source] if result.pending?
+        @failed_results << result if result.failed?
       end
 
       def on_test_case_finished(event)
@@ -84,12 +84,11 @@ module Cucumber
           snippet_text(step_keyword, step_name, multiline_arg)
         }
         do_print_snippets(snippet_text_proc) if config.snippets? && summary.test_steps.total(:undefined) > 0
-        if config.wip?
-          messages = @passed_test_cases.map do |test_case|
-            message = linebreaks("#{test_case.location.on_line(test_case.location.line)}:in `#{test_case.name}'", ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
-          end
-          do_print_passing_wip(messages)
+        return unless config.wip?
+        messages = @passed_test_cases.map do |test_case|
+          linebreaks("#{test_case.location.on_line(test_case.location.line)}:in `#{test_case.name}'", ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
         end
+        do_print_passing_wip(messages)
       end
 
       CHARS = {

data/lib/cucumber/formatter/rerun.rb

@@ -18,7 +18,7 @@ module Cucumber
         end
         config.on_event :test_run_finished do
           next if @failures.empty?
-          @io.print file_failures.join(' ')
+          @io.print file_failures.join('\n')
         end
       end
 

data/lib/cucumber/formatter/steps.rb

@@ -10,7 +10,7 @@ module Cucumber
         @step_definition_files = collect_steps(runtime)
       end
 
-      def after_features(features)
+      def after_features(_features)
         print_summary
       end
 

data/lib/cucumber/formatter/unicode.rb

@@ -15,7 +15,7 @@ if Cucumber::WINDOWS
       Cucumber::CODEPAGE = "cp#{$1.to_i}"
     end
   else
-    Cucumber::CODEPAGE = "cp1252"
+    Cucumber::CODEPAGE = 'cp1252'
     STDERR.puts("WARNING: Couldn't detect your output codepage. Assuming it is 1252. You may have to chcp 1252 or SET CUCUMBER_OUTPUT_ENCODING=cp1252.")
   end
 

data/lib/cucumber/formatter/usage.rb

@@ -15,7 +15,7 @@ module Cucumber
         @stepdef_to_match = Hash.new { |h, stepdef_key| h[stepdef_key] = [] }
         @total_duration = 0
         @matches = {}
-        config.on_event :step_match do |event|
+        config.on_event :step_activated do |event|
           test_step, step_match = *event.attributes
           @matches[test_step.source] = step_match
         end
@@ -23,7 +23,7 @@ module Cucumber
       end
 
       def on_step_definition_registered(event)
-        stepdef_key = StepDefKey.new(event.step_definition.regexp_source, event.step_definition.location)
+        stepdef_key = StepDefKey.new(event.step_definition.expression.to_s, event.step_definition.location)
         @stepdef_to_match[stepdef_key] = []
       end
 
@@ -39,7 +39,7 @@ module Cucumber
         result = event.result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
         step_match = @matches[test_step.source]
         step_definition = step_match.step_definition
-        stepdef_key = StepDefKey.new(step_definition.regexp_source, step_definition.location)
+        stepdef_key = StepDefKey.new(step_definition.expression.to_s, step_definition.location)
         unless @stepdef_to_match[stepdef_key].map { |key| key[:location] }.include? test_step.location
           duration = DurationExtractor.new(result).result_duration
 
@@ -59,11 +59,11 @@ module Cucumber
       def print_summary
         aggregate_info
 
-        if config.dry_run?
-          keys = @stepdef_to_match.keys.sort {|a,b| a.regexp_source <=> b.regexp_source}
-        else
-          keys = @stepdef_to_match.keys.sort {|a,b| a.mean_duration <=> b.mean_duration}.reverse
-        end
+        keys = if config.dry_run?
+                 @stepdef_to_match.keys.sort {|a,b| a.regexp_source <=> b.regexp_source}
+               else
+                 @stepdef_to_match.keys.sort {|a,b| a.mean_duration <=> b.mean_duration}.reverse
+               end
 
         keys.each do |stepdef_key|
           print_step_definition(stepdef_key)
@@ -71,7 +71,7 @@ module Cucumber
           if @stepdef_to_match[stepdef_key].any?
             print_steps(stepdef_key)
           else
-            @io.puts("  " + format_string("NOT MATCHED BY ANY STEPS", :failed))
+            @io.puts('  ' + format_string('NOT MATCHED BY ANY STEPS', :failed))
           end
         end
         @io.puts
@@ -79,7 +79,7 @@ module Cucumber
       end
 
       def print_step_definition(stepdef_key)
-        @io.print format_string(sprintf("%.7f", stepdef_key.mean_duration), :skipped) + " " unless config.dry_run?
+        @io.print format_string(format('%.7f', stepdef_key.mean_duration), :skipped) + ' ' unless config.dry_run?
         @io.print format_string(stepdef_key.regexp_source, stepdef_key.status)
         if config.source?
           indent = max_length - stepdef_key.regexp_source.unpack('U*').length
@@ -91,8 +91,8 @@ module Cucumber
 
       def print_steps(stepdef_key)
         @stepdef_to_match[stepdef_key].each do |step|
-          @io.print "  "
-          @io.print format_string(sprintf("%.7f", step[:duration]), :skipped) + " " unless config.dry_run?
+          @io.print '  '
+          @io.print format_string(format('%.7f', step[:duration]), :skipped) + ' ' unless config.dry_run?
           @io.print format_step(step[:keyword], step[:step_match], step[:status], nil)
           if config.source?
             indent = max_length - (step[:keyword].unpack('U*').length + step[:step_match].format_args.unpack('U*').length)

data/lib/cucumber/gherkin/formatter/ansi_escapes.rb

@@ -84,7 +84,7 @@ module Gherkin
           ALIASES["#{key}_arg"].split(',').map{|color| COLORS[color]}.join('')
         end
       end
-      
+
       def reset
         "\e[0m"
       end

data/lib/cucumber/gherkin/formatter/escaping.rb

@@ -10,7 +10,7 @@ module Gherkin
       #
       # This is used in the pretty formatter.
       def escape_cell(s)
-        s.gsub(/\\(?!\|)/, "\\\\\\\\").gsub(/\n/, "\\n").gsub(/\|/, "\\|")
+        s.gsub(/\\(?!\|)/, '\\\\\\\\').gsub(/\n/, '\\n').gsub(/\|/, '\\|')
       end
     end
   end

data/lib/cucumber/{rb_support/rb_dsl.rb → glue/dsl.rb}

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+require 'cucumber/cucumber_expressions/parameter_type'
+require 'cucumber/deprecate'
+
 module Cucumber
-  module RbSupport
-    # This module defines the methods you can use to define pure Ruby
-    # Step Definitions and Hooks. This module is mixed into the toplevel
-    # object.
-    module RbDsl
+  module Glue
+    # This module provides the methods the DSL you can use to define
+    # steps, hooks, transforms etc.
+    module Dsl
       class << self
         attr_writer :rb_language
 
@@ -20,8 +22,8 @@ module Cucumber
           @rb_language.register_rb_hook(phase, tag_names, proc)
         end
 
-        def register_rb_transform(regexp, proc)
-          @rb_language.register_rb_transform(regexp, proc)
+        def define_parameter_type(parameter_type)
+          @rb_language.define_parameter_type(parameter_type)
         end
 
         def register_rb_step_definition(regexp, proc_or_sym, options = {})
@@ -54,19 +56,19 @@ module Cucumber
       #    World(my_module: MyModule)
       #
       def World(*world_modules, **namespaced_world_modules, &proc)
-        RbDsl.build_rb_world_factory(world_modules, namespaced_world_modules, proc)
+        Dsl.build_rb_world_factory(world_modules, namespaced_world_modules, proc)
       end
 
       # Registers a proc that will run before each Scenario. You can register as many
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
       def Before(*tag_expressions, &proc)
-        RbDsl.register_rb_hook('before', tag_expressions, proc)
+        Dsl.register_rb_hook('before', tag_expressions, proc)
       end
 
       # Registers a proc that will run after each Scenario. You can register as many
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
       def After(*tag_expressions, &proc)
-        RbDsl.register_rb_hook('after', tag_expressions, proc)
+        Dsl.register_rb_hook('after', tag_expressions, proc)
       end
 
       # Registers a proc that will be wrapped around each scenario. The proc
@@ -75,13 +77,13 @@ module Cucumber
       # blocks in 1.8), on which it should call the .call method. You can register
       # as many  as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
       def Around(*tag_expressions, &proc)
-        RbDsl.register_rb_hook('around', tag_expressions, proc)
+        Dsl.register_rb_hook('around', tag_expressions, proc)
       end
 
       # Registers a proc that will run after each Step. You can register as
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
       def AfterStep(*tag_expressions, &proc)
-        RbDsl.register_rb_hook('after_step', tag_expressions, proc)
+        Dsl.register_rb_hook('after_step', tag_expressions, proc)
       end
 
       # Registers a proc that will be called with a step definition argument if it
@@ -90,14 +92,38 @@ module Cucumber
       # provided proc. The return value of the proc is consequently yielded to the
       # step definition.
       def Transform(regexp, &proc)
-        RbDsl.register_rb_transform(regexp, proc)
+        Cucumber.deprecate(
+          'Use ParameterType(...) instead',
+          'Transform',
+          '2.6.0'
+        )
+        parameter_type = CucumberExpressions::ParameterType.new(
+          regexp.to_s,
+          regexp,
+          Object,
+          proc,
+          false,
+          true
+        )
+        Dsl.define_parameter_type(parameter_type)
+      end
+
+      def ParameterType(options)
+        parameter_type = CucumberExpressions::ParameterType.new(
+          options[:name],
+          options[:regexp],
+          options[:type],
+          options[:transformer],
+          options[:use_for_snippets],
+          options[:prefer_for_regexp_match]
+        )
+        Dsl.define_parameter_type(parameter_type)
       end
 
       # Registers a proc that will run after Cucumber is configured. You can register as
       # as you want (typically from ruby scripts under <tt>support/hooks.rb</tt>).
-      # TODO: Deprecate this
       def AfterConfiguration(&proc)
-        RbDsl.register_rb_hook('after_configuration', [], proc)
+        Dsl.register_rb_hook('after_configuration', [], proc)
       end
 
       # Registers a new Ruby StepDefinition. This method is aliased
@@ -117,10 +143,11 @@ module Cucumber
       # the context of the <tt>World</tt> object.
       def register_rb_step_definition(regexp, symbol = nil, options = {}, &proc)
         proc_or_sym = symbol || proc
-        RbDsl.register_rb_step_definition(regexp, proc_or_sym, options)
+        Dsl.register_rb_step_definition(regexp, proc_or_sym, options)
       end
     end
   end
 end
 
-extend(Cucumber::RbSupport::RbDsl)
+# TODO: can we avoid adding methods to the global namespace (Kernel)
+extend(Cucumber::Glue::Dsl)