cuke_modeler 3.20.0 → 3.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db68bd0813ac0151f45f174d89c95c5accb2c11a77df2321f859d18f62ecf06f
-  data.tar.gz: 5d9b7ee4ea5c98a8e90d4d8d6d657223150064be4e867a8ef444eb93b357a195
+  metadata.gz: 1cfecfdb9d15e82e2c516e0fdd8787391258b0b7b17278fb06832a3caaf1ade2
+  data.tar.gz: 055c7e2c74c325fedc1b4b5a89594733276b44b1585ff1bf98eec0da5715b48d
 SHA512:
-  metadata.gz: a166c272417d15db4e3a04dcfb2057c0536a8412e7bce5810b9885998823d354667b42dbf9a49796d73498f469c1978779ea8a518ccd1ed92d2c9f6985c69f5e
-  data.tar.gz: c24f43b46820b37f16a0bf476e48d86c2a159ebc6b6a2b87da3194d7c6e0496b0ed25c7698a83c8a5f4bb1bc5fd77503c188492a19c3b8403298e994b03a5dab
+  metadata.gz: a21c007aeff0f702eaed164c2e9d27beed205532c2a0855aef90816ad61da1bc6658ee42df01319bea8d058ff49dab8872f74a6e35849601f2f68b1d2d40a67d
+  data.tar.gz: 36b498a0d7e1bb9bbf004a0b906ba4adc23f7cc1b895c7ecaba1dd76c5f575d351042c307d8f1807454faf0747495c32b3fea4d20633e74eb75f497702ec0e13

data/CHANGELOG.md

@@ -9,6 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Nothing yet...
 
 
+## [3.20.1] - 2023-10-16
+
+### Changed
+ - Finally made various parts of the codebase private in the Ruby sense of the word instead of only 
+   being marked as private by comments. Not a breaking change because the stuff was already declared to 
+   be not part of the public API.
+
+ - Improved code documentation by making more use of YARD tags.
+
+
 ## [3.20.0] - 2023-9-21
 
 ### Added
@@ -455,7 +465,8 @@ Nothing yet...
  - Initial release
 
 
-[Unreleased]: https://github.com/enkessler/cuke_modeler/compare/v3.20.0...HEAD
+[Unreleased]: https://github.com/enkessler/cuke_modeler/compare/v3.20.1...HEAD
+[3.20.1]: https://github.com/enkessler/cuke_modeler/compare/v3.20.0...v3.20.1
 [3.20.0]: https://github.com/enkessler/cuke_modeler/compare/v3.19.0...v3.20.0
 [3.19.0]: https://github.com/enkessler/cuke_modeler/compare/v3.18.0...v3.19.0
 [3.18.0]: https://github.com/enkessler/cuke_modeler/compare/v3.17.0...v3.18.0

data/README.md

