cuke_modeler 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76a8b71aee8bdbf79c8cf429c31fc694edaa85514a5ca5620952b033e8f237cb
-  data.tar.gz: 2a935d1f999d3b0a31a0a72c6b2dd2c4f419a5c79bcbe8bb88e012280bcee06b
+  metadata.gz: 1c06eb0f7c8ad2e127b31d82a1ed6b1d5fcadeb37abbc24ae23fc9d6e2c04b95
+  data.tar.gz: 1e80f3199b425171a1f4fbc0eb386182469f21d242f9594928f4714b42bf3dc1
 SHA512:
-  metadata.gz: 9608da985b4103317a66f4490a32925ec48a084cee57ecb273e4536b5d1fb30564edc0355917f30e9c98e1f2da7531f28242874f85207aeb7f25d5a0835406ee
-  data.tar.gz: 769dbd96bb7c6f079166747666e6a5307e69949e5a9bc3af0d562c1ddac44873bda92a935b32bd3dec3f16bf66c6aaab093eace3534bbab7c30ce15caf1d4cc5
+  metadata.gz: 6e9880c514513eaef025dc5975aa4fa495bdb511d1496bcc4af8eba43931b1b8de57f755f7aed0d01c452e4068d30c88c1e1a73bf01e808e22d97bd7d39f4fae
+  data.tar.gz: 9de23cb51211b1469ddb0dc4e8cbe77eceea3c76aaf0fa2d1edca1bd3b0f16971578e58633b41f14e0f773f8f57efa9c246031215bf14262e78c358d6ace460c

data/.travis.yml

@@ -6,8 +6,10 @@ language: ruby
 rvm:
   - 1.8.7
   - 1.9.3
-  - 2.3.3
-  - 2.4.0
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
   - jruby-9.1.7.0
 
 gemfile:
@@ -35,6 +37,11 @@ matrix:
   - rvm: 1.9.3
     gemfile: testing/gemfiles/gherkin6.gemfile
 
+  # TODO: use once protobuf is updated
+  # gherkin 6.x uses protobuf, which does not work with Ruby 2.6.x
+  - rvm: 2.6.0
+    gemfile: testing/gemfiles/gherkin6.gemfile
+
   # TODO: turn this back on
   # gherkin 6.x relies on 'google-protobuf', which does not currently work on JRuby (https://github.com/protocolbuffers/protobuf/issues/1594)
   - rvm: jruby-9.1.7.0
@@ -47,8 +54,7 @@ matrix:
   - rvm: 1.9.3
     os: osx
 
-# todo - Remove this once TravisCI fixes their bundler issue (https://github.com/alphagov/govuk_template/pull/186)
 before_install:
-  - gem install bundler -v 1.9.10
+  - gem install bundler -v '< 2'
 
 script: bundle exec rake cuke_modeler:ci_build

data/History.md

@@ -1,3 +1,8 @@
+### Version 1.5.0 / 2019-01-13
+
+* Added methods to easily run elements of an arbitrarily rooted model tree through a given block of code.
+
+
 ### Version 1.4.0 / 2018-11-14
 
 * Now compatible with Gherkin 6.x.

data/LICENSE.txt

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

data/README.md

