cucumber 2.99.0 → 3.0.0.pre.1

data/lib/cucumber/cli/profile_loader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'yaml'
 
 module Cucumber

data/lib/cucumber/cli/rerun_file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Cli
     class RerunFile

data/lib/cucumber/configuration.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
 require 'cucumber/constantize'
 require 'cucumber/cli/rerun_file'
 require 'cucumber/events'
+require 'cucumber/core/event_bus'
 require 'forwardable'
 require 'cucumber/core/gherkin/tag_expression'
+require 'cucumber'
 
 module Cucumber
   # The base class for configuring settings for a Cucumber run.
@@ -20,27 +23,23 @@ module Cucumber
     #
     # @param event_id [Symbol, Class, String] Identifier for the type of event to subscribe to
     # @param handler_object [Object optional] an object to be called when the event occurs
-    # @yield [Object] Block to be called when th event occurs
+    # @yield [Object] Block to be called when the event occurs
     # @method on_event
-    def_instance_delegator :event_bus, :register, :on_event
+    def_instance_delegator :event_bus, :on, :on_event
 
     # @private
-    def_instance_delegator :event_bus, :notify
+    def notify(message, *args)
+      event_bus.send(message, *args)
+    end
 
     def initialize(user_options = {})
-      @options = default_options.merge(Cucumber::Hash(user_options))
+      @options = default_options.merge(Hash(user_options))
     end
 
     def with_options(new_options)
       self.class.new(@options.merge(new_options))
     end
 
-    # TODO: Actually Deprecate???
-    def options
-      warn("Deprecated: Configuration#options will be removed from the next release of Cucumber. Please use the configuration object directly instead.")
-      Marshal.load(Marhal.dump(@options))
-    end
-
     def out_stream
       @options[:out_stream]
     end
@@ -85,6 +84,30 @@ module Cucumber
       @options[:expand]
     end
 
+    def source?
+      @options[:source]
+    end
+
+    def duration?
+      @options[:duration]
+    end
+
+    def snippets?
+      @options[:snippets]
+    end
+
+    def skip_profile_information?
+      @options[:skip_profile_information]
+    end
+
+    def profiles
+      @options[:profiles] || []
+    end
+
+    def custom_profiles
+      profiles - [@options[:default_profile]]
+    end
+
     def paths
       @options[:paths]
     end
@@ -179,8 +202,7 @@ module Cucumber
           factory = formatter_class(format)
           yield factory, path_or_io, Cli::Options.new(STDOUT, STDERR, @options)
         rescue Exception => e
-          e.message << "\nError creating formatter: #{format}"
-          raise e
+          raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
         end
       end
     end
@@ -201,7 +223,7 @@ module Cucumber
     # formatter wants to display snippets to the user.
     #
     # Each proc should take the following arguments:
-    # 
+    #
     #  - keyword
     #  - step text
     #  - multiline argument
@@ -216,6 +238,10 @@ module Cucumber
       self
     end
 
+    def event_bus
+      @options[:event_bus]
+    end
+
   private
 
     def default_options
@@ -235,15 +261,10 @@ module Cucumber
         :snippets            => true,
         :source              => true,
         :duration            => true,
-        :event_bus           => Events::Bus.new(Cucumber::Events)
+        :event_bus           => Core::EventBus.new(Core::Events.registry.merge(Cucumber::Events.registry))
       }
     end
 
-    def event_bus
-      @options[:event_bus]
-    end
-
-
     def default_features_paths
       ["features"]
     end

data/lib/cucumber/constantize.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 module Cucumber
   module Constantize #:nodoc:

data/lib/cucumber/core_ext/instance_exec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 
 module Cucumber

data/lib/cucumber/core_ext/string.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class String #:nodoc:
   def indent(n)
     if n >= 0

data/lib/cucumber/deprecate.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 require 'cucumber/gherkin/formatter/ansi_escapes'
 

data/lib/cucumber/encoding.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # See https://github.com/cucumber/cucumber/issues/693
 if defined? Encoding
   Encoding.default_external = 'utf-8'

data/lib/cucumber/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/test/result'
 
 module Cucumber
@@ -35,7 +36,8 @@ module Cucumber
   # Raised when a step matches 2 or more StepDefinitions
   class Ambiguous < StandardError
     def initialize(step_name, step_definitions, used_guess)
