RubyGems - cucumber_analytics - Versions diffs - 0.0.9 → 1.0.0 - Mend

cucumber_analytics 0.0.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (94) hide show

checksums.yaml +15 -0
data/History.rdoc +16 -0
data/README.rdoc +5 -3
data/Rakefile +7 -2
data/cucumber_analytics.gemspec +7 -5
data/features/analysis/step_collection.feature +44 -45
data/features/modeling/background_modeling.feature +14 -144
data/features/modeling/directory_modeling.feature +3 -2
data/features/modeling/doc_string_modeling.feature +46 -0
data/features/modeling/example_modeling.feature +13 -34
data/features/modeling/feature_file_modeling.feature +3 -2
data/features/modeling/feature_modeling.feature +18 -80
data/features/modeling/outline_modeling.feature +25 -164
data/features/modeling/scenario_modeling.feature +17 -144
data/features/modeling/step_modeling.feature +68 -0
data/features/modeling/table_modeling.feature +41 -0
data/features/step_definitions/background_steps.rb +12 -11
data/features/step_definitions/directory_steps.rb +6 -3
data/features/step_definitions/doc_string_steps.rb +50 -0
data/features/step_definitions/{file_steps.rb → feature_file_steps.rb} +8 -2
data/features/step_definitions/feature_steps.rb +8 -4
data/features/step_definitions/outline_steps.rb +12 -6
data/features/step_definitions/setup_steps.rb +2 -2
data/features/step_definitions/spec_steps.rb +6 -3
data/features/step_definitions/step_steps.rb +91 -0
data/features/step_definitions/table_steps.rb +10 -0
data/features/step_definitions/test_steps.rb +6 -10
data/features/step_definitions/world_steps.rb +28 -19
data/features/support/env.rb +0 -2
data/lib/cucumber_analytics/background.rb +16 -0
data/lib/cucumber_analytics/containing.rb +18 -0
data/lib/cucumber_analytics/directory.rb +83 -0
data/lib/cucumber_analytics/doc_string.rb +55 -0
data/lib/cucumber_analytics/example.rb +100 -0
data/lib/cucumber_analytics/feature.rb +120 -0
data/lib/cucumber_analytics/feature_element.rb +22 -40
data/lib/cucumber_analytics/feature_file.rb +74 -0
data/lib/cucumber_analytics/outline.rb +49 -0
data/lib/cucumber_analytics/parsing.rb +30 -0
data/lib/cucumber_analytics/scenario.rb +31 -0
data/lib/cucumber_analytics/step.rb +142 -32
data/lib/cucumber_analytics/table.rb +51 -0
data/lib/cucumber_analytics/taggable.rb +35 -0
data/lib/cucumber_analytics/test_element.rb +36 -91
data/lib/cucumber_analytics/version.rb +1 -1
data/lib/cucumber_analytics/world.rb +109 -153
data/lib/cucumber_analytics.rb +12 -8
data/spec/integration/background_integration_spec.rb +18 -0
data/spec/integration/directory_integration_spec.rb +24 -0
data/spec/{feature_spec.rb → integration/feature_file_integration_spec.rb} +5 -5
data/spec/integration/feature_integration_spec.rb +86 -0
data/spec/integration/outline_integration_spec.rb +22 -0
data/spec/integration/scenario_integration_spec.rb +18 -0
data/spec/integration/step_integration_spec.rb +116 -0
data/spec/integration/world_integration_spec.rb +40 -0
data/spec/spec_helper.rb +7 -3
data/spec/unit/background_unit_spec.rb +22 -0
data/spec/unit/bare_bones_unit_specs.rb +13 -0
data/spec/unit/containing_element_unit_specs.rb +17 -0
data/spec/unit/directory_unit_spec.rb +91 -0
data/spec/unit/doc_string_unit_spec.rb +65 -0
data/spec/unit/example_unit_spec.rb +171 -0
data/spec/unit/feature_element_unit_spec.rb +19 -0
data/spec/unit/feature_element_unit_specs.rb +39 -0
data/spec/unit/feature_file_unit_spec.rb +82 -0
data/spec/unit/feature_unit_spec.rb +81 -0
data/spec/unit/nested_element_unit_specs.rb +24 -0
data/spec/unit/outline_unit_spec.rb +56 -0
data/spec/unit/parsing_unit_spec.rb +21 -0
data/spec/unit/prepopulated_unit_specs.rb +13 -0
data/spec/unit/scenario_unit_spec.rb +36 -0
data/spec/unit/step_unit_spec.rb +231 -0
data/spec/unit/table_unit_spec.rb +52 -0
data/spec/unit/taggable_unit_spec.rb +63 -0
data/spec/unit/tagged_element_unit_specs.rb +48 -0
data/spec/unit/test_element_unit_spec.rb +40 -0
data/spec/unit/test_element_unit_specs.rb +31 -0
data/spec/unit/world_unit_spec.rb +167 -0
metadata +106 -41
data/lib/cucumber_analytics/logging.rb +0 -28
data/lib/cucumber_analytics/outline_example.rb +0 -110
data/lib/cucumber_analytics/parsed_background.rb +0 -45
data/lib/cucumber_analytics/parsed_directory.rb +0 -78
data/lib/cucumber_analytics/parsed_feature.rb +0 -97
data/lib/cucumber_analytics/parsed_file.rb +0 -199
data/lib/cucumber_analytics/parsed_scenario.rb +0 -67
data/lib/cucumber_analytics/parsed_scenario_outline.rb +0 -122
data/spec/background_spec.rb +0 -23
data/spec/directory_spec.rb +0 -18
data/spec/example_spec.rb +0 -37
data/spec/file_spec.rb +0 -20
data/spec/outline_spec.rb +0 -32
data/spec/scenario_spec.rb +0 -33
data/spec/step_spec.rb +0 -24

data/features/modeling/feature_modeling.feature CHANGED Viewed

@@ -17,80 +17,30 @@ Feature: Features can be modeled.
   Background: Test file setup.
     Given the following feature file "much_stuff.feature":
     """
-    #Don't mind me.
-    #Or any line that is a comment, really.
-    @a_feature_level_tag @and_another@and_another
+    @a_feature_level_tag @and_another
      Feature:The test feature name.
-      Some more feature description.
+      Some feature description.
       And some more.
-      Scenario but not really because I left out the magic ':'
-        Given some description that uses keywords
-        And more of it
-        When I chuck the kitchen sink at it:
-        But
-        *
-        |
-        Scenario Outline
-        Examples
-        \"\"\"
-        Background
-        Then this is still one big valid description
-        # Oddly enough, if this comment had come earlier in the description
-        # it would have broken Cucumber. Comments can't be mixed into the
-        # freeform text for some reason.
-        #@commented_tag
       Background:Some general test setup stuff.
-        A little more information.
         * some setup step
-      @a_tag
-      @another_tag@yet_another_tag
       Scenario: The first scenario's name.
-        Some text describing the scenario.
-        More text.
-        Given the first step
-        And this step takes a table:
-          | data      |
-          | more data |
-        When the second step
-        Then the third step
-    #Random comment
-      @outline_tag
-      Scenario Outline: The scenario outline's name.
-        Some text describing the scenario.
-        More text.
-        Given the first "<param1>"
-        And this step takes a table:
-          | data      |
-          | more data |
-        When the second "<param2>"
-        Then the third step
-      Examples: text describing the significance of the examples
-        | param1 | param2 |
-        | x      | y      |
-        @example_tag
-      Examples: some examples with different significance and a tag
-        | param1 | param2 |
-        | a      | b      |
-        | c      | d      |
+      * a step
+      Scenario Outline: The scenario outline's name.
+        * a step
+      Examples:
+        | param |
+        | x     |
+        | y     |
+      Examples:
+        | param |
+        | z     |
       Scenario: The second scenario's name.
-        Some text describing the scenario.
-        More text.
-        Given the first step
-        When the second step
-        Then the third step
+        * a step
     """
     And the following feature file "barely_any_stuff.feature":
     """
@@ -129,20 +79,8 @@ Feature: Features can be modeled.
   Scenario: The feature's description is modeled.
     Then the descriptive lines of feature "1" are as follows:
-      | Some more feature description.                                      |
-      | And some more.                                                      |
-      | Scenario but not really because I left out the magic ':'            |
-      | Given some description that uses keywords                           |
-      | And more of it                                                      |
-      | When I chuck the kitchen sink at it:                                |
-      | But                                                                 |
-      | *                                                                   |
-      | \|                                                                  |
-      | Scenario Outline                                                    |
-      | Examples                                                            |
-      | """                                                                 |
-      | Background                                                          |
-      | Then this is still one big valid description                        |
+      | Some feature description. |
+      | And some more.            |
     And feature "2" has no descriptive lines
     And feature "3" has no descriptive lines
