cuke_modeler 3.10.0 → 3.14.0

data/lib/cuke_modeler/containing.rb

@@ -55,7 +55,7 @@ module CukeModeler
 
     def populate_scenario(scenario_object, parsed_scenario_data)
       populate_parsing_data(scenario_object, parsed_scenario_data)
-      populate_source_line(scenario_object, parsed_scenario_data)
+      populate_source_location(scenario_object, parsed_scenario_data)
       populate_keyword(scenario_object, parsed_scenario_data)
       populate_name(scenario_object, parsed_scenario_data)
       populate_description(scenario_object, parsed_scenario_data)
@@ -65,7 +65,7 @@ module CukeModeler
 
     def populate_outline(outline_object, parsed_outline_data)
       populate_parsing_data(outline_object, parsed_outline_data)
-      populate_source_line(outline_object, parsed_outline_data)
+      populate_source_location(outline_object, parsed_outline_data)
       populate_keyword(outline_object, parsed_outline_data)
       populate_name(outline_object, parsed_outline_data)
       populate_description(outline_object, parsed_outline_data)
@@ -79,7 +79,7 @@ module CukeModeler
       populate_keyword(background_object, parsed_background_data)
       populate_name(background_object, parsed_background_data)
       populate_description(background_object, parsed_background_data)
-      populate_source_line(background_object, parsed_background_data)
+      populate_source_location(background_object, parsed_background_data)
       populate_steps(background_object, parsed_background_data)
     end
 
@@ -87,7 +87,7 @@ module CukeModeler
       populate_text(step_object, parsed_step_data)
       populate_block(step_object, parsed_step_data)
       populate_keyword(step_object, parsed_step_data)
-      populate_source_line(step_object, parsed_step_data)
+      populate_source_location(step_object, parsed_step_data)
       populate_parsing_data(step_object, parsed_step_data)
     end
 
@@ -102,12 +102,12 @@ module CukeModeler
     def populate_table(table_object, parsed_table_data)
       populate_row_models(table_object, parsed_table_data)
       populate_parsing_data(table_object, parsed_table_data)
-      populate_source_line(table_object, parsed_table_data)
+      populate_source_location(table_object, parsed_table_data)
     end
 
     def populate_cell(cell_object, parsed_cell_data)
       populate_cell_value(cell_object, parsed_cell_data)
-      populate_source_line(cell_object, parsed_cell_data)
+      populate_source_location(cell_object, parsed_cell_data)
       populate_parsing_data(cell_object, parsed_cell_data)
     end
 
@@ -115,13 +115,13 @@ module CukeModeler
       populate_content_type(doc_string_object, parsed_doc_string_data)
       populate_content(doc_string_object, parsed_doc_string_data)
       populate_parsing_data(doc_string_object, parsed_doc_string_data)
-      populate_source_line(doc_string_object, parsed_doc_string_data)
+      populate_source_location(doc_string_object, parsed_doc_string_data)
     end
 
     def populate_example(example_object, parsed_example_data)
       populate_parsing_data(example_object, parsed_example_data)
       populate_keyword(example_object, parsed_example_data)
-      populate_source_line(example_object, parsed_example_data)
+      populate_source_location(example_object, parsed_example_data)
       populate_name(example_object, parsed_example_data)
       populate_description(example_object, parsed_example_data)
       populate_tags(example_object, parsed_example_data)
@@ -129,14 +129,14 @@ module CukeModeler
     end
 
     def populate_row(row_object, parsed_row_data)
-      populate_source_line(row_object, parsed_row_data)
+      populate_source_location(row_object, parsed_row_data)
       populate_row_cells(row_object, parsed_row_data)
       populate_parsing_data(row_object, parsed_row_data)
     end
 
     def populate_feature(feature_object, parsed_feature_data)
       populate_parsing_data(feature_object, parsed_feature_data)
-      populate_source_line(feature_object, parsed_feature_data)
+      populate_source_location(feature_object, parsed_feature_data)
       populate_keyword(feature_object, parsed_feature_data)
       populate_name(feature_object, parsed_feature_data)
       populate_description(feature_object, parsed_feature_data)
@@ -146,7 +146,7 @@ module CukeModeler
 
     def populate_rule(rule_object, parsed_rule_data)
       populate_parsing_data(rule_object, parsed_rule_data)
-      populate_source_line(rule_object, parsed_rule_data)
+      populate_source_location(rule_object, parsed_rule_data)
       populate_keyword(rule_object, parsed_rule_data)
       populate_name(rule_object, parsed_rule_data)
       populate_description(rule_object, parsed_rule_data)
@@ -182,13 +182,13 @@ module CukeModeler
     def populate_tag(tag_object, processed_tag_data)
       populate_name(tag_object, processed_tag_data)
       populate_parsing_data(tag_object, processed_tag_data)
