yard-cucumber2 2.3.3

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

@@ -0,0 +1,56 @@
+def init
+  super
+end
+
+#
+# Append yard-cucumber stylesheet to yard core stylesheets
+# 
+def stylesheets
+  super + %w(css/cucumber.css)
+end
+
+#
+# Append yard-cucumber javascript to yard core javascripts
+# 
+def javascripts
+  super + %w(js/cucumber.js)
+end
+
+#
+# Append yard-cucumber specific menus 'features' and 'tags'
+# 
+# 'features' and 'tags' are enabled by default.
+# 
+# 'step definitions' and 'steps' may be enabled by setting up a value in
+# yard configuration file '~/.yard/config'
+# 
+# @example `~/.yard.config`
+# 
+#     yard-cucumber:
+#       menus: [ 'features', 'directories', 'tags', 'step definitions', 'steps' ]
+# 
+def menu_lists
+  
+  menus = [ "features", "tags" ]
+
+  # load the yard-cucumber menus defined in the configuration file
+  if YARD::Config.options["yard-cucumber"] and YARD::Config.options["yard-cucumber"]["menus"]
+    menus = YARD::Config.options["yard-cucumber"]["menus"]
+  end
+
+  menus.map {|menu_name| yard_cucumber_menus[menu_name] }.compact + super
+end
+
+#
+# When a menu is specified in the yard configuration file, this hash contains
+# the details about the menu necessary for it to be displayed.
+# 
+# @see #menu_lists
+# 
+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' } }
+end

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

@@ -0,0 +1,26 @@
+<% if @elements && !@elements.empty? %>
+  <% i = (@elements.length % 2 == 0 ? 1 : 0) %>
+  <table style="margin-left: 10px; width: 100%;">
+    <tr>
+      <td valign='top' width="50%">
+        <% @elements.each do |letter, objects| %>
+          <% if (i += 1) > (@elements.length / 2 + 1) %>
+          </td><td valign='top' width="50%">
+            <% i = 0 %>
+          <% end %>
+          <ul id="alpha_<%= letter %>" class="alpha">
+            <li class="letter"><%= letter %></li>
+            <ul>
+              <% objects.each do |obj| %>
+                <li>
+                  <%= linkify obj, obj.value %>
+                  <small>(<%= obj.file %>)</small>
+                </li>
+              <% end %>
+            </ul>
+          </ul>
+        <% end %>
+      </td>
+    </tr>
+  </table>
+<% end %>

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

@@ -0,0 +1,50 @@
+<% if @namespace %>
+  <div id="cukes_logo">&nbsp;</div>
+  <div id="cukes_links">
+    <a href="http://cukes.info/">Cucumber</a> |
+    <a href="http://github.com/cucumber/cucumber/wiki/Gherkin">Gherkin</a> |
+    <a href="http://yardoc.org/">YARD</a> |
+    <a href="https://github.com/burtlo/yard-cucumber">YARD-Cucumber</a>
+  </div>
+
+  <div class="requirements">
+
+    <% if features && !features.empty? %>
+      <%= alpha_table(features) %>
+    <% else %>
+      <!-- No Features Defined -->
+      <div class="none">No Features Defined</div>
+    <% end %>
+
+    <div id="directory" style="margin-left: 40px;">
+      <div class="title"><span class="name">Tags</span></div>
+    </div>
+    <div class="tags">
+      <%= tags.collect {|tag| linkify(tag,tag.value) }.join(",\n") %>
+    </div>
+
+    <% if feature_subdirectories && !feature_subdirectories.empty? %>
+      <div id="directory" style="margin-left: 40px;">
+        <div class="title"><span class="name">Subdirectories</span></div>
+      </div>
+      <%= alpha_table(feature_subdirectories) %>
+    <% else %>
+      <!-- No Feature Directories -->
+    <% end %>
+    
+    <div id="directory" style="margin-left: 40px;">
+      <div class="title"><span class="name">Step Definitions &amp; Transforms</span></div>
+    </div>
+    <div class="steptransformers">
+      <%= step_definitions.length %> 
+      <a href="<%= url_for step_transformers, "step_definitions" %>">Step Definitions</a>
+      <%= transformers.length %>
+      <a href="<%= url_for step_transformers, "step_transforms" %>">Transforms</a>
+      and <%= undefined_steps.length %>
+      <a href="<%= url_for step_transformers, "undefined_steps" %>">Undefined Steps</a>
+    </div>
+    
+  </div>
+<% end %>
+
+

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