@@ -150,7 +88,6 @@ Feature: Features can be modeled.
     Then feature "1" is found to have the following tags:
       | @a_feature_level_tag |
       | @and_another         |
-      | @and_another         |
     And feature "2" has no tags
     And feature "3" has no tags
@@ -200,5 +137,6 @@ Feature: Features can be modeled.
     When the corresponding unit tests are run
     Then all of those specifications are met
   Examples:
-    | additional specifications |
-    | feature_spec.rb           |
+    | additional specifications   |
+    | feature_unit_spec.rb        |
+    | feature_integration_spec.rb |

data/features/modeling/outline_modeling.feature CHANGED Viewed

@@ -16,72 +16,23 @@ Feature: Scenario Outline elements can be modeled.
     Given the following feature file:
     """
     @a_feature_level_tag
-    Feature: The test feature name.
-      Some more feature description.
+    Feature:
       @outline_tag
-      Scenario Outline:The scenario outline's name.
-        My big hunk of perfectly valid description:
-          |
-          Scenario Outline
-          Examples
-          \"\"\"
-          Background
-           this is still one big valid description
-          # Basically, if it's not a step keyword or tag then I will accept
-          # it as description here. Cucumber might not but but that's between
-          # you and its lexxer/parser. ;)
-        Given this *parameterized* step takes a table:
-          | <param1> |
-          | <param2> |
-        And some setup step
-        * some setup step
-#
-        When a step with a *parameter*
-        But a big step:
-        #random comment
-        \"\"\"
-      some text
-        #some comments
-        Scenario:
-        Scenario Outline:
-        Examples:
-        @
-        Feature:
-        |
-        Given
-        When
-        Then
-        And
-        But
-        *
-            some more text
-        \"\"\"
-        Then *lots* *of* *parameters*
-      Examples:text describing the significance of the examples
-          Anything besides the | that starts a row should be valid
-          description at this point in the test. YMMV
-        | param1 | param2 |
-        #A more random comment
-        | x      | y      |
-        @example_tag @another_one
-      Examples: some examples with different significance and a tag
-        Words, words, words, words,
-         why so many words?
-         #
-        | param1 | param2 |
-        #
-        #
-        | a      | b      |
+      Scenario Outline: The scenario outline's name.
+          Some outline description
+          Some more description
+        Given a <setup> step
+        When an action step
+        Then a <verification> step
+      Examples: example 1
+        | setup | verification |
+        | x     | y            |
+      Examples: example 2
+        | setup | verification |
+        | a     | b            |
     """
     And parameter delimiters of "*" and "*"
     When the file is read
@@ -93,105 +44,14 @@ Feature: Scenario Outline elements can be modeled.
   Scenario: The outline description is modeled.
     Then the test descriptive lines are as follows:
-      | My big hunk of perfectly valid description:                       |
-      | \|                                                                |
-      | Scenario Outline                                                  |
-      | Examples                                                          |
-      | """                                                               |
-      | Background                                                        |
-      | this is still one big valid description                           |
+      | Some outline description |
+      | Some more description    |
   Scenario: The outline steps are modeled.
     Then the test steps are as follows:
-      | Given this *parameterized* step takes a table: |
-      | \| <param1> \|                                 |
-      | \| <param2> \|                                 |
-      | And some setup step                            |
-      | * some setup step                              |
-      | When a step with a *parameter*                 |
-      | But a big step:                                |
-      | """                                            |
-      | 'some text'                                    |
-      | ''                                             |
-      | '#some comments'                               |
-      | 'Scenario:'                                    |
-      | 'Scenario Outline:'                            |
-      | 'Examples:'                                    |
-      | '@'                                            |
-      | 'Feature:'                                     |
-      | '\|'                                           |
-      | 'Given'                                        |
-      | 'When'                                         |
-      | 'Then'                                         |
-      | 'And'                                          |
-      | 'But'                                          |
-      | '*'                                            |
-      | '    some more text'                           |
-      | """                                            |
-      | Then *lots* *of* *parameters*                  |
-    And the test steps "without" arguments are as follows:
-      | Given this ** step takes a table: |
-      | And some setup step               |
-      | * some setup step                 |
-      | When a step with a **             |
-      | But a big step:                   |
-      | Then ** ** **                     |
-    And the test steps "without" keywords are as follows:
-      | this *parameterized* step takes a table: |
-      | \| <param1> \|                           |
-      | \| <param2> \|                           |
-      | some setup step                          |
-      | some setup step                          |
-      | a step with a *parameter*                |
-      | a big step:                              |
-      | """                                      |
-      | 'some text'                              |
-      | ''                                       |
-      | '#some comments'                         |
-      | 'Scenario:'                              |
-      | 'Scenario Outline:'                      |
-      | 'Examples:'                              |
-      | '@'                                      |
-      | 'Feature:'                               |
-      | '\|'                                     |
-      | 'Given'                                  |
-      | 'When'                                   |
-      | 'Then'                                   |
-      | 'And'                                    |
-      | 'But'                                    |
-      | '*'                                      |
-      | '    some more text'                     |
-      | """                                      |
-      | *lots* *of* *parameters*                 |
-    And the test steps "without" arguments "without" keywords are as follows:
-      | this ** step takes a table: |
-      | some setup step             |
-      | some setup step             |
-      | a step with a **            |
-      | a big step:                 |
-      | ** ** **                    |
-    And the test step "1" has the following block:
-      | \| <param1> \| |
-      | \| <param2> \| |
-    And the test step "5" has the following block:
-      | """                  |
-      | 'some text'          |
-      | ''                   |
-      | '#some comments'     |
-      | 'Scenario:'          |
-      | 'Scenario Outline:'  |
-      | 'Examples:'          |
-      | '@'                  |
-      | 'Feature:'           |
-      | '\|'                 |
-      | 'Given'              |
-      | 'When'               |
-      | 'Then'               |
-      | 'And'                |
-      | 'But'                |
-      | '*'                  |
-      | '    some more text' |
-      | """                  |
+      | a <setup> step        |
+      | an action step        |
+      | a <verification> step |
   Scenario: The outline tags are modeled.
     Then the test is found to have the following tags:
@@ -203,8 +63,8 @@ Feature: Scenario Outline elements can be modeled.
   Scenario: The outline example blocks are modeled.
     And the test example blocks are as follows:
-      | text describing the significance of the examples    |
-      | some examples with different significance and a tag |
+      | example 1 |
+      | example 2 |
   Scenario Outline: Outline models pass all other specifications
   Exact specifications detailing the API for Scenario Outline models.
@@ -212,5 +72,6 @@ Feature: Scenario Outline elements can be modeled.
     When the corresponding unit tests are run
     Then all of those specifications are met
   Examples:
-    | additional specifications |
-    | outline_spec.rb          |
+    | additional specifications   |
+    | outline_unit_spec.rb        |
+    | outline_integration_spec.rb |

data/features/modeling/scenario_modeling.feature CHANGED Viewed

@@ -15,53 +15,17 @@ Feature: Scenario elements can be modeled.
     Given the following feature file:
     """
     @a_feature_level_tag
-    Feature: The test feature name.
-      Some more feature description.
+    Feature:
       @a_tag
-      @another_tag@yet_another_tag
+      @another_tag
       Scenario:The first scenario's name.
-        My big hunk of perfectly valid description:
-          |
-          Scenario Outline
-          Examples
-          \"\"\"
-          Background
-           this is still one big valid description
-          # Basically, if it's not a step keyword or tag then I will accept
-          # it as description here. Cucumber might not but but that's between
-          # you and its lexxer/parser. ;)
-        Given this *parameterized* step takes a table:
-          | data      |
-          | more data |
-        And some setup step
-        * some setup step
-#
-        When a step with a *parameter*
-        But a big step:
-        #random comment
-        \"\"\"
-      some text
-        #some comments
-        Scenario:
-        Scenario Outline:
-        Examples:
-        @
-        Feature:
-        |
-        Given
-        When
-        Then
-        And
-        But
-        *
-            some more text
-        \"\"\"
-        Then *lots* *of* *parameters*
+          Some scenario description
+          Some more description
+        Given a setup step
+        When an action step
+        Then a verification step
     """
     And parameter delimiters of "*" and "*"
     When the file is read
@@ -73,111 +37,19 @@ Feature: Scenario elements can be modeled.
   Scenario: The scenario description is modeled.
     Then the test descriptive lines are as follows:
-      | My big hunk of perfectly valid description: |
-      | \|                                          |
-      | Scenario Outline                            |
-      | Examples                                    |
-      | """                                         |
-      | Background                                  |
-      | this is still one big valid description     |
+      | Some scenario description |
+      | Some more description     |
   Scenario: The scenario steps are modeled.
     Then the test steps are as follows:
-      | Given this *parameterized* step takes a table: |
-      | \| data      \|                                |
-      | \| more data \|                                |
-      | And some setup step                            |
-      | * some setup step                              |
-      | When a step with a *parameter*                 |
-      | But a big step:                                |
-      | """                                            |
-      | 'some text'                                    |
-      | ''                                             |
-      | '#some comments'                               |
-      | 'Scenario:'                                    |
-      | 'Scenario Outline:'                            |
-      | 'Examples:'                                    |
-      | '@'                                            |
-      | 'Feature:'                                     |
-      | '\|'                                           |
-      | 'Given'                                        |
-      | 'When'                                         |
-      | 'Then'                                         |
-      | 'And'                                          |
-      | 'But'                                          |
-      | '*'                                            |
-      | '    some more text'                           |
-      | """                                            |
-      | Then *lots* *of* *parameters*                  |
-    And the test steps "without" arguments are as follows:
-      | Given this ** step takes a table: |
-      | And some setup step               |
-      | * some setup step                 |
-      | When a step with a **             |
-      | But a big step:                   |
-      | Then ** ** **                     |
-    And the test steps "without" keywords are as follows:
-      | this *parameterized* step takes a table: |
-      | \| data      \|                          |
-      | \| more data \|                          |
-      | some setup step                          |
-      | some setup step                          |
-      | a step with a *parameter*                |
-      | a big step:                              |
-      | """                                      |
-      | 'some text'                              |
-      | ''                                       |
-      | '#some comments'                         |
-      | 'Scenario:'                              |
-      | 'Scenario Outline:'                      |
-      | 'Examples:'                              |
-      | '@'                                      |
-      | 'Feature:'                               |
-      | '\|'                                     |
-      | 'Given'                                  |
-      | 'When'                                   |
-      | 'Then'                                   |
-      | 'And'                                    |
-      | 'But'                                    |
-      | '*'                                      |
-      | '    some more text'                     |
-      | """                                      |
-      | *lots* *of* *parameters*                 |
-    And the test steps "without" arguments "without" keywords are as follows:
-      | this ** step takes a table: |
-      | some setup step             |
-      | some setup step             |
-      | a step with a **            |
-      | a big step:                 |
-      | ** ** **                    |
-    And the test step "1" has the following block:
-      | \| data      \| |
-      | \| more data \| |
-    And the test step "5" has the following block:
-      | """                  |
-      | 'some text'          |
-      | ''                   |
-      | '#some comments'     |
-      | 'Scenario:'          |
-      | 'Scenario Outline:'  |
-      | 'Examples:'          |
-      | '@'                  |
-      | 'Feature:'           |
-      | '\|'                 |
-      | 'Given'              |
-      | 'When'               |
-      | 'Then'               |
-      | 'And'                |
-      | 'But'                |
-      | '*'                  |
-      | '    some more text' |
-      | """                  |
+      | a setup step        |
+      | an action step      |
+      | a verification step |
   Scenario: The scenario tags are modeled.
     Then the test is found to have the following tags:
