cucumber-in-the-yard 1.7.3 → 1.7.4

data/History.txt

@@ -1,3 +1,10 @@
+=== 1.7.4 / 2010-12-11
+
+* Ruby 1.9.2 Support
+* Change to YARD Server support:
+   yard server -e /path/to/gem/lib/server.b
+
+
 === 1.7.3 / 2010-12-06
 
 * Shortcut Keys (t) for tags and (r) for features (f was taken)

data/README.md

@@ -77,6 +77,10 @@ OPTS environment variable:
 
     $ yardoc -e path/to/cucumber-in-the-yard/lib/city.rb -p path/to/cucumber-in-the-yard/lib/templates 'features/**/*.*'
 
+**3. YARD Server**
+
+    $ yard server -e path/to/cucumber-in-the-yard/lib/server.rb
+
 
 Details
 --------
@@ -109,31 +113,34 @@ 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.
 
 
-Short Term Goals
+**Current 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.
+1. The landing page for 'All features' should be requirements landing page.
+
+2. '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
+
+3. Provide readme.md markdown support within each of the feature subdirectories
+
+4. 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
+  * Further testing for tag filtering
+
+5. Step Transformers
+  * Better way to illustrate that a step has a transformed applied to a parameter
+
+6. 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**
+**Future Ideas**
 
 **1. Table Step Transforms**
 

data/Rakefile

@@ -2,12 +2,19 @@ require 'rake'
 
 task :default => :gendoc
 
-task :gendoc do
+task :clean do
   `rm -rf doc`
   `rm -rf .yardoc`
-  `yardoc -e lib/city.rb -p lib/templates 'example/**/*.*' --debug`
 end
 
-task :server do
-  `yard server -e lib/city.rb --debug`
+task :gendoc => :clean do
+  `yardoc -e ./lib/city.rb -p ./lib/templates 'example/**/*' --debug`
+end
+
+task :old => :clean do
+  `/usr/bin/yardoc -e lib/city.rb -p lib/templates 'example/**/*' --debug`
 end
+
+task :server do
+  `yard server -e ./lib/server.rb --debug`
+end

data/lib/city.rb

@@ -2,8 +2,9 @@ require 'cucumber/parser/gherkin_builder'
 require 'gherkin/parser/parser'
 require 'gherkin/formatter/tag_count_formatter'
 
+
 module CucumberInTheYARD
-  VERSION = '1.7.3' unless defined?(CucumberInTheYARD::VERSION)
+  VERSION = '1.7.4' unless defined?(CucumberInTheYARD::VERSION)
 end
 
 require File.dirname(__FILE__) + "/yard/code_objects/cucumber/base.rb"
@@ -29,21 +30,14 @@ require File.dirname(__FILE__) + "/yard/handlers/cucumber/feature_handler.rb"
 require File.dirname(__FILE__) + "/yard/handlers/step_definition_handler.rb"
 require File.dirname(__FILE__) + "/yard/handlers/step_transform_handler.rb"
 
+
+require File.dirname(__FILE__) + "/yard/handlers/legacy/step_definition_handler.rb"
+require File.dirname(__FILE__) + "/yard/handlers/legacy/step_transform_handler.rb"
+
 require File.dirname(__FILE__) + "/yard/parser/source_parser.rb"
 require File.dirname(__FILE__) + "/yard/templates/helpers/base_helper.rb"
 
 require File.dirname(__FILE__) + "/yard/server/commands/list_command.rb"
 require File.dirname(__FILE__) + "/yard/server/router.rb"
 
-require File.dirname(__FILE__) + "/yard/rake/city_task.rb"
-
-
-#
-# For `yard server` utilize the templates and the static files at these locations
-# before using the defaults 
-#
-YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/templates'
-YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/docserver'
-
-YARD::Server.register_static_path File.dirname(__FILE__) + "/templates/default/fulldoc/html"
-YARD::Server.register_static_path File.dirname(__FILE__) + "/docserver/default/fulldoc/html"
+require File.dirname(__FILE__) + "/yard/rake/city_task.rb"

data/lib/server.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + "/city"
+#
+# For `yard server` utilize the templates and the static files at these locations
+# before using the defaults 
+#
+YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/templates'
+YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/docserver'
+
+YARD::Server.register_static_path File.dirname(__FILE__) + "/templates/default/fulldoc/html"
+YARD::Server.register_static_path File.dirname(__FILE__) + "/docserver/default/fulldoc/html"

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

