yard-gherkin-turnip 1.0.0

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; Placeholders</div>
+
+  <div class="summary">
+    <div><%= step_definitions.length %><a href="#step_definitions">Step Definitions</a></div>
+    <div><%= placeholders.length %><a href="#placeholders">Placeholders</a></div>
+    <div><%= undefined_steps.length %><a href="#undefined_steps">Undefined Steps</a></div>
+  </div>
+
+</div>

data/lib/templates/default/steptransformers/html/placeholders.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"><%= h item.literal_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? %>
+      <a class="stepdef" href="#">[Collapse]</a>
+    </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">View <%= item.steps.length %> steps</a>]
+      </div>
+    <% end %>
+    <div class="steps" style="display:none">
+      <% 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">
+            <%= highlight_transformed_step(uniq_step.last.first, item) %>
+          </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/setup.rb

@@ -0,0 +1,107 @@
+def init
+  super
+  sections.push :index, :step_definitions_section, :placeholders_section, :undefined_steps_section
+end
+
+def step_definitions
+  @step_definitions ||= begin
+    YARD::Registry.all(:stepdefinition).sort_by {|definition| definition.steps.length * -1 }
+  end
+end
+
+def placeholders
+  @placeholders ||= begin
+    YARD::Registry.all(:placeholder).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 step_definitions_section
+  @item_title = "Step Definitions"
+  @item_anchor_name = "step_definitions"
+  @item_type = "step definition"
+  @items = step_definitions
+  erb(:header) + erb(:step_definitions)
+end
+
+def placeholders_section
+  @item_title = "Placeholders"
+  @item_anchor_name = "placeholders"
+  @item_type = "placeholder"
+  @items = placeholders
+  erb(:header) + erb(:placeholders)
+end
+
+def undefined_steps_section
+  @item_title = "Undefined Steps"
+  @item_anchor_name = "undefined_steps"
+  @item_type = nil
+  @items = undefined_steps
+  erb(:header) + erb(:undefined_steps)
+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_step_definition_name(step_definition)
+    value = step_definition.literal_value.dup
+
+    if step_definition.placeholders
+      value.gsub!(/:[\w]+/) do |match|
+        placeholder = step_definition.placeholders.find {|placeholder| placeholder.literal_value == match }
+        placeholder ? "<a href='#{url_for(placeholder)}'>#{h(match)}</a>" : "<span class='match'>#{match}</span>"
+      end
+    end
+    value
+  end
+
+
+def link_transformed_step(step)
+  value = step.value.dup
+
+  if step.definition
+    matches = step.definition.regex.match(step.value)
+
+    if matches
+      matches[1..-1].reverse.each_with_index do |match,index|
+        next if match == nil
+        placeholder = step.placeholders.find {|placeholder| placeholder.regex.match(match) }
+
+        value[matches.begin((matches.size - 1) - index)..(matches.end((matches.size - 1) - index) - 1)] = placeholder ? "<a href='#{url_for(placeholder)}'>#{h(match)}</a>" : "<span class='match'>#{h(match)}</span>"
+      end
+    end
+  end
+  value
+end
+
+def highlight_transformed_step(step, placeholder)
+  value = step.value.dup
+  if step.definition
+    matches = step.definition.regex.match(value)
+    matches[1..-1].reverse.each_with_index do |match,index|
+      next if match == nil
+      next unless placeholder.regex.match?(match)
+      value[matches.begin((matches.size - 1) - index)..(matches.end((matches.size - 1) - index) - 1)] = "<span class='match'>#{match}</span>"
+    end
+  end
+  value
+end

