cucumber_analytics 0.0.1 → 0.0.2

data/features/modeling/background_modeling.feature

@@ -15,11 +15,17 @@ Feature: Background elements can be modeled.
       Some more feature description.
 
       Background: Some general test setup stuff.
-      #unimportant text
-      #   more of the same
-        A little more information.
-
+       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. ;)
         * this *parameterized* step takes a table:
           | data      |
           | more data |
@@ -62,7 +68,13 @@ Feature: Background elements can be modeled.
 
   Scenario: The background description is modeled.
     Then the background's descriptive lines are as follows:
-      | A little more information. |
+      | My big hunk of perfectly valid description:                       |
+      | \|                                                                |
+      | Scenario Outline                                                  |
+      | Examples                                                          |
+      | """                                                               |
+      | Background                                                        |
+      | this is still one big valid description                           |
 
   Scenario: The background steps are modeled.
     Then the background's steps are as follows:

data/features/modeling/feature_modeling.feature

@@ -26,6 +26,23 @@ Feature: Features can be modeled.
 
       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:
+        *
+        |
+
+        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.
+
+
       Background: Some general test setup stuff.
         A little more information.
         * some setup step
@@ -109,8 +126,19 @@ 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.                 |
+      | 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:                                |
+      | *                                                                   |
+      | \|                                                                  |
+      | Scenario Outline                                                    |
+      | Examples                                                            |
+      | """                                                                 |
+      | Background                                                          |
+      | Then this is still one big valid description                        |
     And feature "2" has no descriptive lines
     And feature "3" has no descriptive lines
 

data/features/modeling/outline_modeling.feature

@@ -20,8 +20,18 @@ Feature: Scenario Outline elements can be modeled.
 
       @outline_tag
       Scenario Outline: The scenario outline's name.
-        Some text describing the scenario.
-        More text.
+        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> |
@@ -49,9 +59,8 @@ Feature: Scenario Outline elements can be modeled.
         Then *lots* *of* *parameters*
 
       Examples: text describing the significance of the examples
-        #
-        #
-        And even more description if you really need it.
+          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      |
@@ -80,8 +89,13 @@ Feature: Scenario Outline elements can be modeled.
 
   Scenario: The outline description is modeled.
     Then the test descriptive lines are as follows:
-      | Some text describing the scenario. |
-      | More text.                         |
+      | My big hunk of perfectly valid description:                       |
+      | \|                                                                |
+      | Scenario Outline                                                  |
+      | Examples                                                          |
+      | """                                                               |
+      | Background                                                        |
+      | this is still one big valid description                           |
 
   Scenario: The outline steps are modeled.
     Then the test steps are as follows:
@@ -181,6 +195,6 @@ Feature: Scenario Outline elements can be modeled.
       | <row1> |
       | <row2> |
   Examples:
-    | outline | set | name                                                | description1                                     | description2       | tag1         | tag2         | row1                   | row2                   |
-    | 1       | 1   | text describing the significance of the examples    | And even more description if you really need it. |                    |              |              | \| param1 \| param2 \| | \| x      \| y      \| |
-    | 1       | 2   | some examples with different significance and a tag | Words, words, words, words,                      | why so many words? | @example_tag | @another_one | \| param1 \| param2 \| | \| a      \| b      \| |
+    | outline | set | name                                                | description1                                              | description2                                | tag1         | tag2         | row1                   | row2                   |
+    | 1       | 1   | 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 \| | \| x      \| y      \| |
+    | 1       | 2   | some examples with different significance and a tag | Words, words, words, words,                               | why so many words?                          | @example_tag | @another_one | \| param1 \| param2 \| | \| a      \| b      \| |

data/features/modeling/scenario_modeling.feature

@@ -21,10 +21,17 @@ Feature: Scenario elements can be modeled.
 
       @another_tag@yet_another_tag
       Scenario: The first scenario's name.
-    #a comment
+        My big hunk of perfectly valid description:
+          |
 
-        Some text describing the scenario.
-        More text.
+          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 |
@@ -62,8 +69,13 @@ Feature: Scenario elements can be modeled.
 
   Scenario: The scenario description is modeled.
     Then the test descriptive lines are as follows:
-      | Some text describing the scenario. |
-      | More text.                         |
+      | My big hunk of perfectly valid description:                       |
+      | \|                                                                |
+      | Scenario Outline                                                  |
+      | Examples                                                          |
+      | """                                                               |
+      | Background                                                        |
+      | this is still one big valid description                           |
 
   Scenario: The scenario steps are modeled.
     Then the test steps are as follows:

