cucumber-core 1.5.0 → 2.0.0

data/lib/cucumber/core/event_bus.rb

@@ -0,0 +1,64 @@
+require 'cucumber/core/events'
+
+module Cucumber
+  module Core
+
+    # Event Bus
+    #
+    # Implements an in-process pub-sub event broadcaster allowing multiple observers
+    # to subscribe to events that fire as your tests are executed.
+    #
+    class EventBus
+      attr_reader :event_types
+
+      # @param [Hash{Symbol => Class}] a hash of event types to use on the bus
+      def initialize(registry = Events.registry)
+        @event_types = registry.freeze
+        @handlers = {}
+      end
+
+      # Register for an event. The handler proc will be called back with each of the attributes
+      # of the event.
+      def on(event_id, handler_object = nil, &handler_proc)
+        handler = handler_proc || handler_object
+        validate_handler_and_event_id!(handler, event_id)
+        event_class = event_types[event_id]
+        handlers_for(event_class) << handler
+      end
+
+      # Broadcast an event
+      def broadcast(event)
+        raise ArgumentError, "Event type #{event.class} is not registered. Try one of these:\n#{event_types.values.join("\n")}" unless is_registered_type?(event.class)
+        handlers_for(event.class).each { |handler| handler.call(event) }
+      end
+
+      def method_missing(event_id, *args)
+        event_class = event_types.fetch(event_id) { super }
+        broadcast event_class.new(*args)
+      rescue NameError => error
+        raise error, error.message + "\nDid you get the ID of the event wrong? Try one of these:\n#{event_types.keys.join("\n")}", error.backtrace
+      end
+
+      private
+
+      def handlers_for(event_class)
+        @handlers[event_class.to_s] ||= []
+      end
+
+      def is_registered_id?(event_id)
+        event_types.keys.include?(event_id)
+      end
+
+      def is_registered_type?(event_type)
+        event_types.values.include?(event_type)
+      end
+
+      def validate_handler_and_event_id!(handler, event_id)
+        raise ArgumentError, "Please pass either an object or a handler block" unless handler
+        raise ArgumentError, "Please use a symbol for the event_id" unless event_id.is_a?(Symbol)
+        raise ArgumentError, "Event ID #{event_id} is not recognised. Try one of these:\n#{event_types.keys.join("\n")}" unless is_registered_id?(event_id)
+      end
+    end
+
+  end
+end

data/lib/cucumber/core/events.rb

@@ -0,0 +1,69 @@
+require 'cucumber/core/event'
+
+module Cucumber
+  module Core
+    module Events
+
+      # Signals that a {Test::Case} is about to be executed
+      class TestCaseStarting < Event.new(:test_case)
+
+        # @return [Test::Case] the test case to be executed
+        attr_reader :test_case
+
+      end
+
+      # Signals that a {Test::Step} is about to be executed
+      class TestStepStarting < Event.new(:test_step)
+
+        # @return [Test::Step] the test step to be executed
+        attr_reader :test_step
+
+      end
+
+      # Signals that a {Test::Step} has finished executing
+      class TestStepFinished < Event.new(:test_step, :result)
+
+        # @return [Test::Step] the test step that was executed
+        attr_reader :test_step
+
+        # @return [Test::Result] the result of running the {Test::Step}
+        attr_reader :result
+
+      end
+
+
+      # Signals that a {Test::Case} has finished executing
+      class TestCaseFinished < Event.new(:test_case, :result)
+
+        # @return [Test::Case] that was executed
+        attr_reader :test_case
+
+        # @return [Test::Result] the result of running the {Test::Step}
+        attr_reader :result
+
+      end
+
+      # The registry contains all the events registered in the core, 
+      # that will be used by the {EventBus} by default.
+      def self.registry
+        build_registry(
+          TestCaseStarting,
+          TestStepStarting,
+          TestStepFinished,
+          TestCaseFinished,
+        )
+      end
+
+      # Build an event registry to be passed to the {EventBus}
+      # constructor from a list of types.
+      #
+      # Each type must respond to `event_id` so that it can be added
+      # to the registry hash.
+      #
+      # @return [Hash{Symbol => Class}]
+      def self.build_registry(*types)
+        types.map { |type| [type.event_id, type] }.to_h
+      end
+    end
+  end
+end