@@ -0,0 +1,51 @@
+def init
+  super
+  sections.push :requirements
+  @namespace = object
+
+end
+
+def features
+  @features ||= Registry.all(:feature)
+end
+
+def tags
+  @tags ||= Registry.all(:tag).sort_by {|l| l.value.to_s }
+end
+
+def feature_directories
+  @feature_directories ||= YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE.children.find_all {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory)}
+end
+
+def feature_subdirectories
+  @feature_subdirectories ||= Registry.all(:featuredirectory) - feature_directories
+end
+
+def step_transformers
+  YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE
+end
+
+def step_definitions
+  @step_definitions ||= YARD::Registry.all(:stepdefinition)
+end
+
+def transformers
+  @transformers ||= YARD::Registry.all(:steptransform)
+end
+
+def undefined_steps
+  @undefined_steps ||= Registry.all(:step).reject {|s| s.definition || s.scenario.outline? }
+end
+
+
+def alpha_table(objects)
+  @elements = Hash.new
+
+  objects = run_verifier(objects)
+  objects.each {|o| (@elements[o.value.to_s[0,1].upcase] ||= []) << o }
+  @elements.values.each {|v| v.sort! {|a,b| b.value.to_s <=> a.value.to_s } }
+  @elements = @elements.sort_by {|l,o| l.to_s }
+
+  @elements.each {|letter,objects| objects.sort! {|a,b| b.value.to_s <=> a.value.to_s }}
+  erb(:alpha_table)
+end

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

@@ -0,0 +1,12 @@
+<div class="title">
+  <% if @item_type %>
+     <a class="control" id="<%= @item_type.gsub(/\s/,'') %>">[Collapse All]</a>
+     <div style="clear: right;"></div>
+   <% end %>
+ 
+  <% if @item_anchor_name %>
+    <a name="<%= @item_anchor_name %>">
+  <% end %>
+  <div class="name"><%= @item_title %></div>
+</div>
+

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

@@ -0,0 +1,10 @@
+<div class="requirements">
+  <div class="title">Step Definitions &amp; Transforms</div>
+
+  <div class="summary">
+    <div><%= step_definitions.length %><a href="#step_definitions">Step Definitions</a></div>
+    <div><%= step_transforms.length %><a href="#step_transforms">Step Transforms</a></div>
+    <div><%= undefined_steps.length %><a href="#undefined_steps">Undefined Steps</a></div>
+  </div>
+
+</div>

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