@@ -1,6 +1,7 @@
 <script type="text/javascript" charset="utf-8">
 $(function() {
   $(".developer").hide();
+  $(".scenario").css('cursor','pointer');
 });
 </script>
 

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

@@ -4,7 +4,7 @@
     <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>
+    <a class="link" style="float:right; clear:right;" href="<% url_for(@scenario.feature,"scenario#{@id}") %>">link</a>
   </div>
 
   <% if @scenario.description.length > 0 %>

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

@@ -4,7 +4,7 @@
   <a name="<%= anchor_for item %>"></a>
   <div class="title">
     <span class="pre"><%= h item.keyword %></span>
-    <span class="name"><%= h item.value %></span>
+    <span class="name"><%= link_constants item %></span>
     <a style="float: right;" href="http://rubular.com/?regex=<%= urlencode item.value %>" target="_blank">Rubular</a>
     <div style="clear: both;"></div>
   </div>

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

@@ -3,7 +3,6 @@ def init
   sections.push :stepdefinitions, :steptransforms, :undefined_steps
 end
 
-
 def stepdefinitions
   @item_title = "Step Definitions"
   @item_type = "step definition"
@@ -32,6 +31,18 @@ def unique_steps(steps)
   uniq_steps
 end
 
+def link_constants(definition)
+  value = definition.literal_value.dup
+
+  definition.constants_from_value(value).each do |name|
+    constant = YARD::Registry.all(:constant).find{|c| c.name == name.to_sym }
+    value.gsub!(/\b#{name}\b/,"<a href='#{url_for(constant)}'>#{name}</a>") if constant
+  end
+
+  value
+end
+
+
 def link_transformed_step(step)
   value = step.value.dup
   

data/lib/yard/code_objects/step_transformer.rb

@@ -5,14 +5,15 @@ module YARD::CodeObjects
 
     include Cucumber::LocationHelper
 
-    attr_reader :constants, :keyword, :source, :value
+    attr_reader :constants, :keyword, :source, :value, :literal_value
     attr_accessor :steps
 
     ESCAPE_PATTERN = /#\{\s*(\w+)\s*\}/
 
     def value=(value)
+      @literal_value = format_source(value)
       @value = format_source(value)
-
+      
       until (nested = constants_from_value).empty?
         nested.each {|n| @value.gsub!(value_regex(n),find_value_for_constant(n)) }
       end

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

@@ -14,7 +14,6 @@ module YARD
           @@step_definitions = cache(:stepdefinition) unless @@step_definitions
           @@step_transforms = cache(:steptransform) unless @@step_transforms
 
-
           if statement
             # For the background and the scenario, find the steps that have definitions
             process_scenario(statement.background) if statement.background
@@ -27,7 +26,6 @@ module YARD
                   process_scenario(example)
                 end
               else
-                #log.info "Processing Scenario: #{scenario.value}"
                 process_scenario(scenario)
               end
             end
@@ -65,8 +63,7 @@ module YARD
         end
 
         def match_step_to_step_definition_and_transforms(step)
-          @@step_definitions.each do |stepdef,stepdef_object|
-
+          @@step_definitions.each_pair do |stepdef,stepdef_object|
             stepdef_matches = step.value.match(stepdef)
 
             if stepdef_matches
@@ -81,6 +78,7 @@ module YARD
               end
               
               # Step has been matched to step definition and step transforms
+              # TODO: If the step were to match again then we would be able to display ambigous step definitions
               break
               
             end

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

@@ -0,0 +1,46 @@
+class YARD::Handlers::Ruby::Legacy::StepDefinitionHandler < YARD::Handlers::Ruby::Legacy::Base
+  #TODO: This needs to become language independent.
+  STEP_DEFINITION_MATCH = /^((When|Given|And|Then)\s*(\/.+\/)\s+do(?:\s*\|.+\|)?\s*)$/
+  handles STEP_DEFINITION_MATCH
+
+  @@unique_name = 0
+
+  def process
+    keyword = statement.tokens.to_s[STEP_DEFINITION_MATCH,2]
+    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| 
+      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
+  # to at least list those in use within a step definition and if you can find a match, go ahead and
+  # make it
+  #
+  def find_steps_defined_in_block(block)
+    #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)  && 
+          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

@@ -0,0 +1,24 @@
+class YARD::Handlers::Ruby::Legacy::StepTransformHandler < YARD::Handlers::Ruby::Legacy::Base
+  STEP_TRANSFORM_MATCH = /^(Transform\s*(\/.+\/)\s+do(?:\s*\|.+\|)?\s*)$/
+  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| 
+      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,48 +1,42 @@
-
-
-class StepDefinitionHandler < YARD::Handlers::Ruby::Legacy::Base
-  #TODO: This needs to become language independent.
-  STEP_DEFINITION_MATCH = /^((When|Given|And|Then)\s*(\/.+\/)\s+do(?:\s*\|.+\|)?\s*)$/
-  handles STEP_DEFINITION_MATCH
-
-  @@unique_name = 0
-
-  def process
-    keyword = statement.tokens.to_s[STEP_DEFINITION_MATCH,2]
-    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| 
-      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
-  # to at least list those in use within a step definition and if you can find a match, go ahead and
-  # make it
-  #
-  def find_steps_defined_in_block(block)
-    #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)  && 
-          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
+
+class YARD::Handlers::Ruby::StepDefinitionHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:When),method_call(:Given),method_call(:And),method_call(:Then)
+  
+  @@unique_name = 0
+  
+  process do
+    @@unique_name += 1
+
+    instance = StepDefinitionObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE,"step_definition#{@@unique_name}") do |o| 
+      o.source = statement.source
+      o.comments = statement.comments
+      o.keyword = statement[0].source
+      o.value = statement[1].source
+    end
+
+    obj = register instance
+    parse_block(statement[2],:owner => obj)
+    
+  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
+  # to at least list those in use within a step definition and if you can find a match, go ahead and
+  # make it
+  #
+  def find_steps_defined_in_block(block)
+    #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)  && 
+          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/step_transform_handler.rb

