cuke_modeler 3.18.0 → 3.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ce5182bc247dd91ecfc20e43a317871507326558424d0637ab1035b9b7661fe
-  data.tar.gz: 04b7b4ca30fdfc6fa76e2251179d0b10eb6a7032ba6420e88c345491367f6590
+  metadata.gz: db68bd0813ac0151f45f174d89c95c5accb2c11a77df2321f859d18f62ecf06f
+  data.tar.gz: 5d9b7ee4ea5c98a8e90d4d8d6d657223150064be4e867a8ef444eb93b357a195
 SHA512:
-  metadata.gz: f7c314712bb69bd700686c04c92a58abcf7cc1f6bd1bc609caeb0bd51e6444c9932eef6e9f88ee0d827359cdc2c0d2b867182d609cf5c8eb9727436cebbe50f6
-  data.tar.gz: 3615b14eabb2e9117a37c805957425d7814a69cc1e0e72398608e2a5bd1c101f55f4bbf75cfc3432c9f4687511f36d42096b76bfd020dfd9b461d00768a21b63
+  metadata.gz: a166c272417d15db4e3a04dcfb2057c0536a8412e7bce5810b9885998823d354667b42dbf9a49796d73498f469c1978779ea8a518ccd1ed92d2c9f6985c69f5e
+  data.tar.gz: c24f43b46820b37f16a0bf476e48d86c2a159ebc6b6a2b87da3194d7c6e0496b0ed25c7698a83c8a5f4bb1bc5fd77503c188492a19c3b8403298e994b03a5dab

data/CHANGELOG.md

@@ -8,6 +8,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing yet...
 
+
+## [3.20.0] - 2023-9-21
+
+### Added
+- Support added for more versions of the `cucumber-gherkin` gem
+    - 27.x
+
+### Changed
+ - `#inspect` for models now returns a reasonably small set of details for the model instead of the potentially 
+   huge screen dump of information. Not considered a breaking change because the API never specified the behavior 
+   of `#inspect` (it was just using the default Ruby implementation). Default Ruby inspection can still be triggered, 
+   if desired (see documentation).
+
+## [3.19.0] - 2023-1-22
+
+### Added
+- Support added for more versions of the `cucumber-gherkin` gem
+    - 26.x
+
 ## [3.18.0] - 2022-11-16
 
 ### Added
@@ -436,7 +455,9 @@ Nothing yet...
  - Initial release
 
 
-[Unreleased]: https://github.com/enkessler/cuke_modeler/compare/v3.18.0...HEAD
+[Unreleased]: https://github.com/enkessler/cuke_modeler/compare/v3.20.0...HEAD
+[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
 [3.17.0]: https://github.com/enkessler/cuke_modeler/compare/v3.16.0...v3.17.0
 [3.16.0]: https://github.com/enkessler/cuke_modeler/compare/v3.15.0...v3.16.0

data/LICENSE.txt

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

data/cuke_modeler.gemspec

@@ -18,11 +18,12 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.metadata = {
-    'bug_tracker_uri'   => 'https://github.com/enkessler/cuke_modeler/issues',
-    'changelog_uri'     => 'https://github.com/enkessler/cuke_modeler/blob/master/CHANGELOG.md',
-    'documentation_uri' => 'https://www.rubydoc.info/gems/cuke_modeler',
-    'homepage_uri'      => 'https://github.com/enkessler/cuke_modeler',
-    'source_code_uri'   => 'https://github.com/enkessler/cuke_modeler'
+    'bug_tracker_uri'       => 'https://github.com/enkessler/cuke_modeler/issues',
+    'changelog_uri'         => 'https://github.com/enkessler/cuke_modeler/blob/master/CHANGELOG.md',
+    'documentation_uri'     => 'https://www.rubydoc.info/gems/cuke_modeler',
+    'homepage_uri'          => 'https://github.com/enkessler/cuke_modeler',
+    'source_code_uri'       => 'https://github.com/enkessler/cuke_modeler',
+    'rubygems_mfa_required' => 'true'
   }
 
   # Specify which files should be added to the gem when it is released.
@@ -36,19 +37,20 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3', '< 4.0'
 
-  spec.add_runtime_dependency 'cucumber-gherkin', '< 26.0'
+  spec.add_runtime_dependency 'cucumber-gherkin', '< 28.0'
 
   spec.add_development_dependency 'bundler', '< 3.0'
   spec.add_development_dependency 'childprocess', '< 5.0'
   spec.add_development_dependency 'ffi', '< 2.0' # This is an invisible dependency for the `childprocess` gem on Windows
   # Cucumber 4.x is the earliest version to use cucumber-gherkin
-  spec.add_development_dependency 'cucumber', '>= 4.0.0', '< 8.0.0'
+  spec.add_development_dependency 'cucumber', '>= 4.0.0', '< 10.0.0'
   spec.add_development_dependency 'rainbow', '< 4.0.0'
   spec.add_development_dependency 'rake', '< 14.0.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  # RuboCop drops Ruby 2.3 support after this version and we need to maintain Ruby 2.3 compatibility when writing code
-  # for this gem
-  spec.add_development_dependency 'rubocop', '< 0.82.0'
+  # Running recent RuboCop versions requires a recent version of Ruby but it can still lint against Ruby 2.3 styles.
+  # Can't set a lower bound because RuboCop will still get installed in the testing environments for earlier Rubies,
+  # even if it never actually gets run. Current "minimum" version is 1.44.0.
+  spec.add_development_dependency 'rubocop', '< 2.0'
   spec.add_development_dependency 'simplecov', '< 1.0'
   spec.add_development_dependency 'simplecov-lcov', '< 1.0'
   spec.add_development_dependency 'test-unit', '< 4.0.0'

data/lib/cuke_modeler/adapters/gherkin_20_adapter.rb

@@ -327,14 +327,23 @@ module CukeModeler
 
     def clear_child_elements(ast, child_paths)
       # rubocop:disable Security/Eval - This is not blind data
+      # rubocop:disable Style/DocumentDynamicEvalDefinition - Nice idea but bad detection ability
       child_paths.each do |traversal_path|
-        # Wipe the value if it's there but don't add any attributes to the object if it didn't already have them
-        if eval("ast['cuke_modeler_parsing_data'].#{traversal_path.join('.')}", binding, __FILE__, __LINE__)
-          property_path = traversal_path[0..-2].join('.')
-          eval("ast['cuke_modeler_parsing_data']#{property_path.empty? ? '' : '.' + property_path}.instance_variable_set(\"@#{traversal_path.last}\", nil)", binding, __FILE__, __LINE__) # rubocop:disable Layout/LineLength
-        end
+        # Don't add any properties to the object if it didn't already have them
+        # e.g. ast['cuke_modeler_parsing_data'].background.steps
+        # e.g. ast['cuke_modeler_parsing_data'].data_table
+        next unless eval("ast['cuke_modeler_parsing_data'].#{traversal_path.join('.')}", binding, __FILE__, __LINE__)
+
+
+        # Determine the path to the property and wipe it
+        property_path = traversal_path[0..-2].join('.')
+        property_path = property_path.empty? ? '' : ".#{property_path}"
+
+        # e.g. ast['cuke_modeler_parsing_data'].scenario.instance_variable_set("@steps", nil)
+        # e.g. ast['cuke_modeler_parsing_data'].instance_variable_set("@tags", nil)
+        eval("ast['cuke_modeler_parsing_data']#{property_path}.instance_variable_set(\"@#{traversal_path.last}\", nil)", binding, __FILE__, __LINE__) # rubocop:disable Layout/LineLength
       end
-      # rubocop:enable Security/Eval
+      # rubocop:enable Security/Eval, Style/DocumentDynamicEvalDefinition
     end
 
     def test_has_examples?(ast_node)

data/lib/cuke_modeler/adapters/gherkin_26_adapter.rb

@@ -0,0 +1,13 @@
+require_relative 'gherkin_20_adapter'
+
+
+module CukeModeler
+
+  # NOT A PART OF THE PUBLIC API
+  # An adapter that can convert the output of version 26.x of the *cucumber-gherkin* gem into input that is consumable
+  # by this gem.
+
+  class Gherkin26Adapter < Gherkin20Adapter
+
+  end
+end

data/lib/cuke_modeler/adapters/gherkin_27_adapter.rb

@@ -0,0 +1,13 @@
+require_relative 'gherkin_20_adapter'
+
+
+module CukeModeler
+
+  # NOT A PART OF THE PUBLIC API
+  # An adapter that can convert the output of version 27.x of the *cucumber-gherkin* gem into input that is consumable
+  # by this gem.
+
+  class Gherkin27Adapter < Gherkin20Adapter
+
+  end
+end

data/lib/cuke_modeler/described.rb

@@ -52,7 +52,7 @@ module CukeModeler
     end
 
     def trim_leading_spaces(description)
-      non_blank_lines = description.select { |line| line =~ /\S/ }
+      non_blank_lines = description.grep(/\S/)
 
       fewest_spaces = non_blank_lines.collect { |line| line[/^\s*/].length }.min || 0
 

data/lib/cuke_modeler/models/background.rb

@@ -53,6 +53,16 @@ module CukeModeler
       text
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a background model, this will be the name of the
+    # background.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @name: #{name.inspect}>"
+    end
+
 
     private
 

data/lib/cuke_modeler/models/cell.rb

@@ -30,12 +30,19 @@ module CukeModeler
       @value ? @value.gsub('\\', '\\\\\\').gsub('|', '\|') : ''
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a cell model, this will be the value of the cell.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @value: #{value.inspect}>"
+    end
+
 
     private
 
 
-    # It's only considered complex because of how deeply nested cells are in the tree. It's not REALLY complex.
-    # rubocop:disable Metrics/AbcSize
     def parse_source(source_text)
       base_file_string = "# language: #{Parsing.dialect}
       #{dialect_feature_keyword}: Fake feature to parse
@@ -47,7 +54,6 @@ module CukeModeler
 
       parsed_file['feature']['elements'].first['steps'].first['table']['rows'].first['cells'].first
     end
-    # rubocop:enable Metrics/AbcSize
 
   end
 

data/lib/cuke_modeler/models/comment.rb

@@ -29,6 +29,15 @@ module CukeModeler
       text || ''
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a comment model, this will be the text of the comment.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @text: #{text.inspect}>"
+    end
+
 
     private
 

data/lib/cuke_modeler/models/directory.rb

@@ -46,6 +46,16 @@ module CukeModeler
       path.to_s
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a directory model, this will be the path of the
+    # directory.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @path: #{@path.inspect}>"
+    end
+
 
     private
 
@@ -75,12 +85,10 @@ module CukeModeler
     end
 
     def process_feature_file(file_path)
-      source_text = IO.read(file_path)
-
+      source_text = File.read(file_path)
       feature_file_data = Parsing.parse_text(source_text, file_path)
-      feature_file_data = feature_file_data.merge({ 'path' => file_path })
 
-      feature_file_data
+      feature_file_data.merge({ 'path' => file_path })
     end
 
   end

data/lib/cuke_modeler/models/doc_string.rb

@@ -34,6 +34,16 @@ module CukeModeler
       text << '"""'
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a doc string model, this will be the content of
+    # the doc string.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @content: #{content.inspect}>"
+    end
+
 
     private
 
@@ -55,7 +65,7 @@ module CukeModeler
     end
 
     def content_output_string
-      content.nil? || content.empty? ? '' : content.gsub('"""', '\"\"\"') + "\n"
+      content.nil? || content.empty? ? '' : "#{content.gsub('"""', '\"\"\"')}\n"
     end
 
   end

data/lib/cuke_modeler/models/example.rb

@@ -99,7 +99,7 @@ module CukeModeler
     end
 
     # Building strings just isn't pretty
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
 
     # Returns a string representation of this model. For an example model,
     # this will be Gherkin text that is equivalent to the example being modeled.
@@ -116,7 +116,16 @@ module CukeModeler
       text
     end
 
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/AbcSize
+
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For an example model, this will be the name of the example.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @name: #{name.inspect}>"
+    end
 
 
     private

data/lib/cuke_modeler/models/feature.rb

@@ -99,6 +99,15 @@ module CukeModeler
 
     # rubocop:enable Metrics/AbcSize
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a feature model, this will be the name of the feature.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @name: #{name.inspect}>"
+    end
+
 
     private
 

data/lib/cuke_modeler/models/feature_file.rb

@@ -47,17 +47,25 @@ module CukeModeler
       path.to_s
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a feature file model, this will be the path of
+    # the feature file.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @path: #{@path.inspect}>"
+    end
+
 
     private
 
 
     def process_feature_file(file_path)
-      source_text = IO.read(file_path)
-
+      source_text = File.read(file_path)
       feature_file_data = Parsing.parse_text(source_text, file_path)
-      feature_file_data = feature_file_data.merge({ 'path' => file_path })
 
-      feature_file_data
+      feature_file_data.merge({ 'path' => file_path })
     end
 
   end

data/lib/cuke_modeler/models/model.rb

@@ -16,16 +16,29 @@ module CukeModeler
       # This should be overridden by a child class
     end
 
+    # It's a lazy implementation but it's mandatory for the class to define this method
+    # rubocop:disable Lint/UselessMethodDefinition
+
     # Returns a string representation of this model.
     def to_s
       # This should be overridden by a child class
       super
     end
 
+    # rubocop:enable Lint/UselessMethodDefinition
+
     # Returns the model objects that belong to this model.
     def children
       []
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class and object ID.
+    def inspect(verbose: false)
+      return super() if verbose
+
+      "#<#{self.class.name}:#{object_id}>"
+    end
+
   end
 end

data/lib/cuke_modeler/models/outline.rb

@@ -47,7 +47,7 @@ module CukeModeler
     end
 
     # Building strings just isn't pretty
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
 
     # Returns a string representation of this model. For an outline model,
     # this will be Gherkin text that is equivalent to the outline being modeled.
@@ -64,7 +64,16 @@ module CukeModeler
       text
     end
 
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/AbcSize
+
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For an outline model, this will be the name of the outline.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @name: #{name.inspect}>"
+    end
 
 
     private

data/lib/cuke_modeler/models/row.rb

@@ -37,6 +37,17 @@ module CukeModeler
       "| #{text_cells.join(' | ')} |"
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a row model, this will be the cells of the row.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      cell_output = @cells&.collect(&:value)
+
+      "#{super.chop} @cells: #{cell_output.inspect}>"
+    end
+
 
     private
 

data/lib/cuke_modeler/models/rule.rb

@@ -60,9 +60,6 @@ module CukeModeler
       models
     end
 
-    # Building strings just isn't pretty
-    # rubocop:disable Metrics/AbcSize
-
     # Returns a string representation of this model. For a rule model,
     # this will be Gherkin text that is equivalent to the rule being modeled.
     def to_s
@@ -76,7 +73,15 @@ module CukeModeler
 
       text
     end
-    # rubocop:enable Metrics/AbcSize
+
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a rule model, this will be the name of the rule.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @name: #{@name.inspect}>"
+    end
 
 
     private

data/lib/cuke_modeler/models/scenario.rb

@@ -61,6 +61,15 @@ module CukeModeler
 
     # rubocop:enable Metrics/AbcSize
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a scenario model, this will be the name of the scenario.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @name: #{name.inspect}>"
+    end
+
 
     private
 

data/lib/cuke_modeler/models/step.rb

@@ -53,6 +53,15 @@ module CukeModeler
       text
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a step model, this will be the text of the step.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @text: #{@text.inspect}>"
+    end
+
 
     private
 

data/lib/cuke_modeler/models/table.rb

@@ -36,6 +36,17 @@ module CukeModeler
       rows.empty? ? '' : rows.collect { |row| row_output_string(row) }.join("\n")
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a table model, this will be the rows of the table.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      row_output = @rows&.collect { |row| row.cells.collect(&:value) }
+
+      "#{super.chop} @rows: #{row_output.inspect}>"
+    end
+
 
     private
 

data/lib/cuke_modeler/models/tag.rb

@@ -29,6 +29,15 @@ module CukeModeler
       name || ''
     end
 
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a tag model, this will be the name of the tag.
+    def inspect(verbose: false)
+      return super(verbose: verbose) if verbose
+
+      "#{super.chop} @name: #{@name.inspect}>"
+    end
+
 
     private
 

data/lib/cuke_modeler/parsing.rb

@@ -9,7 +9,7 @@ require 'gherkin'
 # an 'adapter' appropriate to the version of the *cucumber-gherkin* gem that has been activated.
 gherkin_version = Gem.loaded_specs['cucumber-gherkin'].version.version
 gherkin_major_version = gherkin_version.match(/^(\d+)\./)[1].to_i
-supported_gherkin_versions = (9..25)
+supported_gherkin_versions = (9..27)
 
 raise("Unknown Gherkin version: '#{gherkin_version}'") unless supported_gherkin_versions.include?(gherkin_major_version)
 
@@ -63,7 +63,7 @@ module CukeModeler
       # inside of it, so I'm leaving this here in case it changes again
       # rubocop:disable Lint/DuplicateMethods
       case gherkin_major_version
-        when 20, 21, 22, 23, 24, 25
+        when 20, 21, 22, 23, 24, 25, 26, 27
           # TODO: make these methods private?
           # NOT A PART OF THE PUBLIC API
           # The method to use for parsing Gherkin text
@@ -185,7 +185,7 @@ module CukeModeler
     end
 
     def get_word(word_set)
-      word_set = word_set.is_a?(Array) ? word_set : word_set.split('|')
+      word_set = word_set.split('|') unless word_set.is_a?(Array)
 
       word_set.first
     end

data/lib/cuke_modeler/version.rb

@@ -1,4 +1,4 @@
 module CukeModeler
   # The gem version
-  VERSION = '3.18.0'.freeze
+  VERSION = '3.20.0'.freeze
 end

data/testing/cucumber/features/modeling/background_output.feature

@@ -1,9 +1,10 @@
 Feature: Background output
 
-  A background model's string output is a Gherkin representation of itself. As such, output from a background model can be used as input for the same kind of model.
+  A background model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the name of the background that it models.
 
 
-  Scenario: Outputting a background model
+  Background:
     Given the following gherkin:
       """
       Background: A background with everything that it could have
@@ -20,11 +21,14 @@ Feature: Background output
       """
     And a background model based on that gherkin
       """
-        @model = CukeModeler::Background.new(<source_text>)
+      @model = CukeModeler::Background.new(<source_text>)
       """
+
+
+  Scenario: Stringify a background model
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
@@ -42,5 +46,15 @@ Feature: Background output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Background.new(@model.to_s)
+      CukeModeler::Background.new(@model.to_s)
+      """
+
+  Scenario: Inspect a background model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Background:<object_id> @name: "A background with everything that it could have">
       """