yard-cucumber 2.1.3 → 2.1.4

data/History.txt

@@ -1,3 +1,7 @@
+=== 2.1.4 / 2011-10-10
+
+* Support for multiple scenario outlines (Thanks @jmerrifield)
+
 === 2.1.3 / 2011-09-24
 
 * Support for Gherkin ~ 2.5 (Thanks @turboladen)

data/example/scenario_outline.feature

@@ -77,4 +77,18 @@ Feature: Displaying Scenario Outlines
     And I expect <denomination> to be replaced by the example denomination
     
     Examples:
-      | name | price | denomination |
+      | name | price | denomination |
+
+  Scenario Outline: Multiple Example Table
+    Given that <Customer> is a valid customer
+    And that the product, named '<Product>', is a valid product
+    When the customer has purchased the product
+    Then I expect the customer to be a member of the '<Product>' group
+
+    Examples: Example group A
+     | Customer   | Product   |
+     | Customer A | Product A |
+
+    Examples: Example group B
+     | Customer   | Product   |
+     | Customer B | Product A |

data/example/scenario_outline_multi.feature

@@ -0,0 +1,15 @@
+Feature: My Feature
+
+Scenario Outline: Multiple Example Table
+  Given that <Customer> is a valid customer
+  And that the product, named '<Product>', is a valid product
+  When the customer has purchased the product
+  Then I expect the customer to be a member of the '<Product>' group
+
+  Examples: Example group A
+   | Customer   | Product   |
+   | Customer A | Product A |
+
+  Examples: Example group B
+   | Customer   | Product   |
+   | Customer B | Product A |

data/example/step_definitions/struct.rb

@@ -0,0 +1,11 @@
+#
+# @see https://github.com/burtlo/yard-cucumber/issues/18
+# 
+CustomerUsageBehavior = Struct.new(:weight, :days, :time, :location, :other_party, :usage_type, :direction, :quantity)
+
+
+class CustomerProfile
+  def generate_winner(max=@total_weight)
+     # blah
+  end
+end

data/lib/cucumber/city_builder.rb

@@ -186,16 +186,24 @@ module Cucumber
       # 
       def examples(examples)
         #log.debug "EXAMPLES"
-
-        @step_container.examples = { :keyword => examples.keyword,
+        
+        example = YARD::CodeObjects::Cucumber::ScenarioOutline::Examples.new(:keyword => examples.keyword,
           :name => examples.name,
           :line => examples.line,
           :comments => examples.comments.map{|comment| comment.value}.join("\n"),
-          :rows => matrix(examples.rows) }
+          :rows => matrix(examples.rows))
+          
+          
+        # add the example to the step containers list of examples
 
-        # For each example generate a scenario and steps
-        
-        @step_container.example_data.length.times do |row_index|
+        @step_container.examples << example
+
+        # For each example data row we want to generate a new scenario using our
+        # current scenario as the template.
+
+        example.data.length.times do |row_index|
+          
+          # Generate a copy of the scenario.
 
           scenario = YARD::CodeObjects::Cucumber::Scenario.new(@step_container,"example_#{@step_container.scenarios.length + 1}") do |s|
             s.comments = @step_container.comments
@@ -205,6 +213,8 @@ module Cucumber
             s.value = "#{@step_container.value} (#{@step_container.scenarios.length + 1})"
           end
 
+          # Generate a copy of the scenario steps.
+
           @step_container.steps.each do |step|
             step_instance = YARD::CodeObjects::Cucumber::Step.new(scenario,step.line_number) do |s|
               s.keyword = step.keyword.dup
@@ -215,23 +225,29 @@ module Cucumber
               s.table = clone_table(step.table) if step.has_table?
             end
 
-            @step_container.example_values_for_row(row_index).each do |key,text|
+            # Look at the particular data for the example row and do a simple
+            # find and replace of the <key> with the associated values.
+
+            example.values_for_row(row_index).each do |key,text|
               text ||= "" #handle empty cells in the example table
               step_instance.value.gsub!("<#{key}>",text)
               step_instance.text.gsub!("<#{key}>",text) if step_instance.has_text?
               step_instance.table.each{|row| row.each{|col| col.gsub!("<#{key}>",text)}} if step_instance.has_table?
             end
