cuke_modeler 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a3d9a2a79ed92fc6190aa4d8bfd198d319a283af35d7586ba9dd6e11562b108
-  data.tar.gz: d55ac4e9e29b02999ea13919ad24353e896a07608b854959ded2c2c664608711
+  metadata.gz: 92ec631920bf8e2af7095588f0f85bf6f43e109737d39b7b2b92a5e71b00bd82
+  data.tar.gz: c8d6abcdf38a6d71a9281c841a60feb0cf839bfa4c13430009ab56458b7d7ac2
 SHA512:
-  metadata.gz: 8a6d159ad8a6d3a5dd556cbeb113f973a85dbc4c5cc130d9fef5f6abacf9b37a4cd1fe4bb7b58e75004bd0483ec3ec2a2b6a5b3991f520e906c0a87e34ad8809
-  data.tar.gz: 8b4e011d5152f35091002dc317da68e3a290cbed5069bba218e3ef41642d3c281554c3e2f4f7ff91ec756c18147864070f270e433cff23c05de430972fba5834
+  metadata.gz: a96083807968d997553eb00ab15f1432e89d96527a0d8a814902c1410a87ea11232ff9de904a063782f5efad3aa6a35c6d9ddbd169e3e2bf248cd11c0ccd6710
+  data.tar.gz: 111e2d71eb17c5ac1cd4378bc92672eb76ac412dc6943fc29430eeb6aeacda2955f77171347e633e8fa71fef1a803913affb7a0994bb4e6fee6084e75bbdb760

data/.travis.yml

@@ -2,6 +2,9 @@ os:
   - linux
   - osx
 
+# JRuby isn't working on the new default distribution
+dist: trusty
+
 language: ruby
 rvm:
   - 1.8.7

data/CHANGELOG.md

@@ -8,6 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing yet...
 
+
+## [2.0.0] - 2019-02-11
+
+### Changed
+
+ - Step models now include doc strings and tables when determining their equality with other steps. Previously, only the base text of the step was included and the doc string/table was explicitly ignored.
+
+
 ## [1.5.1] - 2019-04-14
 
 ### Added
@@ -269,7 +277,8 @@ Nothing yet...
  - Initial release
 
 
-[Unreleased]: https://github.com/enkessler/cuke_modeler/compare/v1.5.1...HEAD
+[Unreleased]: https://github.com/enkessler/cuke_modeler/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/enkessler/cuke_modeler/compare/v1.5.1...v2.0.0
 [1.5.1]: https://github.com/enkessler/cuke_modeler/compare/v1.5.0...v1.5.1
 [1.5.0]: https://github.com/enkessler/cuke_modeler/compare/v1.4.0...v1.5.0
 [1.4.0]: https://github.com/enkessler/cuke_modeler/compare/v1.3.0...v1.4.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2019 Eric Kessler, et al
+Copyright (c) 2014-2020 Eric Kessler, et al
 
 MIT License
 

data/lib/cuke_modeler/adapters/gherkin_2_adapter.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # An adapter that can convert the output of version 2.x of the *gherkin* gem into input that is consumable by this gem.
 
   class Gherkin2Adapter

data/lib/cuke_modeler/adapters/gherkin_3_adapter.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # An adapter that can convert the output of version 3.x of the *gherkin* gem into input that is consumable by this gem.
 
   class Gherkin3Adapter

data/lib/cuke_modeler/adapters/gherkin_4_adapter.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # An adapter that can convert the output of version 4.x and 5.x of the *gherkin* gem into input that is consumable by this gem.
 
   class Gherkin4Adapter

data/lib/cuke_modeler/adapters/gherkin_6_adapter.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # An adapter that can convert the output of version 6.x of the *gherkin* gem into input that is consumable by this gem.
 
   class Gherkin6Adapter

data/lib/cuke_modeler/containing.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # A mix-in module containing methods used by models that contain other models.
 
   module Containing

data/lib/cuke_modeler/described.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 a description.
 
   module Described

data/lib/cuke_modeler/models/step.rb

@@ -33,9 +33,11 @@ module CukeModeler
     # Returns *true* if the two steps have the same base text (i.e. minus any keyword,
     # table, or doc string and *false* otherwise.
     def ==(other_step)