@@ -11,7 +11,6 @@ Developer stuff:
 [![Build Status](https://github.com/enkessler/cuke_modeler/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/enkessler/cuke_modeler/actions/workflows/ci.yml?query=branch%3Amaster)
 [![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_modeler/badge.svg?branch=master)](https://coveralls.io/github/enkessler/cuke_modeler?branch=master)
 [![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?branch=master)](https://inch-ci.org/github/enkessler/cuke_modeler)
 
 ---
 
@@ -119,11 +118,11 @@ that feature is ultimately run with SpecFlow (Cucumber for C#), Lettuce
 
 ### <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)
+  * [cql](https://github.com/enkessler/cql) - A convenient DSL for querying modeled Gherkin documents
+  * [cuketagger](https://github.com/enkessler/cuketagger) - A tool for adding tags to feature files
+  * [cuke_cataloger](https://github.com/enkessler/cuke_cataloger) - Easily add uniques IDs to every test case in a suite
+  * [cuke_slicer](https://github.com/enkessler/cuke_slicer) - Break a test suite down into discrete test cases for easy parallel distribution
+  * [cuke_linter](https://github.com/enkessler/cuke_linter) - Identify common code smells in your Gherkin
 
 
 ## Development and Contributing

data/lib/cuke_modeler/adapters/gherkin_10_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_9_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 10.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin10Adapter < Gherkin9Adapter; end
 
-  class Gherkin10Adapter < Gherkin9Adapter
-
-  end
+  private_constant :Gherkin10Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_11_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_9_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 11.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin11Adapter < Gherkin9Adapter; end
 
-  class Gherkin11Adapter < Gherkin9Adapter
-
-  end
+  private_constant :Gherkin11Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_12_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_9_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 12.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin12Adapter < Gherkin9Adapter; end
 
-  class Gherkin12Adapter < Gherkin9Adapter
-
-  end
+  private_constant :Gherkin12Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_13_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_9_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 13.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin13Adapter < Gherkin9Adapter; end
 
-  class Gherkin13Adapter < Gherkin9Adapter
-
-  end
+  private_constant :Gherkin13Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_14_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_9_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 14.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin14Adapter < Gherkin9Adapter; end
 
-  class Gherkin14Adapter < Gherkin9Adapter
-
-  end
+  private_constant :Gherkin14Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_15_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_9_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 15.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin15Adapter < Gherkin9Adapter; end
 
-  class Gherkin15Adapter < Gherkin9Adapter
-
-  end
+  private_constant :Gherkin15Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_16_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_9_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 16.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin16Adapter < Gherkin9Adapter; end
 
-  class Gherkin16Adapter < Gherkin9Adapter
-
-  end
+  private_constant :Gherkin16Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_17_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_9_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 17.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin17Adapter < Gherkin9Adapter; end
 
-  class Gherkin17Adapter < Gherkin9Adapter
-
-  end
+  private_constant :Gherkin17Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_18_adapter.rb

@@ -3,9 +3,10 @@ require_relative 'gherkin_9_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 18.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
   class Gherkin18Adapter < Gherkin9Adapter
 
     # Adapts the AST sub-tree that is rooted at the given rule node.
@@ -21,4 +22,6 @@ module CukeModeler
     end
 
   end
+
+  private_constant :Gherkin18Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_19_adapter.rb

@@ -3,9 +3,10 @@ require_relative 'gherkin_18_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 19.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
   class Gherkin19Adapter < Gherkin18Adapter
 
     # Adapts the AST sub-tree that is rooted at the given step node.
@@ -58,4 +59,6 @@ module CukeModeler
     end
 
   end
+
+  private_constant :Gherkin19Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_20_adapter.rb

@@ -5,9 +5,10 @@ require_relative 'gherkin_base_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 20.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
   class Gherkin20Adapter < GherkinBaseAdapter
 
     # Adapts the given AST into the shape that this gem expects
@@ -355,6 +356,8 @@ module CukeModeler
     end
 
   end
+
+  private_constant :Gherkin20Adapter
 end
 
 # rubocop:enable Metrics/ClassLength, Metrics/AbcSize, Metrics/MethodLength

data/lib/cuke_modeler/adapters/gherkin_21_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_20_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 21.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin21Adapter < Gherkin20Adapter; end
 
-  class Gherkin21Adapter < Gherkin20Adapter
-
-  end
+  private_constant :Gherkin21Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_22_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_20_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 22.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin22Adapter < Gherkin20Adapter; end
 
-  class Gherkin22Adapter < Gherkin20Adapter
-
-  end
+  private_constant :Gherkin22Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_23_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_20_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 23.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin23Adapter < Gherkin20Adapter; end
 
-  class Gherkin23Adapter < Gherkin20Adapter
-
-  end
+  private_constant :Gherkin23Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_24_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_20_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 24.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin24Adapter < Gherkin20Adapter; end
 
-  class Gherkin24Adapter < Gherkin20Adapter
-
-  end
+  private_constant :Gherkin24Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_25_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_20_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 25.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin25Adapter < Gherkin20Adapter; end
 
-  class Gherkin25Adapter < Gherkin20Adapter
-
-  end
+  private_constant :Gherkin25Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_26_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_20_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 26.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin26Adapter < Gherkin20Adapter; end
 
-  class Gherkin26Adapter < Gherkin20Adapter
-
-  end
+  private_constant :Gherkin26Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_27_adapter.rb

@@ -3,11 +3,11 @@ require_relative 'gherkin_20_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 27.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
+  class Gherkin27Adapter < Gherkin20Adapter; end
 
-  class Gherkin27Adapter < Gherkin20Adapter
-
-  end
+  private_constant :Gherkin27Adapter
 end

data/lib/cuke_modeler/adapters/gherkin_9_adapter.rb

@@ -5,9 +5,10 @@ require_relative 'gherkin_base_adapter'
 
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
+  # @api private
+  #
   # An adapter that can convert the output of version 9.x of the *cucumber-gherkin* gem into input that is consumable
-  # by this gem.
+  # by this gem. Internal helper class.
   class Gherkin9Adapter < GherkinBaseAdapter
 
     # Adapts the given AST into the shape that this gem expects
@@ -371,6 +372,8 @@ module CukeModeler
     end
 
   end
+
+  private_constant :Gherkin9Adapter
 end
 
 # rubocop:enable Metrics/ClassLength, Metrics/AbcSize, Metrics/MethodLength

data/lib/cuke_modeler/adapters/gherkin_base_adapter.rb

@@ -1,7 +1,8 @@
 module CukeModeler
 
-  # NOT A PART OF THE PUBLIC API
-  # A class providing some basic and common adapter functionality.
+  # @api private
+  #
+  # A class providing some basic and common adapter functionality. Internal helper class.
   class GherkinBaseAdapter
 
     private
@@ -11,4 +12,6 @@ module CukeModeler
     end
 
   end
+
+  private_constant :GherkinBaseAdapter
 end