data/lib/templates/default/steptransformers/html/step_definitions.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"><%= link_step_definition_name(item) %></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? %>
+      <a class="stepdef" href="#">[Collapse]</a>
+    </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">View <%= item.steps.length %> steps</a>]
+      </div>
+    <% end %>
+    <div class="steps" style="display:none">
+      <% 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/undefined_steps.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,33 @@
+<% 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) %>
+                    <% index = obj.path[(/.+_(\d+)$/),1].to_i - 1 %>
+                    <a href="<%= url_for(obj.feature,"scenario_#{index}") %>">
+                 		  <%= h obj.value %>
+                 		</a>
+                  <% else %>
+                    <%= linkify obj, obj.value %>
+                  <% end %>
+                  <small>(<%= obj.file %>)</small>
+                </li>
+              <% end %>
+            </ul>
+          </ul>
+        <% end %>
+      </td>
+    </tr>
+  </table>
+<% end %>

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

@@ -0,0 +1,27 @@
+def init
+  super
+  @tag = object
+
+  sections.push :tag
+end
+
+def features
+  @tag.features
+end
+
+def scenarios
+  @tag.scenarios
+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/tag/html/tag.erb

@@ -0,0 +1,35 @@
+<div class="tag">
+  <div class="title">
+    <span class="pre">Tag:</span>
+    <span class="name"><%= @tag.value %></span>
+
+  </div>
+
+  <div class="meta">
+    <div class="file">
+      <%= @tag.features.size > 0 ? "#{@tag.features.size} feature#{@tag.features.size > 1 ? 's' : ''} (with #{@tag.indirect_scenarios.size} scenario#{@tag.indirect_scenarios.size > 1 ? 's' : ''})" : "" %>
+      <%= " and " if @tag.features.size > 0 && @tag.scenarios.size > 0 %>
+      <%= @tag.scenarios.size > 0 ? "#{@tag.scenarios.size} scenario#{@tag.scenarios.size > 1 ? 's' : ''}" : "" %>
+    </div>		
+  </div>
+
+  <div style="margin-top: 20px;">&nbsp;</div>
+
+  <% if features && !features.empty? %>
+  <div id="features" style="margin-left: 40px;">
+    <div class="title"><span class="name">Features</span></div>
+  </div>
+  <%= alpha_table(features) %>
+
+  <% end %>
+
+  <% if scenarios && !scenarios.empty? %>
+  <div id="features" style="margin-left: 40px;">
+    <div class="title"><span class="name">Scenarios</span></div>
+  </div>
+  <%= alpha_table(scenarios) %>
+
+  <% end %>
+
+
+</div>

data/lib/yard-gherkin-turnip.rb

@@ -0,0 +1,42 @@
+require 'yard'
+require 'cucumber/platform'
+require 'gherkin/parser'
+
+require File.dirname(__FILE__) + "/yard-gherkin-turnip/version.rb"
+
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/base.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/namespace_object.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/feature.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/scenario_outline.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/scenario.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/step.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/cucumber/tag.rb"
+
+require File.dirname(__FILE__) + "/cucumber/city_builder.rb"
+
+require File.dirname(__FILE__) + "/yard/code_objects/step_transformer.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/step_definition.rb"
+require File.dirname(__FILE__) + "/yard/code_objects/placeholder.rb"
+
+require File.dirname(__FILE__) + "/yard/parser/cucumber/feature.rb"
+
+require File.dirname(__FILE__) + "/yard/handlers/cucumber/base.rb"
+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/placeholder_handler.rb"
+require File.dirname(__FILE__) + "/yard/handlers/placeholder_match_handler.rb"
+
+require File.dirname(__FILE__) + "/yard/templates/helpers/base_helper.rb"
+
+require File.dirname(__FILE__) + "/yard/server/adapter.rb"
+require File.dirname(__FILE__) + "/yard/server/commands/list_command.rb"
+require File.dirname(__FILE__) + "/yard/server/router.rb"
+
+
+# This registered template works for yardoc
+YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/templates'
+
+# The following static paths and templates are for yard server
+YARD::Server.register_static_path File.dirname(__FILE__) + "/templates/default/fulldoc/html"
+YARD::Server.register_static_path File.dirname(__FILE__) + "/docserver/default/fulldoc/html"