cucumber 3.0.0.pre.1 → 4.0.0.rc.4

data/lib/cucumber/encoding.rb

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

data/lib/cucumber/errors.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
+
 require 'cucumber/core/test/result'
 
 module Cucumber
   # Raised when there is no matching StepDefinition for a step.
   class Undefined < Core::Test::Result::Undefined
     def self.from(result, step_name)
-      if result.is_a?(self)
-        return result.with_message(with_prefix(result.message))
-      end
+      return result.with_message(with_prefix(result.message)) if result.is_a?(self)
 
       begin
-        raise self.new(with_prefix(step_name))
-      rescue => exception
-        return exception
+        raise new(with_prefix(step_name)) # rubocop:disable Style/RaiseArgs
+      rescue StandardError => e
+        return e
       end
     end
 
@@ -36,9 +35,9 @@ module Cucumber
   # Raised when a step matches 2 or more StepDefinitions
   class Ambiguous < StandardError
     def initialize(step_name, step_definitions, used_guess)
-      message = String.new
+      message = String.new # rubocop:disable Style/EmptyLiteral
       message << "Ambiguous match of \"#{step_name}\":\n\n"
-      message << step_definitions.map{|sd| sd.backtrace_line}.join("\n")
+      message << step_definitions.map(&: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
       super(message)
@@ -50,4 +49,7 @@ module Cucumber
       super(messages.join("\n"))
     end
   end
+
+  class LogTypeInvalid < StandardError
+  end
 end

data/lib/cucumber/events.rb

@@ -1,8 +1,8 @@
 # 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
@@ -18,13 +18,28 @@ module Cucumber
   #   end
   #
   module Events
+    def self.make_event_bus
+      Core::EventBus.new(registry)
+    end
+
     def self.registry
       Core::Events.build_registry(
+        GherkinSourceParsed,
+        GherkinSourceRead,
+        HookTestStepCreated,
+        StepActivated,
         StepDefinitionRegistered,
-        StepMatch,
+        TestCaseCreated,
+        TestCaseFinished,
+        TestCaseStarted,
+        TestCaseReady,
         TestRunFinished,
+        TestRunStarted,
+        TestStepCreated,
+        TestStepFinished,
+        TestStepStarted,
+        Envelope
       )
     end
   end
 end
-

data/lib/cucumber/events/envelope.rb

@@ -0,0 +1,9 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    class Envelope < Core::Event.new(:envelope)
+      attr_reader :envelope
+    end
+  end
+end

data/lib/cucumber/events/gherkin_source_parsed.rb

@@ -0,0 +1,11 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Fired after we've parsed the contents of a feature file
+    class GherkinSourceParsed < Core::Event.new(:gherkin_document)
+      # The Gherkin Ast
+      attr_reader :gherkin_document
+    end
+  end
+end

data/lib/cucumber/events/gherkin_source_read.rb

@@ -0,0 +1,14 @@
+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/hook_test_step_created.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a step is created from a hook
+    class HookTestStepCreated < Core::Event.new(:test_step, :hook)
+      attr_reader :test_step
+      attr_reader :hook
+    end
+  end
+end

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

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
+
 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)
-
-      # The test step that was matched.
+    # Event fired when a step is activated
+    class StepActivated < Core::Event.new(:test_step, :step_match)
+      # The test step that was matched.
       #
       # @return [Cucumber::Core::Test::Step]
       attr_reader :test_step
 
-      # Information about the matching definition.
+      # Information about the matching definition.
       #
       # @return [Cucumber::StepMatch]
       attr_reader :step_match
 
-      # @private
+      # @private
       def initialize(test_step, step_match)
-        @test_step, @step_match = test_step, step_match
+        @test_step = test_step
+        @step_match = step_match
       end
     end
   end

data/lib/cucumber/events/step_definition_registered.rb

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

data/lib/cucumber/events/test_case_created.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a Test::Case is created from a Pickle
+    class TestCaseCreated < Core::Event.new(:test_case, :pickle)
+      attr_reader :test_case
+      attr_reader :pickle
+    end
+  end
+end

data/lib/cucumber/events/test_case_finished.rb

@@ -0,0 +1,14 @@
+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::Case}
+      attr_reader :result
+    end
+  end
+end