@@ -1,26 +1,23 @@
-
-
-class StepTransformHandler < YARD::Handlers::Ruby::Legacy::Base
-  STEP_TRANSFORM_MATCH = /^(Transform\s*(\/.+\/)\s+do(?:\s*\|.+\|)?\s*)$/
-  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| 
-      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
-
+
+class YARD::Handlers::Ruby::StepTransformHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:Transform)
+  
+  @@unique_name = 0
+
+  process do
+    @@unique_name += 1
+    
+    instance = StepTransformObject.new(YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE,"step_definition#{@@unique_name}") do |o| 
+      o.source = statement.source
+      o.comments = statement.comments
+      o.keyword = statement[0].source
+      o.value = statement[1].source
+    end
+
+    obj = register instance
+    parse_block(statement[2],:owner => obj)
+
+  end
+
+end
+

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cucumber-in-the-yard
 version: !ruby/object:Gem::Version 
-  hash: 13
   prerelease: false
   segments: 
   - 1
   - 7
-  - 3
-  version: 1.7.3
+  - 4
+  version: 1.7.4
 platform: ruby
 authors: 
 - Franklin Webber
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-06 00:00:00 -08:00
+date: 2010-12-12 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
         segments: 
         - 2
         - 2
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 0
         - 7
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         - 6
@@ -98,6 +94,7 @@ files:
 - lib/docserver/default/layout/html/headers.erb
 - lib/docserver/doc_server/full_list/html/full_list.erb
 - lib/docserver/doc_server/full_list/html/setup.rb
+- lib/server.rb
 - lib/templates/default/feature/html/feature.erb
 - lib/templates/default/feature/html/no_steps_defined.erb
 - lib/templates/default/feature/html/outline.erb
@@ -146,6 +143,8 @@ files:
 - lib/yard/code_objects/step_transformer.rb
 - lib/yard/handlers/cucumber/base.rb
 - lib/yard/handlers/cucumber/feature_handler.rb
+- lib/yard/handlers/legacy/step_definition_handler.rb
+- lib/yard/handlers/legacy/step_transform_handler.rb
 - lib/yard/handlers/step_definition_handler.rb
 - lib/yard/handlers/step_transform_handler.rb
 - lib/yard/parser/cucumber/feature.rb
@@ -158,27 +157,9 @@ has_rdoc: true
 homepage: http://github.com/burtlo/Cucumber-In-The-Yard
 licenses: []
 
-post_install_message: |+
-  
-  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
-  
-    Thank you for installing Cucumber-In-The-YARD 1.7.3 / 2010-12-06.
-    
-    Changes:
-      
-    * 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
-    
-  
-  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
-  
+post_install_message: "\n\
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n  Thank you for installing Cucumber-In-The-YARD 1.7.4 / 2010-12-11.\n  \n  Changes:\n    \n  * Ruby 1.9.2 Support\n  * Change to YARD Server support:\n     yard server -e /path/to/gem/lib/server.b\n  \n  \n\n\
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
@@ -188,7 +169,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -197,7 +177,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"