-
+            
+            # Connect these steps that we created to the scenario we created
+            # and then add the steps to the scenario created.
+            
             step_instance.scenario = scenario
             scenario.steps << step_instance
           end
 
-          # Scenario instances of an outline link to the feature but are not linked from the feature
-          # @feature.scenarios << scenario
-
+          # Add the scenario to the list of scenarios maintained by the  feature 
+          # and add the feature to the scenario
+          
           scenario.feature = @feature
           @step_container.scenarios << scenario
-          
+        
         end
         
       end
@@ -261,6 +277,8 @@ module Cucumber
           rubify(step.rows)
         end 
         
+        log.debug "Step: #{multiline_arg}"
+        
         case(multiline_arg)
         when gherkin_multiline_string_class
           @table_owner.text = multiline_arg.value

data/lib/templates/default/feature/html/outline.erb

@@ -9,32 +9,40 @@
 <div class="outline">
   
   <% if @scenario.examples? %>
-  <div class="keyword"> <%= h @scenario.example_keyword %></div>
-  <table>
-    <thead>
-      <tr>
-        <% @scenario.example_headers.each_with_index do |header,header_index| %>
-          <th><%= h(header) %></th>
+    
+    <% @scenario.examples.each_with_index do |example,example_index| %>
+      <div class="keyword">
+        <%= h example.keyword %><%= example.name != "" ? ':' : '' %>
+      </div>
+      <div class="example-group-name"><%= h example.name %></div>
+      <br style="clear: both;"/>
+      <table>
+        <thead>
+          <tr>
+            <% example.headers.each_with_index do |header,header_index| %>
+              <th><%= h(header) %></th>
+            <% end %>
+          </tr>
+        </thead>
+        <% unless example.data.empty? %>
+          <% example.data.each_with_index do |row,row_index| %>
+          <tr class="<%= (row_index + 1) % 2 == 0 ? "even example#{example_index+1}-#{row_index +1}" : "odd example#{example_index+1}-#{row_index +1}" %>">
+            <% row.each_with_index do |column,column_index| %>
+              <td><%= h(column.to_s.strip) %></td>
+            <% end %>
+          </tr>
+          <% end %>
+        <% else %>
+          <!-- Scenario Outline example table is empty -->
+          <tr class="odd">
+            <td colspan="<%= example.headers.length %>" style="text-align: center;">
+              No Examples Defined
+            </td>
+          </tr>
         <% end %>
-      </tr>
-    </thead>
-    <% unless @scenario.example_data.empty? %>
-      <% @scenario.example_data.each_with_index do |row,row_index| %>
-      <tr class="<%= (row_index + 1) % 2 == 0 ? "even example#{row_index +1}" : "odd example#{row_index +1}" %>">
-        <% row.each_with_index do |column,column_index| %>
-          <td><%= h(column.to_s.strip) %></td>
-        <% end %>
-      </tr>
-      <% end %>
-    <% else %>
-      <!-- Scenario Outline example table is empty -->
-      <tr class="odd">
-        <td colspan="<%= @scenario.example_headers.length %>" style="text-align: center;">
-          No Examples Defined
-        </td>
-      </tr>
-    <% end %>
-  </table>
+      </table>
+    <% end  %>
+    
   <% else %>
   <div class="keyword">No Example Table Defined</div>
   <div class="keyword suggestion developer">[!] Did you mean to create a Scenario?</div>

data/lib/templates/default/fulldoc/html/css/cucumber.css

@@ -123,11 +123,19 @@ div.undefined { padding: 6px; }
     margin-left: 40px;
 }
 .outline .keyword {
+    float: left;
+    margin-top: 20px;
     padding: 4px;
     font-weight: bold;
     font-size: 16px;
 }
