RubyGems - yard-cucumber2 - Versions diffs - 2.3.3 - Mend

yard-cucumber2 2.3.3

Files changed (93) hide show

checksums.yaml +7 -0
data/.gitignore +6 -0
data/.rspec +3 -0
data/.ruby-gemset +1 -0
data/.ruby-version +1 -0
data/Gemfile +5 -0
data/Gemfile.lock +37 -0
data/History.txt +274 -0
data/LICENSE.txt +22 -0
data/README.md +188 -0
data/Rakefile +25 -0
data/example/README.md +8 -0
data/example/child_feature/README.md +21 -0
data/example/child_feature/child.feature +11 -0
data/example/child_feature/grandchild_feature/grandchild.feature +12 -0
data/example/empty.feature +2 -0
data/example/french.feature +18 -0
data/example/scenario.feature +63 -0
data/example/scenario_outline.feature +94 -0
data/example/scenario_outline_multi.feature +15 -0
data/example/step_definitions/example.step.rb +109 -0
data/example/step_definitions/first.step.rb +21 -0
data/example/step_definitions/french_steps.rb +32 -0
data/example/step_definitions/struct.rb +11 -0
data/example/step_definitions/support/env.rb +7 -0
data/example/step_definitions/support/env_support.rb +12 -0
data/example/step_definitions/support/support.rb +6 -0
data/example/tags.feature +18 -0
data/example/transform.feature +13 -0
data/lib/cucumber/city_builder.rb +331 -0
data/lib/docserver/default/fulldoc/html/js/cucumber.js +85 -0
data/lib/docserver/default/layout/html/headers.erb +14 -0
data/lib/docserver/doc_server/full_list/html/full_list.erb +39 -0
data/lib/docserver/doc_server/full_list/html/setup.rb +18 -0
data/lib/templates/default/feature/html/feature.erb +39 -0
data/lib/templates/default/feature/html/no_steps_defined.erb +1 -0
data/lib/templates/default/feature/html/outline.erb +56 -0
data/lib/templates/default/feature/html/pystring.erb +3 -0
data/lib/templates/default/feature/html/scenario.erb +55 -0
data/lib/templates/default/feature/html/setup.rb +55 -0
data/lib/templates/default/feature/html/steps.erb +39 -0
data/lib/templates/default/feature/html/table.erb +20 -0
data/lib/templates/default/featuredirectory/html/alpha_table.erb +30 -0
data/lib/templates/default/featuredirectory/html/directory.erb +32 -0
data/lib/templates/default/featuredirectory/html/setup.rb +41 -0
data/lib/templates/default/featuretags/html/namespace.erb +131 -0
data/lib/templates/default/featuretags/html/setup.rb +34 -0
data/lib/templates/default/fulldoc/html/css/cucumber.css +227 -0
data/lib/templates/default/fulldoc/html/directories.erb +53 -0
data/lib/templates/default/fulldoc/html/full_list_featuredirectories.erb +11 -0
data/lib/templates/default/fulldoc/html/full_list_features.erb +29 -0
data/lib/templates/default/fulldoc/html/full_list_stepdefinitions.erb +16 -0
data/lib/templates/default/fulldoc/html/full_list_steps.erb +17 -0
data/lib/templates/default/fulldoc/html/full_list_tags.erb +12 -0
data/lib/templates/default/fulldoc/html/js/cucumber.js +305 -0
data/lib/templates/default/fulldoc/html/setup.rb +175 -0
data/lib/templates/default/layout/html/setup.rb +56 -0
data/lib/templates/default/requirements/html/alpha_table.erb +26 -0
data/lib/templates/default/requirements/html/requirements.erb +50 -0
data/lib/templates/default/requirements/html/setup.rb +51 -0
data/lib/templates/default/steptransformers/html/header.erb +12 -0
data/lib/templates/default/steptransformers/html/index.erb +10 -0
data/lib/templates/default/steptransformers/html/setup.rb +94 -0
data/lib/templates/default/steptransformers/html/transformers.erb +79 -0
data/lib/templates/default/steptransformers/html/undefinedsteps.erb +26 -0
data/lib/templates/default/tag/html/alpha_table.erb +32 -0
data/lib/templates/default/tag/html/setup.rb +27 -0
data/lib/templates/default/tag/html/tag.erb +35 -0
data/lib/yard-cucumber.rb +47 -0
data/lib/yard-cucumber/version.rb +3 -0
data/lib/yard/code_objects/cucumber/base.rb +32 -0
data/lib/yard/code_objects/cucumber/feature.rb +18 -0
data/lib/yard/code_objects/cucumber/namespace_object.rb +49 -0
data/lib/yard/code_objects/cucumber/scenario.rb +26 -0
data/lib/yard/code_objects/cucumber/scenario_outline.rb +75 -0
data/lib/yard/code_objects/cucumber/step.rb +38 -0
data/lib/yard/code_objects/cucumber/tag.rb +27 -0
data/lib/yard/code_objects/step_definition.rb +7 -0
data/lib/yard/code_objects/step_transform.rb +7 -0
data/lib/yard/code_objects/step_transformer.rb +97 -0
data/lib/yard/handlers/cucumber/base.rb +21 -0
data/lib/yard/handlers/cucumber/feature_handler.rb +131 -0
data/lib/yard/handlers/legacy/step_definition_handler.rb +45 -0
data/lib/yard/handlers/legacy/step_transform_handler.rb +24 -0
data/lib/yard/handlers/step_definition_handler.rb +86 -0
data/lib/yard/handlers/step_transform_handler.rb +31 -0
data/lib/yard/parser/cucumber/feature.rb +73 -0
data/lib/yard/server/adapter.rb +43 -0
data/lib/yard/server/commands/list_command.rb +31 -0
data/lib/yard/server/router.rb +32 -0
data/lib/yard/templates/helpers/base_helper.rb +26 -0
data/yard-cucumber.gemspec +65 -0
metadata +199 -0