data/lib/cucumber_analytics/feature_element.rb

@@ -40,15 +40,5 @@ module CucumberAnalytics
       source_lines.shift
     end
 
-    def parse_feature_element_description(source_lines)
-      until source_lines.first =~ /^\s*(?:(?:Given )|(?:When )|(?:Then )|(?:\* ))/ or
-          source_lines.first =~ /^\s*\|/ or
-          source_lines.empty?
-
-        @description << source_lines.first.strip
-        source_lines.shift
-      end
-    end
-
   end
 end

data/lib/cucumber_analytics/outline_example.rb

@@ -27,5 +27,14 @@ module CucumberAnalytics
       rows.concat source_lines.collect { |line| line.strip }
     end
 
+    def parse_feature_element_description(source_lines)
+      until source_lines.first =~ /^\s*\|/ or
+          source_lines.empty?
+
+        @description << source_lines.first.strip
+        source_lines.shift
+      end
+    end
+
   end
 end

data/lib/cucumber_analytics/parsed_background.rb

@@ -19,5 +19,14 @@ module CucumberAnalytics
       parse_test_element_steps(source_lines)
     end
 
+    def parse_feature_element_description(source_lines)
+      until source_lines.first =~ /^\s*(?:(?:Given )|(?:When )|(?:Then )|(?:And )|(?:\* ))/ or
+          source_lines.empty?
+
+        @description << source_lines.first.strip
+        source_lines.shift
+      end
+    end
+
   end
 end

data/lib/cucumber_analytics/parsed_feature.rb

@@ -66,5 +66,14 @@ module CucumberAnalytics
       parse_feature_element(source_lines)
     end
 
+    def parse_feature_element_description(source_lines)
+      until source_lines.first =~ /^\s*(?:(?:Scenario: )|(?:Scenario Outline: )|(?:Background: )|(?:@ ))/ or
+          source_lines.empty?
+
+        @description << source_lines.first.strip
+        source_lines.shift
+      end
+    end
+
   end
 end

data/lib/cucumber_analytics/parsed_file.rb

@@ -38,6 +38,7 @@ module CucumberAnalytics
 
       File.open(@file, 'r') { |file| file_lines = file.readlines }
 
+      # collect feature tag lines
       until file_lines.first =~ /^s*Feature:/
         unless ignored_line?(file_lines.first)
           feature_lines << file_lines.first
@@ -45,6 +46,7 @@ module CucumberAnalytics
         file_lines.shift
       end
 
+      # collect everything else until the end of the feature section
       until file_lines.first =~ /^\s*(?:@|Background:|Scenario:|(?:Scenario Outline:))/ or file_lines.empty?
         unless ignored_line?(file_lines.first)
           feature_lines << file_lines.first
@@ -52,15 +54,28 @@ module CucumberAnalytics
         file_lines.shift
       end
 
