yard-cucumber 2.2.2 → 2.2.3

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use yard-cucumber

data/Gemfile

@@ -1,3 +1,5 @@
 source :rubygems
 
+gem 'redcarpet'
+
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yard-cucumber (2.2.1)
+    yard-cucumber (2.2.2)
       cucumber (>= 0.7.5)
       gherkin (>= 2.2.9)
       yard (>= 0.8.1)
@@ -19,10 +19,12 @@ GEM
     gherkin (2.10.0)
       json (>= 1.4.6)
     json (1.7.3)
-    yard (0.8.2.1)
+    redcarpet (2.2.2)
+    yard (0.8.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  redcarpet
   yard-cucumber!

data/History.txt

@@ -1,3 +1,8 @@
+=== 2.2.3/ 2013-02-15
+
+* Step Definitions that are marked as 'pending' will now appear as pending
+  on the step definition and transforms page.
+
 === 2.2.2/ 2012-10-07
 
 * Steps and Definitions have links to step transformer page
@@ -72,7 +77,7 @@
 
 * 'All Features' lands you on the root features directory; 'Requirements'
   is still accessible through the breadcrumbs.
-* Feature directory pages will display all the features in all subdirectories 
+* Feature directory pages will display all the features in all subdirectories
 * Better sorting for features, tags, and step transformers.
 
 - FIX Feature-Scenario links and Cursors
@@ -89,7 +94,7 @@
 === 1.7.5 / 2010-12-14
 
 * FIX Step Transforms were colliding with Step Definitions in Ruby 1.9.2
-  
+
 === 1.7.4 / 2010-12-11
 
 * Ruby 1.9.2 Support
@@ -101,7 +106,7 @@
 * 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  
+* 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
@@ -207,7 +212,7 @@
 * Cleaned up all references in the fulldoc, full list to references tags
 
 * Moved Cucumber CodeObjects, Handlers, and Parsers to a Cucumber sub-directory
-* Moved StepDefinition and StepTransforms form extensions.rb to individual StepObject and Handlers files 
+* Moved StepDefinition and StepTransforms form extensions.rb to individual StepObject and Handlers files
 
 * (lsegal advice) Created Cucumber Namespace and sub namespaces for features, tags, and step transformers.
 * (lsegal advice) Started to break apart the feature.erb into smaller digestable erb sections
@@ -220,7 +225,7 @@
 * Changed document parsing to mirror the order imposed by Cucumber, this is to stop features being loaded before step definitions.
   This should hopefully address the issue where steps were not being mapped correctly to step definitions.  This fixed the issue
   in the small and large test suite I ran it against.
-  
+
 
 === 1.3 / 2010-10-13
 

data/README.md

@@ -101,7 +101,7 @@ add or remove these search fields.
 :safe_mode: false
 
 :"yard-cucumber": 
-  menus: [ 'features', 'tags', 'steps', 'step definitions' ]
+  menus: [ 'features', 'directories', 'tags', 'steps', 'step definitions' ]
 ```
 
 By default the configuration, yaml format, that is generate by the `yard config`

data/Rakefile

@@ -2,15 +2,24 @@ require 'rake'
 
 task :default => :gendoc
 
+desc "Clean out any existing documentation"
 task :clean do
   `rm -rf doc`
   `rm -rf .yardoc`
 end
 
+desc "Generate documentation from the example data"
 task :gendoc => :clean do
-  `yardoc -e ./lib/yard-cucumber.rb 'example/**/*' --debug`
+  puts `yardoc -e ./lib/yard-cucumber.rb 'example/**/*' --debug`
 end
 
+desc "Run the YARD Server"
+task :server => :gendoc do
+  puts `yard server -e ./lib/yard-cucumber.rb`
+end
+
+desc "Create the yard-cucumber gem"
 task :gem do
-  `gem build city.gemspec`
+  puts `gem build city.gemspec`
 end
+

data/example/step_definitions/first.step.rb

@@ -17,5 +17,5 @@ end
 # This step definition is all about steps
 # 
 Given /^this (scenario|background|#{ORDER}) step$/ do |step|
-  pending "step #{order}"
+  puts "step #{order}"
 end

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

@@ -56,6 +56,11 @@
 .nodefinitions .title {
     background-color: #F5EADD;  border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
 }
+.pending .title {
+    background-color: #ffffc0;  border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
+}
+
+
 
 .scenario .title { border: none; }
 .background .title { background: #cbddeb; }

data/lib/templates/default/fulldoc/html/directories.erb

@@ -0,0 +1,53 @@
+<% n = 1 %>
+
+
+<% if @directory.children %>
+<ul>
+  <% @directory.children.sort {|x,y| x.value.to_s <=> y.value.to_s }.each_with_index do |child,index| %>
+  <% if child.is_a?(YARD::CodeObjects::Cucumber::Feature) %>
+    <li class="r<%= n %>">
+      <%= linkify child, child.value %>
+  <!--
+      <span class='object_link'>
+         <a href="<%= url_for(child,"scenario_#{index}") %>"
+             title="<%= h child.value %>">
+           <%= h child.value %>
+         </a>
+       </span>
+   -->
+       <small><%= child.location %></small>
+    </li>
+  <% end %>
+  <% if child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory) %>
+    <li class="r<%= n %>">
+      <%= "<a class='toggle'></a>" unless child.features.empty? && child.subdirectories.empty? %>
+      <%= linkify child, child.value.to_s.capitalize  %>
+      <small><%= child.location %></small>
+    </li>
+    <%= directory_node child %>
+  <% end %>
+        <% n = n == 2 ? 1 : 2 %>
+  <% end %>
+</ul>
+<% end %>
+
+<!--  YARD::CodeObjects::Cucumber::FeatureDirectory -->
+  
+<!-- 
+<% if @directory.subdirectories %>
+<ul>
+  <% @directory.subdirectories.each_with_index do |subdir,index| %>
+  <li class="r<%= n %>">
+    <span class='object_link'>
+       <a href="<%= url_for(subdir,"scenario_#{index}") %>"
+           title="<%= h subdir.value %>">
+         <%= h subdir.value %>
+       </a>
+     </span>
+     <small><%= subdir.location %></small>
+  </li>
+        <% n = n == 2 ? 1 : 2 %>
+  <% end %>
+</ul>
+<% end %>
+ -->

data/lib/templates/default/fulldoc/html/full_list_featuredirectories.erb

@@ -0,0 +1,11 @@
+<% n = 1 %>
+<% n = n == 2 ? 1 : 2 %>
+<% @items.each do |directory| %>
+<li class="r<%= n %>">
+  <%= "<a class='toggle'></a>" unless directory.features.empty? && directory.subdirectories.empty? %>
+  <%= linkify directory, directory.value %>
+  <small><%= directory.location %></small>
+</li>
+<% n = n == 2 ? 1 : 2 %>
+<%= directory_node directory %>
+<% end %>

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

@@ -2,131 +2,174 @@ include YARD::Templates::Helpers::HtmlHelper
 
 def init
   super
-  
-  # Additional javascript that power the additional menus, collapsing, etc.
-  asset("js/cucumber.js",file("js/cucumber.js",true))
 
-  #
-  # Generate pages for each feature, with the 'feature' template and then 
-  # generate the page which is the full list of features
-  #
+  # Additional javascript that power the additional menus, collapsing, etc.
+  asset "js/cucumber.js", file("js/cucumber.js",true)
 
-  @features = Registry.all(:feature)
+  serialize_object_type :feature
 
-  if @features
-    @features.each {|feature| serialize(feature) } 
-    #generate_full_list @features.sort {|x,y| x.value.to_s <=> y.value.to_s }, :feature
-  end
-  
-  #
-  # Generate pages for each tag, with the 'tag' template and then generate the
-  # page which is the full list of tags. Tags are ordered in descending order
-  # by the size of how many scenarios that the affect
-  #
-  
-  @tags = Registry.all(:tag)
-
-  if @tags
-    @tags.each {|tag| serialize(tag) }
-    #generate_full_list @tags.sort {|x,y| y.all_scenarios.size <=> x.all_scenarios.size }, :tag
-  end
+  serialize_object_type :tag
 
   # Generates the requirements splash page with the 'requirements' template
   serialize(YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE)
 
   # Generates a page for step definitions and step transforms with the 'steptransformers' template
   serialize(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE)
-  
+
   # Generates the tags page with the 'featuretags' template
   serialize(YARD::CodeObjects::Cucumber::CUCUMBER_TAG_NAMESPACE)
-  
-  # Generate pages for each of the directories with features with the 'featuredirectory' template
-  feature_directories = YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE.children.find_all {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory) }
-  serialize_feature_directories(feature_directories)
 
+  serialize_feature_directories
+end
+
+#
+# The top-level feature directories. This is affected by the directories that YARD is told to parse.
+# All other features in sub-directories are contained under each of these top-level directories.
+#
+# @example Generating one feature directory
+#
+#     `yardoc 'example/**/*'`
+#
+# @example Generating two feature directories
+#
+#     `yardoc 'example/**/*' 'example2/**/*'`
+#
+# @return the feature directories at the root of the Cucumber Namespace.
+#
+def root_feature_directories
+  @root_feature_directories ||= YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE.children.find_all {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory)}
+end
+
+#
+# Generate pages for the objects if there are objects of this type contained
+# within the Registry.
+#
+def serialize_object_type(type)
+  objects = Registry.all(type.to_sym)
+  Array(objects).each {|object| serialize(object) }
+end
+
+#
+# Generates pages for the feature directories found. Starting with all root-level feature
+# directories and then recursively finding all child feature directories.
+#
+def serialize_feature_directories
+  serialize_feature_directories_recursively(root_feature_directories)
+  root_feature_directories.each {|directory| serialize(directory) }
+end
+
+#
+# Generate a page for each Feature Directory. This is called recursively to
+# ensure that all feature directories contained as children are rendered to
+# pages.
+#
+def serialize_feature_directories_recursively(namespaces)
+  namespaces.each do |namespace|
+    Templates::Engine.with_serializer(namespace, options[:serializer]) do
+      options[:object] = namespace
+      T('layout').run(options)
+    end
+    serialize_feature_directories_recursively(namespace.children.find_all {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory)})
+  end
 end
 
 
 # Generate feature list
-# @note this method is called automically by YARD based on the menus defined in the layout
+# @note this method is called automatically by YARD based on the menus defined in the layout
 def generate_feature_list
-  @features = Registry.all(:feature)
-  generate_full_list @features.sort {|x,y| x.value.to_s <=> y.value.to_s }, :feature
+  features = Registry.all(:feature)
+  features_ordered_by_name = features.sort {|x,y| x.value.to_s <=> y.value.to_s }
+  generate_full_list features_ordered_by_name, :features
 end
 
 # Generate tag list
-# @note this method is called automically by YARD based on the menus defined in the layout
+# @note this method is called automatically by YARD based on the menus defined in the layout
 def generate_tag_list
-  @tags = Registry.all(:tag)
-  generate_full_list @tags.sort {|x,y| y.all_scenarios.size <=> x.all_scenarios.size }, :tag
+  tags = Registry.all(:tag)
+  tags_ordered_by_use = Array(tags).sort {|x,y| y.all_scenarios.size <=> x.all_scenarios.size }
+
+  generate_full_list tags_ordered_by_use, :tags
 end
 
 # Generate a step definition list
 # @note this menu is not automatically added until yard configuration has this menu added
 # See the layout template method that loads the menus
 def generate_stepdefinition_list
-  generate_full_list YARD::Registry.all(:stepdefinition), :stepdefinition
+  generate_full_list YARD::Registry.all(:stepdefinition), :stepdefinitions,
+    :list_title => "Step Definitions List"
 end
 
 # Generate a step list
 # @note this menu is not automatically added until yard configuration has this menu added
 # See the layout template method that loads the menus
 def generate_step_list
-  generate_full_list YARD::Registry.all(:step), :step
+  generate_full_list YARD::Registry.all(:step), :steps
+end
+
+# Generate feature list
+# @note this menu is not automatically added until yard configuration has this menu added
+# See the layout template method that loads the menus
+def generate_featuredirectories_list
+  directories_ordered_by_name = root_feature_directories.sort {|x,y| x.value.to_s <=> y.value.to_s }
+  generate_full_list directories_ordered_by_name, :featuredirectories, 
+    :list_title => "Features by Directory",
+    :list_filename => "featuredirectories_list.html"
 end
 
-# Helpler method to generate a full_list page of the specified objects with the 
+
+# Helpler method to generate a full_list page of the specified objects with the
 # specified type.
-def generate_full_list(objects,list_type,friendly_name=nil)
+def generate_full_list(objects,type,options = {})
+  defaults = { :list_title => "#{type.to_s.capitalize} List",
+    :css_class => "class",
+    :list_filename => "#{type.to_s.gsub(/s$/,'')}_list.html" }
+
+  options = defaults.merge(options)
+
   @items = objects
-  @list_type = "#{list_type}s"
-  @list_title = "#{friendly_name || list_type.to_s.capitalize} List"
-  @list_class = "class"
-  asset("#{list_type}_list.html",erb(:full_list))
+  @list_type = type
+  @list_title = options[:list_title]
+  @list_class = options[:css_class]
+  asset options[:list_filename], erb(:full_list)
 end
 
 #
-# The existing 'Class List' search field would normally contain the Cucumber
-# Namespace object that has been added. Here we call the class_list method 
-# that is contained in the YARD template and we remove the namespace. Returning
-# it when we are done. 
+# @note This method overrides YARD's default template class_list method.
+#
+# The existing YARD 'Class List' search field contains all the YARD namespace objects.
+# We, however, do not want the Cucumber Namespace YARD Object (which holds the features,
+# tags, etc.) as it is a meta-object.
+#
+# This method removes the namespace from the root node, generates the class list,
+# and then adds it back into the root node.
 #
 def class_list(root = Registry.root)
-  root.instance_eval { children.delete YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE } if root == Registry.root
+  return super unless root == Registry.root
+
+  cucumber_namespace = YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE
+  root.instance_eval { children.delete cucumber_namespace }
   out = super(root)
-  root.instance_eval { children << YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE } if root == Registry.root
+  root.instance_eval { children.push cucumber_namespace }
   out
 end
 
-#
-# Generate a page for each Feature Directory. This is called recursively to 
-# ensure that all feature directories contained as children are rendered to
-# pages.
-#
-def serialize_feature_directories(namespaces)
-  namespaces.each do |namespace|
-    Templates::Engine.with_serializer(namespace, options[:serializer]) do
-      options[:object] = namespace
-      T('layout').run(options)
-    end
-    serialize_feature_directories(namespace.children.find_all {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory)})
-  end
-end
-
 #
 # Generate a link to the 'All Features' in the features_list.html
 #
-# When there are no feature directories or multiple top-level feature directories 
+# When there are no feature directories or multiple top-level feature directories
 # then we want to link to the 'Requirements' page
 #
 # When there are is just one feature directory then we want to link to that directory
 #
 def all_features_link
-  root_feature_directories = YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE.children.find_all {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory)}
-
   if root_feature_directories.length == 0 || root_feature_directories.length > 1
     linkify YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE, "All Features"
   else
     linkify root_feature_directories.first, "All Features"
   end
-end
+end
+
+def directory_node(directory)
+  @directory = directory
+  erb(:directories)
+end

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

@@ -27,7 +27,7 @@ end
 # @example `~/.yard.config`
 # 
 #     yard-cucumber:
-#       menus: [ 'features', 'tags', 'step definitions', 'steps' ]
+#       menus: [ 'features', 'directories', 'tags', 'step definitions', 'steps' ]
 # 
 def menu_lists
   
@@ -49,6 +49,7 @@ end
 # 
 def yard_cucumber_menus
   { "features" => { :type => 'feature', :title => 'Features', :search_title => 'Features' },
+    "directories" => { :type => 'featuredirectories', :title => 'Features by Directory', :search_title => 'Features by Directory' },
     "tags" => { :type => 'tag', :title => 'Tags', :search_title => 'Tags' },
     "step definitions" => { :type => 'stepdefinition', :title => 'Step Definitions', :search_title => 'Step Defs' },
     "steps" => { :type => 'step', :title => 'Steps', :search_title => 'Steps' } }

data/lib/templates/default/steptransformers/html/transformers.erb

@@ -1,11 +1,17 @@
 <% @items.each do |item| %>
 
-<div class="transformer <%= @item_type.gsub(/\s/,'') %> <%= "nodefinitions" if item.steps.nil? || item.steps.empty? %>">
+<div class="transformer <%= @item_type.gsub(/\s/,'') %>
+                        <%= "nodefinitions" if item.steps.nil? || item.steps.empty? %>
+                        <%= "pending" if item.pending %>">
   <a name="<%= anchor_for item %>"></a>
   <div class="title">
     <span class="pre"><%= h item.keyword %></span>
     <span class="name"><%= item.value %></span>
-    <a style="float: right;" href="http://rubular.com/?regex=<%= urlencode item.value %>" target="_blank">Rubular</a>
+    <div style="float: right;">
+      <a href="http://rubular.com/?regex=<%= urlencode item.value %>" target="_blank">Rubular</a>
+      <%= "| PENDING" if item.pending %>
+      <%= "| UNUSED" if item.steps.nil? || item.steps.empty? %>
+    </div>
     <div style="clear: both;"></div>
   </div>
 
@@ -14,7 +20,6 @@
     <div class="meta" style="clear: right;">
       <div class="file"><%= h item.location %></div>
     </div>
-
     
     <!-- Comments -->
     <div>

data/lib/yard-cucumber/version.rb

@@ -1,3 +1,3 @@
 module CucumberInTheYARD
-  VERSION = '2.2.2'
+  VERSION = '2.2.3'
 end

data/lib/yard/code_objects/step_transformer.rb

@@ -5,7 +5,7 @@ module YARD::CodeObjects
 
     include Cucumber::LocationHelper
 
-    attr_reader :constants, :keyword, :source, :value, :literal_value
+    attr_reader :constants, :keyword, :source, :value, :literal_value, :pending
     attr_accessor :steps
     
     # This defines an escape pattern within a string or regex:

data/lib/yard/handlers/cucumber/base.rb

@@ -14,8 +14,8 @@ module YARD
           include Parser::Cucumber
         end
       end
-      
+
       Processor.register_handler_namespace :feature, Cucumber
-    end 
+    end
   end
 end

data/lib/yard/handlers/cucumber/feature_handler.rb

@@ -14,19 +14,19 @@ module YARD
           # files were were assured to be processed last which was accomplished
           # by overriding YARD::SourceParser to make it load file in a similar
           # order as Cucumber.
-          # 
+          #
           # As of YARD 0.7.0 this is no longer necessary as there are callbacks
           # that can be registered after all the files have been loaded. That
           # callback _after_parse_list_ is defined below and performs the
           # functionality described above.
-          # 
+          #
         end
-        
+
         #
         # Register, once, when that when all files are finished to perform
         # the final matching of feature steps to step definitions and step
         # definitions to step transforms.
-        # 
+        #
         YARD::Parser::SourceParser.after_parse_list do |files,globals|
           # For every feature found in the Registry, find their steps and step
           # definitions...
@@ -34,7 +34,7 @@ module YARD
             log.debug "Finding #{feature.file} - steps, step definitions, and step transforms"
             FeatureHandler.match_steps_to_step_definitions(feature)
           end
-          
+
         end
 
         class << self
@@ -77,9 +77,9 @@ module YARD
           #
           # Store all comparable items with their compare_value as the key and the item as the value
           # - Reject any compare values that contain escapes #{} as that means they have unpacked constants
-          # 
+          #
           def cache(type)
-            YARD::Registry.all(type).inject({}) do |hash,item| 
+            YARD::Registry.all(type).inject({}) do |hash,item|
               hash[item.regex] = item if item.regex
               hash
             end
@@ -96,9 +96,9 @@ module YARD
           end
 
           #
-          # Given a step object, attempt to match that step to a step 
+          # Given a step object, attempt to match that step to a step
           # transformation
-          # 
+          #
           def match_step_to_step_definition_and_transforms(step)
             @@step_definitions.each_pair do |stepdef,stepdef_object|
               stepdef_matches = step.value.match(stepdef)

data/lib/yard/handlers/legacy/step_definition_handler.rb

@@ -9,19 +9,19 @@ class YARD::Handlers::Ruby::Legacy::StepDefinitionHandler < YARD::Handlers::Ruby
     step_definition = statement.tokens.to_s[STEP_DEFINITION_MATCH,3]
 
     @@unique_name = @@unique_name + 1
-      
-    stepdef_instance = StepDefinitionObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE, "definition_#{@@unique_name}") do |o| 
+
+    stepdef_instance = StepDefinitionObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE, "definition_#{@@unique_name}") do |o|
       o.source = "#{keyword} #{step_definition} do #{statement.block.to_s =~ /^\s*\|.+/ ? '' : "\n  "}#{statement.block.to_s}\nend"
       o.value = step_definition
       o.keyword = keyword
     end
-    
+
     obj = register stepdef_instance
     parse_block :owner => obj
-    
+
   rescue YARD::Handlers::NamespaceMissingError
   end
-  
+
   #
   # Step Definitions can contain defined steps within them.  While it is likely that they could not
   # very easily be parsed because of variables that are only calculated at runtime, it would be nice
@@ -32,14 +32,14 @@ class YARD::Handlers::Ruby::Legacy::StepDefinitionHandler < YARD::Handlers::Ruby
     #log.debug "#{block} #{block.class}"
     block.each_with_index do |token,index|
       #log.debug "Token #{token.class} #{token.text}"
-        if token.is_a?(YARD::Parser::Ruby::Legacy::RubyToken::TkCONSTANT)  && 
+        if token.is_a?(YARD::Parser::Ruby::Legacy::RubyToken::TkCONSTANT)  &&
           token.text =~ /^(given|when|then|and)$/i &&
           block[index + 2].is_a?(YARD::Parser::Ruby::Legacy::RubyToken::TkSTRING)
           log.debug "Step found in Step Definition: #{block[index + 2].text} "
         end
-          
+
     end
-    
+
   end
-  
+
 end

data/lib/yard/handlers/legacy/step_transform_handler.rb

@@ -3,22 +3,22 @@ class YARD::Handlers::Ruby::Legacy::StepTransformHandler < YARD::Handlers::Ruby:
   handles STEP_TRANSFORM_MATCH
 
   @@unique_name = 0
-  
+
   def process
     transform = statement.tokens.to_s[STEP_TRANSFORM_MATCH,2]
     @@unique_name = @@unique_name + 1
-    
-    instance = StepTransformObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE, "transform_#{@@unique_name}") do |o| 
+
+    instance = StepTransformObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE, "transform_#{@@unique_name}") do |o|
       o.source = "Transform #{transform} do #{statement.block.to_s}\nend"
       o.value = transform
       o.keyword = "Transform"
     end
-  
+
     obj = register instance
     parse_block :owner => obj
-    
+
   rescue YARD::Handlers::NamespaceMissingError
   end
-  
+
 end
 

data/lib/yard/handlers/step_definition_handler.rb

@@ -1,58 +1,89 @@
 #
 # Finds and processes all the step definitions defined in the ruby source
 # code. By default the english gherkin language will be parsed.
-# 
-# To override the language you can define the step definitions in the YARD 
+#
+# To override the language you can define the step definitions in the YARD
 # configuration file `~./yard/config`:
-# 
+#
 # @example `~/.yard/config` with LOLCatz step definitions
-# 
-#     :"yard-cucumber": 
-#       language: 
+#
+#     :"yard-cucumber":
+#       language:
 #         step_definitions: [ 'WEN', 'I CAN HAZ', 'AN', 'DEN' ]
-# 
+#
 # @example `~/.yard/config` with French step definitions
-# 
-#     :"yard-cucumber": 
-#       language: 
+#
+#     :"yard-cucumber":
+#       language:
 #         step_definitions: [ 'Soit', 'Etantdonné', 'Lorsque', 'Lorsqu', 'Alors', 'Et' ]
-# 
+#
 class YARD::Handlers::Ruby::StepDefinitionHandler < YARD::Handlers::Ruby::Base
-  
-  #
-  # By default the english gherkin language will be parsed, however, if the
-  # YARD configuration file `~./yard/config` defines different step definition
-  # handlers those are used.
-  # 
-  # 
-  if YARD::Config.options["yard-cucumber"] and 
+
+  def self.default_step_definitions
+    [ "When", "Given", "And", "Then" ]
+  end
+
+  def self.custom_step_definitions
+    YARD::Config.options["yard-cucumber"]["language"]["step_definitions"]
+  end
+
+  def self.custom_step_definitions_defined?
+    YARD::Config.options["yard-cucumber"] and
     YARD::Config.options["yard-cucumber"]["language"] and
     YARD::Config.options["yard-cucumber"]["language"]["step_definitions"]
-    
-    YARD::Config.options["yard-cucumber"]["language"]["step_definitions"].each do |step_word|
-      handles method_call(step_word.to_sym)
+  end
+
+  def self.step_definitions
+    if custom_step_definitions_defined?
+      custom_step_definitions
+    else
+      default_step_definitions
     end
-    
-  else
-    handles method_call(:When),method_call(:Given),method_call(:And),method_call(:Then)
-  end
-  
-  
-  @@unique_name = 0
-  
+  end
+
+  step_definitions.each { |step_def| handles method_call(step_def) }
+
   process do
-    @@unique_name += 1
 
-    instance = YARD::CodeObjects::StepDefinitionObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE,"step_definition#{@@unique_name}") do |o| 
+    instance = YARD::CodeObjects::StepDefinitionObject.new(step_transform_namespace,step_definition_name) do |o|
       o.source = statement.source
       o.comments = statement.comments
+      # o.keyword = statement.method_name.source
       o.keyword = statement[0].source
+      # o.value = statement.parameters.source
       o.value = statement[1].source
+      o.pending = pending_keyword_used(statement.block)
     end
 
     obj = register instance
     parse_block(statement[2],:owner => obj)
-    
+
+  end
+
+  def pending_keyword
+    "pending"
+  end
+
+  def pending_command_statement?(line)
+    puts "#{line.type} #{line.source}"
+    (line.type == :command || line.type == :vcall) && line.first.source == pending_keyword
+  end
+
+  def pending_keyword_used(block)
+    code_in_block = block.last
+    code_in_block.find { |line| pending_command_statement?(line) }
   end
-  
+
+  def step_transform_namespace
+    YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE
+  end
+
+  def step_definition_name
+    "step_definition#{self.class.generate_unique_id}"
+  end
+
+  def self.generate_unique_id
+    @step_definition_count = @step_definition_count.to_i + 1
+  end
+
 end

data/lib/yard/handlers/step_transform_handler.rb

@@ -1,13 +1,10 @@
 
 class YARD::Handlers::Ruby::StepTransformHandler < YARD::Handlers::Ruby::Base
   handles method_call(:Transform)
-  
-  @@unique_name = 0
 
   process do
-    @@unique_name += 1
-    
-    instance = YARD::CodeObjects::StepTransformObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE,"step_transform#{@@unique_name}") do |o| 
+
+    instance = YARD::CodeObjects::StepTransformObject.new(step_transform_namespace,step_transformer_name) do |o|
       o.source = statement.source
       o.comments = statement.comments
       o.keyword = statement[0].source
@@ -19,5 +16,16 @@ class YARD::Handlers::Ruby::StepTransformHandler < YARD::Handlers::Ruby::Base
 
   end
 
-end
+  def step_transform_namespace
+    YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE
+  end
+
+  def step_transformer_name
+    "step_transform#{self.class.generate_unique_id}"
+  end
+
+  def self.generate_unique_id
+    @step_transformer_count = @step_transformer_count.to_i + 1
+  end
 
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-cucumber
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-07 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -73,6 +73,7 @@ extra_rdoc_files:
 files:
 - .gitignore
 - .rspec
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - History.txt
@@ -116,6 +117,8 @@ files:
 - lib/templates/default/featuretags/html/namespace.erb
 - lib/templates/default/featuretags/html/setup.rb
 - lib/templates/default/fulldoc/html/css/cucumber.css
+- lib/templates/default/fulldoc/html/directories.erb
+- lib/templates/default/fulldoc/html/full_list_featuredirectories.erb
 - lib/templates/default/fulldoc/html/full_list_features.erb
 - lib/templates/default/fulldoc/html/full_list_stepdefinitions.erb
 - lib/templates/default/fulldoc/html/full_list_steps.erb
@@ -160,10 +163,10 @@ files:
 homepage: http://github.com/burtlo/yard-cucumber
 licenses: []
 post_install_message: ! "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
-  (::) (::) (::) (::)\n\n  Thank you for installing yard-cucumber 2.2.2 / 2012-10-07.\n\n
-  \ Changes:\n    \n  * Steps and Definitions have links to step transformer page\n
-  \ * Step definitions in the search menu no longer expand constants\n  \n\n(::) (::)
-  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
+  (::) (::) (::) (::)\n\n  Thank you for installing yard-cucumber 2.2.3 / 2013-02-15.\n\n
+  \ Changes:\n    \n  * Step Definitions that are marked as 'pending' will now appear
+  as pending\n    on the step definition and transforms page.\n  \n\n(::) (::) (::)
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
 rdoc_options:
 - --charset=UTF-8
 require_paths: