cucumber-in-the-yard 1.1 → 1.2

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.2 / 2010-10-10
+
+* FIX: Empty Step Definitions caused failure during serialization
+* FIX: Empty Step Definitions caused failure during rendering HTML
+
 === 1.1 / 2010-10-10
 
 * FIX: Feature template had references to old methods for description (when it was an array)

data/README.md

@@ -9,6 +9,35 @@ Step Definitions, Transforms, and Tags and provides a documentation interface th
 easily view and investigate the test suite.  This tools hopes to bridge the gap of being able
 to provide your feature descriptions to your Product Owners and Stakeholders.
 
+Example
+-------
+
+An example, particularly the example features included with the project, of CITY can be viewed at
+
+   [http://recursivegames.com/cukes/](http://recursivegames.com/cukes/)    
+
+**1. Users are able to search by Feature, Tags, and Scenario.**
+
+Appended to the traditional search areas is the ability to now search by Feature, Tag, and Scenario.
+
+**2. Feature pages are displayed in a decently formatted HTML representation**
+
+As opposed to pointing team members, stakeholders, and product owners to feature files which require 
+an editor with syntax highlighting.  As well as providing the ability to quickly follow tags and steps 
+for more information.
+
+**3. Tag pages display all the Features and scenarios that currently employ the tag.**
+
+Providing quick access to the important tag divisions that have been created in a project.  
+On the top of the page there are some quick calculations of the number of features and scenarios that
+share the specified tag. 
+
+**4. Steps link to Step definitions.  Step definitions show all uses. **
+
+Step definitions are displayed in their own index page and for each step definition a list of implemented
+steps for this step definition.  This is useful for providing example documentation and quickly understanding
+which scenarios are affected by a change to a step definition.
+
 
 Installation
 ------------
@@ -80,23 +109,8 @@ functionality may provide a valuable tool for many as I feel it helps more solid
 the documentation by putting a coat of paint on it.
 
 
-== FEATURES/PROBLEMS:
-
-**1. Searchable Features, Scenarios, Steps, and Tags**: Similar to how YARD provides the ability to search through classes and methods, CITY provides the ability to search through all of the requirements documentation quickly and easily through the browser.  This makes it easy to provide reports for product owners and other stakeholders.
-
-**2. Tags**: Tag view will show all features and scenarios that employ the tag.
-
-**3. Steps map to Step Definitions**: Steps provide links to their step definitions so developers and maintainers of the requirements suite can quickly find their way around the project.  As well, step definitions report all their implemented step definitions to provide a quick way of understanding the impact of augmenting a step definition as well as providing examples.
-
-== SYNOPSIS:
-
-== REQUIREMENTS:
-
-== INSTALL:
-
-== DEVELOPERS:
-
-== LICENSE:
+LICENSE
+-------
 
 (The MIT License)
 

data/Rakefile

@@ -4,12 +4,10 @@ require 'echoe'
 task :default => :gendoc
 
 task :gendoc do
-  #`yardoc -e lib/city.rb -p lib/yard/templates 'example/**/*.rb' 'example/**/*.feature' --debug`
-  `yardoc -e lib/city.rb -p lib/yard/templates 'common/**/*.rb' 'browser/**/*.rb' 'jmx/**/*.rb' --no-output --debug`
-  `yardoc -e lib/city.rb -p lib/yard/templates 'common/**/*.rb' 'browser/**/*.rb' 'jmx/**/*.rb' 'definitions/**/*.rb' 'features/**/*.feature' --debug`
+  `yardoc -e lib/city.rb -p lib/yard/templates 'example/**/*.rb' 'example/**/*.feature' --debug`
 end
 
-Echoe.new('cucumber-in-the-yard', '1.1') do |g|
+Echoe.new('cucumber-in-the-yard', '1.2') do |g|
   g.author = "Frank;lin Webber"
   g.email = "franklin.webber@gmail.com"
   g.url = "http://github.com/burtlo/Cucumber-In-The-Yard"

data/cucumber-in-the-yard.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cucumber-in-the-yard}
-  s.version = "1.1"
+  s.version = "1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Frank;lin Webber"]

data/lib/yard/templates/default/fulldoc/html/setup.rb

@@ -59,9 +59,13 @@ def serialize_object(object)
 end
 
 def create_full_list(objects,friendly_name=nil)
-  @list_type = "#{objects.first.type.to_s}s"
-  @list_title = "#{friendly_name || objects.first.type.to_s.capitalize} List"
-  asset("#{objects.first.type}_list.html",erb(:full_list))
+  if !objects.empty?
+    @list_type = "#{objects.first.type.to_s}s"
+    @list_title = "#{friendly_name || objects.first.type.to_s.capitalize} List"
+    asset("#{objects.first.type}_list.html",erb(:full_list))
+  else
+    log.warn "Full List: Failed to create a list because the objects array is empty."
+  end
 end
 
 def find_unique_tags(tags)

data/lib/yard/templates/default/steptransformers/html/stepdefinition.erb

@@ -4,7 +4,7 @@
 
 <div style="margin: 10px;">&nbsp;</div>
 
-
+<% if @step_transformers.definitions %>
 <% @step_transformers.definitions.each_with_index do |stepdef,index| %>
 
 <div class="stepdef">
@@ -35,4 +35,5 @@
 	</div>
 </div>
 
+<% end %>
 <% end %>

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
-  version: "1.1"
+  - 2
+  version: "1.2"
 platform: ruby
 authors: 
 - Frank;lin Webber