-      populate_source_line(tag_object, processed_tag_data)
+      populate_source_location(tag_object, processed_tag_data)
     end
 
     def populate_comment(comment_object, processed_comment_data)
       populate_comment_text(comment_object, processed_comment_data)
       populate_parsing_data(comment_object, processed_comment_data)
-      populate_source_line(comment_object, processed_comment_data)
+      populate_source_location(comment_object, processed_comment_data)
     end
 
     def populate_comment_text(comment_model, parsed_comment_data)

data/lib/cuke_modeler/nested.rb

@@ -30,6 +30,7 @@ module CukeModeler
         directory: [Directory],
         feature_file: [FeatureFile],
         feature: [Feature],
+        rule: [Rule],
         test: [Scenario, Outline, Background],
         background: [Background],
         scenario: [Scenario],

data/lib/cuke_modeler/parsing.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Metrics/ModuleLength - Just not going to worry about this
+
 # Have to at least load some version of the gem before which version of the gem has been loaded can
 # be determined and the rest of the needed files can be loaded.
 require 'gherkin'
@@ -7,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..19)
+supported_gherkin_versions = (9..22)
 
 raise("Unknown Gherkin version: '#{gherkin_version}'") unless supported_gherkin_versions.include?(gherkin_major_version)
 
@@ -32,7 +34,7 @@ module CukeModeler
 
       # The dialects currently known by the gherkin gem
       def dialects
-        @dialects ||= Gherkin::DIALECTS
+        Gherkin::DIALECTS
       end
 
       # Parses the Cucumber feature given in *source_text* and returns a hash representation of
@@ -61,6 +63,23 @@ 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
+          # TODO: make these methods private?
+          # NOT A PART OF THE PUBLIC API
+          # The method to use for parsing Gherkin text
+          def parsing_method(source_text, filename)
+            messages = Gherkin.from_source(filename,
+                                           source_text,
+                                           { include_gherkin_document: true })
+                              .to_a
+
+            error_message = messages.find(&:parse_error)
+            gherkin_ast_message = messages.find(&:gherkin_document)
+
+            raise error_message.parse_error.message if error_message
+
+            gherkin_ast_message.gherkin_document
+          end
         when 19
           # TODO: make these methods private?
           # NOT A PART OF THE PUBLIC API
@@ -175,3 +194,5 @@ module CukeModeler
 
   end
 end
+
+# rubocop:enable Metrics/ModuleLength

data/lib/cuke_modeler/sourceable.rb

@@ -8,12 +8,15 @@ module CukeModeler
     # The line number where the element began in the source code
     attr_accessor :source_line
 
+    # The column number where the element began in the source code
+    attr_accessor :source_column
 
     private
 
 
-    def populate_source_line(model, parsed_model_data)
+    def populate_source_location(model, parsed_model_data)
       model.source_line = parsed_model_data['line']
+      model.source_column = parsed_model_data['column']
     end
 
   end

data/lib/cuke_modeler/version.rb

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

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

@@ -23,21 +23,21 @@ Feature: Background modeling
       """
 
 
-  Scenario: Modeling a backgrounds's keyword
+  Scenario: Modeling a background's keyword
     When the backgrounds's keyword is requested
       """
         @model.keyword
       """
     Then the model returns "Background"
 
-  Scenario: Modeling a backgrounds's name
+  Scenario: Modeling a background's name
     When the background's name is requested
       """
         @model.name
       """
     Then the model returns "Some general test setup stuff."
 
-  Scenario: Modeling a backgrounds's description
+  Scenario: Modeling a background's description
     When the background's description is requested
       """
         @model.description
@@ -50,7 +50,7 @@ Feature: Background modeling
           Even more.
       """
 
-  Scenario: Modeling a backgrounds's steps
+  Scenario: Modeling a background's steps
     When the background's steps are requested
       """
         @model.steps
@@ -60,7 +60,7 @@ Feature: Background modeling
       | another setup step |
       | an action step     |
 
-  Scenario: Modeling a backgrounds's source line
+  Scenario: Modeling a background's source line
     Given the following gherkin:
       """
       Feature:
@@ -81,3 +81,26 @@ Feature: Background modeling
         @model.source_line
       """
     Then the model returns "3"
+
+  Scenario: Modeling a background's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+
+        Background:
+          * a step
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the background model of that feature model
+      """
+        @model = @model.background
+      """
+    When the background's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "3"

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

@@ -20,3 +20,49 @@ Feature: Cell modeling
         @model.value
       """
     Then the model returns "foo"
+
+  Scenario: Modeling a cell's source line
+    Given the following gherkin:
+      """
+      Feature:
+
+        Scenario:
+          * a step
+            | foo |
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the cell model inside of that feature model
+      """
+        @model = @model.tests.first.steps.first.block.rows.first.cells.first
+      """
+    When the cell's source line is requested
+      """
+        @model.source_line
+      """
+    Then the model returns "5"
+
+  Scenario: Modeling a cell's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+        Scenario:
+          * a step
+            | foo |
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the cell model inside of that feature model
+      """
+        @model = @model.tests.first.steps.first.block.rows.first.cells.first
+      """
+    When the cell's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "9"

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

@@ -40,3 +40,23 @@ Feature: Comment modeling
         @model.source_line
       """
     Then the model returns "1"
+
+  Scenario: Modeling a comment's source column
+    Given a feature file with the following gherkin:
+      """
+      # a comment
+      Feature:
+      """
+    And a feature file model based on that file
+      """
+        @model = CukeModeler::FeatureFile.new(<file_path>)
+      """
+    And the comment model of that feature file model
+      """
+        @model = @model.comments.first
+      """
+    When the comment's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "1"

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

@@ -57,3 +57,29 @@ Feature: Doc string modeling
         @model.source_line
       """
     Then the model returns "5"
+
+
+  Scenario: Modeling a doc string's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+        Scenario:
+          * a step
+            \"\"\"
+            foo
+            \"\"\"
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the doc string model inside of that feature model
+      """
+        @model = @model.tests.first.steps.first.block
+      """
+    When the doc string's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "7"

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

@@ -128,3 +128,28 @@ Feature: Example modeling
         @model.source_line
       """
     Then the model returns "5"
+
+  Scenario: Modeling an example's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+        Scenario Outline:
+          * a step
+        Examples:
+          | param |
+          | value |
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the example model inside of that feature model
+      """
+        @model = @model.tests.first.examples.first
+      """
+    When the example's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "3"

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

@@ -132,3 +132,10 @@ that feature.
         @model.source_line
       """
     Then the model returns "2"
+
+  Scenario: Modeling a feature's source column
+    When the feature's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "1"

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

@@ -124,7 +124,7 @@ Feature: Outline modeling
       | @outline_tag_1 |
       | @outline_tag_2 |
 
-  Scenario: Modeling a outline's source line
+  Scenario: Modeling an outline's source line
     Given the following gherkin:
       """
       Feature:
@@ -148,3 +148,28 @@ Feature: Outline modeling
         @model.source_line
       """
     Then the model returns "3"
+
+  Scenario: Modeling an outline's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+        Scenario Outline:
+          * a step
+        Examples:
+          | param |
+          | value |
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the outline model of that feature model
+      """
+        @model = @model.outlines.first
+      """
+    When the outline's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "3"

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

@@ -45,3 +45,26 @@ Feature: Row modeling
         @model.source_line
       """
     Then the model returns "5"
+
+  Scenario: Modeling a row's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+        Scenario:
+          * a step
+            | foo |
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the row model inside of that feature model
+      """
+        @model = @model.tests.first.steps.first.block.rows.first
+      """
+    When the rows's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "7"

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

@@ -148,3 +148,24 @@ in that rule.
         @model.source_line
       """
     Then the model returns "3"
+
+  Scenario: Modeling a rule's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+        Rule:
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the rule model of that feature model
+      """
+        @model = @model.rules.first
+      """
+    When the rule's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "3"

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

@@ -122,3 +122,25 @@ Feature: Scenario modeling
         @model.source_line
       """
     Then the model returns "3"
+
+  Scenario: Modeling a scenario's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+        Scenario:
+          * a step
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the scenario model of that feature model
+      """
+        @model = @model.scenarios.first
+      """
+    When the scenario's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "3"

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

@@ -50,6 +50,28 @@ Feature: Step modeling
       """
     Then the model returns "4"
 
+  Scenario: Modeling a step's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+        Scenario:
+          * a step
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the step model inside of that feature model
+      """
+        @model = @model.tests.first.steps.first
+      """
+    When the step's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "5"
+
   Scenario: Modeling a step's table
     Given a step model based on the following gherkin:
       """

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

@@ -47,3 +47,27 @@ Feature: Table modeling
         @model.source_line
       """
     Then the model returns "5"
+
+  Scenario: Modeling a table's source column
+    Given the following gherkin:
+      """
+      Feature:
+
+        Scenario:
+          * a step
+            | value 1 |
+            | value 2 |
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the table model inside of that feature model
+      """
+        @model = @model.tests.first.steps.first.block
+      """
+    When the table's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "7"

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

@@ -40,3 +40,23 @@ Feature: Tag modeling
         @model.source_line
       """
     Then the model returns "1"
+
+  Scenario: Modeling a tag's source column
+    Given the following gherkin:
+      """
+      @a_tag
+      Feature:
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Feature.new(<source_text>)
+      """
+    And the tag model of that feature model
+      """
+        @model = @model.tags.first
+      """
+    When the tag's source column is requested
+      """
+        @model.source_column
+      """
+    Then the model returns "1"