cucumber-core 12.0.0 → 13.0.0

data/lib/cucumber/core/events.rb

@@ -1,10 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 require 'cucumber/core/event'
 
 module Cucumber
   module Core
     module Events
-
       class Envelope < Event.new(:envelope)
         attr_reader :envelope
       end
@@ -13,7 +14,6 @@ module Cucumber
       class GherkinSourceParsed < Event.new(:gherkin_document)
         # @return [GherkinDocument] the GherkinDocument Ast Node
         attr_reader :gherkin_document
-
       end
 
       # Signals that a Test::Step was created from a PickleStep
@@ -36,40 +36,32 @@ module Cucumber
 
       # Signals that a {Test::Case} is about to be executed
       class TestCaseStarted < 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 TestStepStarted < 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,
@@ -83,7 +75,7 @@ module Cucumber
           TestCaseStarted,
           TestStepStarted,
           TestStepFinished,
-          TestCaseFinished,
+          TestCaseFinished
         )
       end
 

data/lib/cucumber/core/filter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Cucumber
   module Core
-
     # Filters process test cases.
     #
     # Each filter must respond to the following protocol:
@@ -22,7 +22,6 @@ module Cucumber
     # Finally, the `done` message is sent. A filter should pass this message directly to its receiver.
     #
     module Filter
-
       # Utility method for quick construction of filter classes.
       #
       # @example Example usage:
@@ -70,7 +69,6 @@ module Cucumber
             args[-1] = new_receiver
             self.class.new(*args)
           end
-
         end
 
         if block

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'gherkin'
 
 module Cucumber
@@ -17,19 +18,8 @@ module Cucumber
         end
 
         def document(document)
-          messages = ::Gherkin.from_source(document.uri, document.body, gherkin_options(document))
-          messages.each do |message|
-            event_bus.envelope(message)
-            gherkin_query.update(message)
-            if !message.gherkin_document.nil?
-              event_bus.gherkin_source_parsed(message.gherkin_document)
-            elsif !message.pickle.nil?
-              receiver.pickle(message.pickle)
-            elsif message.parse_error
-              raise Core::Gherkin::ParseError.new("#{document.uri}: #{message.parse_error.message}")
-            else
-              raise "Unknown message: #{message.to_hash}"
-            end
+          source_messages(document).each do |message|
+            process(message, document)
           end
         end
 
@@ -46,6 +36,44 @@ module Cucumber
           receiver.done
           self
         end
+
+        private
+
+        def source_messages(document)
+          ::Gherkin.from_source(document.uri, document.body, gherkin_options(document))
+        end
+
+        def process(message, document)
+          generate_envelope(message)
+          update_gherkin_query(message)
+
+          case type?(message)
+          when :gherkin_document; then event_bus.gherkin_source_parsed(message.gherkin_document)
+          when :pickle;           then receiver.pickle(message.pickle)
+          when :parse_error;      then raise ParseError.new("#{document.uri}: #{message.parse_error.message}")
+          else                    raise "Unknown message: #{message.to_hash}"
+          end
+        end
+
+        def generate_envelope(message)
+          event_bus.envelope(message)
+        end
+
+        def update_gherkin_query(message)
+          gherkin_query.update(message)
+        end
+
+        def type?(message)
+          if !message.gherkin_document.nil?
+            :gherkin_document
+          elsif !message.pickle.nil?
+            :pickle
+          elsif message.parse_error
+            :parse_error
+          else
+            :unknown
+          end
+        end
       end
     end
   end

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+
 module Cucumber
   module Core
     module Gherkin
       module Writer
-
         module HasOptionsInitializer
           def self.included(base)
             base.extend HasDefaultKeyword
@@ -79,6 +79,7 @@ module Cucumber
           end
 
           private
+
           def elements
             @elements ||= []
           end
@@ -89,9 +90,10 @@ module Cucumber
             end
 
             private
+
             def element(name)
               define_method name do |*args, &source|
