cuke_modeler 1.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76a8b71aee8bdbf79c8cf429c31fc694edaa85514a5ca5620952b033e8f237cb
-  data.tar.gz: 2a935d1f999d3b0a31a0a72c6b2dd2c4f419a5c79bcbe8bb88e012280bcee06b
+  metadata.gz: 12a7bac33e0fe407f250239e15637b732497d9d106893ae9d08943bb2497821c
+  data.tar.gz: 26e6cf550dfdec1f87109651d73c01f403a97235277497ea7dc09017448a9a7c
 SHA512:
-  metadata.gz: 9608da985b4103317a66f4490a32925ec48a084cee57ecb273e4536b5d1fb30564edc0355917f30e9c98e1f2da7531f28242874f85207aeb7f25d5a0835406ee
-  data.tar.gz: 769dbd96bb7c6f079166747666e6a5307e69949e5a9bc3af0d562c1ddac44873bda92a935b32bd3dec3f16bf66c6aaab093eace3534bbab7c30ce15caf1d4cc5
+  metadata.gz: 129e84d0e7d10a7b217c040d7f6cab3590096e76345f679f61a51b3833c0c771fbb2299d997fd319851042d4a40bb2990310112d7fa8836d260ff91107d760cd
+  data.tar.gz: 7dd7f4ebd77a9c9b898f4f07fcd33fe1e9216205b9d745ce7da5cff54dc6ba5febe6ed129594287d2c006165ef08a9717c88710b5cae346d15fe98c3e90844fe

data/CHANGELOG.md

