yard-lucid 0.1.0

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

@@ -0,0 +1,111 @@
+def init
+  super
+end
+
+# Append yard-lucid stylesheet to yard core stylesheets
+def stylesheets
+  super + %w(css/lucid.css)
+end
+
+# Append yard-lucid javascript to yard core javascripts
+def javascripts
+  super + %w(js/lucid.js)
+end
+
+# Append yard-lucid 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-lucid:
+#       menus: [ 'features', 'directories', 'tags', 'step definitions', 'steps' ]
+def menu_lists
+  current_menu_lists.map { |menu_name| yard_lucid_menus[menu_name] }.compact + super
+end
+
+# By default we want to display the 'features' and 'tags' menu but we will allow
+# the YARD configuration to override that functionality.
+def current_menu_lists
+  @current_menu_lists ||= begin
+    menus = [ "features", "tags" ]
+
+    if YARD::Config.options["yard-lucid"] and YARD::Config.options["yard-lucid"]["menus"]
+      menus = YARD::Config.options["yard-lucid"]["menus"]
+    end
+
+    menus
+  end
+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_lucid_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
+
+# This method overrides YARD's default layout template's layout method.
+#
+# The existing YARD layout method generates the url for the nav menu on the left
+# side. For Yard-Lucid objects this will default to the class_list.html.
+# which is not what we want for features, tags, and so forth.
+#
+# So we override this method and put in some additional logic to figure out the
+# correct list to appear in the search. This can be particularly tricky because
+#
+# This method removes the namespace from the root node, generates the class list,
+# and then adds it back into the root node.
+def layout
+  @nav_url = url_for_list(!@file || options.index ? 'class' : 'file')
+
+  if is_yard_lucid_object?(object)
+    @nav_url = rewrite_nav_url(@nav_url)
+  end
+
+  if !object || object.is_a?(String)
+    @path = nil
+  elsif @file
+    @path = @file.path
+  elsif !object.is_a?(YARD::CodeObjects::NamespaceObject)
+    @path = object.parent.path
+  else
+    @path = object.path
+  end
+
+  erb(:layout)
+end
+
+# Determine if the object happens to be a CodeObject defined in this gem.
+#
+# Quite a few of the classes/modules defined here are not object that we
+# would never want to display but it's alright if we match on them.
+def is_yard_lucid_object?(object)
+  YARD::CodeObjects::Lucid.constants.any? { |constant| object.class.name == "YARD::CodeObjects::Lucid::#{constant}" }
+end
+
+# The re-write rules will only change the nav link to a new menu if it is a
+# a Lucid CodeObject that we care about and that we have also generated a
+# menu for that item.
+def rewrite_nav_url(nav_url)
+  if object.is_a?(YARD::CodeObjects::Lucid::Feature) && current_menu_lists.include?('features')
+    nav_url.gsub('class_list.html','feature_list.html')
+  elsif object.is_a?(YARD::CodeObjects::Lucid::FeatureDirectory) && current_menu_lists.include?('directories')
+    nav_url.gsub('class_list.html','featuredirectories_list.html')
+  elsif object.is_a?(YARD::CodeObjects::Lucid::Tag) && current_menu_lists.include?('tags')
+    nav_url.gsub('class_list.html','tag_list.html')
+  elsif object.is_a?(YARD::CodeObjects::Lucid::Step) && current_menu_lists.include?('steps')
+    nav_url.gsub('class_list.html','step_list.html')
+  elsif object.is_a?(YARD::CodeObjects::Lucid::StepTransformersObject) && current_menu_lists.include?('step definitions')
+    nav_url.gsub('class_list.html','stepdefinition_list.html')
+  else
+    nav_url
+  end
+end

data/lib/templates/default/specifications/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/specifications/html/setup.rb

@@ -0,0 +1,49 @@
+def init
+  super
+  sections.push :specifications
+  @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::Lucid::LUCID_NAMESPACE.children.find_all { |child| child.is_a?(YARD::CodeObjects::Lucid::FeatureDirectory) }
+end
+
+def feature_subdirectories
+  @feature_subdirectories ||= Registry.all(:featuredirectory) - feature_directories
+end
+
+def step_transformers
+  YARD::CodeObjects::Lucid::LUCID_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/specifications/html/specifications.erb