data/lib/docserver/default/layout/html/headers.erb ADDED

@@ -0,0 +1,14 @@
+<meta name="Content-Type" content="text/html; charset=UTF-8" />
+<title><%= @page_title %></title>
+<link rel="stylesheet" href="/css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="/css/custom.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="/css/common.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="/css/cucumber.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/autocomplete.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/app.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/live.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/cucumber.js"></script>
+<script type="text/javascript" charset="utf-8">
+  library = '<%= base_path(router.list_prefix) %>';
+</script>

data/lib/docserver/doc_server/full_list/html/full_list.erb ADDED

@@ -0,0 +1,39 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta name="Content-Type" content="text/html; charset=<%= charset %>" />
+    <link rel="stylesheet" href="/css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+    <link rel="stylesheet" href="/css/common.css" type="text/css" media="screen" charset="utf-8" />
+    <link rel="stylesheet" href="/css/cucumber.css" type="text/css" media="screen" charset="utf-8" />
+    <script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
+    <script type="text/javascript" charset="utf-8" src="/js/full_list.js"></script>
+    <script type="text/javascript" charset="utf-8" src="/js/cucumber.js"></script>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames';
+      }
+    </script>
+    <div id="content">
+      <h1 id="full_list_header"><%= @list_title %></h1>
+      <div id="nav">
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/features">Features</a> |
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/tags">Tags</a> |
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/class">Classes</a> |
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/methods">Methods</a> |
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/files">Files</a>
+      </div>
+      <div id="search">Search: <input type="text" /></div>
+      <ul id="full_list" class="<%= @list_class || @list_type %>">
+        <%= erb "full_list_#{@list_type}" %>
+      </ul>
+    </div>
+  </body>
+</html>

data/lib/docserver/doc_server/full_list/html/setup.rb ADDED

@@ -0,0 +1,18 @@
+include T('default/fulldoc/html')
+def init
+  # This is the css class type; here we just default to class
+  @list_class = "class"
+  case @list_type.to_sym
+  when :features; @list_title = "Features"
+  when :tags; @list_title = "Tags"
+  when :class; @list_title = "Class List"
+  when :methods; @list_title = "Method List"
+  when :files; @list_title = "File List"
+  end
+  sections :full_list
+end
+def all_features_link
+  linkify YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE, "All Features"
+end

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

@@ -0,0 +1,39 @@
+<script type="text/javascript" charset="utf-8">
+$(function() {
+  $(".developer").hide();
+  $(".scenario .title").css('cursor','pointer');
+});
+</script>
+<div class="feature">
+  <div class="title">
+    <a id="view" class="control" href="#">[More Detail]</a>
+    <a id="expand" class="control" href="#">[Collapse All]</a>
+    <div style="clear: right;"></div>
+    <span class="pre"><%= @feature.keyword %>:</span>
+    <span class="name"><%= @feature.value %></span>
+  </div>
+  <% if @feature.comments.length > 0 %>
+  <div class="comments developer">
+    <%= htmlify_with_newlines @feature.comments %>
+  </div>
+  <% end %>
+  <div class="description">
+    <%= htmlify_with_newlines @feature.description %>
+  </div>
+  <div class="meta">
+    <div class="file developer"><%= h(@feature.file) %></div>
+    <div style="clear: right;"></div>
+    <div class="tags developer">
+      <% @feature.tags.each do |tag| %>
+      <a href="<%= url_for tag %>"><%= tag.value %></a>
+      <% end %>
+    </div>
+  </div>
+  <%= yieldall %>
+</div>

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

	@@ -0,0 +1 @@
1	+ <div class="none">No Steps Defined</div>

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