@@ -1,5 +1,4 @@
 [![Gem Version](https://badge.fury.io/rb/cuke_modeler.svg)](https://rubygems.org/gems/cuke_modeler)
-[![Dependency Status](https://gemnasium.com/enkessler/cuke_modeler.svg)](https://gemnasium.com/enkessler/cuke_modeler)
 [![Build Status](https://travis-ci.org/enkessler/cuke_modeler.svg?branch=dev)](https://travis-ci.org/enkessler/cuke_modeler)
 [![Build status](https://ci.appveyor.com/api/projects/status/is8xqvoqn3pjh9l0/branch/dev?svg=true)](https://ci.appveyor.com/project/enkessler/cuke-modeler/branch/dev)
 [![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_modeler/badge.svg?branch=dev)](https://coveralls.io/github/enkessler/cuke_modeler?branch=dev)
@@ -18,7 +17,7 @@ the rescue by providing a modeling layer that is easier to work with.
  
 Whether you just want something that will let you easily inspect your test 
 suite or you are looking for a foundation tool upon which to build something 
-Really Neat, this gem has you covered.
+[Really Neat](#projects), this gem has you covered.
 
 
 ## Installation
@@ -108,12 +107,13 @@ that feature is ultimately run with SpecFlow (Cucumber for C#), Lettuce
 (Cucumber for Python), or some other flavor of Cucumber. 
 
 
-### Other gems that are (or soon will be) powered by **cuke_modeler**
+### <a id="projects"></a>Other gems that are powered by **cuke_modeler**
 
   * [cql](https://github.com/enkessler/cql)
   * [cuketagger](https://github.com/enkessler/cuketagger)
   * [cuke_cataloger](https://github.com/enkessler/cuke_cataloger)
   * [cuke_slicer](https://github.com/grange-insurance/cuke_slicer)
+  * [cuke_linter](https://github.com/enkessler/cuke_linter)
 
 
 ## Contributing

data/appveyor.yml

@@ -4,28 +4,46 @@ environment:
   matrix:
 
       # Gherkin 2.x does not appear to support 32-bit Ruby 2.x and it's not worth it to investigate if this is true or not
-    - RUBY_VERSION: 23-x64
+    - RUBY_VERSION: 24-x64
+      BUNDLE_GEMFILE: testing/gemfiles/gherkin2.gemfile
+    - RUBY_VERSION: 25-x64
       BUNDLE_GEMFILE: testing/gemfiles/gherkin2.gemfile
 
-    - RUBY_VERSION: 23
+    - RUBY_VERSION: 24
+      BUNDLE_GEMFILE: testing/gemfiles/gherkin3.gemfile
+    - RUBY_VERSION: 24-x64
+      BUNDLE_GEMFILE: testing/gemfiles/gherkin3.gemfile
+    - RUBY_VERSION: 25
       BUNDLE_GEMFILE: testing/gemfiles/gherkin3.gemfile
-    - RUBY_VERSION: 23-x64
+    - RUBY_VERSION: 25-x64
       BUNDLE_GEMFILE: testing/gemfiles/gherkin3.gemfile
 
-    - RUBY_VERSION: 23
+    - RUBY_VERSION: 24
+      BUNDLE_GEMFILE: testing/gemfiles/gherkin4.gemfile
+    - RUBY_VERSION: 24-x64
+      BUNDLE_GEMFILE: testing/gemfiles/gherkin4.gemfile
+    - RUBY_VERSION: 25
       BUNDLE_GEMFILE: testing/gemfiles/gherkin4.gemfile
-    - RUBY_VERSION: 23-x64
+    - RUBY_VERSION: 25-x64
       BUNDLE_GEMFILE: testing/gemfiles/gherkin4.gemfile
 
-    - RUBY_VERSION: 23
+    - RUBY_VERSION: 24
       BUNDLE_GEMFILE: testing/gemfiles/gherkin5.gemfile
-    - RUBY_VERSION: 23-x64
+    - RUBY_VERSION: 24-x64
+      BUNDLE_GEMFILE: testing/gemfiles/gherkin5.gemfile
+    - RUBY_VERSION: 25
+      BUNDLE_GEMFILE: testing/gemfiles/gherkin5.gemfile
+    - RUBY_VERSION: 25-x64
       BUNDLE_GEMFILE: testing/gemfiles/gherkin5.gemfile
 
       # Gherkin 6.x requires at least Ruby 2.2
-    - RUBY_VERSION: 23
+    - RUBY_VERSION: 24
+      BUNDLE_GEMFILE: testing/gemfiles/gherkin6.gemfile
+    - RUBY_VERSION: 24-x64
+      BUNDLE_GEMFILE: testing/gemfiles/gherkin6.gemfile
+    - RUBY_VERSION: 25
       BUNDLE_GEMFILE: testing/gemfiles/gherkin6.gemfile
-    - RUBY_VERSION: 23-x64
+    - RUBY_VERSION: 25-x64
       BUNDLE_GEMFILE: testing/gemfiles/gherkin6.gemfile
 
 install:

data/cuke_modeler.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('json', '>= 1.0', '< 3.0')
   spec.add_runtime_dependency('multi_json', '~> 1.0')
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", '< 13.0.0'
   spec.add_development_dependency 'cucumber', '< 5.0.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/cuke_modeler/containing.rb

@@ -4,6 +4,19 @@ module CukeModeler
 
   module Containing
 
+    def each_descendant(&block)
+      children.each do |child_model|
+        block.call(child_model)
+        child_model.each_descendant(&block) if child_model.respond_to?(:each_descendant)
+      end
+    end
+
+    def each_model(&block)
+      block.call(self)
+
+      each_descendant(&block)
+    end
+
 
     private
 

data/lib/cuke_modeler/parsing.rb

@@ -44,8 +44,9 @@ module CukeModeler
         require 'gherkin/parser'
         require 'cuke_modeler/adapters/gherkin_4_adapter'
 
-        # TODO: shouldn't the filename be used?
+
         # todo - make these methods private?
+        # 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
@@ -59,6 +60,7 @@ module CukeModeler
         require 'cuke_modeler/adapters/gherkin_3_adapter'
 
 
+        # 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
@@ -89,7 +91,6 @@ module CukeModeler
         end
 
       else
-        # TODO: test this
         raise("Unknown Gherkin version: '#{gherkin_version}'")
     end
 

data/lib/cuke_modeler/version.rb

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

data/testing/gemfiles/gherkin5.gemfile

@@ -16,6 +16,7 @@ if RUBY_VERSION =~ /^1\./
   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/rspec/spec/integration/parsing_integration_spec.rb

@@ -9,7 +9,16 @@ describe 'Parsing, Integration' do
   describe 'unique behavior' do
 
     it 'will complain if using an unknown version of `gherkin`' do
-      skip('finish me')
+      original_version = Gem.loaded_specs['gherkin'].version
+      unknown_version  = Gem::Version.new('0.0.0')
+
+      begin
+        Gem.loaded_specs['gherkin'].instance_variable_set(:@version, unknown_version)
+
+        expect { load "#{File.dirname(__FILE__)}/../../../../lib/cuke_modeler/parsing.rb" }.to raise_error("Unknown Gherkin version: '0.0.0'")
+      ensure
+        Gem.loaded_specs['gherkin'].instance_variable_set(:@version, original_version)
+      end
     end
 
     it 'loads the correct dialects based on the version of Gherkin used', :gherkin6 => true do
@@ -68,6 +77,10 @@ describe 'Parsing, Integration' do
       expect { nodule.parse_text('bad file', 'file foo.txt') }.to raise_error(/'file foo\.txt'/)
     end
 
+    it 'has a default file name used while parsing if one is not provided' do
+      expect { nodule.parse_text('bad file') }.to raise_error(ArgumentError, /'cuke_modeler_fake_file\.feature'/)
+    end
+
     it 'includes the underlying error message in the error that it raises' do
       begin
         $old_method = CukeModeler::Parsing.method(:parsing_method)
@@ -104,14 +117,6 @@ describe 'Parsing, Integration' do
 
     end
 
-    it 'has a default file name if one is not provided' do
-      expect { nodule.parse_text('bad file') }.to raise_error(ArgumentError, /'cuke_modeler_fake_file\.feature'/)
-    end
-
-    it 'uses the given file name if one is provided' do
-      skip('finish me')
-    end
-
   end
 
 end

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_modeler
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2019-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -62,16 +62,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement