cucumber-in-the-yard 1.7.2 → 1.7.3

data/History.txt

@@ -1,3 +1,15 @@
+=== 1.7.3 / 2010-12-06
+
+* Shortcut Keys (t) for tags and (r) for features (f was taken)
+* Step definitions/transforms consolidate steps for easier viewing
+  and when they have no steps they are colored differently
+* Tag filtering supports inverse (~) of tags  
+
+* FIX Scenario Outlines without examples will not crash the parser
+* FIX Features, Scenarios, and Directories should display in alphabetic order
+* FIX Comments and multiline strings will display correctly
+* FIX Feature comments will show
+
 === 1.7.2 / 2010-11-30
 
 * Step Definition and Transform page enhancements

data/README.md

@@ -108,7 +108,29 @@ scale to test the functionality of small software component.  Though, ultimately
 functionality may provide a valuable tool for many as I feel it helps more solidly bridge the reporting of 
 the documentation by putting a coat of paint on it.
 
+
+Short Term Goals
+----------------
+
+1. Add the features listing to the index.html
+2. The landing page for 'All features' should be requirements landing page.
+3. 'All Features' takes you to all the features.
+  * represent the file structure in a file structure way and change
+    the subtitle 'subdirectories' to 'features by directory' and
+    show the directory headings with the features within them
+6. Provide readme.md markdown support within each of the feature subdirectories
+7. Tag filering
+  * create and provide a video link of how to filter
+  * allow you to remove tag elements visually with the mouse click
+  * provide a copy to clipboard for the command line execution
+8. Step Transformers
+  * provide copy to clipboard
+  * Think of a way to illustrate that a step has a transform being applied
+9. Feature Directory
+  * Layout of the subdirectories should be more directory like and provide more information
 Roadmap
+  * Parent directories of directories contain no feature/scenario/tags statistics
+
 -------
 
 **Future Feature Ideas**

data/example/child_feature/child.feature

@@ -0,0 +1,11 @@
+@scenarios
+Feature: Child Feature
+  As a reader of the documentation I expect that scenario are documented correctly
+
+  Background:
+    Given this background step
+
+  Scenario: Child Scenario
+    Given this first step
+	  When this second step
+	  Then this third step

data/example/child_feature/grandchild_feature/grandchild.feature

@@ -0,0 +1,12 @@
+@scenarios
+Feature: Grandchild Feature
+  As a reader of the documentation I expect that scenario are documented correctly
+
+  Background:
+    Given this background step
+
+  @first
+  Scenario: Grandchild Scenario
+    Given this first step
+  	When this second step
+	  Then this third step

data/example/scenario.feature

@@ -1,7 +1,9 @@
-@scenarios @bvt
-Feature: Scenario
+# Comments that appear before the feature are associated with the feature
+@scenarios
+Feature: Displaying Scenarios
   As a reader of the documentation I expect that scenario are documented correctly
-
+  
+  # Comments after the feature description belong to the background or first scenario
   Background:
     Given this background step
 
@@ -11,9 +13,9 @@ Feature: Scenario
   @second
   Scenario: Scenario With Steps
     Given this first step
-    When this second step
-    Then this third step
-
+	When this second step
+	Then this third step
+	
   @third @optional_parameters
   Scenario: Optional Parameter Step Definition
     # This step definition has some optional parameters
@@ -35,17 +37,25 @@ Feature: Scenario
   @sixth @text
   Scenario: Scenario With Text
     Given the following text:
-      """
-        Oh what a bother!
-      """
+    """
+      Oh what a bother!
+      That this text has to take up two lines
+    """
 
+  # Comments before the scenario
   @seventh @comments
-  Scenario: Scenario with comments and
-    with multiple lines for the name
-
+  Scenario: Scenario with comments and a description
+    There once was a need for information to be displayed alongside all the
+    entities that I hoped to test
     # First Comment
     Given this first step
-    # Second Comment
+    # Second Comment that
+    # spans a few lines
     And this second step
     # Third Comment
     And this third step
+    # Comments after the last step, where do they go?
+
+  Scenario: Step ending with a match with double-quotes
+    When searching the log for the exact match of the message "Entering application."
+    When the step definition has HTML escaped characters like: "<>&"

data/example/scenario_outline.feature

@@ -1,5 +1,5 @@
 @scenario_outlines @bvt
-Feature: Scenario Outline
+Feature: Displaying Scenario Outlines
   As a reader of the documentation I expect that scenario outlines are documented correctly
 
   @first