-      return false unless other_step.respond_to?(:text)
+      return false unless other_step.is_a?(CukeModeler::Step)
 
-      text == other_step.text
+      text_matches?(other_step) &&
+          table_matches?(other_step) &&
+          doc_string_matches?(other_step)
     end
 
     # Returns the model objects that belong to this model.
@@ -65,5 +67,32 @@ module CukeModeler
       parsed_file.first['feature']['elements'].first['steps'].first
     end
 
+    def text_matches?(other_step)
+      text == other_step.text
+    end
+
+    def table_matches?(other_step)
+      return false if (!block.is_a?(CukeModeler::Table) || !other_step.block.is_a?(CukeModeler::Table)) && (block.is_a?(CukeModeler::Table) || other_step.block.is_a?(CukeModeler::Table))
+      return true unless block.is_a?(CukeModeler::Table) && other_step.block.is_a?(CukeModeler::Table)
+
+      first_step_values  = block.rows.collect { |table_row| table_row.cells.map(&:value) }
+      second_step_values = other_step.block.rows.collect { |table_row| table_row.cells.map(&:value) }
+
+      first_step_values == second_step_values
+    end
+
+    def doc_string_matches?(other_step)
+      return false if (!block.is_a?(CukeModeler::DocString) || !other_step.block.is_a?(CukeModeler::DocString)) && (block.is_a?(CukeModeler::DocString) || other_step.block.is_a?(CukeModeler::DocString))
+      return true unless block.is_a?(CukeModeler::DocString) && other_step.block.is_a?(CukeModeler::DocString)
+
+      first_content       = block.content
+      first_content_type  = block.content_type
+      second_content      = other_step.block.content
+      second_content_type = other_step.block.content_type
+
+      (first_content == second_content) &&
+          (first_content_type == second_content_type)
+    end
+
   end
 end

data/lib/cuke_modeler/named.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 a name.
 
   module Named

data/lib/cuke_modeler/nested.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # A mix-in module containing methods used by models that are nested inside
   # of other models.
 

data/lib/cuke_modeler/parsed.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # A mix-in module containing methods used by models that are parsed from source text.
 
   module Parsed

data/lib/cuke_modeler/parsing.rb

@@ -30,6 +30,7 @@ module CukeModeler
         require 'gherkin/gherkin'
         require 'cuke_modeler/adapters/gherkin_6_adapter'
 
+        # NOT A PART OF THE PUBLIC API
         # The method to use for parsing Gherkin text
         def self.parsing_method(source_text, filename)
           messages = Gherkin::Gherkin.from_source(filename, source_text, {:default_dialect => CukeModeler::Parsing.dialect}).to_a
@@ -37,6 +38,7 @@ module CukeModeler
           messages.map(&:to_hash).find { |message| message[:gherkinDocument] }[:gherkinDocument]
         end
 
+        # NOT A PART OF THE PUBLIC API
         # The adapter to use when converting an AST to a standard internal shape
         def self.adapter_class
           CukeModeler::Gherkin6Adapter
@@ -48,12 +50,14 @@ module CukeModeler
 
 
         # todo - make these methods private?
+        # NOT A PART OF THE PUBLIC API
         # The method to use for parsing Gherkin text
         # Filename isn't used by this version of Gherkin but keeping the parameter so that the calling method only has to know one method signature
         def self.parsing_method(source_text, _filename)
           Gherkin::Parser.new.parse(source_text)
         end
 
+        # NOT A PART OF THE PUBLIC API
         # The adapter to use when converting an AST to a standard internal shape
         def self.adapter_class
           CukeModeler::Gherkin4Adapter
@@ -64,12 +68,14 @@ module CukeModeler
         require 'cuke_modeler/adapters/gherkin_3_adapter'
 
 
+        # NOT A PART OF THE PUBLIC API
         # The method to use for parsing Gherkin text
         # Filename isn't used by this version of Gherkin but keeping the parameter so that the calling method only has to know one method signature
         def self.parsing_method(source_text, _filename)
           Gherkin::Parser.new.parse(source_text)
         end
 
+        # NOT A PART OF THE PUBLIC API
         # The adapter to use when converting an AST to a standard internal shape
         def self.adapter_class
           CukeModeler::Gherkin3Adapter
