gherkin 8.1.1 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b980738a33c8315a4c75f6a40d9c64c8db4e73090a0e3994b5faf630cfcd57d
-  data.tar.gz: b747a6767dea475e580d3ba1ee2a8abe19a1f3a23bfefa58d3ddf639ea77e91a
+  metadata.gz: c425e6ebae052b06f2464f7c5a53d744013a51538cd063d8894c922460aaa85b
+  data.tar.gz: 60a4f31c0b53f7995f75f258a25773043eabc82116565706a5789ede5eaacd78
 SHA512:
-  metadata.gz: e9f680f17ea1eef814cb66bff79122bcf7e0b73cdd0e310a7ae740b8a493f319cc864b6bbefcba4af7ab17b200e0f23f7efa19c215f93c61462412b9f097fc35
-  data.tar.gz: a5c01fb1dc5f2f56f86e39598ac110fe37d38f4e1e47a83f4a54a1597fb02f84022753c58b157e8f4b19fbe7eddc31fadd30167cd9d82d0c192fe55db6b7513f
+  metadata.gz: db8446162a263304c961c2fd79ff808c47a2c71c69c34c1300b412fa17c924df7a54becffd84e6608babab7441a968790e299a9360d4f2123c377ced30bbeb89
+  data.tar.gz: fcb986c6d9abb4c3a388d783cb0f51e2187a152830d9a207692bf0bf02b5a76c442d813cff62c3106c1279380c3023fc637c5cecf8a9223252ac009838d71384

data/bin/gherkin

@@ -12,7 +12,8 @@ options = {
   include_source: true,
   include_gherkin_document: true,
   include_pickles: true,
-  json: false
+  json: false,
+  predictable_ids: false
 }
 
 OptionParser.new do |opts|
@@ -28,6 +29,9 @@ OptionParser.new do |opts|
   opts.on("--json", "Print messages as JSON") do |v|
     options[:json] = v
   end
+  opts.on("--predictable-ids", "Generate incrementing ids rather than UUIDs") do |v|
+    options[:predictable_ids] = v
+  end
 end.parse!
 
 def process_messages(messages, options)

data/lib/gherkin/ast_builder.rb

@@ -1,9 +1,11 @@
 require 'cucumber/messages'
 require 'gherkin/ast_node'
+require 'gherkin/id_generator'
 
 module Gherkin
   class AstBuilder
-    def initialize
+    def initialize(id_generator = Gherkin::IdGenerator::UUID.new)
+      @id_generator = id_generator
       reset
     end
 
@@ -57,7 +59,8 @@ module Gherkin
         token.matched_items.each do |tag_item|
           tags.push(Cucumber::Messages::GherkinDocument::Feature::Tag.new(
             location: get_location(token, tag_item.column),
-            name: tag_item.text
+            name: tag_item.text,
+            id: @id_generator.new_id
           ))
         end
       end
@@ -68,6 +71,7 @@ module Gherkin
     def get_table_rows(node)
       rows = node.get_tokens(:TableRow).map do |token|
         Cucumber::Messages::GherkinDocument::Feature::TableRow.new(
+          id: @id_generator.new_id,
           location: get_location(token, 0),
           cells: get_cells(token)
         )
@@ -111,28 +115,26 @@ module Gherkin
         data_table = node.get_single(:DataTable)
         doc_string = node.get_single(:DocString)
 
-        props = {
+        Cucumber::Messages::GherkinDocument::Feature::Step.new(
           location: get_location(step_line, 0),
           keyword: step_line.matched_keyword,
-          text: step_line.matched_text
-        }
-        props[:data_table] = data_table if data_table
-        props[:doc_string] = doc_string if doc_string
-
-        Cucumber::Messages::GherkinDocument::Feature::Step.new(props)
+          text: step_line.matched_text,
+          data_table: data_table,
+          doc_string: doc_string,
+          id: @id_generator.new_id
+        )
       when :DocString
         separator_token = node.get_tokens(:DocStringSeparator)[0]
         content_type = separator_token.matched_text == '' ? nil : separator_token.matched_text
         line_tokens = node.get_tokens(:Other)
         content = line_tokens.map { |t| t.matched_text }.join("\n")
 
