cucumber-core 5.0.2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ab18c1635eeda0fbd575d01a83bafc96a0073a1ec0ba1249e4bf26b9c60f914
-  data.tar.gz: 1dccc021f15d75d76c2c3974049f768ee926e0dd7ced151cc9b46a2b422b6906
+  metadata.gz: 1b9ecd1991c28bb04a27496f473972f9da886f102c94ac5a6176d4167773afb3
+  data.tar.gz: f833220cdb22fd26e68b3457c0c8ced6cc574227c8dc6dd30a540680a09ea8d2
 SHA512:
-  metadata.gz: 81461cf45c9616e3e36fc70a25da1b3c0e30e709cc12e675994e6fd0f730ff4e68f9680453e31ecb4814d69a9a79a98ceeb0691a7365fc660fe9e4cad7462092
-  data.tar.gz: 3a8cc3c74351d91f90c36f509a813b56cab9a333057de9b3b596de4b1feaa8dc912d87827d2682f1fc3f2b2eca2f82c75f38bd2f75204119eb21bcbcf0b8507a
+  metadata.gz: d720066139dee301d46a5bb64e2c9e630d599d4750ca5026a40e70cb5c547b14301aee31bdbe12627f043d9df0b427c87444adfa24b2d01c463e484feba2e724
+  data.tar.gz: 9d7e4f57de2b4c84c2e8a94bf68bc22aea34d058c8ef6bead5e975866a0bcaed53d5d987c0884d6db42e496eddf46273a946aba13565f78ba34b2eb9d22df265

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CONTRIBUTING.md) on how to contribute to Cucumber.
 