-
+.outline .example-group-name {
+    float: left;
+    margin-top: 20px;
+    padding: 4px 4px 4px 20px;
+    font-size: 14px;
+    color: #343332;
+}
 .multiline table tr, .outline table tr {
     padding: 4px;
 }

data/lib/yard/code_objects/cucumber/scenario_outline.rb

@@ -13,7 +13,7 @@ module YARD::CodeObjects::Cucumber
       @steps = []
       @tags = []
       @scenarios = []
-      @examples = {}
+      @examples = []
     end
 
     def background?
@@ -25,40 +25,49 @@ module YARD::CodeObjects::Cucumber
     end
     
     def examples?
-      !@examples[:rows].nil?
-    end
-
-    def example_keyword
-      @examples[:keyword]
+      @examples.find {|example| example.rows }
     end
     
-    def example_headers
-      @examples[:rows].first
-    end
     
-    def example_data
-      return "" unless @examples[:rows]
-      @examples[:rows][1..-1]
-    end
+    class Examples
+      
+      attr_accessor :name, :line, :keyword, :comments, :rows
+      
+      # The first row of the rows contains the headers for the table
+      def headers
+        rows.first
+      end
+      
+      # The data of the table starts at the second row. When there is no data then
+      # return a empty string.
+      def data
+        rows ? rows[1..-1] : ""
+      end
+      
+      def values_for_row(row)
+        hash = {}
 
-    def example_values_for_row(row)
-      hash = {}
+        headers.each_with_index do |header,index|
+          hash[header] = data[row][index]
+        end
 
-      example_headers.each_with_index do |header,index|
-        hash[header] = example_data[row][index]
+        hash
       end
+      
+      def to_hash
+        hash = {}
 
-      hash
-    end
-    
-    def example_hash
-      hash = {}
+        rows.each_with_index do |header,index|
+          hash[header] = rows.collect {|row| row[index] }
+        end
+
+        hash
+      end
       
-      @examples[:rows].each_with_index do |header,index|
-        hash[header] = @examples[:rows].collect {|row| row[index] }
+      def initialize(parameters = {})
+        parameters.each {|key,value| send("#{key.to_sym}=",value) if respond_to? "#{key.to_sym}=" }
       end
       
-      hash
     end
     
   end

data/lib/yard-cucumber.rb

@@ -4,7 +4,7 @@ require 'gherkin/formatter/tag_count_formatter'
 
 
 module CucumberInTheYARD
-  VERSION = '2.1.3'
+  VERSION = '2.1.4'
 end
 
 require File.dirname(__FILE__) + "/yard/code_objects/cucumber/base.rb"

metadata

@@ -2,7 +2,7 @@
 name: yard-cucumber
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.3
+  version: 2.1.4
 platform: ruby
 authors: 
 - Franklin Webber
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-24 00:00:00 Z
+date: 2011-10-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gherkin
@@ -68,9 +68,11 @@ files:
 - example/french.feature
 - example/scenario.feature
 - example/scenario_outline.feature
+- example/scenario_outline_multi.feature
 - example/step_definitions/example.step.rb
 - example/step_definitions/first.step.rb
 - example/step_definitions/french_steps.rb
+- example/step_definitions/struct.rb
 - example/step_definitions/support/env.rb
 - example/step_definitions/support/env_support.rb
 - example/step_definitions/support/support.rb
@@ -139,7 +141,7 @@ homepage: http://github.com/burtlo/yard-cucumber
 licenses: []
 
 post_install_message: "\n\
-  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n  Thank you for installing yard-cucumber 2.1.3 / 2011-09-24.\n  \n  Changes:\n    \n  * Support for Gherkin ~ 2.5 (Thanks @turboladen)\n  \n\n\
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n  Thank you for installing yard-cucumber 2.1.4 / 2011-10-10.\n  \n  Changes:\n    \n  * Support for multiple scenario outlines (Thanks @jmerrifield)\n  \n\n\
   (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
 rdoc_options: 
 - --charset=UTF-8