@@ -0,0 +1,56 @@
+<% sc = 0 %>
+<% @scenario.examples.each_with_index do |example, example_index| %>
+  <% example.data.each_with_index do |row, row_index| %>
+    <div style="display: none;" class="steps <%= "example#{example_index + 1}-#{row_index +1}" %>">
+      <% scenario = @scenario.scenarios[sc] %>
+      <% @scenario_outline = @scenario ; @scenario = scenario ; @steps = scenario.steps %>
+      <%= erb(:steps) %>
+      <% @scenario = @scenario_outline %>
+      <% sc += 1 %>
+    </div>
+  <% end %>
+<% end %>
+<div class="outline">
+  <% if @scenario.examples? %>
+    <% @scenario.examples.each_with_index do |example,example_index| %>
+      <div class="keyword">
+        <%= h example.keyword %><%= example.name != "" ? ':' : '' %>
+      </div>
+      <div class="example-group-name"><%= h example.name %></div>
+      <br style="clear: both;"/>
+      <table>
+        <thead>
+          <tr>
+            <% example.headers.each_with_index do |header,header_index| %>
+              <th><%= h(header) %></th>
+            <% end %>
+          </tr>
+        </thead>
+        <% unless example.data.empty? %>
+          <% example.data.each_with_index do |row,row_index| %>
+          <tr class="<%= (row_index + 1) % 2 == 0 ? "even example#{example_index+1}-#{row_index +1}" : "odd example#{example_index+1}-#{row_index +1}" %>">
+            <% row.each_with_index do |column,column_index| %>
+              <td><%= h(column.to_s.strip) %></td>
+            <% end %>
+          </tr>
+          <% end %>
+        <% else %>
+          <!-- Scenario Outline example table is empty -->
+          <tr class="odd">
+            <td colspan="<%= example.headers.length %>" style="text-align: center;">
+              No Examples Defined
+            </td>
+          </tr>
+        <% end %>
+      </table>
+    <% end  %>
+  <% else %>
+  <div class="keyword">No Example Table Defined</div>
+  <div class="keyword suggestion developer">[!] Did you mean to create a Scenario?</div>
+  <% end %>
+</div>

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

@@ -0,0 +1,3 @@
+<div class="text">
+  <%= htmlify_with_newlines @step.text %>
+</div>

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

@@ -0,0 +1,55 @@
+<div class="scenario <%= @id %>">
+  <a name="<%= @id %>" />
+  <div class="title">
+    <div style="float: left;">
+      <a class="toggle"> - </a>
+      <span class="pre"><%= @scenario.keyword %>:</span>
+      <span class="name"><%= h @scenario.value %></span>
+    </div>
+    <a class="link" style="float:right; clear:right;" href="<%= url_for(@scenario.feature, @id) %>">link</a>
+  </div>
+  <% if @scenario.description.length > 0 %>
+  <div class="description">
+    <%= htmlify_with_newlines @scenario.description %>
+  </div>
+  <% end %>
+  <% if @scenario.comments.length > 0 %>
+  <div class="comments developer">
+    <%= htmlify_with_newlines @scenario.comments %>
+  </div>
+  <% end %>
+  <div class="details">
+    <div class="meta developer">
+      <div class="file"><%= @scenario.location %></div>
+      <% unless @scenario.tags.empty? %>
+        <div style="clear:right;"></div>
+        <div class="tags">
+          <% @scenario.tags.each do |tag| %>
+            <a href="<%= url_for tag %>"><%= tag.value %></a>
+          <% end %>
+        </div>
+      <% end%>
+      <div style="clear: both;"></div>
+    </div>
+    <div class="steps">
+      <% if @scenario.steps.empty?  %>
+        <%= erb(:no_steps_defined) %>
+      <% else %>
+        <%= @steps = @scenario.steps ; erb(:steps) %>
+      <% end %>
+    </div>
+    <%= erb(:outline) if @scenario.outline? %>
+  </div>
+  <div class="attributes" style="display:none;">
+    <input type="hidden" name="collapsed" value="false">
+  </div>
+</div>

data/lib/templates/default/feature/html/setup.rb ADDED

