cucumber-in-the-yard 1.7.5 → 1.7.6

data/History.txt

@@ -1,6 +1,11 @@
+=== 1.7.6 / 2011-01-06
+
+* Feature descriptions, multi-line strings, and comments will preserve spacing.
+* Feature Directories now support a README.md file that can be used to provide
+  information (with markdown support) about the directory of features.
+
 === 1.7.5 / 2010-12-14
 
-* Ruby 1.9.2 Support
 * FIX Step Transforms were colliding with Step Definitions in Ruby 1.9.2
   
 === 1.7.4 / 2010-12-11

data/README.md

@@ -36,6 +36,7 @@ The implemented example has been deployed at [http://recursivegames.com/cukes/](
 
 **8. [Undefined steps](http://recursivegames.com/cukes/requirements/step_transformers.html#undefined_steps) and even [Rubular](http://rubular.com/) links of your step definitions.**
 
+**9. Feature directories with a README.md will be parsed into the description** [example](http://recursivegames.com/cukes/requirements/example/child_feature.html)
 
 Installation
 ------------

data/city.gemspec

@@ -57,7 +57,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'gherkin', '>= 2.2.9'
   s.add_dependency 'cucumber', '>= 0.7.5'
-  s.add_dependency 'yard', '>= 0.6.2'
+  s.add_dependency 'yard', '>= 0.6.3'
   
   s.rubygems_version   = "1.3.7"
   s.files            = `git ls-files`.split("\n")

data/example/child_feature/README.md

@@ -0,0 +1,19 @@
+Feature Directory README
+========================
+
+Synopsis
+--------
+
+This collection of features are contained in this folder.  The description README
+allows a user to place a description for entire directory of the features and appears
+in the output to assist with understanding about the collection of features.
+
+Resources
+---------
+
+Links to particular resources like the links to the stories, tasks, or other areas
+can also be represented.
+
+The implemented example has been deployed at [http://recursivegames.com/cukes/](http://recursivegames.com/cukes/).
+
+**1. An Item** [example](http://recursivegames.com/cukes/requirements/)

data/example/scenario.feature

@@ -38,8 +38,10 @@ Feature: Displaying Scenarios
   Scenario: Scenario With Text
     Given the following text:
     """
-      Oh what a bother!
-      That this text has to take up two lines
+    Oh what a bother!
+    That this text has to take up two lines
+      This line should be indented 2 spaces
+        This line should be idented 4 spaces      
     """
 
   # Comments before the scenario

data/example/tags.feature

@@ -0,0 +1,18 @@
+@tags
+Feature: Tags
+  As a developer of the test suite I expect that various tags will be supported
+
+  @tag
+  Scenario: Basic Tag
+
+  @tag123456  
+  Scenario: Tag With Numbers
+  
+  @tag_with_underscore
+  Scenario: Tag With Underscore
+
+  @tag-with-dash
+  Scenario: Tag With Dash
+  
+  @tag+with+plus
+  Scenario: Tag With Plus

data/lib/city.rb

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

data/lib/cucumber/city_builder.rb

@@ -15,15 +15,21 @@ module Cucumber
       end
 
       def find_or_create_namespace(file)
-        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)}
+        @namespace = YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE
+        
+        File.dirname(file).split('/').each do |directory|
+          @namespace = @namespace.children.find {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory) && child.name.to_s == directory } ||
+            @namespace = YARD::CodeObjects::Cucumber::FeatureDirectory.new(@namespace,directory) {|dir| dir.add_file(directory)}
+        end
+
+        if @namespace.description == "" && File.exists?("#{File.dirname(file)}/README.md")
+          @namespace.description = File.read("#{File.dirname(file)}/README.md")
         end
       end
 
       def find_or_create_tag(tag_name,parent)
         #log.debug "Processing tag #{tag_name}"
-        tag_code_object = YARD::Registry.all(:tag).find {|tag| tag.value == tag_name } || 
+        tag_code_object = YARD::Registry.all(:tag).find {|tag| tag.value == tag_name } ||
           YARD::CodeObjects::Cucumber::Tag.new(YARD::CodeObjects::Cucumber::CUCUMBER_TAG_NAMESPACE,tag_name.gsub('@','')) {|t| t.owners = [] ; t.value = tag_name }
 
         tag_code_object.add_file(@file,parent.line)

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

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

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

@@ -51,5 +51,5 @@ def highlight_matches(step)
 end
 
 def htmlify_with_newlines(text)
-  text.split("\n").collect {|c| h(c) }.join("<br/>") 
+  text.split("\n").collect {|c| h(c).gsub(/\s/,'&nbsp;') }.join("<br/>")
 end

data/lib/templates/default/featuredirectory/html/directory.erb

@@ -14,31 +14,13 @@
     <div class="tags"><span class="name">Tags:</span>
       <%= tags.collect {|tag| linkify(tag,tag.value) }.join(",\n") %>
     </div>
+  </div>
 
+  <div class="readme">
+    <%= markdown @directory.description %>
+  </div>
 
-    <% if @directories_by_letter && !@directories_by_letter.empty? %>
-      <div id="directory">
-        <div class="title"><span class="name">Subdirectories</span></div>
-      </div>
-      <% i = 0 %>
-      <table>
-        <tr>
-          <td valign='top' width="33%">
-            <% @directories_by_letter.each do |directory| %>
-              <% if (i += 1) % 8 == 0 %>
-              </td><td valign='top' width="33%">
-                <% i = 0 %>
-              <% end %>
-              <ul>
-                <%= linkify directory, directory.name %>
-              </ul>
-            <% end %>
-          </td>
-        </tr>
-      </table>
-
-    <% end %>
-
+  <div>
     <% if @objects_by_letter && !@objects_by_letter.empty? %>
       <div id="features">
         <div class="title"><span class="name">Features</span></div>
@@ -72,5 +54,28 @@
     <% end %>
   <% end %>
 
+  <% if @directories_by_letter && !@directories_by_letter.empty? %>
+    <div id="directory">
+      <div class="title"><span class="name">Subdirectories</span></div>
+    </div>
+    <% i = 0 %>
+    <table>
+      <tr>
+        <td valign='top' width="33%">
+          <% @directories_by_letter.each do |directory| %>
+            <% if (i += 1) % 8 == 0 %>
+            </td><td valign='top' width="33%">
+              <% i = 0 %>
+            <% end %>
+            <ul>
+              <%= linkify directory, directory.name %>
+            </ul>
+          <% end %>
+        </td>
+      </tr>
+    </table>
+
+  <% end %>
+
 </div>
 

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

@@ -4,6 +4,10 @@ def init
   @directory = object
 end
 
+def markdown(text)
+  h(text,:markdown) rescue h(text)
+end
+
 def directory
   @objects_by_letter = all_types_by_letter(YARD::CodeObjects::Cucumber::Feature)
   @directories_by_letter = @directory.children.find_all {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory) }.sort_by {|dir| dir.name.to_s }
@@ -35,3 +39,6 @@ def tags
   (features.collect{|feature| feature.tags } + scenarios.collect {|scenario| scenario.tags }).flatten.uniq
 end
 
+def htmlify_with_newlines(text)
+  text.split("\n").collect {|c| h(c).gsub(/\s/,'&nbsp;') }.join("<br/>")
+end

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

@@ -20,6 +20,7 @@
 
 .suggestion { color: #ff686e; }
 
+.readme { margin: 0px 10px 0px 30px; padding: 0px; }
 
 .feature .description, .requirements .summary {
     margin: 10px 20px 0px 30px;
@@ -66,12 +67,11 @@
 .scenario .tags { float: right; margin-right: 20px; margin-top: 5px; }
 
 
-* ul.alpha { padding-left: 50px; font-size: 1.1em; }
+* ul.alpha { font-size: 1.1em; }
 * ul.alpha { padding-bottom: 10px; list-style: none; }
 * ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
-* ul.alpha ul { padding-left: 5px; }
+* ul.alpha ul { padding-left: 15px; }
 * ul small { color: #666; font-size: 0.7em; }
-* ul.alpha ul li { list-style: none; padding-left: 0px;}
 
 
 .scenario .steps {

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

@@ -9,7 +9,20 @@
 
   <div class="requirements">
 
+    <div class="summary">
+      <span class="name">Features:</span><span class="value"><%= features.size %></span>
+      <span class="name">Scenarios:</span><span class="value"><%= scenarios.size %></span>
+      <span class="name">Steps:</span><span class="value"><%= steps.size %></span>
+      <span class="name">Tags:</span><span class="value"><%= tags.size %></span>
+    </div>
+    <div class="tags"><span class="name">Tags:</span>
+      <%= tags.collect {|tag| linkify(tag,tag.value) }.join(",\n") %>
+    </div>
+   
     <% if features && !features.empty? %>
+      <div id="features" style="margin-left: 40px;">
+        <div class="title"><span class="name">Features</span></div>
+      </div>
       <% i = 0 %>
       <table style="margin-left: 10px;">
         <tr>

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

@@ -11,7 +11,14 @@ module YARD::CodeObjects::Cucumber
   class StepTransformersObject < NamespaceObject ; end
 
   class FeatureDirectory < YARD::CodeObjects::NamespaceObject
-    
+
+    attr_accessor :description
+
+    def initialize(namespace,name)
+      super(namespace,name)
+      @description = ""
+    end
+
     def location
       files.first.first if files && !files.empty?
     end

data/lib/yard/templates/helpers/base_helper.rb

@@ -9,6 +9,8 @@ module YARD::Templates::Helpers
         "Step Definitions and Transforms"
       elsif object.is_a?(YARD::CodeObjects::Cucumber::NamespaceObject)
         "#{format_object_type(object)}#{object.value ? ": #{object.value}" : ''}"
+      elsif object.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory)
+        "Feature Directory: #{object.name}"
       else
         case object
         when YARD::CodeObjects::RootObject

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cucumber-in-the-yard
 version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: false
   segments: 
   - 1
   - 7
-  - 5
-  version: 1.7.5
+  - 6
+  version: 1.7.6
 platform: ruby
 authors: 
 - Franklin Webber
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 -08:00
+date: 2011-01-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 2
         - 2
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 0
         - 7
@@ -55,11 +58,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 1
         segments: 
         - 0
         - 6
-        - 2
-        version: 0.6.2
+        - 3
+        version: 0.6.3
   type: :runtime
   version_requirements: *id003
 description: " \n    Cucumber-In-The-Yard is a YARD extension that processes Cucumber Features, Scenarios, Steps,\n    Step Definitions, Transforms, and Tags and provides a documentation interface that allows you\n    easily view and investigate the test suite.  This tools hopes to bridge the gap of being able\n    to provide your feature descriptions to your Product Owners and Stakeholders.  "
@@ -77,6 +81,7 @@ files:
 - README.md
 - Rakefile
 - city.gemspec
+- example/child_feature/README.md
 - example/child_feature/child.feature
 - example/child_feature/grandchild_feature/grandchild.feature
 - example/empty.feature
@@ -87,6 +92,7 @@ files:
 - example/step_definitions/support/env.rb
 - example/step_definitions/support/env_support.rb
 - example/step_definitions/support/support.rb
+- example/tags.feature
 - example/transform.feature
 - lib/city.rb
 - lib/cucumber/city_builder.rb
@@ -120,8 +126,6 @@ files:
 - lib/templates/default/layout/html/search.erb
 - lib/templates/default/requirements/html/namespace.erb
 - lib/templates/default/requirements/html/setup.rb
-- lib/templates/default/scenario/html/scenario.erb
-- lib/templates/default/scenario/setup.rb
 - lib/templates/default/steptransformers/html/header.erb
 - lib/templates/default/steptransformers/html/transformers.erb
 - lib/templates/default/steptransformers/html/undefined_steps.erb
@@ -157,9 +161,21 @@ has_rdoc: true
 homepage: http://github.com/burtlo/Cucumber-In-The-Yard
 licenses: []
 
-post_install_message: "\n\
-  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n  Thank you for installing Cucumber-In-The-YARD 1.7.5 / 2010-12-14.\n  \n  Changes:\n    \n  * Ruby 1.9.2 Support\n  * FIX Step Transforms were colliding with Step Definitions in Ruby 1.9.2\n    \n\n\
-  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
+post_install_message: |+
+  
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  
+    Thank you for installing Cucumber-In-The-YARD 1.7.6 / 2011-01-06.
+    
+    Changes:
+      
+    * Feature descriptions, multi-line strings, and comments will preserve spacing.
+    * Feature Directories now support a README.md file that can be used to provide
+      information (with markdown support) about the directory of features.
+    
+  
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
@@ -169,6 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -177,6 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"

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

@@ -1,23 +0,0 @@
-<div class="scenario">
-	<div class="title">
-		<span class="pre">Scenario:</span>
-		<span class="name"><%= @scenario.value %></span>
-	</div>
-	<% unless @scenario.tags.empty? %>
-	<div class="tags"><%= @scenario.tags.collect { |tags| tags.value }.join("&nbsp;&nbsp;") %></div>		
-	<% end %>
-	<% unless @scenario.description.empty? %>
-	<div class="description">
-		<%= @scenario.description.join("\n<br/>") %>
-	</div>
-	<% end %>
-	<div class="steps">
-		<% unless @scenario.steps.empty? %>
-		<% @scenario.steps.each do |step| %>
-		<div class="step"><span class="predicate"><%= step.keyword %></span>&nbsp;<%= step.line %></div>
-		<% end %>
-		<% else %>
-		<span>No Steps Defined</span>
-		<% end %>
-	</div>
-</div>

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

@@ -1,5 +0,0 @@
-def init
-  super
-  sections.push :scenario
-  @scenario = object
-end