cuke_modeler 1.3.0 → 2.1.0

data/testing/rspec/spec/unit/cuke_modeler_unit_spec.rb

@@ -0,0 +1,25 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+
+describe 'the gem' do
+
+  let(:gemspec) { eval(File.read "#{File.dirname(__FILE__)}/../../../../cuke_modeler.gemspec") }
+
+
+  it 'validates cleanly' do
+    mock_ui = Gem::MockGemUi.new
+    Gem::DefaultUserInteraction.use_ui(mock_ui) { gemspec.validate }
+
+    expect(mock_ui.error).to_not match(/warn/i)
+  end
+
+end
+
+
+describe CukeModeler do
+
+  it "has a version number" do
+    expect(CukeModeler::VERSION).not_to be nil
+  end
+
+end

data/testing/rspec/spec/unit/{background_unit_spec.rb → models/background_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Background, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{cell_unit_spec.rb → models/cell_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Cell, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{comment_unit_spec.rb → models/comment_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Comment, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{directory_unit_spec.rb → models/directory_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Directory, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{doc_string_unit_spec.rb → models/doc_string_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'DocString, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{example_unit_spec.rb → models/example_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Example, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{feature_file_unit_spec.rb → models/feature_file_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'FeatureFile, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{feature_unit_spec.rb → models/feature_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Feature, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{model_unit_spec.rb → models/model_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Model, Unit' do

data/testing/rspec/spec/unit/{outline_unit_spec.rb → models/outline_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Outline, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{row_unit_spec.rb → models/row_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Row, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{scenario_unit_spec.rb → models/scenario_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Scenario, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{step_unit_spec.rb → models/step_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Step, Unit', :unit_test => true do
@@ -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/testing/rspec/spec/unit/{table_unit_spec.rb → models/table_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Table, Unit', :unit_test => true do

data/testing/rspec/spec/unit/{tag_unit_spec.rb → models/tag_unit_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Tag, Unit', :unit_test => true do

data/testing/rspec/spec/unit/shared/containing_models_unit_specs.rb

@@ -22,4 +22,106 @@ shared_examples_for 'a containing model' do
     expect(model.children).to_not include(nil)
   end
 
+  it 'can execute code on all models in its model tree' do
+    expect(model).to respond_to(:each_model)
+  end
+
+  it 'can execute code on all of its descendants' do
+    expect(model).to respond_to(:each_descendant)
+  end
+
+
+  context 'without children' do
+
+    let(:parent_model) do
+      m = clazz.new
+
+      # Not all models have a name, so making sure that this one does
+      def m.name
+        'top level model'
+      end
+
+      # Redefining what children are returned for the model rather than fiddling with all of the different kinds of child models that various model classes have
+      def m.children
+        []
+      end
+
+      m
+    end
+
+
+    it 'executes the provided code on each descendant of the model' do
+      names = []
+
+      parent_model.each_descendant do |descendant_model|
+        names << descendant_model.name
+      end
+
+      expect(names).to be_empty
+    end
+
+    it 'executes the provided code on each model in its tree' do
+      names = []
+
+      parent_model.each_model do |model_node|
+        names << model_node.name
+      end
+
+      expect(names).to match_array(['top level model'])
+    end
+
+  end
+
+
+  context 'with children' do
+
+    let(:parent_model) do
+      m = clazz.new
+
+      # Not all models have a name, so making sure that this one does
+      def m.name
+        'top level model'
+      end
+
+      # Redefining what children are returned for the model rather than fiddling with all of the different kinds of child models that various model classes have
+      def m.children
+        containing_model_stub     = Struct.new(:name, :children)
+        non_containing_model_stub = Struct.new(:name)
+        nested_child_object       = containing_model_stub.new('grandchild object', [])
+        nested_child_object.extend(CukeModeler::Containing)
+
+        non_containing_child_object = non_containing_model_stub.new('child object 1')
+
+        child_object_with_children = containing_model_stub.new('child object 2', [nested_child_object])
+        child_object_with_children.extend(CukeModeler::Containing)
+
+        [non_containing_child_object, child_object_with_children]
+      end
+
+      m
+    end
+
+
+    it 'executes the provided code on each descendant of the model' do
+      names = []
+
+      parent_model.each_descendant do |descendant_model|
+        names << descendant_model.name
+      end
+
+      expect(names).to match_array(['child object 1', 'child object 2', 'grandchild object'])
+    end
+
+    it 'executes the provided code on each model in its tree' do
+      names = []
+
+      parent_model.each_model do |model_node|
+        names << model_node.name
+      end
+
+      expect(names).to match_array(['top level model', 'child object 1', 'child object 2', 'grandchild object'])
+    end
+
+  end
+
 end

data/todo.txt

@@ -5,11 +5,13 @@ 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
+# todo - incorporate new flexibility of `Example` keyword, etc.
+# todo - Have CukeModeler::Parsing.dialect also control the default dialect used by Gherkin
 
 Backlog
 -------------
@@ -20,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.3.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '10.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -62,16 +62,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +156,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 description: This gem facilitates modeling a test suite that is written in Gherkin
   (e.g. Cucumber, SpecFlow, Lettuce, etc.). It does this by providing an abstraction
   layer on top of the Abstract Syntax Tree that the 'gherkin' gem generates when parsing
@@ -171,8 +185,8 @@ files:
 - ".gitignore"
 - ".simplecov"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- History.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -182,6 +196,11 @@ files:
 - lib/cuke_modeler/adapters/gherkin_2_adapter.rb
 - lib/cuke_modeler/adapters/gherkin_3_adapter.rb
 - lib/cuke_modeler/adapters/gherkin_4_adapter.rb
+- lib/cuke_modeler/adapters/gherkin_5_adapter.rb
+- lib/cuke_modeler/adapters/gherkin_6_adapter.rb
+- lib/cuke_modeler/adapters/gherkin_7_adapter.rb
+- lib/cuke_modeler/adapters/gherkin_8_adapter.rb
+- lib/cuke_modeler/adapters/gherkin_9_adapter.rb
 - lib/cuke_modeler/containing.rb
 - lib/cuke_modeler/described.rb
 - lib/cuke_modeler/models/background.rb
@@ -207,6 +226,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
@@ -251,52 +271,65 @@ files:
 - testing/cucumber/step_definitions/tag_steps.rb
 - testing/cucumber/step_definitions/verification_steps.rb
 - testing/cucumber/support/env.rb
-- testing/cucumber/support/transforms.rb
 - testing/dialect_helper.rb
 - testing/file_helper.rb
 - testing/gemfiles/gherkin2.gemfile
 - testing/gemfiles/gherkin3.gemfile
 - testing/gemfiles/gherkin4.gemfile
 - testing/gemfiles/gherkin5.gemfile
-- testing/rspec/spec/integration/background_integration_spec.rb
-- testing/rspec/spec/integration/cell_integration_spec.rb
-- testing/rspec/spec/integration/comment_integration_spec.rb
-- testing/rspec/spec/integration/directory_integration_spec.rb
-- testing/rspec/spec/integration/doc_string_integration_spec.rb
-- testing/rspec/spec/integration/example_integration_spec.rb
-- testing/rspec/spec/integration/feature_file_integration_spec.rb
-- testing/rspec/spec/integration/feature_integration_spec.rb
-- testing/rspec/spec/integration/gherkin_2_adapter_spec.rb
-- testing/rspec/spec/integration/gherkin_3_adapter_spec.rb
-- testing/rspec/spec/integration/gherkin_4_adapter_spec.rb
-- testing/rspec/spec/integration/model_integration_spec.rb
+- testing/gemfiles/gherkin6.gemfile
+- testing/gemfiles/gherkin7.gemfile
+- testing/gemfiles/gherkin8.gemfile
+- testing/gemfiles/gherkin9.gemfile
+- testing/helper_methods.rb
+- testing/rspec/spec/integration/adapters/gherkin_2_adapter_spec.rb
+- testing/rspec/spec/integration/adapters/gherkin_3_adapter_spec.rb
+- testing/rspec/spec/integration/adapters/gherkin_4_adapter_spec.rb
+- testing/rspec/spec/integration/adapters/gherkin_5_adapter_spec.rb
+- testing/rspec/spec/integration/adapters/gherkin_6_adapter_spec.rb
+- testing/rspec/spec/integration/adapters/gherkin_7_adapter_spec.rb
+- testing/rspec/spec/integration/adapters/gherkin_8_adapter_spec.rb
+- testing/rspec/spec/integration/adapters/gherkin_9_adapter_spec.rb
+- testing/rspec/spec/integration/models/background_integration_spec.rb
+- testing/rspec/spec/integration/models/cell_integration_spec.rb
+- testing/rspec/spec/integration/models/comment_integration_spec.rb
+- testing/rspec/spec/integration/models/directory_integration_spec.rb
+- testing/rspec/spec/integration/models/doc_string_integration_spec.rb
+- testing/rspec/spec/integration/models/example_integration_spec.rb
+- testing/rspec/spec/integration/models/feature_file_integration_spec.rb
+- testing/rspec/spec/integration/models/feature_integration_spec.rb
+- testing/rspec/spec/integration/models/model_integration_spec.rb
+- testing/rspec/spec/integration/models/outline_integration_spec.rb
+- testing/rspec/spec/integration/models/row_integration_spec.rb
+- testing/rspec/spec/integration/models/scenario_integration_spec.rb
+- testing/rspec/spec/integration/models/step_integration_spec.rb
+- testing/rspec/spec/integration/models/table_integration_spec.rb
+- testing/rspec/spec/integration/models/tag_integration_spec.rb
 - testing/rspec/spec/integration/nested_integration_spec.rb
-- testing/rspec/spec/integration/outline_integration_spec.rb
 - testing/rspec/spec/integration/parsing_integration_spec.rb
-- testing/rspec/spec/integration/row_integration_spec.rb
-- testing/rspec/spec/integration/scenario_integration_spec.rb
 - testing/rspec/spec/integration/shared/models_integration_specs.rb
-- testing/rspec/spec/integration/step_integration_spec.rb
-- testing/rspec/spec/integration/table_integration_spec.rb
-- testing/rspec/spec/integration/tag_integration_spec.rb
 - testing/rspec/spec/spec_helper.rb
-- testing/rspec/spec/unit/background_unit_spec.rb
-- testing/rspec/spec/unit/cell_unit_spec.rb
-- testing/rspec/spec/unit/comment_unit_spec.rb
+- testing/rspec/spec/unit/cuke_modeler_unit_spec.rb
 - testing/rspec/spec/unit/described_unit_spec.rb
-- testing/rspec/spec/unit/directory_unit_spec.rb
-- testing/rspec/spec/unit/doc_string_unit_spec.rb
-- testing/rspec/spec/unit/example_unit_spec.rb
-- testing/rspec/spec/unit/feature_file_unit_spec.rb
-- testing/rspec/spec/unit/feature_unit_spec.rb
-- testing/rspec/spec/unit/model_unit_spec.rb
+- testing/rspec/spec/unit/models/background_unit_spec.rb
+- testing/rspec/spec/unit/models/cell_unit_spec.rb
+- testing/rspec/spec/unit/models/comment_unit_spec.rb
+- testing/rspec/spec/unit/models/directory_unit_spec.rb
+- testing/rspec/spec/unit/models/doc_string_unit_spec.rb
+- testing/rspec/spec/unit/models/example_unit_spec.rb
+- testing/rspec/spec/unit/models/feature_file_unit_spec.rb
+- testing/rspec/spec/unit/models/feature_unit_spec.rb
+- testing/rspec/spec/unit/models/model_unit_spec.rb
+- testing/rspec/spec/unit/models/outline_unit_spec.rb
+- testing/rspec/spec/unit/models/row_unit_spec.rb
+- testing/rspec/spec/unit/models/scenario_unit_spec.rb
+- testing/rspec/spec/unit/models/step_unit_spec.rb
+- testing/rspec/spec/unit/models/table_unit_spec.rb
+- testing/rspec/spec/unit/models/tag_unit_spec.rb
 - testing/rspec/spec/unit/named_unit_spec.rb
 - testing/rspec/spec/unit/nested_unit_spec.rb
-- testing/rspec/spec/unit/outline_unit_spec.rb
 - testing/rspec/spec/unit/parsed_unit_spec.rb
 - testing/rspec/spec/unit/parsing_unit_spec.rb
-- testing/rspec/spec/unit/row_unit_spec.rb
-- testing/rspec/spec/unit/scenario_unit_spec.rb
 - testing/rspec/spec/unit/shared/bare_bones_models_unit_specs.rb
 - testing/rspec/spec/unit/shared/containing_models_unit_specs.rb
 - testing/rspec/spec/unit/shared/described_models_unit_specs.rb
@@ -311,10 +344,7 @@ files:
 - testing/rspec/spec/unit/shared/stringifiable_models_unit_specs.rb
 - testing/rspec/spec/unit/shared/tagged_models_unit_specs.rb
 - testing/rspec/spec/unit/sourceable_unit_spec.rb
-- testing/rspec/spec/unit/step_unit_spec.rb
 - testing/rspec/spec/unit/stepped_unit_spec.rb
-- testing/rspec/spec/unit/table_unit_spec.rb
-- testing/rspec/spec/unit/tag_unit_spec.rb
 - testing/rspec/spec/unit/taggable_unit_spec.rb
 - testing/test_languages.json
 - todo.txt
@@ -330,7 +360,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -338,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A gem providing functionality to model Gherkin based test suites.