+## [6.0.0](https://github.com/cucumber/cucumber-ruby-core/compare/v5.0.2...v6.0.0)
+
+### Changed
+
+* Update to Gherkin 10
+
+### Added
+
+* Add `envelope` event, which are used when emitting `Cucumber::Messages`
+* Add `TestCaseCreated` and `TestStepCreated` events, emitted when compiling a `Pickle`
+* Add `Id` field to `TestCase` and `TestStep`
+* Added rubocop (with todo file), and removed backports gems
+  ([#186](https://github.com/cucumber/cucumber-ruby-core/pull/186),
+  [#182](https://github.com/cucumber/cucumber-ruby-core/issues/182)
+  [tas50](https://github.com/tas50),
+  [luke-hill](https://github.com/luke-hill))
+
+### Removed
+
+* Remove location for MultiLine arguments
+
+
 ## [5.0.2](https://github.com/cucumber/cucumber-ruby-core/compare/v5.0.1...v5.0.2)
 
 ### Changed

data/lib/cucumber/core.rb

@@ -4,6 +4,8 @@ require 'cucumber/core/gherkin/parser'
 require 'cucumber/core/gherkin/document'
 require 'cucumber/core/compiler'
 require 'cucumber/core/test/runner'
+require 'cucumber/messages'
+require 'gherkin/query'
 
 module Cucumber
   module Core
@@ -11,21 +13,22 @@ module Cucumber
     def execute(gherkin_documents, filters = [], event_bus = EventBus.new)
       yield event_bus if block_given?
       receiver = Test::Runner.new(event_bus)
-      compile gherkin_documents, receiver, filters
+      compile gherkin_documents, receiver, filters, event_bus
       self
     end
 
     def compile(gherkin_documents, last_receiver, filters = [], event_bus = EventBus.new)
       first_receiver = compose(filters, last_receiver)
-      compiler = Compiler.new(first_receiver)
-      parse gherkin_documents, compiler, event_bus
+      gherkin_query = ::Gherkin::Query.new
+      compiler = Compiler.new(first_receiver, gherkin_query, event_bus)
+      parse gherkin_documents, compiler, event_bus, gherkin_query
       self
     end
 
     private
 
-    def parse(gherkin_documents, compiler, event_bus)
-      parser = Core::Gherkin::Parser.new(compiler, event_bus)
+    def parse(gherkin_documents, compiler, event_bus, gherkin_query)
+      parser = Core::Gherkin::Parser.new(compiler, event_bus, gherkin_query)
       gherkin_documents.each do |document|
         parser.document document
       end
@@ -38,6 +41,5 @@ module Cucumber
         filter.with_receiver(receiver)
       end
     end
-
   end
 end

data/lib/cucumber/core/compiler.rb

@@ -6,16 +6,20 @@ require 'cucumber/core/test/tag'
 require 'cucumber/core/test/doc_string'
 require 'cucumber/core/test/data_table'
 require 'cucumber/core/test/empty_multiline_argument'
+require 'cucumber/messages'
 
 module Cucumber
   module Core
     # Compiles the Pickles into test cases
     class Compiler
-      attr_reader :receiver
-      private     :receiver
+      attr_reader :receiver, :gherkin_query, :id_generator
+      private     :receiver, :gherkin_query, :id_generator
 
-      def initialize(receiver)
+      def initialize(receiver, gherkin_query, event_bus = nil)
         @receiver = receiver
+        @id_generator = Cucumber::Messages::IdGenerator::UUID.new
+        @gherkin_query = gherkin_query
+        @event_bus = event_bus
       end
 
       def pickle(pickle)
@@ -33,15 +37,19 @@ module Cucumber
       def create_test_case(pickle)
         uri = pickle.uri
         test_steps = pickle.steps.map { |step| create_test_step(step, uri) }
-        lines = pickle.locations.map { |location| location.line }.sort.reverse
-        tags = pickle.tags.map { |tag| Test::Tag.new(Test::Location.new(uri, tag.location.line), tag.name) }
-        Test::Case.new(pickle.name, test_steps, Test::Location.new(uri, lines), tags, pickle.language)
+        lines = source_lines_for_pickle(pickle).sort.reverse
+        tags = pickle.tags.map { |tag| Test::Tag.new(Test::Location.new(uri, source_line_for_pickle_tag(tag)), tag.name) }
+        test_case = Test::Case.new(id_generator.new_id, pickle.name, test_steps, Test::Location.new(uri, lines), tags, pickle.language)
+        @event_bus.test_case_created(test_case, pickle) unless @event_bus.nil?
+        test_case
       end
 
       def create_test_step(pickle_step, uri)
-        lines = pickle_step.locations.map { |location| location.line }.sort.reverse
+        lines = source_lines_for_pickle_step(pickle_step).sort.reverse
         multiline_arg = create_multiline_arg(pickle_step, uri)
-        Test::Step.new(pickle_step.text, Test::Location.new(uri, lines), multiline_arg)
+        step = Test::Step.new(id_generator.new_id, pickle_step.text, Test::Location.new(uri, lines), multiline_arg)
+        @event_bus.test_step_created(step, pickle_step) unless @event_bus.nil?
+        step
       end
 
       def create_multiline_arg(pickle_step, uri)
@@ -50,21 +58,34 @@ module Cucumber
             doc_string = pickle_step.argument.doc_string
             Test::DocString.new(
               doc_string.content,
-              doc_string.contentType,
-              Test::Location.new(uri, doc_string.location.line)
+              doc_string.media_type
             )
           elsif pickle_step.argument.data_table
             data_table = pickle_step.argument.data_table
-            first_cell = data_table.rows.first.cells.first
             Test::DataTable.new(
-              data_table.rows.map { |row| row.cells.map { |cell| cell.value } },
-              Test::Location.new(uri, first_cell.location.line)
+              data_table.rows.map { |row| row.cells.map { |cell| cell.value } }
             )
           end
         else
           Test::EmptyMultilineArgument.new
         end
       end
+
+      def source_lines_for_pickle(pickle)
+        pickle.ast_node_ids.map { |id| source_line(id) }
+      end
+
+      def source_lines_for_pickle_step(pickle_step)
+        pickle_step.ast_node_ids.map { |id| source_line(id) }
+      end
+
+      def source_line_for_pickle_tag(tag)
+        source_line(tag.ast_node_id)
+      end
+
+      def source_line(id)
+        gherkin_query.location(id).line
+      end
     end
   end
 end

data/lib/cucumber/core/event.rb

@@ -1,5 +1,3 @@
-require 'backports/2.1.0/array/to_h'
-
 module Cucumber
   module Core
     class Event

data/lib/cucumber/core/events.rb

@@ -5,6 +5,10 @@ module Cucumber
   module Core
     module Events
 
+      class Envelope < Event.new(:envelope)
+        attr_reader :envelope
+      end
+
       # Signals that a gherkin source has been parsed
       class GherkinSourceParsed < Event.new(:gherkin_document)
         # @return [GherkinDocument] the GherkinDocument Ast Node
@@ -12,6 +16,24 @@ module Cucumber
 
       end
 
+      # Signals that a Test::Step was created from a PickleStep
+      class TestStepCreated < Event.new(:test_step, :pickle_step)
+        # The created test step
+        attr_reader :test_step
+
+        # The source pickle step
+        attr_reader :pickle_step
+      end
+
+      # Signals that a Test::Case was created from a Pickle
+      class TestCaseCreated < Event.new(:test_case, :pickle)
+        # The created test step
+        attr_reader :test_case
+
+        # The source pickle step
+        attr_reader :pickle
+      end
+
       # Signals that a {Test::Case} is about to be executed
       class TestCaseStarted < Event.new(:test_case)
 
@@ -55,7 +77,10 @@ module Cucumber
       # that will be used by the {EventBus} by default.
       def self.registry
         build_registry(
+          Envelope,
           GherkinSourceParsed,
+          TestStepCreated,
+          TestCaseCreated,
           TestCaseStarted,
           TestStepStarted,
           TestStepFinished,

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

@@ -7,24 +7,27 @@ module Cucumber
       ParseError = Class.new(StandardError)
 
       class Parser
-        attr_reader :receiver, :event_bus
-        private     :receiver, :event_bus
+        attr_reader :receiver, :event_bus, :gherkin_query
+        private     :receiver, :event_bus, :gherkin_query
 
-        def initialize(receiver, event_bus)
+        def initialize(receiver, event_bus, gherkin_query)
           @receiver = receiver
           @event_bus = event_bus
+          @gherkin_query = gherkin_query
         end
 
         def document(document)
           messages = ::Gherkin.from_source(document.uri, document.body, gherkin_options(document))
           messages.each do |message|
-            if !message.gherkinDocument.nil?
-              event_bus.gherkin_source_parsed(message.gherkinDocument)
+            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.attachment.nil?
               # Parse error
-              raise Core::Gherkin::ParseError.new("#{document.uri}: #{message.attachment.data}")
+              raise Core::Gherkin::ParseError.new("#{document.uri}: #{message.attachment.text}")
             else
               raise "Unknown message: #{message.to_hash}"
             end

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

@@ -7,10 +7,11 @@ module Cucumber
   module Core
     module Test
       class Case
-        attr_reader :name, :test_steps, :location, :tags, :language, :around_hooks
+        attr_reader :id, :name, :test_steps, :location, :tags, :language, :around_hooks
 
-        def initialize(name, test_steps, location, tags, language, around_hooks = [])
+        def initialize(id, name, test_steps, location, 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
@@ -35,11 +36,11 @@ module Cucumber
         end
 
         def with_steps(test_steps)
-          self.class.new(name, test_steps, location, tags, language, around_hooks)
+          self.class.new(id, name, test_steps, location, tags, language, around_hooks)
         end
 
         def with_around_hooks(around_hooks)
-          self.class.new(name, test_steps, location, tags, language, around_hooks)
+          self.class.new(id, name, test_steps, location, tags, language, around_hooks)
         end
 
         def match_tags?(*expressions)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'cucumber/core/test/location'
 
 module Cucumber
   module Core
@@ -24,18 +23,15 @@ module Cucumber
       # This will store <tt>[['a', 'b'], ['c', 'd']]</tt> in the <tt>data</tt> variable.
       #
       class DataTable
-        include HasLocation
-
         # Creates a new instance. +raw+ should be an Array of Array of String
         # or an Array of Hash
         # You don't typically create your own DataTable objects - Cucumber will do
         # it internally and pass them to your Step Definitions.
         #
-        def initialize(rows, location)
+        def initialize(rows)
           raw = ensure_array_of_array(rows)
           verify_rows_are_same_length(raw)
           @raw = raw.freeze
-          @location = location
         end
         attr_reader :raw
 
@@ -58,7 +54,7 @@ module Cucumber
         # Creates a copy of this table
         #
         def dup
-          self.class.new(raw.dup, location)
+          self.class.new(raw.dup)
         end
 
         # Returns a new, transposed table. Example:
@@ -73,7 +69,7 @@ module Cucumber
         #   | 4 | 2 |
         #
         def transpose
-          self.class.new(raw.transpose, location)
+          self.class.new(raw.transpose)
         end
 
         def map(&block)
@@ -81,7 +77,7 @@ module Cucumber
             row.map(&block)
           end
 
-          self.class.new(new_raw, location)
+          self.class.new(new_raw)
         end
 
         def ==(other)
@@ -89,7 +85,7 @@ module Cucumber
         end
 
         def inspect
-          %{#<#{self.class} #{raw.inspect} (#{location})>}
+          %{#<#{self.class} #{raw.inspect})>}
         end
 
         private

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

@@ -20,14 +20,11 @@ module Cucumber
       # Note how the indentation from the source is stripped away.
       #
       class DocString < SimpleDelegator
-        include HasLocation
-
         attr_reader :content_type, :content
 
-        def initialize(content, content_type, location)
+        def initialize(content, content_type)
           @content = content
           @content_type = content_type
-          @location = location
           super @content
         end
 
@@ -46,7 +43,7 @@ module Cucumber
         def map
           raise ArgumentError, "No block given" unless block_given?
           new_content = yield content
-          self.class.new(new_content, content_type, location)
+          self.class.new(new_content, content_type)
         end
 
         def to_step_definition_arg
@@ -65,7 +62,7 @@ module Cucumber
 
         def inspect
           [
-            %{#<#{self.class} (#{location})},
+            %{#<#{self.class}},
             %{  """#{content_type}},
             %{  #{@content}},
             %{  """>}

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

@@ -9,7 +9,6 @@ module Cucumber
         STRICT_AFFECTED_TYPES = [:flaky, :undefined, :pending].freeze
 
         def self.ok?(type, be_strict = StrictConfiguration.new)
-          private
           class_name = type.to_s.slice(0, 1).capitalize + type.to_s.slice(1..-1)
           const_get(class_name).ok?(be_strict.strict?(type))
         end
@@ -43,6 +42,13 @@ module Cucumber
           def with_filtered_backtrace(filter)
             self
           end
+
+          def to_message
+            Cucumber::Messages::TestStepResult.new(
+              status: Cucumber::Messages::TestStepResult::Status::UNKNOWN,
+              duration: UnknownDuration.new.to_message_duration
+            )
+          end
         end
 
         class Passed
@@ -68,6 +74,13 @@ module Cucumber
             "✓"
           end
 
+          def to_message
+            Cucumber::Messages::TestStepResult.new(
+              status: Cucumber::Messages::TestStepResult::Status::PASSED,
+              duration: duration.to_message_duration
+            )
+          end
+
           def ok?(be_strict = nil)
             self.class.ok?
           end
@@ -83,6 +96,7 @@ module Cucumber
 
         class Failed
           include Result.query_methods :failed
+
           attr_reader :duration, :exception
 
           def self.ok?(be_strict = false)
@@ -107,6 +121,20 @@ module Cucumber
             "✗"
           end
 
+          def to_message
+            begin
+              message = exception.backtrace.join("\n")
+            rescue NoMethodError
+              message = ""
+            end
+
+            Cucumber::Messages::TestStepResult.new(
+              status: Cucumber::Messages::TestStepResult::Status::FAILED,
+              duration: duration.to_message_duration,
+              message: message
+            )
+          end
+
           def ok?(be_strict = nil)
             self.class.ok?
           end
@@ -186,6 +214,13 @@ module Cucumber
           def to_s
             "?"
           end
+
+          def to_message
+            Cucumber::Messages::TestStepResult.new(
+              status: Cucumber::Messages::TestStepResult::Status::UNDEFINED,
+              duration: duration.to_message_duration
+            )
+          end
         end
 
         class Skipped < Raisable
@@ -204,6 +239,13 @@ module Cucumber
           def to_s
             "-"
           end
+
+          def to_message
+            Cucumber::Messages::TestStepResult.new(
+              status: Cucumber::Messages::TestStepResult::Status::SKIPPED,
+              duration: duration.to_message_duration
+            )
+          end
         end
 
         class Pending < Raisable
@@ -222,6 +264,13 @@ module Cucumber
           def to_s
             "P"
           end
+
+          def to_message
+            Cucumber::Messages::TestStepResult.new(
+              status: Cucumber::Messages::TestStepResult::Status::PENDING,
+              duration: duration.to_message_duration
+            )
+          end
         end
 
         # Handles the strict settings for the result types that are
@@ -229,7 +278,7 @@ module Cucumber
         class StrictConfiguration
           attr_accessor :settings
           private :settings
-          
+
           def initialize(strict_types = [])
             @settings = Hash[STRICT_AFFECTED_TYPES.map { |t| [t, :default] }]
             strict_types.each do |type|
@@ -329,7 +378,7 @@ module Cucumber
           def decrement_failed
             @totals[:failed] -= 1
           end
-          
+
           private
 
           def get_total(method_name)
@@ -344,14 +393,22 @@ module Cucumber
         end
 
         class Duration
+          include Cucumber::Messages::TimeConversion
+
           attr_reader :nanoseconds
 
           def initialize(nanoseconds)
             @nanoseconds = nanoseconds
           end
+
+          def to_message_duration
+            seconds_to_duration(nanoseconds.to_f / NANOSECONDS_PER_SECOND)
+          end
         end
 
         class UnknownDuration
+          include Cucumber::Messages::TimeConversion
+
           def tap(&block)
             self
           end
@@ -359,6 +416,10 @@ module Cucumber
           def nanoseconds
             raise "#nanoseconds only allowed to be used in #tap block"
           end
+
+          def to_message_duration
+            seconds_to_duration(0)
+          end
         end
       end
     end