-      message = "Ambiguous match of \"#{step_name}\":\n\n"
+      message = String.new
+      message << "Ambiguous match of \"#{step_name}\":\n\n"
       message << step_definitions.map{|sd| sd.backtrace_line}.join("\n")
       message << "\n\n"
       message << "You can run again with --guess to make Cucumber be more smart about it\n" unless used_guess

data/lib/cucumber/events.rb

@@ -1,20 +1,30 @@
+# frozen_string_literal: true
+Dir[File.dirname(__FILE__) + '/events/*.rb'].map(&method(:require))
+
 module Cucumber
 
   # Events tell you what's happening while Cucumber runs your features.
   #
   # They're designed to be read-only, appropriate for writing formatters and other
-  # output tools. If you need to be able to influence the result of a scenario, use a hook instead.
+  # output tools. If you need to be able to influence the result of a scenario, use a {RbSupport::RbDsl hook} instead.
   #
   # To subscribe to an event, use {Cucumber::Configuration#on_event}
   #
   # @example
   #   AfterConfiguration do |config|
-  #     config.on_event :after_test_step do |event|
+  #     config.on_event :test_case_finished do |event|
   #       puts event.result
   #     end
   #   end
+  #
   module Events
+    def self.registry
+      Core::Events.build_registry(
+        StepDefinitionRegistered,
+        StepMatch,
+        TestRunFinished,
+      )
+    end
   end
 end
 
-Dir[File.dirname(__FILE__) + '/events/*.rb'].map(&method(:require))

data/lib/cucumber/events/step_definition_registered.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Event fired after each step definition has been registered
+    class StepDefinitionRegistered < Core::Event.new(:step_definition)
+
+
+      #_The step definition that was just registered.
+      #
+      # @return [Cucumber::Core::Test::Case]
+      attr_reader :step_definition
+
+      #_@private
+      def initialize(step_definition)
+        @step_definition = step_definition
+      end
+
+    end
+
+  end
+end

data/lib/cucumber/events/step_match.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+require 'cucumber/core/events'
+
 module Cucumber
   module Events
 
     # Event fired when a step is matched to a definition
-    class StepMatch
+    class StepMatch < Core::Event.new(:test_step, :step_match)
 
       # The test step that was matched.
       #

data/lib/cucumber/events/test_run_finished.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Event fired after all test cases have finished executing
+    class TestRunFinished < Core::Event.new
+    end
+
+  end
+end

data/lib/cucumber/file_specs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber'
 require 'cucumber/core/ast/location'
 

data/lib/cucumber/filters.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/filters/activate_steps'
 require 'cucumber/filters/apply_after_step_hooks'
 require 'cucumber/filters/apply_before_hooks'
@@ -6,4 +7,5 @@ require 'cucumber/filters/apply_around_hooks'
 require 'cucumber/filters/prepare_world'
 require 'cucumber/filters/quit'
 require 'cucumber/filters/randomizer'
+require 'cucumber/filters/retry'
 require 'cucumber/filters/tag_limits'

data/lib/cucumber/filters/activate_steps.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/filter'
 require 'cucumber/step_match'
 require 'cucumber/events'
@@ -43,7 +44,7 @@ module Cucumber
 
           def result
             return NoStepMatch.new(test_step.source.last, test_step.name) unless matches.any?
-            configuration.notify Events::StepMatch.new(test_step, match)
+            configuration.notify :step_match, test_step, match
             return SkippingStepMatch.new if configuration.dry_run?
             match
           end

data/lib/cucumber/filters/apply_after_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
     class ApplyAfterHooks < Core::Filter.new(:hooks)

data/lib/cucumber/filters/apply_after_step_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/filter'
 
 module Cucumber

data/lib/cucumber/filters/apply_around_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/filter'
 
 module Cucumber

data/lib/cucumber/filters/apply_before_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
     class ApplyBeforeHooks < Core::Filter.new(:hooks)

data/lib/cucumber/filters/gated_receiver.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
 

data/lib/cucumber/filters/prepare_world.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/filter'
 require 'cucumber/core/ast/location'
 require 'cucumber/running_test_case'

data/lib/cucumber/filters/quit.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
 

data/lib/cucumber/filters/randomizer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'digest/sha2'
 
 module Cucumber