@@ -0,0 +1,55 @@
+def init
+  super
+  @feature = object
+  sections.push :feature
+  sections.push :scenarios if object.scenarios
+end
+def background
+  @scenario = @feature.background
+  @id = "background"
+  erb(:scenario)
+end
+def scenarios
+  scenarios = ""
+  if @feature.background
+    @scenario = @feature.background
+    @id = "background"
+    scenarios += erb(:scenario)
+  end
+  @feature.scenarios.each_with_index do |scenario,index|
+    @scenario = scenario
+    @id = "scenario_#{index}"
+    scenarios += erb(:scenario)
+  end
+  scenarios
+end
+def highlight_matches(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
+        value[matches.begin((matches.size - 1) - index)..(matches.end((matches.size - 1) - index) - 1)] = "<span class='match'>#{h(match)}</span>"
+      end
+    end
+  end
+  value
+end
+def htmlify_with_newlines(text)
+  text.split("\n").collect {|c| h(c).gsub(/\s/,'&nbsp;') }.join("<br/>")
+end

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

@@ -0,0 +1,39 @@
+<% @steps.each_with_index do |step,index| %>
+  <% @step = step %>
+  <% if step.comments && step.comments.length > 0 %>
+  <div class="comments developer"><%= htmlify_with_newlines step.comments %></div>
+  <% end %>
+  <div class="step <%= (index + 1) % 2 == 0 ? 'even' : 'odd' %>">
+    <span class="predicate"><%= step.keyword %></span>
+    <% if @scenario.outline? %>
+      <%= h step.value %>
+    <% else %>
+      <% if step.definition %>
+        <span class="defined">
+          <%=  highlight_matches(step) %>
+          <div class="definition developer">
+            <a href="<%= url_for step.definition %>"><div class="valid">&nbsp;</div></a>
+          </div>
+        </span>
+      <% else %>
+        <span class="undefined">
+          <%= h step.value %>
+          <div class="definition developer">
+            <a href="<%= url_for YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE %>#undefined_steps">
+              <div class="invalid">&nbsp;</div>
+            </a>
+          </div>
+        </span>
+      <% end %>
+    <% end %>
+  </div>
+  <%= erb(:table) if step.has_table? %>
+  <%= erb(:pystring) if step.has_text? %>
+<% end %>

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

@@ -0,0 +1,20 @@
+<div class="multiline">
+  <table style="">
+    <thead>
+      <tr>
+        <% @step.table.first.each_with_index do |column,column_index| %>
+          <th class="<%= (column_index + 1) % 2 == 0 ? 'even' : 'odd' %>"><%= h(column.strip) %></th>
+        <% end %>
+      </tr>
+    </thead>
+    <% @step.table[1..-1].each_with_index do |row,row_index| %>
+      <tr class="<%= (row_index + 1) % 2 == 0 ? 'even' : 'odd' %>">
+        <% row.each_with_index do |column,column_index| %>
+          <td><%= h(column.strip) %></td>
+        <% end %>
+      </tr>
+    <% end %>
+  </table>
+</div>

data/lib/templates/default/featuredirectory/html/alpha_table.erb ADDED

@@ -0,0 +1,30 @@
+<% 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 %>
+                  <% if obj.is_a? YARD::CodeObjects::Cucumber::FeatureDirectory %>
+                    <small>(<%= obj.expanded_path %>)</small>
+                  <% else %>
+                    <small>(<%= obj.file %>)</small>
+                  <% end %>
+                </li>
+              <% end %>
+            </ul>
+          </ul>
+        <% end %>
+      </td>
+    </tr>
+  </table>
+<% end %>

data/lib/templates/default/featuredirectory/html/directory.erb ADDED

@@ -0,0 +1,32 @@
+<% if @directory %>
+<div class="requirements">
+  <div class="title">
+    <span class="pre">Directory:</span>
+    <span class="name"><%= h @directory.name.to_s.capitalize %></span>
+  </div>
+  <div class="readme">
+    <%= markdown @directory.description %>
+  </div>
+  <% if features && !features.empty? %>
+    <%= alpha_table(features) %>
+  <% end %>
+  <div id="directory">
+    <div class="title"><span class="name">Tags</span></div>
+  </div>
+  <div class="tags">
+    <%= tags.collect {|tag| linkify(tag,tag.value) }.join(",\n") %>
+  </div>
+  <% if directories && !directories.empty? %>
+  <div id="directory">
+    <div class="title"><span class="name">Subdirectories</span></div>
+  </div>
+  <%= alpha_table(directories) %>
+  <% end %>
+</div>
+<% end %>

data/lib/templates/default/featuredirectory/html/setup.rb ADDED

@@ -0,0 +1,41 @@
+def init
+  super
+  sections.push :directory
+  @directory = object
+end
+def markdown(text)
+  htmlify(text,:markdown) rescue h(text)
+end
+def htmlify_with_newlines(text)
+  text.split("\n").collect {|c| h(c).gsub(/\s/,'&nbsp;') }.join("<br/>")
+end
+def directories
+  @directories ||= @directory.subdirectories
+end
+def features
+  @features ||= @directory.features + directories.collect {|d| d.features }.flatten
+end
+def scenarios
+  @scenarios ||= features.collect {|feature| feature.scenarios }.flatten
+end
+def tags
+  @tags ||= (features.collect{|feature| feature.tags } + scenarios.collect {|scenario| scenario.tags }).flatten.uniq.sort_by {|l| l.value.to_s }
+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