-        props = {
+        Cucumber::Messages::GherkinDocument::Feature::Step::DocString.new(
           location: get_location(separator_token, 0),
           content: content,
-          delimiter: separator_token.matched_keyword
-        }
-        props[:content_type] = content_type if content_type
-        Cucumber::Messages::GherkinDocument::Feature::Step::DocString.new(props)
+          delimiter: separator_token.matched_keyword,
+          content_type: content_type,
+        )
       when :DataTable
         rows = get_table_rows(node)
         Cucumber::Messages::GherkinDocument::Feature::Step::DataTable.new(
@@ -144,14 +146,13 @@ module Gherkin
         description = get_description(node)
         steps = get_steps(node)
 
-        props = {
+        Cucumber::Messages::GherkinDocument::Feature::Background.new(
           location: get_location(background_line, 0),
           keyword: background_line.matched_keyword,
           name: background_line.matched_text,
+          description: description,
           steps: steps
-        }
-        props[:description] = description if description
-        Cucumber::Messages::GherkinDocument::Feature::Background.new(props)
+        )
       when :ScenarioDefinition
         tags = get_tags(node)
         scenario_node = node.get_single(:Scenario)
@@ -159,16 +160,16 @@ module Gherkin
         description = get_description(scenario_node)
         steps = get_steps(scenario_node)
         examples = scenario_node.get_items(:ExamplesDefinition)
-        props = {
+        Cucumber::Messages::GherkinDocument::Feature::Scenario.new(
+          id: @id_generator.new_id,
           tags: tags,
           location: get_location(scenario_line, 0),
           keyword: scenario_line.matched_keyword,
           name: scenario_line.matched_text,
+          description: description,
           steps: steps,
           examples: examples
-        }
-        props[:description] = description if description
-        Cucumber::Messages::GherkinDocument::Feature::Scenario.new(props)
+        )
       when :ExamplesDefinition
         tags = get_tags(node)
         examples_node = node.get_single(:Examples)
@@ -179,16 +180,15 @@ module Gherkin
         table_header = rows.nil? ? nil : rows.first
         table_body = rows.nil? ? nil : rows[1..-1]
 
-        props = {
+        Cucumber::Messages::GherkinDocument::Feature::Scenario::Examples.new(
           tags: tags,
           location: get_location(examples_line, 0),
           keyword: examples_line.matched_keyword,
           name: examples_line.matched_text,
-        }
-        props[:table_header] = table_header if table_header
-        props[:table_body] = table_body if table_body
-        props[:description] = description if description
-        Cucumber::Messages::GherkinDocument::Feature::Scenario::Examples.new(props)
+          description: description,
+          table_header: table_header,
+          table_body: table_body,
+        )
       when :ExamplesTable
         get_table_rows(node)
       when :Description
@@ -215,17 +215,15 @@ module Gherkin
         description = get_description(header)
         language = feature_line.matched_gherkin_dialect
 
-        props = {
+        Cucumber::Messages::GherkinDocument::Feature.new(
           tags: tags,
           location: get_location(feature_line, 0),
           language: language,
           keyword: feature_line.matched_keyword,
           name: feature_line.matched_text,
+          description: description,
           children: children,
-        }
-        props[:description] = description if description
-
-        Cucumber::Messages::GherkinDocument::Feature.new(props)
+        )
       when :Rule
         header = node.get_single(:RuleHeader)
         return unless header

data/lib/gherkin/id_generator.rb

@@ -0,0 +1,22 @@
+require 'securerandom'
+
+module Gherkin
+  module IdGenerator
+    class Incrementing
+      def initialize
+        @index = -1
+      end
+
+      def new_id
+        @index += 1
+        @index.to_s
+      end
+    end
+
+    class UUID
+      def new_id
+        SecureRandom.uuid
+      end
+    end
+  end
+end

data/lib/gherkin/parser.rb

@@ -56,7 +56,7 @@ module Gherkin
   class Parser
     attr_accessor :stop_at_first_error
 
-    def initialize(ast_builder=AstBuilder.new)
+    def initialize(ast_builder = AstBuilder.new)
       @ast_builder = ast_builder
     end
 

data/lib/gherkin/pickles/compiler.rb

@@ -1,9 +1,13 @@
 require 'cucumber/messages'
-require 'digest'
+require 'gherkin/id_generator'
 
 module Gherkin
   module Pickles
     class Compiler
+      def initialize(id_generator = Gherkin::IdGenerator::UUID.new)
+        @id_generator = id_generator
+      end
+
       def compile(gherkin_document, source)
         pickles = []
 
@@ -63,11 +67,11 @@ module Gherkin
 
         pickle = Cucumber::Messages::Pickle.new(
           uri: source.uri,
-          id: calculate_id(source.data, [scenario.location]),
+          id: @id_generator.new_id,
           tags: pickle_tags(tags),
           name: scenario.name,
           language: language,
-          locations: [scenario.location],
+          sourceIds: [scenario.id],
           steps: steps
         )
         pickles.push(pickle)
@@ -76,67 +80,34 @@ module Gherkin
       def compile_scenario_outline(feature_tags, background_steps, scenario, language, pickles, source)
         scenario.examples.reject { |examples| examples.table_header.nil? }.each do |examples|
           variable_cells = examples.table_header.cells
-          examples.table_body.each do |values|
-            value_cells = values.cells
+          examples.table_body.each do |values_row|
+            value_cells = values_row.cells
             steps = scenario.steps.empty? ? [] : [].concat(background_steps)
             tags = [].concat(feature_tags).concat(scenario.tags).concat(examples.tags)
 
             scenario.steps.each do |scenario_outline_step|
-              step_props = pickle_step_props(scenario_outline_step, variable_cells, value_cells)
-              step_props[:locations].push(values.location)
+              step_props = pickle_step_props(scenario_outline_step, variable_cells, values_row)
               steps.push(Cucumber::Messages::Pickle::PickleStep.new(step_props))
             end
 
             pickle = Cucumber::Messages::Pickle.new(
               uri: source.uri,
-              id: calculate_id(source.data, [scenario.location, values.location]),
+              id: @id_generator.new_id,
               name: interpolate(scenario.name, variable_cells, value_cells),
               language: language,
               steps: steps,
               tags: pickle_tags(tags),
-              locations: [
-                scenario.location,
-                values.location
-              ]
+              sourceIds: [
+                scenario.id,
+                values_row.id
+              ],
             )
-            pickles.push(pickle);
+            pickles.push(pickle)
 
           end
         end
       end
 
-      def create_pickle_arguments(argument, variable_cells, value_cells)
-        result = []
-        return result if argument.nil?
-        if (argument[:type] == :DataTable)
-          table = {
-            rows: argument[:rows].map do |row|
-              {
-                cells: row[:cells].map do |cell|
-                  {
-                    location: cell.location,
-                    value: interpolate(cell.value, variable_cells, value_cells)
-                  }
-                end
-              }
-            end
-          }
-          result.push(table)
-        elsif (argument[:type] == :DocString)
-          doc_string = {
-            location: pickle_location(argument.location),
-            content: interpolate(argument[:content], variable_cells, value_cells)
-          }
-          if argument.key?(:contentType)
-            doc_string[:contentType] = interpolate(argument[:contentType], variable_cells, value_cells)
-          end
-          result.push(doc_string)
-        else
-          raise 'Internal error'
-        end
-        result
-      end
-
       def interpolate(name, variable_cells, value_cells)
         variable_cells.each_with_index do |variable_cell, n|
           value_cell = value_cells[n]
@@ -145,15 +116,6 @@ module Gherkin
         name
       end
 
-      def calculate_id(source_data, locations)
-        sha1 = Digest::SHA1.new
-        sha1 << source_data
-        locations.each do |location|
-          sha1 << [location.line, location.column].pack('V*')
-        end
-        sha1.hexdigest
-      end
-
       def pickle_steps(steps)
         steps.map do |step|
           pickle_step(step)
@@ -161,14 +123,19 @@ module Gherkin
       end
 
       def pickle_step(step)
-        Cucumber::Messages::Pickle::PickleStep.new(pickle_step_props(step, [], []))
+        Cucumber::Messages::Pickle::PickleStep.new(pickle_step_props(step, [], nil))
       end
 
-      def pickle_step_props(step, variable_cells, value_cells)
+      def pickle_step_props(step, variable_cells, values_row)
+        value_cells = values_row ? values_row.cells : []
         props = {
+          id: @id_generator.new_id,
+          sourceIds: [step.id],
           text: interpolate(step.text, variable_cells, value_cells),
-          locations: [pickle_step_location(step)]
         }
+        if values_row
+          props[:sourceIds].push(values_row.id)
+        end
 
         if step.data_table
           data_table = Cucumber::Messages::PickleStepArgument.new(
@@ -191,7 +158,6 @@ module Gherkin
             Cucumber::Messages::PickleStepArgument::PickleTable::PickleTableRow.new(
               cells: row.cells.map do |cell|
                 Cucumber::Messages::PickleStepArgument::PickleTable::PickleTableRow::PickleTableCell.new(
-                  location: cell.location,
                   value: interpolate(cell.value, variable_cells, value_cells)
                 )
               end
@@ -202,7 +168,6 @@ module Gherkin
 
       def pickle_doc_string(doc_string, variable_cells, value_cells)
         props = {
-          location: doc_string.location,
           content: interpolate(doc_string.content, variable_cells, value_cells)
         }
         if doc_string.content_type
@@ -211,13 +176,6 @@ module Gherkin
         Cucumber::Messages::PickleStepArgument::PickleDocString.new(props)
       end
 
-      def pickle_step_location(step)
-        Cucumber::Messages::Location.new(
-          line: step.location.line,
-          column: step.location.column + (step.keyword ? step.keyword.length : 0)
-        )
-      end
-
       def pickle_tags(tags)
         tags.map {|tag| pickle_tag(tag)}
       end
@@ -225,7 +183,7 @@ module Gherkin
       def pickle_tag(tag)
         Cucumber::Messages::Pickle::PickleTag.new(
           name: tag.name,
-          location: tag.location
+          sourceId: tag.id
         )
       end
     end

data/lib/gherkin/stream/parser_message_stream.rb

@@ -2,6 +2,7 @@ require 'cucumber/messages'
 require 'gherkin/parser'
 require 'gherkin/token_matcher'
 require 'gherkin/pickles/compiler'
+require 'gherkin/id_generator'
 
 module Gherkin
   module Stream
@@ -10,8 +11,14 @@ module Gherkin
         @paths = paths
         @sources = sources
         @options = options
-        @parser = Parser.new
-        @compiler = Pickles::Compiler.new
+
+        id_generator = id_generator_class.new
+        @parser = Parser.new(AstBuilder.new(id_generator))
+        @compiler = Pickles::Compiler.new(id_generator)
+      end
+
+      def id_generator_class
+        @options[:predictable_ids] ? Gherkin::IdGenerator::Incrementing : Gherkin::IdGenerator::UUID
       end
 
       def messages

data/spec/gherkin/id_generator_spec.rb

@@ -0,0 +1,29 @@
+require 'rspec'
+require 'gherkin/id_generator'
+
+describe Gherkin::IdGenerator::Incrementing do
+  subject { Gherkin::IdGenerator::Incrementing.new }
+
+  context '#new_id' do
+    it 'returns 0 the first time' do
+      expect(subject.new_id).to eq("0")
+    end
+
+    it 'increments on every call' do
+      expect(subject.new_id).to eq("0")
+      expect(subject.new_id).to eq("1")
+      expect(subject.new_id).to eq("2")
+    end
+  end
+end
+
+describe Gherkin::IdGenerator::UUID do
+  subject { Gherkin::IdGenerator::UUID.new }
+
+  context '#new_id' do
+    it 'generates a UUID' do
+      allowed_characters = "[0-9a-fA-F]"
+      expect(subject.new_id).to match(/#{allowed_characters}{8}\-#{allowed_characters}{4}\-#{allowed_characters}{4}\-#{allowed_characters}{4}\-#{allowed_characters}{12}/)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gherkin
 version: !ruby/object:Gem::Version
-  version: 8.1.1
+  version: 8.2.0
 platform: ruby
 authors:
 - Gáspár Nagy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-messages
@@ -18,20 +18,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -41,7 +41,7 @@ dependencies:
         version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -51,7 +51,7 @@ dependencies:
         version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,7 @@ files:
 - lib/gherkin/errors.rb
 - lib/gherkin/gherkin-languages.json
 - lib/gherkin/gherkin_line.rb
+- lib/gherkin/id_generator.rb
 - lib/gherkin/parser.rb
 - lib/gherkin/pickles/compiler.rb
 - lib/gherkin/stream/parser_message_stream.rb
@@ -123,6 +124,7 @@ files:
 - spec/coverage.rb
 - spec/gherkin/dialect_spec.rb
 - spec/gherkin/gherkin_spec.rb
+- spec/gherkin/id_generator_spec.rb
 - spec/gherkin/stream/subprocess_message_stream_spec.rb
 homepage: https://github.com/cucumber/gherkin-ruby
 licenses:
@@ -153,10 +155,11 @@ rubyforge_project:
 rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
-summary: gherkin-8.1.1
+summary: gherkin-8.2.0
 test_files:
 - spec/gherkin/dialect_spec.rb
 - spec/gherkin/stream/subprocess_message_stream_spec.rb
+- spec/gherkin/id_generator_spec.rb
 - spec/gherkin/gherkin_spec.rb
 - spec/capture_warnings.rb
 - spec/coverage.rb