data/lib/cucumber/core/filter.rb

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

data/lib/cucumber/core/gherkin/ast_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/ast'
 require 'cucumber/core/platform'
 
@@ -271,7 +272,7 @@ module Cucumber
           def initialize(*)
             super
             @step_builders = attributes[:steps].map { |step| OutlineStepBuilder.new(file, step) }
-            @example_builders = attributes[:examples].map { |example| ExamplesTableBuilder.new(file, example) }
+            @example_builders = attributes[:examples] ? attributes[:examples].map { |example| ExamplesTableBuilder.new(file, example) } : []
           end
 
           def result(language)
@@ -305,10 +306,8 @@ module Cucumber
 
           def initialize(*)
             super
-            @header_builder = HeaderBuilder.new(file, attributes[:table_header])
-            @example_rows_builders = attributes[:table_body].map do |row_attributes|
-              ExampleRowBuilder.new(file, row_attributes)
-            end
+            @header_builder = attributes[:table_header] ? HeaderBuilder.new(file, attributes[:table_header]) : NullHeaderBuilder.new
+            @example_rows_builders = attributes[:table_body] ? attributes[:table_body].map { |row_attributes| ExampleRowBuilder.new(file, row_attributes) } : []
           end
 
           def result(language)
@@ -341,6 +340,16 @@ module Cucumber
             end
           end
 
+          class NullHeaderBuilder < Builder
+            def initialize
+              @line = -1 # this inhibits Builder#handle_comments to put any comments in this object. 
+            end
+
+            def result
+              nil
+            end
+          end
+
           def children
             [header_builder] + example_rows_builders
           end

data/lib/cucumber/core/gherkin/document.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
 
 module Cucumber
   module Core
     module Gherkin
       class Document
-        attr_reader :uri, :body
+        attr_reader :uri, :body, :language
 
-        def initialize(uri, body)
-          @uri = uri
-          @body = body
+        def initialize(uri, body, language=nil)
+          @uri      = uri
+          @body     = body
+          @language = language || 'en'
         end
 
         def to_s

data/lib/cucumber/core/gherkin/parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gherkin/parser'
 require 'gherkin/token_scanner'
 require 'gherkin/errors'
@@ -18,12 +19,13 @@ module Cucumber
         end
 
         def document(document)
-          parser  = ::Gherkin::Parser.new
-          scanner = ::Gherkin::TokenScanner.new(document.body)
-          core_builder = AstBuilder.new(document.uri)
+          parser        = ::Gherkin::Parser.new
+          scanner       = ::Gherkin::TokenScanner.new(document.body)
+          token_matcher = ::Gherkin::TokenMatcher.new(document.language)
+          core_builder  = AstBuilder.new(document.uri)
 
           begin
-            result = parser.parse(scanner)
+            result = parser.parse(scanner, token_matcher)
 
             receiver.feature core_builder.feature(result)
           rescue *PARSER_ERRORS => e

data/lib/cucumber/core/gherkin/tag_expression.rb

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

data/lib/cucumber/core/gherkin/writer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/gherkin/writer/helpers'
 require 'cucumber/core/gherkin/document'
 

data/lib/cucumber/core/gherkin/writer/helpers.rb

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

data/lib/cucumber/core/platform.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Detect the platform we're running on so we can tweak behaviour
 # in various places.
 require 'rbconfig'

data/lib/cucumber/core/report/summary.rb

@@ -1,25 +1,49 @@
+# frozen_string_literal: true
 module Cucumber
   module Core
     module Report
       class Summary
         attr_reader :test_cases, :test_steps
 
-        def initialize
+        def initialize(event_bus)
           @test_cases = Test::Result::Summary.new
           @test_steps = Test::Result::Summary.new
+          subscribe_to(event_bus)
         end
 