@@ -0,0 +1,94 @@
+def init
+  super
+  sections.push :index, :stepdefinitions, :steptransforms, :undefinedsteps
+end
+
+def step_definitions
+  @step_definitions ||= begin
+    YARD::Registry.all(:stepdefinition).sort_by {|definition| definition.steps.length * -1 }
+  end
+end
+
+def step_transforms
+  @step_transforms ||= begin
+    YARD::Registry.all(:steptransform).sort_by {|definition| definition.steps.length * -1 }
+  end
+end
+
+def undefined_steps
+  @undefined_steps ||= begin
+    unique_steps(Registry.all(:step).reject {|s| s.definition || s.scenario.outline? }).sort_by{|steps| steps.last.length * -1 }
+  end
+end
+
+def stepdefinitions
+  @item_title = "Step Definitions"  
+  @item_anchor_name = "step_definitions"
+  @item_type = "step definition"
+  @items = step_definitions
+  erb(:header) + erb(:transformers)
+end
+
+def steptransforms
+  @item_title = "Step Transforms"
+  @item_anchor_name = "step_transforms"
+  @item_type = "step transform"
+  @items = step_transforms
+  erb(:header) + erb(:transformers)
+end
+
+def undefinedsteps
+  @item_title = "Undefined Steps"  
+  @item_anchor_name = "undefined_steps"
+  @item_type = nil
+  @items = undefined_steps
+  erb(:header) + erb(:undefinedsteps)
+end
+
+
+def unique_steps(steps)
+  uniq_steps = {}
+  steps.each {|s| (uniq_steps[s.value.to_s] ||= []) << s }
+  uniq_steps
+end
+
+def display_comments_for(item)
+  begin
+    T('docstring').run(options.dup.merge({:object => item}))
+  rescue
+    log.warn %{An error occurred while attempting to render the comments for: #{item.location} }
+    return ""
+  end
+  
+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
+  
+  if step.definition
+    matches = step.value.match(step.definition.regex)
+    
+    if matches
+      matches[1..-1].reverse.each_with_index do |match,index|
+        next if match == nil
+        transform = step.transforms.find {|transform| transform.regex.match(match) }
+        
+        value[matches.begin((matches.size - 1) - index)..(matches.end((matches.size - 1) - index) - 1)] = transform ? "<a href='#{url_for(transform)}'>#{h(match)}</a>" : "<span class='match'>#{match}</span>"
+      end
+    end
+  end
+  
+  value
+end

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

@@ -0,0 +1,79 @@
+<% @items.each do |item| %>
+
+<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>
+    <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>
+
+  <div class="details">
+    
+    <div class="meta" style="clear: right;">
+      <div class="file"><%= h item.location %></div>
+    </div>
+    
+    <!-- Comments -->
+    <div>
+      <%= display_comments_for item %>
+    </div>
+    
+
+    <!-- Source Code -->
+    <div class="method_details_list">
+      <table class="source_code">
+        <tr>
+          <td>
+            <pre class="lines"><%= "" %><%= h format_lines(item) %></pre>
+          </td>
+          <td>
+            <pre class="code"><%= "" %><%= html_syntax_highlight item.source %></pre>
+          </td>
+        </tr>
+      </table>
+    </div>
+
+    <!-- Matching Step Instances -->
+    <% if item.steps.length > 0 %>
+      <div class='showSteps'>
+        [<a href='#' class='toggleSteps' alt="<%= item.steps.length %> steps">Hide <%= item.steps.length %> steps</a>]
+      </div>
+    <% end %>
+    <div class="steps">
+      <% if item.steps && !item.steps.empty? %>
+      <% unique_steps(item.steps).each_with_index do |uniq_step,step_index| %>
+      <div class="step <%= (step_index + 1) % 2 == 0 ? 'even' : 'odd' %>">
+        <div>
+          <span class="predicate">
+            <%= h uniq_step.last.first.keyword %>
+          </span>
+          <span class="defined">
+            <%= link_transformed_step(uniq_step.last.first) %>
+          </span>
+        </div>
+        <% uniq_step.last.each do |step| %>
+        <a class="definition" style="clear: right;" href="<%= url_for step.scenario.feature %>"><%= h step.location %></a>
+        <% end %>
+        <div style="clear: both;"></div>
+      </div>
+      <% end %>
+      <% else %>
+      <div class="undefined">No steps were found to match this <%= @item_type %>.</div>
+      <% end%>
+    </div>
+    
+  </div>
+
+  <div style="margin: 30px 20px; border-top: 1px dotted #AAA;"></div>
+
+</div>
+
+<% end %>

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

@@ -0,0 +1,26 @@
+<div class="transformer">
+  <div class="steps">
+  <% if @undefined_steps && !@undefined_steps.empty? %>
+    <% @undefined_steps.each_with_index do |uniq_step,step_index| %>
+    <div class="step <%= (step_index + 1) % 2 == 0 ? 'even' : 'odd' %>">
+      <div>
+        <span class="predicate"><%= uniq_step.last.first.keyword %></span>
+        <span class="undefined">
+          <%= h uniq_step.last.first.value %>
+        </span>
+      </div>
+      <% uniq_step.last.each do |step| %>
+        <a class="definition" style="clear: right;" href="<%= url_for step.scenario.feature %>">
+          <%= h step.location %>
+        </a>
+      <% end%>
+      <div style="clear: both;"></div>
+    </div>
+    <% end %>
+    <% else %>
+    <div class="steps">
+      <div class="undefined">No undefined steps</div>
+    </div>
+    <% end%>
+  </div>
+</div>

data/lib/templates/default/tag/html/alpha_table.erb

@@ -0,0 +1,32 @@
+<% if @elements && !@elements.empty? %>
+  <% i = (@elements.length % 2 == 0 ? 1 : 0) %>
+  <table style="margin-left: 10px; width: 100%;">
+    <tr>
+      <td valign='top' width="50%">
+        <% @elements.each do |letter, objects| %>
+          <% if (i += 1) > (@elements.length / 2 + 1) %>
+          </td><td valign='top' width="50%">
+            <% i = 0 %>
+          <% end %>
+          <ul id="alpha_<%= letter %>" class="alpha">
+            <li class="letter"><%= letter %></li>
+            <ul>
+              <% objects.each do |obj| %>
+                <li>
+                  <% if obj.is_a?(YARD::CodeObjects::Cucumber::Scenario) || obj.is_a?(YARD::CodeObjects::Cucumber::ScenarioOutline) %>
+                    <a href="<%= url_for(obj.feature,"scenario_#{obj.path[(/.+_(\d+)$/),1]}") %>">
+                 		  <%= h obj.value %>
+                 		</a>
+                  <% else %>
+                    <%= linkify obj, obj.value %>
+                  <% end %>
+                  <small>(<%= obj.file %>)</small>
+                </li>
+              <% end %>
+            </ul>
+          </ul>
+        <% end %>
+      </td>
+    </tr>
+  </table>
+<% end %>