-                factory_name = String(name).split("_").map(&:capitalize).join
+                factory_name = String(name).split('_').map(&:capitalize).join
                 factory = Writer.const_get(factory_name)
                 factory.new(slurp_comments, *args).tap do |builder|
                   builder.instance_exec(&source) if source
@@ -106,7 +108,7 @@ module Cucumber
         module Indentation
           def self.level(number)
             Module.new do
-              define_method :indent do |string, amount=nil|
+              define_method :indent do |string, amount = nil|
                 amount ||= number
                 return string if string.nil? || string.empty?
                 (' ' * amount) + string
@@ -125,6 +127,7 @@ module Cucumber
 
         module HasDescription
           private
+
           def description
             options.fetch(:description, '').split("\n").map(&:strip)
           end
@@ -168,7 +171,6 @@ module Cucumber
           end
         end
       end
-
     end
   end
 end

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 require 'cucumber/core/gherkin/writer/helpers'
 require 'cucumber/core/gherkin/document'
 
 module Cucumber
   module Core
     module Gherkin
-
       module Writer
         NEW_LINE = ''
         def gherkin(uri = nil, &source)
@@ -55,6 +55,7 @@ module Cucumber
           end
 
           private
+
           def language
             options[:language]
           end
@@ -86,6 +87,7 @@ module Cucumber
           elements :step
 
           private
