cuke_modeler 1.3.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f6ce507c3e4cce81b178759608f8421995acb33
-  data.tar.gz: 28e38d785382112db34e4bd8ad21c2ab2d520fb2
+SHA256:
+  metadata.gz: 1e45af46cbcc095433e4bf40fd868daed964bbbc53dac06d3d3de6ca6a4c2db1
+  data.tar.gz: 36e8660c3f4e993732113f79979168ac59b1bd33c35e8722fc06abdf4e54ce85
 SHA512:
-  metadata.gz: 6468b515b7f55540cf96319c3862ef04d7560b583294a694c71a3077becc915516465dec013e414c24d05b6fe8cfa0ef37844b4eab23dc1f62068b876b0fa17c
-  data.tar.gz: c636a5d624e5ad31be581134f0429bf63cd2d52bbef6a0278c5484ac8a2d0e18519e0d372051d5de44f4a012959dd7d93801559eda4f693e44247b779dd0c210
+  metadata.gz: 39109727b23ffbed1015bc7d690367a10c8f8a88e12d099ba973fcd722cfc5fd0f15e9c5dfeef4a61793850b75a46feb9933f1bba66845cb7ccd72c323d26c36
+  data.tar.gz: 11848c5307c7da2a0669e80dfef83cf535ba1259e3c04d05897b12ab5057760419f239ff7eaaebbc37fec33e7610cc11c771f81128d05f7a779794ad70770978

data/.travis.yml

@@ -2,12 +2,17 @@ os:
   - linux
   - osx
 
+# JRuby isn't working on the new default distribution
+dist: trusty
+
 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:
@@ -15,24 +20,62 @@ gemfile:
   - testing/gemfiles/gherkin3.gemfile
   - testing/gemfiles/gherkin4.gemfile
   - testing/gemfiles/gherkin5.gemfile
+  - testing/gemfiles/gherkin6.gemfile
+  - testing/gemfiles/gherkin7.gemfile
+  - testing/gemfiles/gherkin8.gemfile
+  - testing/gemfiles/gherkin9.gemfile
 
 matrix:
   exclude:
-  # gherkin 3.x does not work with Ruby 1.8.x
-  - rvm: 1.8.7
-    gemfile: testing/gemfiles/gherkin3.gemfile
-  # gherkin 4.x does not work with Ruby 1.8.x
-  - rvm: 1.8.7
-    gemfile: testing/gemfiles/gherkin4.gemfile
-  # gherkin 5.x does not work with Ruby 1.8.x
-  - rvm: 1.8.7
-    gemfile: testing/gemfiles/gherkin5.gemfile
-  # Travis does not provide 1.8.7 on OSX
-  - rvm: 1.8.7
-    os: osx
-
-# todo - Remove this once TravisCI fixes their bundler issue (https://github.com/alphagov/govuk_template/pull/186)
+
+    # gherkin 3.x+ does not work with Ruby 1.8.x
+    - rvm: 1.8.7
+      gemfile: testing/gemfiles/gherkin3.gemfile
+    - rvm: 1.8.7
+      gemfile: testing/gemfiles/gherkin4.gemfile
+    - rvm: 1.8.7
+      gemfile: testing/gemfiles/gherkin5.gemfile
+    - rvm: 1.8.7
+      gemfile: testing/gemfiles/gherkin6.gemfile
+    - rvm: 1.8.7
+      gemfile: testing/gemfiles/gherkin7.gemfile
+    - rvm: 1.8.7
+      gemfile: testing/gemfiles/gherkin8.gemfile
+    - rvm: 1.8.7
+      gemfile: testing/gemfiles/gherkin9.gemfile
+
+    # gherkin 6.x+ does not work with Ruby 1.9.x
+    - rvm: 1.9.3
+      gemfile: testing/gemfiles/gherkin6.gemfile
+    - rvm: 1.9.3
+      gemfile: testing/gemfiles/gherkin7.gemfile
+    - rvm: 1.9.3
+      gemfile: testing/gemfiles/gherkin8.gemfile
+    - rvm: 1.9.3
+      gemfile: testing/gemfiles/gherkin9.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
+      gemfile: testing/gemfiles/gherkin6.gemfile
+    - rvm: jruby-9.1.7.0
+      gemfile: testing/gemfiles/gherkin7.gemfile
+    - rvm: jruby-9.1.7.0
+      gemfile: testing/gemfiles/gherkin8.gemfile
+    - rvm: jruby-9.1.7.0
+      gemfile: testing/gemfiles/gherkin9.gemfile
+
+    # Travis does not provide 1.8.7 on OSX
+    - rvm: 1.8.7
+      os: osx
+    # Travis does not provide 1.9.3 on OSX
+    - rvm: 1.9.3
+      os: osx
+    # Ruby 2.3.x is currently broken on TravisCI for OSX and is no longer a supported Ruby version, anyway.
+    - rvm: 2.3.8
+      os: osx
+
 before_install:
-  - gem install bundler -v 1.9.10
+  - gem install bundler -v '< 2'
 
 script: bundle exec rake cuke_modeler:ci_build

data/CHANGELOG.md

