cuke_modeler 1.3.0 → 2.1.0

data/lib/cuke_modeler/sourceable.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # A mix-in module containing methods used by models that know from which line of
   # source code they originate.
 

data/lib/cuke_modeler/stepped.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # A mix-in module containing methods used by models that represent an element that has steps.
 
   module Stepped

data/lib/cuke_modeler/taggable.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # A mix-in module containing methods used by models that represent an element that can be tagged.
 
   module Taggable

data/lib/cuke_modeler/version.rb

@@ -1,4 +1,4 @@
 module CukeModeler
   # The gem version
-  VERSION = '1.3.0'
+  VERSION = '2.1.0'
 end

data/testing/cucumber/features/analysis/step_comparison.feature

@@ -0,0 +1,25 @@
+Feature: Step comparison
+
+  Step comparison using `==` is done based on 'significant' properties. Keywords, being completely interchangeable, do not affect step equality.
+
+
+  Scenario: Comparison of steps
+    Given a model for the following step:
+      """
+      Given a step
+      """
+    And a model for the following step:
+      """
+      When a step
+      """
+    And a model for the following step:
+      """
+      Then a step
+      """
+    When the models are compared
+    Then all of them are equivalent
+    But none of the models are equivalent with a model for the following step:
+      """
+      And a step
+        | plus this table |
+      """

data/testing/cucumber/features/analysis/test_comparison.feature

@@ -1,6 +1,6 @@
 Feature: Test comparison
 
-  Gherkin elements that contain steps (i.e. backgrounds, scenarios, and outlines) can be compared with one another in order to determine equality. Elements are considered equal if the base text of their steps match. That is, the keyword used for the step and any table or doc string that may be associated with that step are ignored for the purposes of comparison.
+  Gherkin elements that contain steps (i.e. backgrounds, scenarios, and outlines) can be compared with one another in order to determine equality. Elements are considered equal if their steps match (see step comparison). Properties that do not affect what a test *does* (e.g. name, description, tags) are ignored for the purposes of comparison.
 
 
   Scenario: Comparing tests

data/testing/cucumber/step_definitions/feature_file_steps.rb

@@ -6,7 +6,7 @@ Given(/^a feature file model based on "([^"]*)"$/) do |file_name|
 end
 
 And(/^a feature file model based on that file$/) do |code_text|
-  code_text.gsub!('<file_path>', "'#{@file_path}'")
+  code_text = code_text.gsub('<file_path>', "'#{@file_path}'")
 
   eval(code_text)
 end

data/testing/cucumber/step_definitions/modeling_steps.rb

@@ -13,13 +13,13 @@ When(/^the model is output as a string$/) do |code_text|
 end
 
 And(/^a(?:n)? \w+(?: \w+)? model based on that gherkin$/) do |code_text|
-  code_text.gsub!('<source_text>', "'#{@source_text}'")
+  code_text = code_text.gsub('<source_text>', "'#{@source_text}'")
 
   eval(code_text)
 end
 
 Given(/^(?:a|the) (?:directory|feature file) is modeled$/) do |code_text|
-  code_text.gsub!('<path_to>', @root_test_directory)
+  code_text = code_text.gsub('<path_to>', @root_test_directory)
 
   eval(code_text)
 end
@@ -42,3 +42,8 @@ Given(/^a model for the following outline:$/) do |gherkin_text|
   @models ||= []
   @models << CukeModeler::Outline.new(gherkin_text)
 end
+
+Given(/^a model for the following step:$/) do |gherkin_text|
+  @models ||= []
+  @models << CukeModeler::Step.new(gherkin_text)
+end

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -12,7 +12,7 @@ Then(/^all of them can be output as text appropriate to the model type$/) do |co
 end
 
 Then(/^the following text is provided:$/) do |expected_text|
-  expected_text.sub!('<path_to>', @root_test_directory)
+  expected_text = expected_text.sub('<path_to>', @root_test_directory)
 
   expect(@output).to eq(expected_text)
 end
@@ -58,12 +58,13 @@ end
 
 Then(/^the model returns "([^"]*)"$/) do |value|
   value.gsub!('path_to', @root_test_directory) if value.is_a?(String)
+  value = value.to_i if value =~ /^\d+$/
 
   expect(@result).to eq(value)
 end
 
 Then(/^the model returns$/) do |value|
-  value.gsub!('path_to', @root_test_directory) if value.is_a?(String)
+  value = value.gsub('path_to', @root_test_directory) if value.is_a?(String)
 
   expect(@result).to eq(value)
 end
@@ -165,6 +166,14 @@ But(/^none of the models are equivalent with a model for the following scenario:
   end
 end
 
+But(/^none of the models are equivalent with a model for the following step:$/) do |gherkin_text|
+  model = CukeModeler::Step.new(gherkin_text)
+
+  @models.each do |other_model|
+    expect(model == other_model).to_not be true
+  end
+end
+
 Then(/^the model returns models for the following comments:$/) do |model_values|
   model_values = model_values.raw.flatten
 

data/testing/file_helper.rb

@@ -1,3 +1,6 @@
+require 'tmpdir'
+
+
 module CukeModeler
   module FileHelper
 

data/testing/gemfiles/gherkin2.gemfile

@@ -7,13 +7,21 @@ gem "gherkin", "~> 2.0"
 
 if RUBY_VERSION =~ /^1\./
 
+  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
+    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
+  end
+
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
 
   if RUBY_VERSION =~ /^1\.8/
     gem 'cucumber', '~> 1.0' # Ruby 1.8.x support dropped after this version
+    gem 'rainbow', '< 2.0' # Ruby 1.8.x support dropped after this version
     gem 'rake', '< 11.0' # Ruby 1.8.x support dropped after this version
+  else
+    gem 'rake', '< 12.3.0' # Ruby 1.9.x support dropped after this version
   end
 
 elsif RUBY_VERSION =~ /^2\./

data/testing/gemfiles/gherkin3.gemfile

@@ -7,9 +7,15 @@ gem "gherkin", "~> 3.0"
 
 if RUBY_VERSION =~ /^1\./
 
+  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
+    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
+  end
+
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # Ruby 1.9.x support dropped after this version
 
 elsif RUBY_VERSION =~ /^2\./
 

data/testing/gemfiles/gherkin4.gemfile

@@ -7,9 +7,16 @@ gem "gherkin", "~> 4.0"
 
 if RUBY_VERSION =~ /^1\./
 
+  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
+    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
+  end
+
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # Ruby 1.9.x support dropped after this version
+  gem 'cucumber', '< 3.0.0' # Ruby 1.9.x support dropped after this version
 
 elsif RUBY_VERSION =~ /^2\./
 

data/testing/gemfiles/gherkin5.gemfile

@@ -7,9 +7,16 @@ gem "gherkin", "~> 5.0"
 
 if RUBY_VERSION =~ /^1\./
 
+  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
+    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
+  end
+
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # Ruby 1.9.x support dropped after this version
+  gem 'cucumber-core', '< 3.0.0' # Ruby 1.9.x support dropped after this version
 
 elsif RUBY_VERSION =~ /^2\./
 

data/testing/gemfiles/gherkin6.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+gem "gherkin", "~> 6.0"
+gem 'cucumber', '~>4.0.rc' # TODO: Upgrade to Cucumber 4.0 when it is finally released
+
+if RUBY_VERSION =~ /^2\.[23456789]/
+  gem 'test-unit'
+end

data/testing/gemfiles/gherkin7.gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+gem "gherkin", "~> 7.0"
+
+if RUBY_VERSION =~ /^2\.[23456789]/
+  gem 'test-unit'
+end

data/testing/gemfiles/gherkin8.gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+gem "gherkin", "~> 8.0"
+
+if RUBY_VERSION =~ /^2\.[23456789]/
+  gem 'test-unit'
+end

data/testing/gemfiles/gherkin9.gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+gem "gherkin", "~> 9.0"
+
+if RUBY_VERSION =~ /^2\.[23456789]/
+  gem 'test-unit'
+end

data/testing/helper_methods.rb

@@ -0,0 +1,23 @@
+module CukeModeler
+  module HelperMethods
+
+    def assert_bidirectional_equality(base_thing, compared_thing)
+      expect(base_thing).to eq(compared_thing)
+      expect(compared_thing).to eq(base_thing)
+    end
+
+    def assert_bidirectional_inequality(base_thing, compared_thing)
+      expect(base_thing).to_not eq(compared_thing)
+      expect(compared_thing).to_not eq(base_thing)
+    end
+
+    def gherkin?(*versions)
+      versions.include?(gherkin_major_version)
+    end
+
+    def gherkin_major_version
+      Gem.loaded_specs['gherkin'].version.version.match(/^(\d+)\./)[1].to_i
+    end
+
+  end
+end

data/testing/rspec/spec/integration/{gherkin_2_adapter_spec.rb → adapters/gherkin_2_adapter_spec.rb}

@@ -1,56 +1,56 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
-describe 'Gherkin2Adapter, Integration', :gherkin2 => true do
+describe 'Gherkin2Adapter, Integration', :if => gherkin?(2) do
 
   let(:clazz) { CukeModeler::Gherkin2Adapter }
   let(:adapter) { clazz.new }
   let(:source_text) { "# feature comment
                        @tag1 @tag2 @tag3
-                       #{@feature_keyword}: A feature with everything it could have
+                       #{FEATURE_KEYWORD}: A feature with everything it could have
 
                        Including a description
                        and then some.
 
                          # background comment
-                         #{@background_keyword}:
+                         #{BACKGROUND_KEYWORD}:
 
                          Background
                          description
 
-                           #{@step_keyword} a step
+                           #{STEP_KEYWORD} a step
                            # table comment
                              | value1 |
                            # table row comment
                              | value2 |
-                           #{@step_keyword} another step
+                           #{STEP_KEYWORD} another step
 
                          # scenario comment
                          @scenario_tag
-                         #{@scenario_keyword}:
+                         #{SCENARIO_KEYWORD}:
 
                          Scenario
                          description
 
-                           #{@step_keyword} a step
-                           #{@step_keyword} another step
+                           #{STEP_KEYWORD} a step
+                           #{STEP_KEYWORD} another step
                              \"\"\"
                              some text
                              \"\"\"
 
                          # outline comment
                          @outline_tag
-                         #{@outline_keyword}:
+                         #{OUTLINE_KEYWORD}:
 
                          Outline
                          description
 
                            # step comment
-                           #{@step_keyword} a step
+                           #{STEP_KEYWORD} a step
                            # table comment
                              | value2 |
                            # step comment
-                           #{@step_keyword} another step
+                           #{STEP_KEYWORD} another step
                            # doc string comment
                              \"\"\"
                              some text
@@ -58,7 +58,7 @@ describe 'Gherkin2Adapter, Integration', :gherkin2 => true do
 
                          # example comment
                          @example_tag
-                         #{@example_keyword}:
+                         #{EXAMPLE_KEYWORD}:
 
                          Example
                          description

data/testing/rspec/spec/integration/{gherkin_3_adapter_spec.rb → adapters/gherkin_3_adapter_spec.rb}

@@ -1,56 +1,56 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
-describe 'Gherkin3Adapter, Integration', :gherkin3 => true do
+describe 'Gherkin3Adapter, Integration', :if => gherkin?(3) do
 
   let(:clazz) { CukeModeler::Gherkin3Adapter }
   let(:adapter) { clazz.new }
   let(:source_text) { "# feature comment
                        @tag1 @tag2 @tag3
-                       #{@feature_keyword}: A feature with everything it could have
+                       #{FEATURE_KEYWORD}: A feature with everything it could have
 
                        Including a description
                        and then some.
 
                          # background comment
-                         #{@background_keyword}:
+                         #{BACKGROUND_KEYWORD}:
 
                          Background
                          description
 
-                           #{@step_keyword} a step
+                           #{STEP_KEYWORD} a step
                            # table comment
                              | value1 |
                            # table row comment
                              | value2 |
-                           #{@step_keyword} another step
+                           #{STEP_KEYWORD} another step
 
                          # scenario comment
                          @scenario_tag
-                         #{@scenario_keyword}:
+                         #{SCENARIO_KEYWORD}:
 
                          Scenario
                          description
 
-                           #{@step_keyword} a step
-                           #{@step_keyword} another step
+                           #{STEP_KEYWORD} a step
+                           #{STEP_KEYWORD} another step
                              \"\"\"
                              some text
                              \"\"\"
 
                          # outline comment
                          @outline_tag
-                         #{@outline_keyword}:
+                         #{OUTLINE_KEYWORD}:
 
                          Outline
                          description
 
                            # step comment
-                           #{@step_keyword} a step
+                           #{STEP_KEYWORD} a step
                            # table comment
                              | value2 |
                            # step comment
-                           #{@step_keyword} another step
+                           #{STEP_KEYWORD} another step
                            # doc string comment
                              \"\"\"
                              some text
@@ -58,7 +58,7 @@ describe 'Gherkin3Adapter, Integration', :gherkin3 => true do
 
                          # example comment
                          @example_tag
-                         #{@example_keyword}:
+                         #{EXAMPLE_KEYWORD}:
 
                          Example
                          description