cucumber-core 5.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a5ba16d6f3fc1772d232afd8159f009c8464e586
-  data.tar.gz: 69531a546edaa1bd2d51cb66510451043f32e87a
+SHA256:
+  metadata.gz: c03c5c2ccda9326120bc377c75a0a3c56e386070c108c677f6bffea29bc21eb6
+  data.tar.gz: 965d2ec74b9fbfba44d2355d2d8ba083a24c82be5cd72d371a4ab504049a2f77
 SHA512:
-  metadata.gz: ee28cc3b48def98ad79cae99e5b8eb4ded00dd08e550235d2289a89ad2d4a46a2ef58709294089289adb4aed9a69b60093f655879aa1a9e66164e23dba0942f2
-  data.tar.gz: 1809cd9af683812a02b68fd82ef97a858bc5529dd9951718cfff8dd940fe8eef2a43eb6d5f78d62148588fe5c2698db031888b382928a64fdc1acbc351ca5685
+  metadata.gz: 063f801da4e9df7f0a0a592b3823ac173255dd218f52b97dccdddc0a735ecbd33317ffbb93f223688c563f43e0f567751ae98d47b4db5314200205c96bd2be58
+  data.tar.gz: 62f5793d529b180b0ace6012db447f763ba6029438a0140d9f665893dafa75bcef653d74ec641658d3075014a74b7661a0264ea776564c415d8fc3e6a020c387

data/CHANGELOG.md

@@ -1,26 +1,54 @@
 Please see [CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CONTRIBUTING.md) on how to contribute to Cucumber.
 
-## [In Git](https://github.com/cucumber/cucumber-ruby-core/compare/v5.0.0...master)
+## [7.1.0](https://github.com/cucumber/cucumber-ruby-core/compare/v7.0.0...v7.0.1)
 
 ### Changed
 
-* N/A
+* Updated gems:
+  * `cucumber-gherkin` ~> 14.0.1
+  * `cucumber-messages` ~> 12.2.0
 
-### Added
+## [7.0.0](https://github.com/cucumber/cucumber-ruby-core/compare/v6.0.0...v7.0.0)
 
-* N/A
+### Changed
 
-### Fixed
+* Updated monorepo libraries:
+  - cucumber-gherkin ~> 13
+  - cucumber-messages ~> 12
 
-* N/A
+## [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
 
-* N/A
+* Remove location for MultiLine arguments
 
-### Improved
 
-* N/A
+## [5.0.2](https://github.com/cucumber/cucumber-ruby-core/compare/v5.0.1...v5.0.2)
+
+### Changed
+
+* Update to use Gherkin v8
+
+## [5.0.1](https://github.com/cucumber/cucumber-ruby-core/compare/v5.0.0...v5.0.1)
+
+### Removed
+
+* Remove support for ruby 2.2 and below. 2.3 or higher is required now.
 
 ## [5.0.0](https://github.com/cucumber/cucumber-ruby-core/compare/v4.0.0...v5.0.0)
 

data/README.md

@@ -1,6 +1,7 @@
 # cucumber-core
 
 [![Chat with us](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cucumber/cucumber-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![CircleCI](https://circleci.com/gh/cucumber/cucumber-ruby-core.svg?style=svg)](https://circleci.com/gh/cucumber/cucumber-ruby-core)
 [![Build Status](https://travis-ci.org/cucumber/cucumber-ruby-core.svg?branch=master)](https://travis-ci.org/cucumber/cucumber-ruby-core)
 [![Code Climate](https://codeclimate.com/github/cucumber/cucumber-ruby-core.svg)](https://codeclimate.com/github/cucumber/cucumber-ruby-core)
 [![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby-core/badge.svg?branch=master)](https://coveralls.io/r/cucumber/cucumber-ruby-core?branch=master)

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'gherkin/gherkin'
+require 'gherkin'
 
 module Cucumber
   module Core
@@ -7,30 +7,41 @@ 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::Gherkin.from_source(document.uri, document.body, {default_dialect: document.language, include_source: false})
+          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}")
+            elsif message.parse_error
+              raise Core::Gherkin::ParseError.new("#{document.uri}: #{message.parse_error.message}")
             else
               raise "Unknown message: #{message.to_hash}"
             end
           end
         end
 
+        def gherkin_options(document)
+          {
+            default_dialect: document.language,
+            include_source: false,
+            include_gherkin_document: true,
+            include_pickles: true
+          }
+        end
+
         def done
           receiver.done
           self

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

@@ -48,7 +48,7 @@ module Cucumber
 
           default_keyword 'Feature'
 
-          elements :background, :scenario, :scenario_outline
+          elements :background, :rule, :scenario, :scenario_outline
 
           def build(source = [])
             elements.inject(source + statements) { |acc, el| el.build(acc) + [NEW_LINE] }
@@ -85,7 +85,29 @@ module Cucumber
 
           private
           def statements
-            prepare_statements comments_statement, tag_statement, name_statement, description_statement
+            prepare_statements comments_statement,
+              tag_statement,
+              name_statement,
+              description_statement
+          end
+        end
+
+        class Rule
+          include HasElements
+          include HasOptionsInitializer
+          include HasDescription
+          include Indentation.level 2
+
+          default_keyword 'Rule'
+
+          elements :example, :scenario
+
+          private
+          def statements
+            prepare_statements comments_statement,
+              name_statement,
+              description_statement,
+              NEW_LINE
           end
         end
 
@@ -108,6 +130,12 @@ module Cucumber
           end
         end
 
+        class Example < Scenario
+          include Indentation.level 4
+
+          default_keyword 'Example'
+        end
+
         class ScenarioOutline
           include HasElements
           include HasOptionsInitializer

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