+
           def statements
             prepare_statements(
               comments_statement,
@@ -107,6 +109,7 @@ module Cucumber
           elements :example, :scenario
 
           private
+
           def statements
             prepare_statements(
               comments_statement,
@@ -128,6 +131,7 @@ module Cucumber
           elements :step
 
           private
+
           def statements
             prepare_statements(
               comments_statement,
@@ -155,6 +159,7 @@ module Cucumber
           elements :step, :examples
 
           private
+
           def statements
             prepare_statements comments_statement, tag_statement, name_statement, description_statement
           end
@@ -174,6 +179,7 @@ module Cucumber
           end
 
           private
+
           def statements
             prepare_statements comments_statement, name_statement
           end
@@ -195,6 +201,7 @@ module Cucumber
           end
 
           private
+
           def statements
             row_statements
           end
@@ -216,13 +223,14 @@ module Cucumber
           end
 
           private
+
           def statements
             prepare_statements doc_string_statement
           end
 
           def doc_string_statement
             [
-              %["""#{content_type}],
+              %("""#{content_type}),
               strings,
               '"""'
             ]
@@ -242,6 +250,7 @@ module Cucumber
           end
 
           private
+
           def statements
             prepare_statements(
               NEW_LINE,

data/lib/cucumber/core/platform.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Detect the platform we're running on so we can tweak behaviour
 # in various places.
 require 'rbconfig'
@@ -6,7 +7,7 @@ require 'rbconfig'
 module Cucumber
   unless defined?(Cucumber::VERSION)
     JRUBY         = defined?(JRUBY_VERSION)
-    IRONRUBY      = defined?(RUBY_ENGINE) && RUBY_ENGINE == "ironruby"
+    IRONRUBY      = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ironruby'
     WINDOWS       = RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
     OS_X          = RbConfig::CONFIG['host_os'] =~ /darwin/
     WINDOWS_MRI   = WINDOWS && !JRUBY && !IRONRUBY

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Cucumber
   module Core
     module Report
@@ -12,26 +13,34 @@ module Cucumber
           subscribe_to(event_bus)
         end
 
-        def ok?(be_strict = Test::Result::StrictConfiguration.new)
-          test_cases.ok?(be_strict)
+        def ok?(strict: Test::Result::StrictConfiguration.new)
+          test_cases.ok?(strict: strict)
         end
 
         private
 
         def subscribe_to(event_bus)
+          register_test_case_finished_listener(event_bus)
+          register_test_step_finished_listener(event_bus)
+          self
+        end
+
+        def register_test_case_finished_listener(event_bus)
           event_bus.on(:test_case_finished) do |event|
             if event.test_case != @previous_test_case
               @previous_test_case = event.test_case
-              event.result.describe_to test_cases
+              event.result.describe_to(test_cases)
             elsif event.result.passed? || event.result.skipped?
               test_cases.flaky
               test_cases.decrement_failed
             end
           end
+        end
+
+        def register_test_step_finished_listener(event_bus)
           event_bus.on(:test_step_finished) do |event|
-            event.result.describe_to test_steps unless event.test_step.hook?
+            event.result.describe_to(test_steps) unless event.test_step.hook?
           end
-          self
         end
       end
     end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'cucumber/core/test/location'
 require 'cucumber/core/test/result'
 require 'cucumber/core/test/timer'
@@ -8,8 +9,8 @@ module Cucumber
     module Test
       class Action
         def initialize(location = nil, &block)
-          raise ArgumentError, "Passing a block to execute the action is mandatory." unless block
-          @location = location ? location : Test::Location.new(*block.source_location)
+          raise ArgumentError, 'Passing a block to execute the action is mandatory.' unless block
+          @location = location || Test::Location.new(*block.source_location)
           @block = block
           @timer = Timer.new
         end
@@ -78,7 +79,6 @@ module Cucumber
           Result::Undefined.new
         end
       end
-
     end
   end
 end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Cucumber
   module Core
     module Test
@@ -16,7 +17,7 @@ module Cucumber
           true
         end
 
-        def execute(*args, &continue)
+        def execute(*_args, &continue)
           @timer.start
           @block.call(continue)
           Result::Unknown.new # Around hook does not know the result of the inner test steps
@@ -27,6 +28,7 @@ module Cucumber
         end
 
         private
+
         def failed(exception)
           Result::Failed.new(@timer.duration, exception)
         end

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

@@ -7,14 +7,15 @@ module Cucumber
   module Core
     module Test
       class Case
-        attr_reader :id, :name, :test_steps, :location, :tags, :language, :around_hooks
+        attr_reader :id, :name, :test_steps, :location, :parent_locations, :tags, :language, :around_hooks
 
-        def initialize(id, name, test_steps, location, tags, language, around_hooks = [])
+        def initialize(id, name, test_steps, location, parent_locations, tags, language, around_hooks = [])
           raise ArgumentError.new("test_steps should be an Array but is a #{test_steps.class}") unless test_steps.is_a?(Array)
           @id = id
           @name = name
           @test_steps = test_steps
           @location = location
+          @parent_locations = parent_locations
           @tags = tags
           @language = language
           @around_hooks = around_hooks
@@ -36,11 +37,11 @@ module Cucumber
         end
 
         def with_steps(test_steps)
-          self.class.new(id, name, test_steps, location, tags, language, around_hooks)
+          self.class.new(id, name, test_steps, location, parent_locations, tags, language, around_hooks)
         end
 
         def with_around_hooks(around_hooks)
-          self.class.new(id, name, test_steps, location, tags, language, around_hooks)
+          self.class.new(id, name, test_steps, location, parent_locations, tags, language, around_hooks)
         end
 
         def match_tags?(*expressions)
@@ -61,6 +62,7 @@ module Cucumber
 
         def matching_locations
           [
+            parent_locations,
             location,
             tags.map(&:location),
             test_steps.map(&:matching_locations)

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

@@ -95,11 +95,9 @@ module Cucumber
         private
 
         def verify_rows_are_same_length(raw)
-          begin
-            raw.transpose
-          rescue IndexError
-            raise ArgumentError, "Rows must all be the same length"
-          end
+          raw.transpose
+        rescue IndexError
+          raise ArgumentError, 'Rows must all be the same length'
         end
 
         def ensure_array_of_array(array)
@@ -108,9 +106,8 @@ module Cucumber
 
         def hashes_to_array(hashes)
           header = hashes[0].keys.sort
-          [header] + hashes.map {|hash| header.map {|key| hash[key]}}
+          [header] + hashes.map { |hash| header.map { |key| hash[key] } }
         end
-
       end
     end
   end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'delegate'
 module Cucumber
   module Core
@@ -41,7 +42,7 @@ module Cucumber
         end
 
         def map
-          raise ArgumentError, "No block given" unless block_given?
+          raise ArgumentError, 'No block given' unless block_given?
           new_content = yield content
           self.class.new(new_content, content_type)
         end
@@ -66,10 +67,10 @@ module Cucumber
 
         def inspect
           [
-            %{#<#{self.class}},
-            %{  """#{content_type}},
-            %{  #{@content}},
-            %{  """>}
+            %(#<#{self.class}),
+            %(  """#{content_type}),
+            %(  #{@content}),
+            %(  """>)
           ].join("\n")
         end
       end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Cucumber
   module Core
     module Test
@@ -15,7 +16,7 @@ module Cucumber
           false
         end
 
-        def map(&block)
+        def map
           self
         end
 

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

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Core
     module Test
       module Filters
-
         # This filter is used for testing Cucumber itself. It adds step definitions
         # that will activate steps to have passed / failed / pending results
         # if they use conventional names.
@@ -19,7 +20,7 @@ module Cucumber
               when /pending/
                 step.with_action { raise Test::Result::Pending }
               when /pass/
-                step.with_action {}
+                step.with_action { :no_op }
               else
                 step
               end
@@ -28,7 +29,6 @@ module Cucumber
             test_case.with_steps(test_steps).describe_to(receiver)
           end
         end
-
       end
     end
   end

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

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
+
 require 'cucumber/core/filter'
 
 module Cucumber
   module Core
     module Test
-
       # Sorts and filters scenarios based on a list of locations
       class LocationsFilter < Filter.new(:filter_locations)
-
         def test_case(test_case)
           test_cases[test_case.location.file] << test_case
           self

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 require 'cucumber/core/filter'
 
 module Cucumber
   module Core
     module Test
       class NameFilter < Filter.new(:name_regexps)
-
         def test_case(test_case)
           if accept?(test_case)
             test_case.describe_to(receiver)

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 require 'cucumber/core/filter'
 
 module Cucumber
   module Core
     module Test
       class TagFilter < Filter.new(:filter_expressions)
-
         def test_case(test_case)
           test_cases << test_case
           if test_case.match_tags?(filter_expressions)

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

@@ -1,4 +1,5 @@
 # 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/location.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'forwardable'
 require 'cucumber/core/platform'
 module Cucumber
@@ -7,7 +8,6 @@ module Cucumber
       IncompatibleLocations = Class.new(StandardError)
 
       module Location
-
         def self.of_caller(additional_depth = 0)
           from_file_colon_line(*caller[1 + additional_depth])
         end
@@ -30,7 +30,7 @@ module Cucumber
         end
 
         def self.new(file, raw_lines=nil)
-          file || raise(ArgumentError, "file is mandatory")
+          file || raise(ArgumentError, 'file is mandatory')
           if raw_lines
             Precise.new(file, Lines.new(raw_lines))
           else
@@ -47,7 +47,7 @@ module Cucumber
             other.file == file
           end
 
-          def include?(lines)
+          def include?(_lines)
             true
           end
         end
@@ -68,7 +68,7 @@ module Cucumber
           end
 
           def to_s
-            [file, lines.to_s].join(":")
+            [file, lines.to_s].join(':')
           end
 
           def hash
@@ -91,7 +91,7 @@ module Cucumber
           end
 
           def inspect
-            "<#{self.class}: #{to_s}>"
+            "<#{self.class}: #{self}>"
           end
         end
 
@@ -128,7 +128,7 @@ module Cucumber
             return first.to_s if data.length == 1
             return "#{data.min}..#{data.max}" if range?
 
-            data.to_a.join(":")
+            data.to_a.join(':')
           end
 
           def inspect
@@ -180,7 +180,6 @@ module Cucumber
           # will be overriden by nodes that actually have a multiline_argument
           Test::EmptyMultilineArgument.new
         end
-
       end
     end
   end