data/lib/cucumber/filters/retry.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
 require 'cucumber/core/filter'
 require 'cucumber/running_test_case'
-require 'cucumber/events/bus'
-require 'cucumber/events/after_test_case'
+require 'cucumber/events'
 
 module Cucumber
   module Filters
     class Retry < Core::Filter.new(:configuration)
 
       def test_case(test_case)
-        configuration.on_event(:after_test_case) do |event|
+        configuration.on_event(:test_case_finished) do |event|
           next unless retry_required?(test_case, event)
 
           test_case_counts[test_case] += 1

data/lib/cucumber/filters/tag_limits.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "cucumber/filters/gated_receiver"
 require "cucumber/filters/tag_limits/test_case_index"
 require "cucumber/filters/tag_limits/verifier"

data/lib/cucumber/filters/tag_limits/test_case_index.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
     class TagLimits

data/lib/cucumber/filters/tag_limits/verifier.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cucumber
   module Filters
     class TagLimits

data/lib/cucumber/formatter/ansicolor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 require 'cucumber/term/ansicolor'
 

data/lib/cucumber/formatter/backtrace_filter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/platform'
 
 
@@ -19,9 +20,9 @@ module Cucumber
         return @exception if ::Cucumber.use_full_backtrace
 
         pwd_pattern = /#{::Regexp.escape(::Dir.pwd)}\//m
-        @exception.backtrace.each { |line| line.gsub!(pwd_pattern, "./") }
+        backtrace = @exception.backtrace.map { |line| line.gsub(pwd_pattern, "./") }
 
-        filtered = (@exception.backtrace || []).reject do |line|
+        filtered = (backtrace || []).reject do |line|
           BACKTRACE_FILTER_PATTERNS.detect { |p| line =~ p }
         end
 

data/lib/cucumber/formatter/console.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require 'cucumber/formatter/ansicolor'
 require 'cucumber/formatter/duration'
-require 'cucumber/formatter/summary'
+require 'cucumber/gherkin/i18n'
 
 module Cucumber
   module Formatter
@@ -28,7 +29,6 @@ module Cucumber
     module Console
       extend ANSIColor
       include Duration
-      include Summary
 
       def format_step(keyword, step_match, status, source_indent)
         comment = if source_indent
@@ -59,75 +59,53 @@ module Cucumber
       end
 
       def print_elements(elements, status, kind)
-        if elements.any?
+        return if elements.empty?
+
+        element_messages = element_messages(elements, status)
+        print_element_messages(element_messages, status, kind)
+      end
+
+      def print_element_messages(element_messages, status, kind)
+        if element_messages.any?
           @io.puts(format_string("(::) #{status} #{kind} (::)", status))
           @io.puts
           @io.flush
         end
 
-        elements.each_with_index do |element, i|
-          if status == :failed
-            print_exception(element.exception, status, 0)
-          else
-            message = linebreaks(element.backtrace_line, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
-            @io.puts(format_string(message, status))
-          end
+        element_messages.each do |message|
+          @io.puts(format_string(message, status))
           @io.puts
           @io.flush
         end
       end
 
-      def print_stats(features, options)
-        duration = features ? features.duration : nil
-        print_statistics(duration, options)
-      end
-
-      def print_statistics(duration, options)
-        failures = collect_failing_scenarios(runtime)
-        if !failures.empty?
-          print_failing_scenarios(failures, options.custom_profiles, options[:source])
+      def print_statistics(duration, config, counts, issues)
+        if issues.any?
+          @io.puts issues.to_s
+          @io.puts
         end
 
-        @io.puts scenario_summary(runtime) {|status_count, status| format_string(status_count, status)}
-        @io.puts step_summary(runtime) {|status_count, status| format_string(status_count, status)}
-        @io.puts(format_duration(duration)) if duration && options[:duration]
+        @io.puts counts.to_s
+        @io.puts(format_duration(duration)) if duration && config.duration?
 
-        if runtime.configuration.randomize?
+        if config.randomize?
           @io.puts
-          @io.puts "Randomized with seed #{runtime.configuration.seed}"
+          @io.puts "Randomized with seed #{config.seed}"
         end
 
         @io.flush
       end
 
-      def collect_failing_scenarios(runtime)
-        # TODO: brittle - stop coupling to types
-        scenario_class = LegacyApi::Ast::Scenario
-        example_table_class = Core::Ast::ExamplesTable
-
-        runtime.scenarios(:failed).select do |s|
-          [scenario_class, example_table_class].include?(s.class)
-        end.map do |s|
-          s.is_a?(example_table_class)? s.scenario_outline : s
-        end
-      end
-
-      def print_failing_scenarios(failures, custom_profiles, given_source)
-        @io.puts format_string("Failing Scenarios:", :failed)
-        failures.each do |failure|
-          profiles_string = custom_profiles.empty? ? '' : (custom_profiles.map{|profile| "-p #{profile}" }).join(' ') + ' '
-          source = given_source ? format_string(" # " + failure.name, :comment) : ''
-          @io.puts format_string("cucumber #{profiles_string}" + failure.location, :failed) + source
-        end
-        @io.puts
+      def print_exception(e, status, indent)
+        string = exception_message_string(e, indent)
+        @io.puts(format_string(string, status))
       end
 
-      def print_exception(e, status, indent)
-        message = "#{e.message} (#{e.class})".force_encoding("UTF-8")
+      def exception_message_string(e, indent)
+        message = "#{e.message} (#{e.class})".dup.force_encoding("UTF-8")
         message = linebreaks(message, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
 
         string = "#{message}\n#{e.backtrace.join("\n")}".indent(indent)
-        @io.puts(format_string(string, status))
       end
 
       # http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/10655
@@ -151,8 +129,15 @@ module Cucumber
         return unless options[:snippets]
         return if runtime.steps(:undefined).empty?
 
+        snippet_text_proc = lambda { |step_keyword, step_name, multiline_arg|
+          runtime.snippet_text(step_keyword, step_name, multiline_arg)
+        }
+        do_print_snippets(snippet_text_proc)
+      end
+
+      def do_print_snippets(snippet_text_proc)
         snippets = @snippets_input.map do |data|
-          @runtime.snippet_text(data.actual_keyword, data.step.name, data.step.multiline_arg)
+          snippet_text_proc.call(data.actual_keyword, data.step.name, data.step.multiline_arg)
         end.uniq
 
         text = "\nYou can implement step definitions for undefined steps with these snippets:\n\n"
@@ -165,10 +150,14 @@ module Cucumber
 
       def print_passing_wip(options)
         return unless options[:wip]
-        passed = runtime.scenarios(:passed)
-        if passed.any?
+        passed_messages = element_messages(runtime.scenarios(:passed), :passed)
+        do_print_passing_wip(passed_messages)
+      end
+
+      def do_print_passing_wip(passed_messages)
+        if passed_messages.any?
           @io.puts format_string("\nThe --wip switch was used, so I didn't expect anything to pass. These scenarios passed:", :failed)
-          print_elements(passed, :passed, "scenarios")
+          print_element_messages(passed_messages, :passed, "scenarios")
         else
           @io.puts format_string("\nThe --wip switch was used, so the failures were expected. All is good.\n", :passed)
         end
@@ -217,7 +206,10 @@ module Cucumber
 
       def print_profile_information
         return if @options[:skip_profile_information] || @options[:profiles].nil? || @options[:profiles].empty?
-        profiles = @options[:profiles]
+        do_print_profile_information(@options[:profiles])
+      end
+
+      def do_print_profile_information(profiles)
         profiles_sentence = ''
         profiles_sentence = profiles.size == 1 ? profiles.first :
           "#{profiles[0...-1].join(', ')} and #{profiles.last}"
@@ -240,6 +232,23 @@ module Cucumber
         not test_step.source.last.respond_to?(:actual_keyword)
       end
 
+      def element_messages(elements, status)
+        element_messages = elements.map do |element|
+          if status == :failed
+            message = exception_message_string(element.exception, 0)
+          else
+            message = linebreaks(element.backtrace_line, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
+          end
+        end
+      end
+
+      def snippet_text(step_keyword, step_name, multiline_arg)
+        keyword = Cucumber::Gherkin::I18n.code_keyword_for(step_keyword).strip
+        config.snippet_generators.map { |generator|
+          generator.call(keyword, step_name, multiline_arg, config.snippet_type)
+        }.join("\n")
+      end
+
       class SnippetData
         attr_reader :actual_keyword, :step
         def initialize(actual_keyword, step)