data/lib/cucumber/events/test_case_ready.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a Test::Case is ready to be ran (matching has been done, hooks added etc)
+    class TestCaseReady < Core::Event.new(:test_case)
+      attr_reader :test_case
+    end
+  end
+end

data/lib/cucumber/events/test_case_started.rb

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

data/lib/cucumber/events/test_run_finished.rb

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

data/lib/cucumber/events/test_run_started.rb

@@ -0,0 +1,14 @@
+# 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 TestRunStarted < 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_created.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    # Event fired when a TestStep is created from a PickleStep
+    class TestStepCreated < Core::Event.new(:test_step, :pickle_step)
+      attr_reader :test_step
+      attr_reader :pickle_step
+    end
+  end
+end

data/lib/cucumber/events/test_step_finished.rb

@@ -0,0 +1,14 @@
+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_started.rb

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

data/lib/cucumber/file_specs.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 require 'cucumber'
-require 'cucumber/core/ast/location'
+require 'cucumber/core/test/location'
 
 module Cucumber
   class FileSpecs
@@ -8,7 +9,7 @@ module Cucumber
 
     def initialize(file_specs)
       Cucumber.logger.debug("Features:\n")
-      @file_specs = file_specs.map { |s| FileSpec.new(s) }
+      @file_specs = file_specs.map { |spec| FileSpec.new(spec) }
       Cucumber.logger.debug("\n")
     end
 
@@ -21,8 +22,8 @@ module Cucumber
     end
 
     class FileSpec
-      def initialize(s)
-        @file, @lines = *FILE_COLON_LINE_PATTERN.match(s).captures
+      def initialize(spec)
+        @file, @lines = *FILE_COLON_LINE_PATTERN.match(spec).captures
         Cucumber.logger.debug("  * #{@file}\n")
         @lines = String(@lines).split(':').map { |line| Integer(line) }
       end
@@ -30,8 +31,8 @@ module Cucumber
       attr_reader :file
 
       def locations
-        return [ Core::Ast::Location.new(@file) ] if @lines.empty?
-        @lines.map { |line| Core::Ast::Location.new(@file, line) }
+        return [Core::Test::Location.new(@file)] if @lines.empty?
+        @lines.map { |line| Core::Test::Location.new(@file, line) }
       end
     end
   end

data/lib/cucumber/filters.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
+
 require 'cucumber/filters/activate_steps'
 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_started_event'
 require 'cucumber/filters/prepare_world'
 require 'cucumber/filters/quit'
 require 'cucumber/filters/randomizer'
 require 'cucumber/filters/retry'
 require 'cucumber/filters/tag_limits'
+require 'cucumber/filters/broadcast_test_case_ready_event'

data/lib/cucumber/filters/activate_steps.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'cucumber/core/filter'
 require 'cucumber/step_match'
 require 'cucumber/events'
@@ -7,7 +8,6 @@ require 'cucumber/errors'
 module Cucumber
   module Filters
     class ActivateSteps < Core::Filter.new(:step_match_search, :configuration)
-
       def test_case(test_case)
         CaseFilter.new(test_case, step_match_search, configuration).test_case.describe_to receiver
       end
@@ -26,7 +26,7 @@ module Cucumber
         private
 
         def new_test_steps
-          @original_test_case.test_steps.map(&self.method(:attempt_to_activate))
+          @original_test_case.test_steps.map(&method(:attempt_to_activate))
         end
 
         def attempt_to_activate(test_step)
@@ -39,12 +39,18 @@ module Cucumber
 
         class FindMatch
           def initialize(step_match_search, configuration, test_step)
-            @step_match_search, @configuration, @test_step = step_match_search, configuration, test_step
+            @step_match_search = step_match_search
+            @configuration = configuration
+            @test_step = test_step
           end
 
           def result
-            return NoStepMatch.new(test_step.source.last, test_step.name) unless matches.any?
-            configuration.notify :step_match, test_step, match
+            begin
+              return NoStepMatch.new(test_step, test_step.text) unless matches.any?
+            rescue Cucumber::Ambiguous => e
+              return AmbiguousStepMatch.new(e)
+            end
+            configuration.notify :step_activated, test_step, match
             return SkippingStepMatch.new if configuration.dry_run?
             match
           end
@@ -59,7 +65,7 @@ module Cucumber
           end
 
           def matches
-            step_match_search.call(test_step.name)
+            step_match_search.call(test_step.text)
           end
         end
       end