-      until file_lines.first =~ /^\s*(?:@|Scenario:|(?:Scenario Outline:))/ or file_lines.empty?
-        if file_lines.first =~ /^\s*"""/
-          background_lines.concat(extract_doc_string!(file_lines))
-        else
+      if file_lines.first =~ /^\s*Background:/
+
+        # collect the background description lines
+        until (file_lines.first =~ /^\s*(?:(?:Given )|(?:When )|(?:Then )|(?:And )|(?:\* )|@|Scenario:|(?:Scenario Outline:))/) or file_lines.empty?
           unless ignored_line?(file_lines.first)
             background_lines << file_lines.first
           end
           file_lines.shift
         end
+
+        # collect everything else up to the first test
+        until file_lines.first =~ /^\s*(?:@|Scenario:|(?:Scenario Outline:))/ or file_lines.empty?
+          if file_lines.first =~ /^\s*"""/
+            background_lines.concat(extract_doc_string!(file_lines))
+          else
+            unless ignored_line?(file_lines.first)
+              background_lines << file_lines.first
+            end
+            file_lines.shift
+          end
+        end
+
       end
 
       @feature = ParsedFeature.new(feature_lines)
@@ -76,8 +91,11 @@ module CucumberAnalytics
       test_lines = []
 
       until lines.empty?
+        # we'll need this in order to figure out whether we are dealing with a
+        # scenario or an outline
         current_test_line = lines.index { |line| line =~ /^\s*(?:Scenario:|(?:Scenario Outline:))/ }
 
+        # collect the tag lines
         until lines.first =~ /^\s*(?:Scenario:|(?:Scenario Outline:))/
           unless ignored_line?(lines.first)
             test_lines << lines.first
@@ -88,6 +106,15 @@ module CucumberAnalytics
         test_lines << lines.first
         lines.shift
 
+        # collect the description lines
+        until (lines.first =~ /^\s*(?:(?:Given )|(?:When )|(?:Then )|(?:And )|(?:\* )|Scenario:|(?:Scenario Outline:))/) or lines.empty?
+          unless ignored_line?(lines.first)
+            test_lines << lines.first
+          end
+          lines.shift
+        end
+
+        # collect everything else up to the next test
         until (lines.first =~ /^\s*(?:Scenario:|(?:Scenario Outline:))/) or lines.empty?
           if (lines.first =~ /^\s*"""/)
             test_lines.concat(extract_doc_string!(lines))
@@ -99,12 +126,14 @@ module CucumberAnalytics
           end
         end
 
+        # backtrack in order to not end up stealing the next test's tag lines
         unless lines.empty?
           while  (test_lines.last =~ /^\s*@/)
             lines = [test_lines.pop].concat(lines)
           end
         end
 
+        # use the collected lines to create a scenario or an outline accordingly
         if test_lines[current_test_line] =~ /^\s*Scenario Outline:/
           next_test = ParsedScenarioOutline.new(test_lines)
         else

data/lib/cucumber_analytics/parsed_scenario.rb

@@ -25,5 +25,14 @@ module CucumberAnalytics
       parse_test_element_steps(source_lines)
     end
 
+    def parse_feature_element_description(source_lines)
+      until source_lines.first =~ /^\s*(?:(?:Given )|(?:When )|(?:Then )|(?:And )|(?:\* ))/ or
+          source_lines.empty?
+
+        @description << source_lines.first.strip
+        source_lines.shift
+      end
+    end
+
   end
 end

data/lib/cucumber_analytics/parsed_scenario_outline.rb

@@ -31,6 +31,15 @@ module CucumberAnalytics
       parse_outline_examples(source_lines)
     end
 
+    def parse_feature_element_description(source_lines)
+      until source_lines.first =~ /^\s*(?:(?:Given )|(?:When )|(?:Then )|(?:And )|(?:\* )| (?:Examples: ))/ or
+          source_lines.empty?
+
+        @description << source_lines.first.strip
+        source_lines.shift
+      end
+    end
+
     def parse_outline_examples(source_lines)
       until source_lines.empty?
         current_example_line = source_lines.index { |line| line =~ /^\s*Examples/ }

data/lib/cucumber_analytics/version.rb

@@ -1,3 +1,3 @@
 module CucumberAnalytics
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber_analytics
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-28 00:00:00.000000000 Z
+date: 2012-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake