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

data/lib/cucumber/cli/profile_loader.rb

@@ -11,7 +11,7 @@ module Cucumber
       end
 
       def args_from(profile)
-        unless cucumber_yml.has_key?(profile)
+        unless cucumber_yml.key?(profile)
           raise(ProfileNotFound, <<-END_OF_ERROR)
 Could not find profile: '#{profile}'
 
@@ -22,34 +22,39 @@ Defined profiles in cucumber.yml:
 
         args_from_yml = cucumber_yml[profile] || ''
 
-        case(args_from_yml)
-          when String
-            raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was blank.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml =~ /^\s*$/
-            if(Cucumber::WINDOWS)
-              #Shellwords treats backslash as an escape character so here's a rudimentary approximation of the same code
-              args_from_yml = args_from_yml.split
-              args_from_yml = args_from_yml.collect {|x| x.gsub(/^\"(.*)\"/,'\1') }
-            else
-              require 'shellwords'
-              args_from_yml = Shellwords.shellwords(args_from_yml)
-            end
-          when Array
-            raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was empty.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml.empty?
+        require 'shellwords'
+
+        case args_from_yml
+        when String
+          raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was blank.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml =~ /^\s*$/
+          if Cucumber::WINDOWS
+            # Shellwords treats backslash as an escape character so we have to mask it out temporarily
+
+            placeholder = 'pseudo_unique_backslash_placeholder'
+            sanitized_line = args_from_yml.gsub('\\', placeholder)
+
+            args_from_yml = Shellwords.shellwords(sanitized_line).collect { |argument| argument.gsub(placeholder, '\\') }
           else
-            raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was a #{args_from_yml.class}. It must be a String or Array"
+            args_from_yml = Shellwords.shellwords(args_from_yml)
+          end
+        when Array
+          raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was empty.  Please define the command line arguments for the '#{profile}' profile in cucumber.yml.\n" if args_from_yml.empty?
+        else
+          raise YmlLoadError, "The '#{profile}' profile in cucumber.yml was a #{args_from_yml.class}. It must be a String or Array"
         end
+
         args_from_yml
       end
 
       def has_profile?(profile)
-        cucumber_yml.has_key?(profile)
+        cucumber_yml.key?(profile)
       end
 
       def cucumber_yml_defined?
         cucumber_file && File.exist?(cucumber_file)
       end
 
-    private
+      private
 
       # Loads the profile, processing it through ERB and YAML, and returns it as a hash.
       def cucumber_yml
@@ -62,13 +67,13 @@ Defined profiles in cucumber.yml:
         require 'yaml'
         begin
           @cucumber_erb = ERB.new(IO.read(cucumber_file), nil, '%').result(binding)
-        rescue Exception => e
+        rescue StandardError
           raise(YmlLoadError,"cucumber.yml was found, but could not be parsed with ERB.  Please refer to cucumber's documentation on correct profile usage.\n#{$!.inspect}")
         end
 
         begin
           @cucumber_yml = YAML::load(@cucumber_erb)
-        rescue StandardError => e
+        rescue StandardError
           raise(YmlLoadError,"cucumber.yml was found, but could not be parsed. Please refer to cucumber's documentation on correct profile usage.\n")
         end
 
@@ -89,4 +94,3 @@ Defined profiles in cucumber.yml:
     end
   end
 end
-

data/lib/cucumber/configuration.rb

@@ -4,7 +4,6 @@ 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
@@ -130,13 +129,8 @@ module Cucumber
       with_default_features_path(dirs)
     end
 
-    # todo: remove
-    def tag_expression
-      Cucumber::Core::Gherkin::TagExpression.new(@options[:tag_expressions])
-    end
-
     def tag_limits
-      tag_expression.limits.to_hash
+      @options[:tag_limits]
     end
 
     def tag_expressions
@@ -153,7 +147,7 @@ module Cucumber
 
     def feature_files
       potential_feature_files = with_default_features_path(paths).map do |path|
-        path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
+        path = path.tr('\\', '/') # In case we're on windows. Globs don't work with backslashes.
         path = path.chomp('/')
 
         # TODO: Move to using feature loading strategies stored in
@@ -179,7 +173,7 @@ module Cucumber
 
     def all_files_to_load
       files = require_dirs.map do |path|
-        path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes.
+        path = path.tr('\\', '/') # In case we're on windows. Globs don't work with backslashes.
         path = path.gsub(/\/$/, '') # Strip trailing slash.
         File.directory?(path) ? Dir["#{path}/**/*"] : path
       end.flatten.uniq
@@ -195,12 +189,13 @@ module Cucumber
     end
 
     def formatter_factories
-      @options[:formats].map do |format_and_out|
-        format = format_and_out[0]
-        path_or_io = format_and_out[1]
+      formats.map do |format, formatter_options, path_or_io|
         begin
           factory = formatter_class(format)
-          yield factory, path_or_io, Cli::Options.new(STDOUT, STDERR, @options)
+          yield factory,
+                formatter_options,
+                path_or_io,
+                Cli::Options.new(STDOUT, STDERR, @options)
         rescue Exception => e
           raise e, "#{e.message}\nError creating formatter: #{format}", e.backtrace
         end
@@ -208,7 +203,7 @@ module Cucumber
     end
 
     def formatter_class(format)
-      if(builtin = Cli::Options::BUILTIN_FORMATS[format])
+      if (builtin = Cli::Options::BUILTIN_FORMATS[format])
         constantize(builtin[0])
       else
         constantize(format)
@@ -242,7 +237,7 @@ module Cucumber
       @options[:event_bus]
     end
 
-  private
+    private
 
     def default_options
       {
@@ -261,12 +256,12 @@ module Cucumber
         :snippets            => true,
         :source              => true,
         :duration            => true,
-        :event_bus           => Core::EventBus.new(Core::Events.registry.merge(Cucumber::Events.registry))
+        :event_bus           => Cucumber::Events.make_event_bus
       }
     end
 
     def default_features_paths
-      ["features"]
+      ['features']
     end
 
     def with_default_features_path(paths)

data/lib/cucumber/constantize.rb

@@ -29,7 +29,7 @@ module Cucumber
       camel_cased_word.to_s.gsub(/::/, '/').
         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
         gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
+        tr('-', '_').
         downcase
     end
 

data/lib/cucumber/core_ext/string.rb

@@ -4,7 +4,7 @@ class String #:nodoc:
     if n >= 0
       gsub(/^/, ' ' * n)
     else
-      gsub(/^ {0,#{-n}}/, "")
+      gsub(/^ {0,#{-n}}/, '')
     end
   end
 end

data/lib/cucumber/deprecate.rb

@@ -13,7 +13,7 @@ module Cucumber
     end
 
     module ForDevelopers
-      def self.call(message, method, remove_after_version)
+      def self.call(_message, _method, remove_after_version)
         if Cucumber::VERSION > remove_after_version
           raise "This method is due for removal after version #{remove_after_version}"
         end

data/lib/cucumber/events.rb

@@ -18,11 +18,21 @@ module Cucumber
   #   end
   #
   module Events
+    def self.make_event_bus
+      Core::EventBus.new(registry)
+    end
+
     def self.registry
       Core::Events.build_registry(
+        TestCaseStarting,
+        TestCaseFinished,
+        TestStepFinished,
+        TestStepStarting,
         StepDefinitionRegistered,
-        StepMatch,
+        StepActivated,
         TestRunFinished,
+        GherkinSourceRead,
+        TestRunStarting
       )
     end
   end

data/lib/cucumber/events/gherkin_source_read.rb

@@ -0,0 +1,17 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Fired after we've read in the contents of a feature file
+    class GherkinSourceRead < Core::Event.new(:path, :body)
+
+      # The path to the file
+      attr_reader :path
+
+      # The raw Gherkin source
+      attr_reader :body
+    end
+
+  end
+end

data/lib/cucumber/events/{step_match.rb → step_activated.rb}

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

data/lib/cucumber/events/step_definition_registered.rb

@@ -10,7 +10,7 @@ module Cucumber
 
       #_The step definition that was just registered.
       #
-      # @return [Cucumber::Core::Test::Case]
+      # @return [RbSupport::RbStepDefinition]
       attr_reader :step_definition
 
       #_@private

data/lib/cucumber/events/test_case_finished.rb

@@ -0,0 +1,18 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Signals that a {Cucumber::Core::Test::Case} has finished executing
+    class TestCaseFinished < Core::Events::TestCaseFinished
+
+      # @return [Cucumber::Core::Test::Case] that was executed
+      attr_reader :test_case
+
+      # @return [Cucumber::Core::Test::Result] the result of running the {Cucumber::Core::Test::Step}
+      attr_reader :result
+
+    end
+
+  end
+end

data/lib/cucumber/events/test_case_starting.rb

@@ -0,0 +1,15 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Signals that a {Cucumber::Core::Test::Case} is about to be executed
+    class TestCaseStarting < Core::Events::TestCaseStarting
+
+      # @return [Cucumber::Core::Test::Case] the test case to be executed
+      attr_reader :test_case
+
+    end
+
+  end
+end

data/lib/cucumber/events/test_run_starting.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Event fired once all test cases have been filtered before
+    # the first one is executed.
+    class TestRunStarting < Core::Event.new(:test_cases)
+
+      # @return [Array<Cucumber::Core::Test::Case>] the test cases to be executed
+      attr_reader :test_cases
+    end
+
+  end
+end

data/lib/cucumber/events/test_step_finished.rb

@@ -0,0 +1,20 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Signals that a {Cucumber::Core::Test::Step} has finished executing
+    class TestStepFinished < Core::Events::TestStepFinished
+
+      # @return [Cucumber::Core::Test::Step] the test step that was executed
+      attr_reader :test_step
+
+      # @return [Cucumber::Core::Test::Result] the result of running the {Cucumber::Core::Test::Step}
+      attr_reader :result
+
+    end
+
+  end
+end
+
+

data/lib/cucumber/events/test_step_starting.rb

@@ -0,0 +1,17 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+
+    # Signals that a {Cucumber::Core::Test::Step} is about to be executed
+    class TestStepStarting < Core::Events::TestStepStarting
+
+      # @return [Cucumber::Core::Test::Step] the test step to be executed
+      attr_reader :test_step
+
+    end
+
+  end
+end
+
+

data/lib/cucumber/filters.rb

@@ -4,6 +4,7 @@ require 'cucumber/filters/apply_after_step_hooks'
 require 'cucumber/filters/apply_before_hooks'
 require 'cucumber/filters/apply_after_hooks'
 require 'cucumber/filters/apply_around_hooks'
+require 'cucumber/filters/broadcast_test_run_starting_event'
 require 'cucumber/filters/prepare_world'
 require 'cucumber/filters/quit'
 require 'cucumber/filters/randomizer'

data/lib/cucumber/filters/activate_steps.rb

@@ -44,7 +44,7 @@ module Cucumber
 
           def result
             return NoStepMatch.new(test_step.source.last, test_step.name) unless matches.any?
-            configuration.notify :step_match, test_step, match
+            configuration.notify :step_activated, test_step, match
             return SkippingStepMatch.new if configuration.dry_run?
             match
           end

data/lib/cucumber/filters/broadcast_test_run_starting_event.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Cucumber
+  module Filters
+    # Added at the end of the filter chain to broadcast a list of
+    # all of the test cases that have made it through the filters.
+    class BroadcastTestRunStartingEvent < Core::Filter.new(:config)
+      def initialize(config, receiver=nil)
+        super
+        @test_cases = []
+      end
+
+      def test_case(test_case)
+        @test_cases << test_case
+        self
+      end
+
+      def done
+        config.notify :test_run_starting, @test_cases
+        @test_cases.map do |test_case|
+          test_case.describe_to(@receiver)
+        end
+        super
+        self
+      end
+    end
+  end
+end

data/lib/cucumber/filters/retry.rb

@@ -12,7 +12,7 @@ module Cucumber
           next unless retry_required?(test_case, event)
 
           test_case_counts[test_case] += 1
-          event.test_case.describe_to(receiver)
+          test_case.describe_to(receiver)
         end
 
         super

data/lib/cucumber/filters/tag_limits.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
-require "cucumber/filters/gated_receiver"
-require "cucumber/filters/tag_limits/test_case_index"
-require "cucumber/filters/tag_limits/verifier"
+require 'cucumber/filters/gated_receiver'
+require 'cucumber/filters/tag_limits/test_case_index'
+require 'cucumber/filters/tag_limits/verifier'
 
 module Cucumber
   module Filters

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

@@ -28,7 +28,7 @@ module Cucumber
         attr_reader :tag_limits
 
         class Breach
-          INDENT = (" " * 2).freeze
+          INDENT = (' ' * 2).freeze
 
           def initialize(tag_name, limit, locations)
             @tag_name = tag_name

data/lib/cucumber/formatter/ansicolor.rb

@@ -9,7 +9,7 @@ if Cucumber::WINDOWS_MRI
   end
 end
 
-Cucumber::Term::ANSIColor.coloring = false if !STDOUT.tty? && !ENV.has_key?("AUTOTEST")
+Cucumber::Term::ANSIColor.coloring = false if !STDOUT.tty? && !ENV.key?('AUTOTEST')
 
 module Cucumber
   module Formatter
@@ -60,6 +60,7 @@ module Cucumber
       end.merge({
         'undefined' => 'yellow',
         'pending'   => 'yellow',
+        'flaky'     => 'yellow',
         'failed'    => 'red',
         'passed'    => 'green',
         'outline'   => 'cyan',
@@ -105,7 +106,7 @@ module Cucumber
         begin
           gem 'genki-ruby-terminfo'
           require 'terminfo'
-          case TermInfo.default_object.tigetnum("colors")
+          case TermInfo.default_object.tigetnum('colors')
           when 0
             raise "Your terminal doesn't support colours."
           when 1
@@ -118,9 +119,9 @@ module Cucumber
           end
         rescue Exception => e
           if e.class.name == 'TermInfo::TermInfoError'
-            STDERR.puts "*** WARNING ***"
+            STDERR.puts '*** WARNING ***'
             STDERR.puts "You have the genki-ruby-terminfo gem installed, but you haven't set your TERM variable."
-            STDERR.puts "Try setting it to TERM=xterm-256color to get grey colour in output."
+            STDERR.puts 'Try setting it to TERM=xterm-256color to get grey colour in output.'
             STDERR.puts "\n"
             alias grey white
           else
@@ -130,19 +131,15 @@ module Cucumber
       end
 
       def self.define_real_grey #:nodoc:
-        def grey(string) #:nodoc:
-          if ::Cucumber::Term::ANSIColor.coloring?
-            "\e[90m#{string}\e[0m"
-          else
-            string
-          end
+        define_method :grey do |string|
+          ::Cucumber::Term::ANSIColor.coloring? ? "\e[90m#{string}\e[0m" : string
         end
       end
 
       define_grey
 
       def cukes(n)
-        ("(::) " * n).strip
+        ('(::) ' * n).strip
       end
 
       def green_cukes(n)