@@ -22,7 +22,7 @@ Feature: Scenario Outline
     The <noun> jumped over the <place>
     """
     When I click on an example row
- 	Then I expect <noun> to be replaced by the example noun
+ 	  Then I expect <noun> to be replaced by the example noun
     And I expect <place> to be replaced by the example place
     
     Examples:
@@ -36,7 +36,7 @@ Feature: Scenario Outline
       | name   | price   | quantity |
       | <name> | <price> | 100000   |
     When I click on an example row
- 	Then I expect <name> to be replaced by the example name
+ 	  Then I expect <name> to be replaced by the example name
     And I expect <price> to be replaced by the example price
 
     Examples:
@@ -49,12 +49,32 @@ Feature: Scenario Outline
     Given the following table:
       | name   | <denomination> | quantity |
       | <name> | <price>        | 100000   |
-	When I click on an example row
- 	Then I expect <name> to be replaced by the example name
+	  When I click on an example row
+    Then I expect <name> to be replaced by the example name
     And I expect <price> to be replaced by the example price
     And I expect <denomination> to be replaced by the example denomination
 
     Examples:
      | name | price | denomination    |
      | toy  | 99    | cost in euros   |
-     | game | 49    | cost in dollars |
+     | game | 49    | cost in dollars |
+     
+  # This is an example of a scenario outline in development.
+  # The example table has not been defined yet
+  Scenario Outline: Example Table Missing
+    When I click on an example row
+    Then I expect <name> to be replaced by the example name
+    And I expect <price> to be replaced by the example price
+    And I expect <denomination> to be replaced by the example denomination
+      
+    
+  # This is an example of a scenario outline in development.  
+  # The examples table has been defined, but is missing data.
+  Scenario Outline: Empty Example Table
+    When I click on an example row
+    Then I expect <name> to be replaced by the example name
+    And I expect <price> to be replaced by the example price
+    And I expect <denomination> to be replaced by the example denomination
+    
+    Examples:
+      | name | price | denomination |

data/lib/city.rb

@@ -3,7 +3,7 @@ require 'gherkin/parser/parser'
 require 'gherkin/formatter/tag_count_formatter'
 
 module CucumberInTheYARD
-  VERSION = '1.7.2' unless defined?(CucumberInTheYARD::VERSION)
+  VERSION = '1.7.3' unless defined?(CucumberInTheYARD::VERSION)
 end
 
 require File.dirname(__FILE__) + "/yard/code_objects/cucumber/base.rb"

data/lib/cucumber/city_builder.rb

@@ -15,7 +15,6 @@ module Cucumber
       end
 
       def find_or_create_namespace(file)
-        # TODO: The directory that is added should have the full path
         file.split('/')[0..-2].each do |directory|
           @namespace = @namespace.children.find {|child| child.name == directory } ||
             YARD::CodeObjects::Cucumber::FeatureDirectory.new(@namespace,directory) {|dir| dir.add_file(directory)}
@@ -101,7 +100,7 @@ module Cucumber
       end
 
       def examples(examples)
-        #log.debug "EXAMPLES #{examples.name}"
+        #log.debug "EXAMPLES"
 
         @step_container.examples = { :keyword => examples.keyword,
           :name => examples.name,
@@ -132,6 +131,7 @@ module Cucumber
             end
 
             @step_container.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?

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

@@ -1,32 +1,38 @@
 <script type="text/javascript" charset="utf-8">
-  $(function() {
-    $(".developer").hide();
-  });
+$(function() {
+  $(".developer").hide();
+});
 </script>
 
 <div class="feature">
   <div class="title">
+    <a id="view" class="control" href="#">[More Detail]</a>
+    <a id="expand" class="control" href="#">[Collapse All]</a>
+    <div style="clear: right;"></div>
     <span class="pre"><%= @feature.keyword %>:</span>
     <span class="name"><%= @feature.value %></span>
+  </div>
 
-    <div id="view" class="control">[More Detail]</div>
-    <div id="expand" class="control">[Collapse All]</div>
-</div>
+  <% if @feature.comments.length > 0 %>
+  <div class="comments developer">
+    <%= htmlify_with_newlines @feature.comments %>  
+  </div>
+  <% end %>
 
-<div class="meta">
-  <div class="file developer"><%= h(@feature.file) %></div>
-  <div style="clear: right;"></div>
-  <div class="tags developer">
-    <% @feature.tags.each do |tag| %>
-      <a href="<%= url_for tag %>"><%= tag.value %></a>
-    <% end %>
+  <div class="description">
+    <%= htmlify_with_newlines @feature.description %>
   </div>
-</div>
 
-<div class="description">
-  <%= @feature.description %>
-</div>
+  <div class="meta">
+    <div class="file developer"><%= h(@feature.file) %></div>
+    <div style="clear: right;"></div>
+    <div class="tags developer">
+      <% @feature.tags.each do |tag| %>
+      <a href="<%= url_for tag %>"><%= tag.value %></a>
+      <% end %>
+    </div>
+  </div>
 
-<%= yieldall %>
+  <%= yieldall %>
 </div>
 

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

@@ -7,7 +7,9 @@
 <% end %>
 
 <div class="outline">
-  <div class="keyword"> <%= h @scenario.example_keyword %> </div>
+  
+  <% if @scenario.examples? %>
+  <div class="keyword"> <%= h @scenario.example_keyword %></div>
   <table>
     <thead>
       <tr>
@@ -16,12 +18,25 @@
         <% end %>
       </tr>
     </thead>
-    <% @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>
+    <% 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 %>
-    </tr>
+    <% 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>
+  <% else %>
+  <div class="keyword">No Example Table Defined</div>
+  <div class="keyword suggestion developer">[!] Did you mean to create a Scenario?</div>
+  <% end %>
 </div>

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

@@ -1,3 +1,3 @@
 <div class="text">
-	<%= h @step.text %>
+	<%= htmlify_with_newlines @step.text %>
 </div>

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

@@ -4,17 +4,18 @@
     <a class="toggle"> - </a>
     <span class="pre"><%= @scenario.keyword %>:</span>
     <span class="name"><%= h @scenario.value %></span>
+    <a style="float:right; clear:right;" href="<% url_for(@scenario.feature,"scenario#{@id}") %>">link</a>
   </div>
 
   <% if @scenario.description.length > 0 %>
   <div class="description">
-    <%= h @scenario.description %>
+    <%= htmlify_with_newlines @scenario.description %>
   </div>
   <% end %>
 
   <% if @scenario.comments.length > 0 %>
   <div class="comments developer">
-    <%= h @scenario.comments %>
+    <%= htmlify_with_newlines @scenario.comments %>
   </div>
   <% end %>
 

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

@@ -2,7 +2,7 @@
   <% @step = step %>
 
   <% if step.comments && step.comments.length > 0 %>
-  <div class="comments developer"><%= h step.comments %></div>
+  <div class="comments developer"><%= htmlify_with_newlines step.comments %></div>
   <% end %>
   <div class="step <%= (index + 1) % 2 == 0 ? 'even' : 'odd' %>">
     <span class="predicate"><%= step.keyword %></span>

data/lib/templates/default/feature/setup.rb

@@ -48,4 +48,8 @@ def highlight_matches(step)
   end
   
   value
+end
+
+def htmlify_with_newlines(text)
+  text.split("\n").collect {|c| h(c) }.join("<br/>") 
 end

data/lib/templates/default/featuredirectory/html/setup.rb

@@ -15,6 +15,7 @@ def all_types_by_letter(type)
   objects = @directory.children.find_all {|child| child.is_a?(type) }
   objects = run_verifier(objects)
   objects.each {|o| (hash[o.value.to_s[0,1].upcase] ||= []) << o }
+  hash.values.each {|v| v.sort! {|a,b| b.value.to_s <=> a.value.to_s } }
   hash
 end
 

data/lib/templates/default/featuretags/html/namespace.erb

@@ -4,6 +4,23 @@
       var tag_list = [ <%= tags.collect{|t| "'#{t.value}'" }.join(',') %> ];
 
       $(function() {
+
+        // On focus, remove all the shortcut keys
+        $("#tag_search").focus(function() {
+          $(document).unbind('keypress');
+        });
+        
+        // On blur, return all the shortcut keys
+        $("#tag_search").blur(function() {
+          $(document).bind('keypress',keyboardShortcuts);
+          $(document).bind('keypress',cucumberKeyboardShortcuts);
+        });
+
+        $("#tag_search").keyup(function(evt) {
+          updateTagFiltering($("#tag_search")[0].value);
+        });
+
+        
         $("#tag_search").keyup(function(evt) {
           updateTagFiltering($("#tag_search")[0].value);
         });
@@ -11,15 +28,29 @@
          $(".tag").click(function(evt) {
             if (typeof evt !== "undefined") {
 
-              if (evt.ctrlKey === true)  {
+              if (evt.shiftKey === true)  {
                 window.location = $(this).attr("href");
-              } else if (evt.altKey === true ) {
-                $("#tag_search")[0].value += ($("#tag_search")[0].value != "" ? "," : "") + this.innerHTML;
-                updateTagFiltering($("#tag_search")[0].value);
+                return true;
+              }
+              
+              var tagSearchElement = $("#tag_search")[0];
+              
+              var tagToAdd = this.innerHTML;
+              var tagModifer = "";
+              
+              if (evt.altKey === true ) {
+                tagToAdd = "~" + tagToAdd;
+              }
+              
+              if (evt.ctrlKey === true ) {
+                tagModifier = ",";
               } else {
-                $("#tag_search")[0].value += ($("#tag_search")[0].value != "" ? " " : "") + this.innerHTML;
-                updateTagFiltering($("#tag_search")[0].value);
+                tagModifier = " ";
               }
+              
+              tagSearchElement.value = (tagSearchElement.value != "" ? tagSearchElement.value + tagModifier : "") + tagToAdd;
+              updateTagFiltering(tagSearchElement.value);
+              
             }
         });
       });
@@ -30,16 +61,19 @@
     </div>
 
     <div id="tag_filtering" >
-        <span>Tag Filtering <a href="https://github.com/aslakhellesoy/cucumber/wiki/Tags" target="_blank">?</a></span>
+        <span style="font-size: 18px;">Tag Filtering <a href="https://github.com/aslakhellesoy/cucumber/wiki/Tags" target="_blank">?</a></span>
         
         <div style="clear: both"></div>
         
-        <div style="float: left; margin-top: 10px; font-size: 10px; font-style: italic;">
-          Left-click tags to 'AND'; ALT left-click tags to 'OR'
+        <div style="float: left; margin-top: 10px; padding-left: 5px; line-height: 1.5; font-size: 10px; font-style: italic;">
+          Type in tags with spaces between to 'AND' and commas between to 'OR'<br/> 
+          LEFT CLICK to AND tags; CTRL+LEFT CLICK to OR tags; hold ALT for inverse (~) tags
         </div>
         
+        <div style="clear: both;"></div>
+          
         <div style="float: right;">
-          <a href="" onclick=" updateTagFiltering(""); return true;">clear</a>
+          <a href="#" onclick="clearTagFiltering(); $('#tag_search')[0].value = ''; return true;">clear</a>
         </div>
         
         <div style="clear: both"></div>
@@ -58,37 +92,37 @@
         <span class="name">Features</span>
       </div>
       <% n = 1 %>
+      <ul style="padding-left: 0px;">
       <% features.each do |feature| %>
-        <li class="feature r<%= n %> <%= feature.tags.collect{|t| t.value }.join(" ") %>">
+        <li class="feature <%= n % 2 == 0 ? 'even' : 'odd' %> <%= feature.tags.collect {|t| t.value}.join(" ") %>">
         <%= linkify feature, feature.value %>
-          <% itags = feature.tags.collect{|t| tagify(t) }.join(", ") %>
-          <% if itags && itags != "" %>
-            - <small><%= itags %></small>
+          <% ftags = feature.tags.collect{|t| tagify(t) }.join(", ") %>
+          <% if ftags && ftags != "" %>
+          - <small><%= ftags %></small>
           <% end %>
         </li>
         <% n = n == 2 ? 1 : 2 %>
+        <% if feature.scenarios %>
+          <ul style="padding-left: 20px;">
+          	<% feature.scenarios.each do |scenario| %>
+          	<li class="scenario <%= n % 2 == 0 ? 'even' : 'odd' %> <%= feature.tags.collect{|t| t.value }.join(" ") %> <%= scenario.tags.collect{|t| t.value }.join(" ") %>">
+          	  <span class='object_link'>
+             		<a href="<%= url_for(scenario.feature,"scenario#{scenario.feature.scenarios.index(scenario) }") %>">
+             		  <%= h scenario.value %>
+             		</a>
+             	</span>
+             	<% stags = scenario.tags.collect{|t| tagify(t) }.join(", ") %>
+              <% if stags && stags != "" %>
+                - <small><%= stags %></small>
+              <% end %>
+          	</li>
+            <% n = n == 2 ? 1 : 2 %>
+          	<% end %>
+          </ul>
         <% end %>
-    </div>
-
-    <div id="scenarios">
-      <div class="title">
-        <span class="name">Scenarios</span>
-      </div>
-      <% n = 1 %>
-      <% scenarios.each_with_index do |scenario,index| %>
-        <li class="scenario r<%= n %> <%= scenario.tags.collect{|t| t.value }.join(" ") %>">
-            <span class='object_link'>
-           		<a href="<%= url_for(scenario.feature,"scenario#{scenario.feature.scenarios.index(scenario) }") %>">
-           		  <%= h scenario.value %>
-           		</a>
-           	</span>
-          <% itags = scenario.tags.collect{|t| tagify(t) }.join(", ") %>
-          <% if itags && itags != "" %>
-            - <small><%= itags %></small>
-          <% end %>
-        </li>
-      <% n = n == 2 ? 1 : 2 %>
       <% end %>
+      </ul>
+      <div class="undefined" style="display:none;">No Features or Scenarios match the Tag Expression</div>
     </div>
 
   </div>