@@ -0,0 +1,329 @@
+# 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...
+
+## [3.0.0] - 2020-06-08
+
+### Changed
+ - This gem now wraps the `cucumber-gherkin` gem instead of the `gherkin` gem, now that `cucumber-gherkin` has superseded `gherkin`.
+ - Support for versions of Ruby earlier than 2.3 has been dropped due to that being the minimum required version of Ruby required by the `cucumber-gherkin` gem.
+ - When using the parsing functionality provided by this gem, the standardized AST returned when parsing Gherkin text is now returned directly as a Hash instead of also being wrapped in an array. The array was an artifact of basing the AST on the earliest versions of `gherkin` that were supported.
+ - No longer including every file in the Git repository as part of the gem. Only the files needed for using the gem (and the informative ones like the README) will be packaged into the released gem.
+
+### Added
+ - Support added for more versions of the `cucumber-gherkin` gem
+   - 13.x
+   - 12.x
+   - 11.x
+   - 10.x
+   - 9.x
+
+## [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/v3.0.0...HEAD
+[3.0.0]: https://github.com/enkessler/cuke_modeler/compare/v2.1.0...v3.0.0
+[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/LICENSE.txt

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

data/README.md

@@ -1,24 +1,33 @@
+Basic stuff:
 [![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)
-[![Code Quality](https://codeclimate.com/github/enkessler/cuke_modeler/badges/gpa.svg)](https://codeclimate.com/github/enkessler/cuke_modeler)
 [![Project License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/mit-license.php)
+[![Downloads](https://img.shields.io/gem/dt/cuke_modeler.svg)](https://rubygems.org/gems/cuke_modeler)
 
+User stuff:
+[![Cucumber Docs](http://img.shields.io/badge/Documentation-Features-green.svg)](https://app.cucumber.pro/projects/cuke_modeler)
+[![Yard Docs](http://img.shields.io/badge/Documentation-API-blue.svg)](https://www.rubydoc.info/gems/cuke_modeler)
+
+Developer stuff:
+[![Build Status](https://travis-ci.org/enkessler/cuke_modeler.svg)](https://travis-ci.org/enkessler/cuke_modeler)
+[![Build status](https://ci.appveyor.com/api/projects/status/is8xqvoqn3pjh9l0?svg=true)](https://ci.appveyor.com/project/enkessler/cuke-modeler)
+[![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_modeler/badge.svg)](https://coveralls.io/github/enkessler/cuke_modeler)
+[![Maintainability](https://api.codeclimate.com/v1/badges/83986d8f7a918fed9707/maintainability)](https://codeclimate.com/github/enkessler/cuke_modeler/maintainability)
+[![Inline docs](http://inch-ci.org/github/enkessler/cuke_modeler.svg)](https://inch-ci.org/github/enkessler/cuke_modeler)
+
+---
 
 # CukeModeler
 
 There comes a time in every programmer's adventures with Cucumber when they 
 want to do Really Cool Stuff with their tests. This usually necessitates 
 scanning all of their feature files and playing with the output. While the 
-**[gherkin](https://github.com/cucumber/gherkin)** gem does a fine job of parsing feature files, reading or even manipulating 
+**[cucumber-gherkin](https://github.com/cucumber/cucumber/tree/master/gherkin)** gem does a fine job of parsing feature files, reading or even manipulating 
 the resulting Abstract Syntax Tree is not always fun. **cuke_modeler** comes to 
 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
@@ -74,7 +83,7 @@ One could, if so inclined, use this method to dynamically edit or even create
 an entire test suite!
 
 For more information on the different models and how to use them, see the 
-[documentation](http://www.relishapp.com/enkessler/CukeModeler/docs).
+[documentation](https://app.cucumber.pro/projects/cuke_modeler).
 
 ## Modeling dialects other than English
 
@@ -108,21 +117,19 @@ 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)
+
+
+## Development and Contributing
 
+See [CONTRIBUTING.md](https://github.com/enkessler/cuke_modeler/blob/master/CONTRIBUTING.md)
 
-## Contributing
+## License
 
-1. Fork it
-2. Create your feature branch (off of the development branch)
-   `git checkout -b my-new-feature`
-3. Commit your changes
-   `git commit -am 'Add some feature'`
-4. Push to the branch
-   `git push origin my-new-feature`
-5. Create new Pull Request
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/cuke_modeler.gemspec

@@ -9,24 +9,30 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Eric Kessler"]
   spec.email         = ["morrow748@gmail.com"]
   spec.summary       = %q{A gem providing functionality to model Gherkin based test suites.}
-  spec.description   = %q{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 features, as well as providing models for feature files and directories in order to be able to have a fully traversable model tree of a test suite's structure. These models can then be analyzed or manipulated more easily than the underlying AST layer.}
+  spec.description   = %q{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 'cucumber-gherkin' gem generates when parsing features, as well as providing models for feature files and directories in order to be able to have a fully traversable model tree of a test suite's structure. These models can then be analyzed or manipulated more easily than the underlying AST layer.}
   spec.homepage      = 'https://github.com/enkessler/cuke_modeler'
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('', __dir__)) do
+    source_controlled_files = `git ls-files -z`.split("\x0")
+    source_controlled_files.keep_if { |file| file =~ %r{^(lib|testing/cucumber/features)} }
+    source_controlled_files + ['README.md', 'LICENSE.txt', 'CHANGELOG.md', 'cuke_modeler.gemspec']
+  end
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'gherkin', '< 7.0'
-  spec.add_runtime_dependency('json', '>= 1.0', '< 3.0')
-  spec.add_runtime_dependency('multi_json', '~> 1.0')
+  spec.required_ruby_version = '>= 2.3', '< 3.0'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_runtime_dependency 'cucumber-gherkin', '< 14.0'
+
+  spec.add_development_dependency 'bundler', '< 3.0'
   spec.add_development_dependency "rake", '< 13.0.0'
   spec.add_development_dependency 'cucumber', '< 5.0.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '< 1.0.0'
+  spec.add_development_dependency 'simplecov', '<= 0.16.1'
   spec.add_development_dependency 'racatt', '~> 1.0'
   spec.add_development_dependency 'coveralls', '< 1.0.0'
+  spec.add_development_dependency 'rainbow', '< 4.0.0'
+  spec.add_development_dependency 'test-unit', '< 4.0.0'
 end