cucumber-gherkin 9.1.0

data/lib/gherkin/token_scanner.rb

@@ -0,0 +1,40 @@
+require 'stringio'
+require 'gherkin/token'
+require 'gherkin/gherkin_line'
+
+module Gherkin
+  # The scanner reads a gherkin doc (typically read from a .feature file) and
+  # creates a token for line. The tokens are passed to the parser, which outputs
+  # an AST (Abstract Syntax Tree).
+  #
+  # If the scanner sees a # language header, it will reconfigure itself dynamically
+  # to look for Gherkin keywords for the associated language. The keywords are defined
+  # in gherkin-languages.json.
+  class TokenScanner
+    def initialize(source_or_io)
+      @line_number = 0
+
+      case(source_or_io)
+      when String
+        @io = StringIO.new(source_or_io)
+      when StringIO, IO
+        @io = source_or_io
+      else
+        fail ArgumentError, "Please a pass String, StringIO or IO. I got a #{source_or_io.class}"
+      end
+    end
+
+    def read
+      location = {line: @line_number += 1, column: 0}
+      if @io.nil? || line = @io.gets
+        gherkin_line = line ? GherkinLine.new(line, location[:line]) : nil
+        Token.new(gherkin_line, location)
+      else
+        @io.close unless @io.closed? # ARGF closes the last file after final gets
+        @io = nil
+        Token.new(nil, location)
+      end
+    end
+
+  end
+end

data/spec/capture_warnings.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+# With thanks to @myronmarston
+# https://github.com/vcr/vcr/blob/master/spec/capture_warnings.rb
+
+module CaptureWarnings
+  def report_warnings(&block)
+    current_dir = Dir.pwd
+    warnings, errors = capture_error(&block).partition { |line| line.include?('warning') }
+    project_warnings, other_warnings = warnings.uniq.partition { |line| line.include?(current_dir) }
+
+    if errors.any?
+      puts errors.join("\n")
+    end
+
+    if other_warnings.any?
+      puts "#{ other_warnings.count } warnings detected, set VIEW_OTHER_WARNINGS=true to see them."
+      print_warnings('other', other_warnings) if ENV['VIEW_OTHER_WARNINGS']
+    end
+
+    # Until they fix https://bugs.ruby-lang.org/issues/10661
+    if RUBY_VERSION == "2.2.0"
+      project_warnings = project_warnings.reject { |w| w =~ /warning: possible reference to past scope/ }
+    end
+
+    if project_warnings.any?
+      puts "#{ project_warnings.count } warnings detected"
+      print_warnings('cucumber-expressions', project_warnings)
+      fail "Please remove all cucumber-expressions warnings."
+    end
+
+    ensure_system_exit_if_required
+  end
+
+  def capture_error(&block)
+    old_stderr = STDERR.clone
+    pipe_r, pipe_w = IO.pipe
+    pipe_r.sync    = true
+    error          = String.new
+    reader = Thread.new do
+      begin
+        loop do
+          error << pipe_r.readpartial(1024)
+        end
+      rescue EOFError
+      end
+    end
+    STDERR.reopen(pipe_w)
+    block.call
+  ensure
+    capture_system_exit
+    STDERR.reopen(old_stderr)
+    pipe_w.close
+    reader.join
+    return error.split("\n")
+  end
+
+  def print_warnings(type, warnings)
+    puts
+    puts "-" * 30 + " #{type} warnings: " + "-" * 30
+    puts
+    puts warnings.join("\n")
+    puts
+    puts "-" * 75
+    puts
+  end
+
+  def ensure_system_exit_if_required
+    raise @system_exit if @system_exit
+  end
+
+  def capture_system_exit
+    @system_exit = $!
+  end
+end

data/spec/coverage.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'simplecov'
+formatters = [ SimpleCov::Formatter::HTMLFormatter ]
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(*formatters)
+SimpleCov.add_filter 'spec/'
+SimpleCov.start

data/spec/gherkin/dialect_spec.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+require 'rspec'
+require 'gherkin/dialect'
+
+module Gherkin
+  describe Dialect do
+    it 'provides an interface to the keywords of a dialect' do
+      dialect_en = Dialect.for('en')
+
+      expect(dialect_en.feature_keywords).to eq(['Feature', 'Business Need', 'Ability'])
+    end
+  end
+end

data/spec/gherkin/gherkin_spec.rb

@@ -0,0 +1,45 @@
+require 'rspec'
+require 'gherkin'
+
+describe Gherkin do
+  it "can process feature file paths" do
+    messages = Gherkin.from_paths(
+      ["testdata/good/minimal.feature"],
+      {include_source: true,
+       include_gherkin_document: true,
+       include_pickles: true}
+    ).to_a
+
+    expect(messages.length).to eq(3)
+  end
+
+  it "can process feature file content" do
+    data = File.open("testdata/good/minimal.feature", 'r:UTF-8', &:read)
+
+    messages = Gherkin.from_source(
+      "uri",
+      data,
+      {include_source: true,
+       include_gherkin_document: true,
+       include_pickles: true}
+    ).to_a
+
+    expect(messages.length).to eq(3)
+  end
+
+  it "can set the default dialect for the feature file content" do
+    data = File.open("testdata/good/i18n_no.feature", 'r:UTF-8', &:read)
+    data_without_language_header = data.split("\n")[1..-1].join("\n")
+
+    messages = Gherkin.from_source(
+      "uri",
+      data,
+      {include_source: true,
+       include_gherkin_document: true,
+       include_pickles: true,
+       default_dialect: "no"}
+    ).to_a
+
+    expect(messages.length).to eq(3)
+  end
+end

data/spec/gherkin/query_spec.rb

@@ -0,0 +1,142 @@
+require 'rspec'
+require 'gherkin'
+require 'gherkin/query'
+
+describe Gherkin::Query do
+  let(:subject) { Gherkin::Query.new() }
+
+  def filter_messages_by_attribute(messages, attribute)
+    messages.map do |message|
+      return unless message.respond_to?(attribute)
+      message.send(attribute)
+    end.compact
+  end
+
+  def find_message_by_attribute(messages, attribute)
+    filter_messages_by_attribute(messages, attribute).first
+  end
+
+  let(:gherkin_document) { find_message_by_attribute(messages, :gherkin_document) }
+
+  let(:messages) {
+    Gherkin.from_source(
+      "some/path",
+      feature_content,
+      {
+        include_gherkin_document: true
+      }
+    ).to_a
+  }
+
+  let(:feature_content) {
+    """
+    @feature-tag
+    Feature: my feature
+
+      Background:
+        Given a passed background step
+
+      @scenario-tag
+      Scenario: my scenario
+        Given a passed step
+
+      Scenario Outline: with examples
+        Given a <Status> step
+
+        @example-tag
+        Examples:
+          | Status |
+          | passed |
+
+
+      Rule: this is a rule
+        Background:
+          Given the passed step in the rule background
+
+        @ruled-scenario-tag
+        Scenario: a ruled scenario
+          Given a step in the ruled scenario
+      """
+  }
+
+  before do
+    messages.each { |message|
+      subject.update(message)
+    }
+  end
+
+  context '#location' do
+    let(:background) { find_message_by_attribute(gherkin_document.feature.children, :background) }
+    let(:scenarios) { filter_messages_by_attribute(gherkin_document.feature.children, :scenario) }
+    let(:scenario) { scenarios.first }
+
+    it 'raises an exception when the AST node ID is unknown' do
+      expect { subject.location("this-id-may-not-exist-for-real") }.to raise_exception(Gherkin::AstNodeNotLocatedException)
+    end
+
+    it 'provides the location of a scenario' do
+      expect(subject.location(scenario.id)).to eq(scenario.location)
+    end
+
+    it 'provides the location of an examples table row' do
+      node = scenarios.last.examples.first.table_body.first
+      expect(subject.location(node.id)).to eq(node.location)
+    end
+
+    context 'when querying steps' do
+      let(:background_step) { background.steps.first }
+      let(:scenario_step) { scenario.steps.first }
+
+      it 'provides the location of a background step' do
+        expect(subject.location(background_step.id)).to eq(background_step.location)
+      end
+
+      it 'provides the location of a scenario step' do
+        expect(subject.location(scenario_step.id)).to eq(scenario_step.location)
+      end
+    end
+
+    context 'when querying tags' do
+      let(:feature_tag) { gherkin_document.feature.tags.first }
+      let(:scenario_tag) { scenario.tags.first }
+      let(:example_tag) { scenarios.last.examples.first.tags.first }
+
+      it 'provides the location of a feature tags' do
+        expect(subject.location(feature_tag.id)).to eq(feature_tag.location)
+      end
+
+      it 'provides the location of a scenario tags' do
+        expect(subject.location(scenario_tag.id)).to eq(scenario_tag.location)
+      end
+
+      it 'provides the location of a scenario example tags' do
+        expect(subject.location(example_tag.id)).to eq(example_tag.location)
+      end
+    end
+
+    context 'when children are scoped in a Rule' do
+      let(:rule) { find_message_by_attribute(gherkin_document.feature.children, :rule) }
+      let(:rule_background) { find_message_by_attribute(rule.children, :background) }
+      let(:rule_background_step) { rule_background.steps.first }
+      let(:rule_scenario) { find_message_by_attribute(rule.children, :scenario) }
+      let(:rule_scenario_step) { rule_scenario.steps.first }
+      let(:rule_scenario_tag) { rule_scenario.tags.first }
+
+      it 'provides the location of a background step' do
+        expect(subject.location(rule_background_step.id)).to eq(rule_background_step.location)
+      end
+
+      it 'provides the location of a scenario' do
+        expect(subject.location(rule_scenario.id)).to eq(rule_scenario.location)
+      end
+
+      it 'provides the location of a scenario tag' do
+        expect(subject.location(rule_scenario_tag.id)).to eq(rule_scenario_tag.location)
+      end
+
+      it 'provides the location of a scenario step' do
+        expect(subject.location(rule_scenario_step.id)).to eq(rule_scenario_step.location)
+      end
+    end
+  end
+end

data/spec/gherkin/stream/parser_message_stream_spec.rb

@@ -0,0 +1,67 @@
+require 'rspec'
+require 'gherkin/stream/parser_message_stream'
+
+module Gherkin
+  module Stream
+    describe ParserMessageStream do
+      let(:feature_content) {
+        "Feature: my feature\n" \
+        "  Scenario: a scenario\n" \
+        "    Given some context"
+      }
+
+      let(:source_feature) {
+        Cucumber::Messages::Source.new({
+          uri: '//whatever/uri',
+          data: feature_content,
+          media_type: 'text/x.cucumber.gherkin+plain'
+        })
+      }
+
+      let(:options) {
+        {
+          include_gherkin_document: true,
+        }
+      }
+
+      let(:gherkin_document) {
+        ParserMessageStream.new([], [source_feature], options).messages.first.gherkin_document
+      }
+
+      let(:scenario_id) { gherkin_document.feature.children.first.scenario.id }
+
+      context '#messages' do
+        it "raises an exception on second iteration" do
+          messages = ParserMessageStream.new([], [source_feature], options).messages
+
+          expect { messages.map(&:to_s) }.not_to raise_exception
+          expect { messages.map(&:to_s) }.to raise_exception(Gherkin::DoubleIterationException)
+        end
+      end
+
+      context 'options.id_generator' do
+        context 'when not set' do
+          it 'generates random UUIDs' do
+            expect(scenario_id).to match(/[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}/)
+          end
+        end
+
+
+        context 'when set' do
+          let(:id_generator) { double }
+          let(:options) {
+            {
+              include_gherkin_document: true,
+              id_generator: id_generator
+            }
+          }
+
+          it 'uses the generator instance to produce the IDs' do
+            allow(id_generator).to receive(:new_id).and_return('some-random-id')
+            expect(scenario_id).to eq('some-random-id')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/gherkin/stream/subprocess_message_stream_spec.rb

@@ -0,0 +1,18 @@
+require 'rspec'
+require 'gherkin/stream/subprocess_message_stream'
+
+module Gherkin
+  module Stream
+    describe SubprocessMessageStream do
+      it "works" do
+        cucumber_messages = SubprocessMessageStream.new(
+          "./bin/gherkin",
+          ["testdata/good/minimal.feature"],
+          true, true, true
+        )
+        messages = cucumber_messages.messages.to_a
+        expect(messages.length).to eq(3)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-gherkin
+version: !ruby/object:Gem::Version
+  version: 9.1.0
+platform: ruby
+authors:
+- Gáspár Nagy
+- Aslak Hellesøy
+- Steve Tooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber-messages
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+description: Gherkin parser
+email: cukes@googlegroups.com
+executables:
+- gherkin-ruby
+- gherkin
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/gherkin
+- bin/gherkin-ruby
+- lib/gherkin.rb
+- lib/gherkin/ast_builder.rb
+- lib/gherkin/ast_node.rb
+- lib/gherkin/dialect.rb
+- lib/gherkin/errors.rb
+- lib/gherkin/gherkin-languages.json
+- lib/gherkin/gherkin_line.rb
+- lib/gherkin/parser.rb
+- lib/gherkin/pickles/compiler.rb
+- lib/gherkin/query.rb
+- lib/gherkin/stream/parser_message_stream.rb
+- lib/gherkin/stream/subprocess_message_stream.rb
+- lib/gherkin/token.rb
+- lib/gherkin/token_formatter_builder.rb
+- lib/gherkin/token_matcher.rb
+- lib/gherkin/token_scanner.rb
+- spec/capture_warnings.rb
+- spec/coverage.rb
+- spec/gherkin/dialect_spec.rb
+- spec/gherkin/gherkin_spec.rb
+- spec/gherkin/query_spec.rb
+- spec/gherkin/stream/parser_message_stream_spec.rb
+- spec/gherkin/stream/subprocess_message_stream_spec.rb
+homepage: https://github.com/cucumber/gherkin-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/cucumber/cucumber/issues
+  changelog_uri: https://github.com/cucumber/cucumber/blob/master/gherkin/CHANGELOG.md
+  documentation_uri: https://cucumber.io/docs/gherkin/
+  mailing_list_uri: https://groups.google.com/forum/#!forum/cukes
+  source_code_uri: https://github.com/cucumber/cucumber/blob/master/gherkin/ruby
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: cucumber-gherkin-9.1.0
+test_files:
+- spec/gherkin/dialect_spec.rb
+- spec/gherkin/stream/parser_message_stream_spec.rb
+- spec/gherkin/stream/subprocess_message_stream_spec.rb
+- spec/gherkin/gherkin_spec.rb
+- spec/gherkin/query_spec.rb
+- spec/capture_warnings.rb
+- spec/coverage.rb