@@ -0,0 +1,312 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Nothing yet...
+
+## [2.1.0] - 2020-05-27
+
+### Added
+ - Support added for more versions of the `gherkin` gem
+   - 9.x
+   - 8.x
+   - 7.x
+
+### Fixed
+ - Parsing errors are now correctly bubbled up when using Gherkin 6.x
+
+## [2.0.0] - 2020-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
+
+ - Add dependency version limits to Ruby which was previously unbound
+ - Add dependency version limits to `bundler`, which was previously unbound
+ - Added inline documentation to some methods that did not have any
+
+## [1.5.0] - 2019-01-13
+
+### Added
+
+ - Added methods to easily run elements of an arbitrarily rooted model tree through a given block of code.
+
+
+## [1.4.0] - 2018-11-14
+
+### Added
+
+ - Now compatible with Gherkin 6.x.
+
+
+## [1.3.0] - 2017-10-19
+
+### Added
+
+ - Now compatible with Gherkin 5.x.
+
+
+## [1.2.1] - 2017-04-25
+
+### Added
+
+ - Now officially compatible with Rake 12.x.
+
+
+## [1.2.0] - 2016-11-23
+
+### Added
+
+ - The comments in a feature file are now a modeled element.
+
+
+## [1.1.1] - 2016-10-28
+
+### Fixed
+
+ - Abstract instantiation of models when using a non-default dialect 
+   now works correctly.
+
+
+## [1.1.0] - 2016-10-28
+
+### Added
+
+ - Support added for non-English dialects. This gem should now be able to model 
+   feature files using any dialect supported by the 'gherkin' gem.
+
+ - Models for elements of Gherkin that have keywords (e.g. 'Feature', 'Scenario', 
+   'Examples') now keep track of the keyword used by the element that they model.
+
+### Fixed
+
+ - Fixed a bug that was causing example models to output extra newline 
+   characters under certain circumstances. 
+
+
+## [1.0.4] - 2016-10-07
+
+### Fixed
+
+ - Fixed a bug that caused some models to include nil objects in their 
+   children collection if they did not have the relevant child object.
+
+
+## [1.0.3] - 2016-09-12
+
+### Fixed
+
+ - Fixed a gem dependency that was accidentally declared with '<=' instead of '<'.
+
+
+## [1.0.2] - 2016-09-12
+
+### Added
+
+ - A more detailed gem description and summary have been added to the gemspec.
+
+ - The gem now declares version limits on its dependencies.
+ 
+ - Badges for the current status of the project have been added to the Readme.
+
+
+## [1.0.1] - 2016-09-10
+
+### Added
+
+ - In the Readme file, added a link to the published documentation.
+
+
+## [1.0.0] - 2016-09-08
+
+### Added
+
+ - Background models can now be compared to other models that have steps (i.e. 
+   scenarios and outlines).
+
+ - Added specific ancestor types for scenario, outline, and background models as 
+   alternatives to the generic 'test' ancestor type.
+
+
+### Changed
+
+ -  A base model class has been added in order to simplify adding new element 
+   models. Other classes and modules used for organizing common model behavior 
+   have been created/removed/renamed.
+
+ - All modeled elements of a Cucumber test suite are now modeled with actual 
+   classes. Previously, some elements (such as tags or rows in an example table) 
+   were modeled with simple strings.
+
+ - Feature file models now only have a single feature model instead of a 
+   collection of them (that would only ever have one item in it).
+
+ - Rows in an example table and rows in a step table no longer use two different 
+   classes for modeling.
+
+ - All models for Gherkin elements now track the line number from which they 
+   originate in a source file.
+
+ - The source line of a model is now a mutable attribute instead of being read 
+   only.
+
+ - The file path of a feature file is now a mutable attribute instead of being 
+   read only.
+
+ - Standardized the initial values of the attributes of abstractly created 
+   models so that they are consistent across model types.
+
+ - Extra whitespace around parsed element descriptions is now trimmed away 
+   before being stored in a model.
+  
+ - Adding rows to examples via hashes can now be done without regard to the 
+   order of the keys in the hash. The correct order can be determined by the 
+   model.
+
+ - The saved parsing data that is generated by the 'gherkin' gem is no longer 
+   duplicated for each model, resulting in significantly less memory usage.
+
+ - Various methods have been renamed.
+
+
+### Removed
+
+ - Removed the backdoor used to pass around model data during the model creation 
+   process. Model input can now only be text.
+
+ - Simple counting methods have been removed. Ruby's collection methods are just 
+   as easy to use directly when dealing with classes that contain collections 
+   and the removal of these counting methods simplifies the codebase.
+
+ - The 'World' module has been removed. The scope of this gem is to model files 
+   written in Gherkin. Concepts like 'step definitions' and 'hooks' are better 
+   left to libraries that include (possibly programming language specific) test 
+   execution logic within their scope of concern.
+
+ - Step models no longer have 'arguments' because they require the concept of 
+   step definitions, which are no longer within the scope of this gem.
+
+ - Removed deprecated behavior
+     - Marked
+         - Doc strings no longer use an array of strings to model their content
+         - Tables no longer use nested arrays of strings to model their rows
+         - Models that have descriptions no longer use an array of strings to 
+           model their description
+         - The convenient (read: awkward) #step_text has been removed.
+     - Unmarked
+         - Examples no longer use an array of hashes to model their rows
+
+
+### Fixed
+
+ - String output of models has been improved. More special characters in Gherkin 
+   (e.g. vertical bars in rows) are appropriately escaped in the string output 
+   of a model and several minor bugs related to using model string output as the 
+   input text for new models have been fixed.
+
+
+## [0.4.1] - 2016-05-12
+
+### Added
+
+ - Increased the flexibility of input when adding rows to an Example object. Non-
+   string values can now be used as input and they will be converted into 
+   strings. Original input objects are not modified.
+
+ - Added some error checking around adding value rows to an Example object 
+   without adding a parameter row as well.
+
+
+## [0.4.0] - 2016-05-01
+
+### Added
+
+ - The path of a Directory object is now a changeable attribute instead of only 
+   being populated if the instance was given a diretory to model.
+
+### Fixed
+
+ - Fixed a bug that occurred if a Directory object was asked for its 
+   `#name` when it was created as 'abstract' instead of modeling an existing 
+   directory.
+
+
+## [0.3.0] - 2016-04-24
+
+### Added
+
+ - Support for version 4.x of the 'gherkin' gem added.
+
+### Fixed
+
+ - Fixed a bug that was preventing Example objects from being created 
+   from text if that text had less Gherkin structure than normal.
+
+
+## [0.2.0] - 2016-02-21
+
+### Added
+
+ - Better error feedback when parsing errors are encountered. It is now easier 
+   to tell which file contained invalid Gherkin.
+
+
+## [0.1.0] - 2016-02-10
+
+### Added
+
+ - Support for version 3.x of the 'gherkin' gem added.
+
+### Fixed
+
+ - The saved parsing data that is generated by the 'gherkin' gem is no 
+   longer modified by the rest of the model creation process.
+
+
+## [0.0.2] - 2015-11-22
+
+### Fixed
+
+ - Fixed a bug that was causing object comparison using #== to not 
+   work when comparing some models to other types of objects.
+
+
+## [0.0.1] - 2014-06-02
+
+### Added
+
+ - Initial release
+
+
+[Unreleased]: https://github.com/enkessler/cuke_modeler/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/enkessler/cuke_modeler/compare/v2.0.0...v2.1.0
+[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
+[1.3.0]: https://github.com/enkessler/cuke_modeler/compare/v1.2.1...v1.3.0
+[1.2.1]: https://github.com/enkessler/cuke_modeler/compare/v1.2.0...v1.2.1
+[1.2.0]: https://github.com/enkessler/cuke_modeler/compare/v1.1.1...v1.2.0
+[1.1.1]: https://github.com/enkessler/cuke_modeler/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/enkessler/cuke_modeler/compare/v1.0.4...v1.1.0
+[1.0.4]: https://github.com/enkessler/cuke_modeler/compare/v1.0.3...v1.0.4
+[1.0.3]: https://github.com/enkessler/cuke_modeler/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/enkessler/cuke_modeler/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/enkessler/cuke_modeler/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/enkessler/cuke_modeler/compare/v0.4.1...v1.0.0
+[0.4.1]: https://github.com/enkessler/cuke_modeler/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/enkessler/cuke_modeler/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/enkessler/cuke_modeler/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/enkessler/cuke_modeler/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/enkessler/cuke_modeler/compare/v0.0.2...v0.1.0
+[0.0.2]: https://github.com/enkessler/cuke_modeler/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/enkessler/cuke_modeler/compare/ce627fb591966c9ef19a9e69338b1282e9902a0d...v0.0.1

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in cuke_modeler.gemspec
 gemspec
@@ -7,6 +7,11 @@ gemspec
 
 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
@@ -14,15 +19,26 @@ if RUBY_VERSION =~ /^1\./
   if RUBY_VERSION =~ /^1\.8/
     gem 'cucumber', '~> 1.0' # Ruby 1.8.x support dropped after this version
     gem 'gherkin', '< 2.12.1' # 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
+    gem 'mime-types', '< 2.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
+    gem 'cucumber', '< 3.0.0' # Ruby 1.9.x support dropped after this version
+    gem 'rainbow', '< 3.0' # Ruby 1.9.x support dropped after this version
+    gem 'mime-types', '< 3.0' # Ruby 1.x support dropped after this version
   end
 
+  gem 'simplecov', '< 0.18' # Ruby 1.x support dropped after this version
+  gem 'thor', '< 1.0' # Ruby 1.x support dropped after this version
 elsif RUBY_VERSION =~ /^2\./
 
   if RUBY_VERSION =~ /^2\.[23456789]/
     gem 'test-unit'
   end
 
-  gem 'gherkin', '~> 5.0'
-
 end
+
+# Note: When testing against 6.x, the latest version (6.0.17) is missing an executable for Windows 64-bit
+# gem 'gherkin', '>= 6.0', '< 6.0.17'
+gem 'gherkin', '~> 9.0'