@@ -83,6 +89,7 @@ module CukeModeler
         require 'cuke_modeler/adapters/gherkin_2_adapter'
 
 
+        # NOT A PART OF THE PUBLIC API
         # The method to use for parsing Gherkin text
         def self.parsing_method(source_text, filename)
           io = StringIO.new
@@ -93,6 +100,7 @@ module CukeModeler
           MultiJson.load(io.string)
         end
 
+        # NOT A PART OF THE PUBLIC API
         # The adapter to use when converting an AST to a standard internal shape
         def self.adapter_class
           CukeModeler::Gherkin2Adapter

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.5.1'
+  VERSION = '2.0.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/modeling_steps.rb

@@ -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

@@ -166,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/rspec/spec/integration/models/step_integration_spec.rb

@@ -206,46 +206,140 @@ describe 'Step, Integration' do
 
     describe 'step comparison' do
 
-      it 'is equal to another Step that has the same text' do
-        source_1 = "#{STEP_KEYWORD} a step"
-        source_2 = "#{STEP_KEYWORD} a step"
-        source_3 = "#{STEP_KEYWORD} a different step"
+      context 'a step that has text' do
 
-        step_1 = clazz.new(source_1)
-        step_2 = clazz.new(source_2)
-        step_3 = clazz.new(source_3)
+        let(:step_text) { "#{STEP_KEYWORD} a step" }
+        let(:base_step) { clazz.new(step_text) }
 
+        context 'compared to a step that has the same text' do
 
-        expect(step_1).to eq(step_2)
-        expect(step_1).to_not eq(step_3)
-      end
+          let(:compared_step) { clazz.new(step_text) }
 
-      it 'ignores steps keywords when comparing steps' do
-        source_1 = "#{GIVEN_KEYWORD} a step"
-        source_2 = "#{THEN_KEYWORD}  a step"
+          it 'considers them to be equal' do
+            assert_bidirectional_equality(base_step, compared_step)
+          end
 
-        step_1 = clazz.new(source_1)
-        step_2 = clazz.new(source_2)
+        end
 
+        context 'compared to a step that has different text' do
 
-        expect(step_1).to eq(step_2)
-      end
+          let(:compared_step) { clazz.new(step_text + ' plus some more') }
 
-      it 'ignores step tables when comparing steps' do
-        source_1 = "#{STEP_KEYWORD} a step"
-        source_2 = "#{STEP_KEYWORD} a step\n|with a table|"
+          it 'considers them to not be equal' do
+            assert_bidirectional_inequality(base_step, compared_step)
+          end
 
-        step_1 = clazz.new(source_1)
-        step_2 = clazz.new(source_2)
+        end
 
+        context 'compared to a step that has a table' do
 
-        expect(step_1).to eq(step_2)
-      end
+          let(:compared_step) { clazz.new(step_text + "\n | foo |") }
+
+          it 'considers them to not be equal' do
+            assert_bidirectional_inequality(base_step, compared_step)
+          end
+
+        end
+
+        context 'compared to a step that has a doc string' do
+
+          let(:compared_step) { clazz.new(step_text + "\n \"\"\"\n foo\n\"\"\"") }
+
+          it 'considers them to not be equal' do
+            assert_bidirectional_inequality(base_step, compared_step)
+          end
+
+        end
+
+
+        context 'and has table' do
+
+          let(:step_text) { "#{STEP_KEYWORD} a step\n | foo |" }
+          let(:base_step) { clazz.new(step_text) }
+
+          context 'compared to a step that has the same table' do
+
+            let(:compared_step) { clazz.new(step_text) }
+
+            it 'considers them to be equal' do
+              assert_bidirectional_equality(base_step, compared_step)
+            end
+
+          end
+
+          context 'compared to a step that has a different table' do
 
-      it 'ignores step doc strings when comparing steps' do
-        source_1 = "#{STEP_KEYWORD} a step"
-        source_2 = "#{STEP_KEYWORD} a step\n\"\"\"\nwith a doc string\n\"\"\""
+            let(:compared_step) { clazz.new(step_text + "\n | a different table |") }
 
+            it 'considers them to not be equal' do
+              assert_bidirectional_inequality(base_step, compared_step)
+            end
+
+          end
+
+        end
+
+
+        context 'and has a doc string' do
+
+          let(:content) { 'foo' }
+          let(:base_step) { clazz.new("#{step_text}\n\"\"\"\n#{content}\n\"\"\"") }
+
+          context 'compared to a step that has the same doc string' do
+
+            let(:compared_step) { clazz.new("#{step_text}\n\"\"\"\n#{content}\n\"\"\"") }
+
+            it 'considers them to be equal' do
+              assert_bidirectional_equality(base_step, compared_step)
+            end
+
+          end
+
+          context 'compared to a step that has a different doc string' do
+
+            let(:compared_step) { clazz.new("#{step_text}\n\"\"\"\n#{content + 'different'}\n\"\"\"") }
+
+            it 'considers them to not be equal' do
+              assert_bidirectional_inequality(base_step, compared_step)
+            end
+
+          end
+
+          context 'and has a content type' do
+
+            let(:content_type) { 'foo' }
+            let(:base_step) { clazz.new("#{step_text}\n\"\"\" #{content_type}\n#{content}\n\"\"\"") }
+
+
+            context 'compared to a step that has the same content type' do
+
+              let(:compared_step) { clazz.new("#{step_text}\n\"\"\" #{content_type}\n#{content}\n\"\"\"") }
+
+              it 'considers them to be equal' do
+                assert_bidirectional_equality(base_step, compared_step)
+              end
+
+            end
+
+            context 'compared to a step that has a different content type' do
+
+              let(:compared_step) { clazz.new("#{step_text}\n\"\"\" different #{content_type}\n#{content}\n\"\"\"") }
+
+              it 'considers them to not be equal' do
+                assert_bidirectional_inequality(base_step, compared_step)
+              end
+
+            end
+
+          end
+
+        end
+
+      end
+
+      it 'ignores steps keywords when comparing steps' do
+        source_1 = "#{GIVEN_KEYWORD} a step"
+        source_2 = "#{THEN_KEYWORD}  a step"
 
         step_1 = clazz.new(source_1)
         step_2 = clazz.new(source_2)

data/testing/rspec/spec/spec_helper.rb

@@ -122,4 +122,15 @@ RSpec.configure do |config|
     end
   end
 
+
+  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
+
 end

data/testing/rspec/spec/unit/models/step_unit_spec.rb

@@ -98,7 +98,7 @@ describe 'Step, Unit', :unit_test => true do
 
     it 'can gracefully be compared to other types of objects' do
       # Some common types of object
-      [1, 'foo', :bar, [], {}].each do |thing|
+      [1, 'foo', :bar, [], {}, nil].each do |thing|
         expect { step == thing }.to_not raise_error
         expect(step == thing).to be false
       end

data/todo.txt

@@ -5,8 +5,8 @@ Show less boilerplate code in the documentation
 replace copying raw data during adaptation (all of the Marshal#load/#unload calls) with simply testing that modification never happens in order to increase performance?
 
 
-document helper modules as not part of the public API
 
+# todo - add compatibility with newer versions of Gherkin
 # todo - incorporate cuke_modeler extensions from other projects
 # todo - add plenty of testing around weird and minimal gherkin text for all models
 # todo - add support for `Rule` keyword
@@ -22,3 +22,4 @@ replace joined array source text with single string source text/heredocs
 unit testing around parsing/modeling cases (whitespace, indentation, minimalistic feature elements, etc.)
 replace "\n" usages with the currently set record separator (i.e "\$" )
 make sure that all classes and tests are covered and attaches to code coverage
+- make an actual Gherkin 5 adapter (just inherit from the Gherkin 4 adapter)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_modeler
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-14 00:00:00.000000000 Z
+date: 2020-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -222,6 +222,7 @@ files:
 - lib/cuke_modeler/stepped.rb
 - lib/cuke_modeler/taggable.rb
 - lib/cuke_modeler/version.rb
+- testing/cucumber/features/analysis/step_comparison.feature
 - testing/cucumber/features/analysis/test_comparison.feature
 - testing/cucumber/features/modeling/background_modeling.feature
 - testing/cucumber/features/modeling/background_output.feature