cuke_modeler 1.5.1 → 3.2.0

data/lib/cuke_modeler/sourceable.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # A mix-in module containing methods used by models that know from which line of
   # source code they originate.
 

data/lib/cuke_modeler/stepped.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # A mix-in module containing methods used by models that represent an element that has steps.
 
   module Stepped

data/lib/cuke_modeler/taggable.rb

@@ -1,5 +1,6 @@
 module CukeModeler
 
+  # NOT A PART OF THE PUBLIC API
   # A mix-in module containing methods used by models that represent an element that can be tagged.
 
   module Taggable

data/lib/cuke_modeler/version.rb

@@ -1,4 +1,4 @@
 module CukeModeler
   # The gem version
-  VERSION = '1.5.1'
+  VERSION = '3.2.0'
 end

data/testing/cucumber/features/analysis/step_comparison.feature

@@ -0,0 +1,25 @@
+Feature: Step comparison
+
+  Step comparison using `==` is done based on 'significant' properties. Keywords, being completely interchangeable, do not affect step equality.
+
+
+  Scenario: Comparison of steps
+    Given a model for the following step:
+      """
+      Given a step
+      """
+    And a model for the following step:
+      """
+      When a step
+      """
+    And a model for the following step:
+      """
+      Then a step
+      """
+    When the models are compared
+    Then all of them are equivalent
+    But none of the models are equivalent with a model for the following step:
+      """
+      And a step
+        | plus this table |
+      """

data/testing/cucumber/features/analysis/test_comparison.feature

@@ -1,6 +1,6 @@
 Feature: Test comparison
 
-  Gherkin elements that contain steps (i.e. backgrounds, scenarios, and outlines) can be compared with one another in order to determine equality. Elements are considered equal if the base text of their steps match. That is, the keyword used for the step and any table or doc string that may be associated with that step are ignored for the purposes of comparison.
+  Gherkin elements that contain steps (i.e. backgrounds, scenarios, and outlines) can be compared with one another in order to determine equality. Elements are considered equal if their steps match (see step comparison). Properties that do not affect what a test *does* (e.g. name, description, tags) are ignored for the purposes of comparison.
 
 
   Scenario: Comparing tests

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

@@ -1,6 +1,8 @@
 Feature: Feature modeling
 
-Feature models are the top level element of the gherkin portion of the model tree. They expose several attributes of the feature that they represent, as well as containing models for any background, scenarios, or outlines that are present in that feature.
+Feature models are the top level element of the Gherkin portion of the model tree. They expose several attributes of the
+feature that they represent, as well as containing models for any background, scenarios, or outlines that are present in
+that feature.
 
 
   Background:
@@ -29,11 +31,18 @@ Feature models are the top level element of the gherkin portion of the model tre
         Scenario: Scenario 2
           * a step
 
-        Scenario Outline: Outline 2
-          * a step
-        Examples:
-          | param |
-          | value |
+        Rule: a rule
+
+          Scenario: Scenario 3
+            * a step
+
+        Rule: another rule
+
+          Scenario Outline: Outline 2
+            * a step
+          Examples:
+            | param |
+            | value |
       """
     And a feature model based on that gherkin
       """
@@ -75,7 +84,18 @@ Feature models are the top level element of the gherkin portion of the model tre
       """
     Then the model returns a model for the background "The background"
 
+  Scenario: Modeling a feature's rules
+    When the feature's rules are requested
+      """
+        @model.rules
+      """
+    Then the model returns models for the following rules:
+      | a rule       |
+      | another rule |
+
   Scenario: Modeling a feature's scenarios
+  Note: Scenarios under a Rule keyword are included in the corresponding Rule model instead of the Feature model
+
     When the feature's scenarios are requested
       """
         @model.scenarios
@@ -85,13 +105,14 @@ Feature models are the top level element of the gherkin portion of the model tre
       | Scenario 2 |
 
   Scenario: Modeling a feature's outlines
+  Note: Outlines under a Rule keyword are included in the corresponding Rule model instead of the Feature model
+
     When the feature's outlines are requested
       """
         @model.outlines
       """
     Then the model returns models for the following outlines:
       | Outline 1 |
-      | Outline 2 |
 
   Scenario: Modeling a feature's tags
 

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

@@ -11,23 +11,28 @@ Feature: Feature output
       Feature: A feature with everything it could have
       Including a description
       and then some.
-      Background:
+      Background: non-nested background
       Background
       description
       * a step
       |value1|
+      |value2|
       * another step
       @scenario_tag
-      Scenario:
+      Scenario: non-nested scenario
       Scenario
       description
       * a step
       * another step
-      \"\"\"
+      \"\"\" with content type
         some text
       \"\"\"
+      Rule: a rule
+      Rule description 
+      Background: nested background
+      * a step
       @outline_tag
-      Scenario Outline:
+      Scenario Outline: nested outline
       Outline
       description
       * a step
@@ -42,6 +47,9 @@ Feature: Feature output
       description
       |param|
       |value|
+      Examples: additional example
+      Rule: another rule
+      Which is empty
       """
     And a feature model based on that gherkin
       """
@@ -59,48 +67,62 @@ Feature: Feature output
       Including a description
       and then some.
 
-        Background:
+        Background: non-nested background
 
         Background
         description
 
           * a step
             | value1 |
+            | value2 |
           * another step
 
         @scenario_tag
-        Scenario:
+        Scenario: non-nested scenario
 
         Scenario
         description
 
           * a step
           * another step
-            \"\"\"
+            \"\"\" with content type
               some text
             \"\"\"
 
-        @outline_tag
-        Scenario Outline:
+        Rule: a rule
 
-        Outline
-        description
+        Rule description
 
-          * a step
-            | value2 |
-          * another step
-            \"\"\"
-              some text
-            \"\"\"
+          Background: nested background
+            * a step
 
-        @example_tag
-        Examples:
+          @outline_tag
+          Scenario Outline: nested outline
 
-        Example
-        description
+          Outline
+          description
+
+            * a step
+              | value2 |
+            * another step
+              \"\"\"
+                some text
+              \"\"\"
+
+          @example_tag
+          Examples:
+
+          Example
+          description
+
+            | param |
+            | value |
+
+          Examples: additional example
+
+        Rule: another rule
 
-          | param |
-          | value |
+        Which is empty
       """
     And the output can be used to make an equivalent model
       """

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

@@ -0,0 +1,108 @@
+Feature: Rule modeling
+
+Rule models Scenario portion of a feature. They expose several attributes of the rule that they represent, as well as
+containing models for any background, scenarios, or outlines that are present in that rule.
+
+
+  Background:
+    Given the following gherkin:
+      """
+      Rule: Rule Foo
+
+          Some rule description.
+
+        Some more.
+            And some more.
+
+        Background: The background
+          * some setup step
+
+        Scenario: Scenario 1
+          * a step
+
+        Scenario Outline: Outline 1
+          * a step
+        Examples:
+          | param |
+          | value |
+
+        Scenario: Scenario 2
+          * a step
+      """
+    And a feature model based on that gherkin
+      """
+        @model = CukeModeler::Rule.new(<source_text>)
+      """
+
+
+  Scenario: Modeling a rule's keyword
+    When the rule's keyword is requested
+      """
+        @model.keyword
+      """
+    Then the model returns "Rule"
+
+  Scenario: Modeling a rule's name
+    When the rule's name is requested
+      """
+        @model.name
+      """
+    Then the model returns "Rule Foo"
+
+  Scenario: Modeling a rule's description
+    When the rule's description is requested
+      """
+        @model.description
+      """
+    Then the model returns
+      """
+        Some rule description.
+
+      Some more.
+          And some more.
+      """
+
+  Scenario: Modeling a rule's background
+    When the rule's background is requested
+      """
+        @model.background
+      """
+    Then the model returns a model for the background "The background"
+
+  Scenario: Modeling a rule's scenarios
+    When the rule's scenarios are requested
+      """
+        @model.scenarios
+      """
+    Then the model returns models for the following scenarios:
+      | Scenario 1 |
+      | Scenario 2 |
+
+  Scenario: Modeling a rule's outlines
+    When the rule's outlines are requested
+      """
+        @model.outlines
+      """
+    Then the model returns models for the following outlines:
+      | Outline 1 |
+
+  Scenario: Modeling a rule's source line
+    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 line is requested
+      """
+        @model.source_line
+      """
+    Then the model returns "3"

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

@@ -0,0 +1,111 @@
+Feature: Rule output
+
+  A rule model's string output is a Gherkin representation of itself. As such, output from a rule model can be used as
+  input for the same kind of model.
+
+
+  Scenario: Outputting a rule model
+    Given the following gherkin:
+      """
+      Rule: A rule with everything it could have
+      Including a description
+      and then some.
+      Background: a background
+      Background
+      description
+      * a step
+      |value1|
+      |value2|
+      * another step
+      @scenario_tag
+      Scenario: a scenario
+      Scenario
+      description
+      * a step
+      * another step
+      \"\"\" with content type
+        some text
+      \"\"\"
+      @outline_tag
+      Scenario Outline: an outline
+      Outline
+      description
+      * a step
+      |value2|
+      * another step
+      \"\"\"
+        some text
+      \"\"\"
+      @example_tag
+      Examples:
+      Example
+      description
+      |param|
+      |value|
+      Examples: additional example
+      """
+    And a rule model based on that gherkin
+      """
+        @model = CukeModeler::Rule.new(<source_text>)
+      """
+    When the model is output as a string
+      """
+        @model.to_s
+      """
+    Then the following text is provided:
+      """
+      Rule: A rule with everything it could have
+
+      Including a description
+      and then some.
+
+        Background: a background
+
+        Background
+        description
+
+          * a step
+            | value1 |
+            | value2 |
+          * another step
+
+        @scenario_tag
+        Scenario: a scenario
+
+        Scenario
+        description
+
+          * a step
+          * another step
+            \"\"\" with content type
+              some text
+            \"\"\"
+
+        @outline_tag
+        Scenario Outline: an outline
+
+        Outline
+        description
+
+          * a step
+            | value2 |
+          * another step
+            \"\"\"
+              some text
+            \"\"\"
+
+        @example_tag
+        Examples:
+
+        Example
+        description
+
+          | param |
+          | value |
+
+        Examples: additional example
+      """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Rule.new(@model.to_s)
+      """