-        def after_test_case(test_case, result)
-          result.describe_to test_cases
+        private
+
+        def subscribe_to(event_bus)
+          event_bus.on(:test_case_finished) do |event|
+            event.result.describe_to test_cases
+          end
+          event_bus.on(:test_step_finished) do |event|
+            event.result.describe_to test_steps if is_step?(event.test_step)
+          end
+          self
         end
 
-        def after_test_step(test_step, result)
-          result.describe_to test_steps
+        def is_step?(test_step)
+          StepQueryVisitor.new(test_step).is_step?
         end
+      end
 
-        def method_missing(*)
+      class StepQueryVisitor
+        def initialize(test_step)
+          @step = false
+          test_step.source.last.describe_to(self)
+        end
+
+        def is_step?
+          @step
         end
 
+        def step(*)
+          @step = true
+        end
+        
+        def method_missing(*)
+        end
       end
     end
   end

data/lib/cucumber/core/test/action.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/test/result'
 require 'cucumber/core/test/timer'
 require 'cucumber/core/test/result'

data/lib/cucumber/core/test/around_hook.rb

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

data/lib/cucumber/core/test/case.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/test/result'
 require 'cucumber/core/gherkin/tag_expression'
 require 'cucumber/core/ast/location'
@@ -99,6 +100,18 @@ module Cucumber
           source.first
         end
 
+        def hash
+          location.hash
+        end
+
+        def eql?(other)
+          other.hash == hash
+        end
+
+        def ==(other)
+          eql?(other)
+        end
+
         private
 
         def compose_around_hooks(visitor, *args, &block)

data/lib/cucumber/core/test/filters.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/test/filters/locations_filter'
 require 'cucumber/core/test/filters/name_filter'
 require 'cucumber/core/test/filters/tag_filter'

data/lib/cucumber/core/test/filters/locations_filter.rb

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

data/lib/cucumber/core/test/filters/name_filter.rb

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

data/lib/cucumber/core/test/filters/tag_filter.rb

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

data/lib/cucumber/core/test/result.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
 module Cucumber
   module Core
@@ -30,6 +31,10 @@ module Cucumber
           def describe_to(visitor, *args)
             self
           end
+
+          def with_filtered_backtrace(filter)
+            self
+          end
         end
 
         class Passed

data/lib/cucumber/core/test/runner.rb

@@ -1,43 +1,43 @@
+# frozen_string_literal: true
 require 'cucumber/core/test/timer'
 
 module Cucumber
   module Core
     module Test
       class Runner
-        attr_reader :report, :running_test_case, :running_test_step
-        private :report, :running_test_case, :running_test_step
+        attr_reader :event_bus, :running_test_case, :running_test_step
+        private :event_bus, :running_test_case, :running_test_step
 
-        def initialize(report)
-          @report = report
+        def initialize(event_bus)
+          @event_bus = event_bus
         end
 
         def test_case(test_case, &descend)
           @running_test_case = RunningTestCase.new
           @running_test_step = nil
-          report.before_test_case(test_case)
+          event_bus.test_case_starting(test_case)
           descend.call(self)
-          report.after_test_case(test_case, running_test_case.result)
+          event_bus.test_case_finished(test_case, running_test_case.result)
           self
         end
 
         def test_step(test_step)
           @running_test_step = test_step
-          report.before_test_step test_step
+          event_bus.test_step_starting test_step
           step_result = running_test_case.execute(test_step)
-          report.after_test_step test_step, step_result
+          event_bus.test_step_finished test_step, step_result
           @running_test_step = nil
           self
         end
 
         def around_hook(hook, &continue)
           result = running_test_case.execute(hook, &continue)
-          report.after_test_step running_test_step, result if running_test_step
+          event_bus.test_step_finished running_test_step, result if running_test_step
           @running_test_step = nil
           self
         end
 
         def done
-          report.done
           self
         end
 

data/lib/cucumber/core/test/step.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cucumber/core/test/result'
 require 'cucumber/core/test/action'
 

data/lib/cucumber/core/test/timer.rb

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