-      | @a_tag           |
-      | @another_tag     |
-      | @yet_another_tag |
+      | @a_tag       |
+      | @another_tag |
   Scenario: The scenario applied tags are modeled.
     Then the test is found to have the following applied tags:
@@ -189,5 +61,6 @@ Feature: Scenario elements can be modeled.
     When the corresponding unit tests are run
     Then all of those specifications are met
   Examples:
-    | additional specifications |
-    | scenario_spec.rb          |
+    | additional specifications    |
+    | scenario_unit_spec.rb        |
+    | scenario_integration_spec.rb |

data/features/modeling/step_modeling.feature ADDED Viewed

@@ -0,0 +1,68 @@
+Feature: Step elements can be modeled.
+  Acceptance criteria
+  All conceptual pieces of a Step can be modeled:
+    1. the step's keyword
+    2. the text of the step
+    3. the step's arguments, if any
+    4. the step's associated block, if any
+  Background: Test file setup.
+    Given the following feature file:
+    """
+    Feature:
+      Scenario:
+        Given some setup step
+        And some big setup step:
+        \"\"\" content_type
+      some text
+            some more text
+        \"\"\"
+        When this *parameterized* step takes a table:
+          | data      | a header |
+          | more data | a value  |
+        Then a step with a *parameter*
+    """
+    And parameter delimiters of "*" and "*"
+    When the file is read
+  Scenario: The step's keyword is modeled.
+    Then the test step "1" keyword is "Given"
+    And the test step "2" keyword is "And"
+    And the test step "3" keyword is "When"
+    And the test step "4" keyword is "Then"
+  Scenario: The text of the step is modeled.
+    Then test step "1" text is "some setup step"
+    And test step "2" text is "some big setup step:"
+    And test step "3" text is "this *parameterized* step takes a table:"
+    And test step "4" text is "a step with a *parameter*"
+  Scenario: The step's arguments are modeled.
+    Then test step "1" has no arguments
+    And test step "2" has no arguments
+    And test step "3" arguments are:
+      | parameterized |
+    And test step "4" arguments are:
+      | parameter |
+  Scenario: The steps's block is modeled.
+    Then step "1" has no block
+    Then step "2" has a "doc string"
+    And step "3" has a "table"
+    And step "4" has no block
+  Scenario Outline: Step models pass all other specifications
+  Exact specifications detailing the API for Step models.
+    Given that there are "<additional specifications>" detailing models
+    When the corresponding unit tests are run
+    Then all of those specifications are met
+  Examples:
+    | additional specifications |
+    | step_unit_spec.rb         |
+    | step_integration_spec.rb  |

data/features/modeling/table_modeling.feature ADDED Viewed

@@ -0,0 +1,41 @@
+Feature: Table elements can be modeled.
+  Acceptance criteria
+  All conceptual pieces of a Table can be modeled:
+    1. the table's contents
+  Background: Test file setup.
+    Given the following feature file:
+    """
+    Feature:
+      Scenario:
+        * some data filled step:
+          | value 1 | value 2 |
+          | value 3 | value 4 |
+        * some data filled step:
+          | value 1 |
+          | value 2 |
+    """
+    When the file is read
+  Scenario: The table's contents are modeled.d
+    Then the step "1" table has the following contents:
+      | value 1 | value 2 |
+      | value 3 | value 4 |
+    And the step "2" table has the following contents:
+      | value 1 |
+      | value 2 |
+  Scenario Outline: Table models pass all other specifications
+  Exact specifications detailing the API for Table String models.
+    Given that there are "<additional specifications>" detailing models
+    When the corresponding unit tests are run
+    Then all of those specifications are met
+  Examples:
+    | additional specifications |
+    | table_unit_spec.rb        |