@@ -0,0 +1,46 @@
+<% if @namespace %>
+  <div id="lucid_logo">&nbsp;</div>
+  <div id="lucid_links">
+    <a href="https://github.com/jeffnyman/yard-lucid">Yard-Lucid</a> |
+    <a href="http://github.com/cucumber/cucumber/wiki/Gherkin">Gherkin</a> |
+    <a href="http://cukes.info/">Cucumber</a> |
+    <a href="http://yardoc.org/">YARD</a>
+  </div>
+
+  <div class="specifications">
+    <% 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/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,9 @@
+<div class="specifications">
+  <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,92 @@
+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,74 @@
+<% @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? %>
+      <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">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::Lucid::Scenario) || obj.is_a?(YARD::CodeObjects::Lucid::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 %>

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

@@ -0,0 +1,26 @@
+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,31 @@
+<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/code_objects/lucid/base.rb

@@ -0,0 +1,23 @@
+module YARD::CodeObjects::Lucid
+  module LocationHelper
+    def line_number
+      files.first.last
+    end
+
+    def file
+      files.first.first if files && !files.empty?
+    end
+
+    def location
+      "#{file}:#{line_number}"
+    end
+  end
+
+  class Base < YARD::CodeObjects::Base
+    include LocationHelper
+
+    def path
+      @value || super
+    end
+  end
+end

data/lib/yard/code_objects/lucid/feature.rb

@@ -0,0 +1,12 @@
+module YARD::CodeObjects::Lucid
+  class Feature < NamespaceObject
+    attr_accessor :background, :comments, :description, :keyword, :scenarios, :tags, :value
+
+    def initialize(namespace,name)
+      @comments = ""
+      @scenarios = []
+      @tags = []
+      super(namespace,name.to_s.strip)
+    end
+  end
+end

data/lib/yard/code_objects/lucid/namespace_object.rb

@@ -0,0 +1,43 @@
+module YARD::CodeObjects::Lucid
+
+  class NamespaceObject < YARD::CodeObjects::NamespaceObject
+    include LocationHelper
+    def value ; nil ; end
+  end
+
+  class Specifications < NamespaceObject ; end
+  class FeatureTags < NamespaceObject ; end
+  class StepTransformersObject < NamespaceObject ; end
+
+  class FeatureDirectory < YARD::CodeObjects::NamespaceObject
+    attr_accessor :description
+
+    def initialize(namespace,name)
+      super(namespace,name)
+      @description = ""
+    end
+
+    def location
+      files.first.first if files && !files.empty?
+    end
+
+    def expanded_path
+      to_s.split('::')[1..-1].join('/')
+    end
+
+    def value ; name ; end
+
+    def features
+      children.find_all { |d| d.is_a?(Feature) }
+    end
+
+    def subdirectories
+      subdirectories = children.find_all { |d| d.is_a?(FeatureDirectory) }
+      subdirectories + subdirectories.collect { |s| s.subdirectories }.flatten
+    end
+  end
+
+  LUCID_NAMESPACE = Specifications.new(:root, "specifications") unless defined?(LUCID_NAMESPACE)
+  LUCID_TAG_NAMESPACE = FeatureTags.new(LUCID_NAMESPACE, "tags") unless defined?(LUCID_TAG_NAMESPACE)
+  LUCID_STEPTRANSFORM_NAMESPACE = StepTransformersObject.new(LUCID_NAMESPACE, "step_transformers") unless defined?(LUCID_STEPTRANSFORM_NAMESPACE)
+end

data/lib/yard/code_objects/lucid/scenario.rb

@@ -0,0 +1,20 @@
+module YARD::CodeObjects::Lucid
+  class Scenario < NamespaceObject
+    attr_accessor :value, :comments, :keyword, :description, :steps, :tags, :feature
+
+    def initialize(namespace,name)
+      super(namespace,name.to_s.strip)
+      @comments = @description = @keyword = @value = @feature = nil
+      @steps = []
+      @tags = []
+    end
+
+    def background?
+      @keyword == "Background"
+    end
+
+    def outline?
+      false
+    end
+  end
+end