yard-cucumber 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0307aff56f1f409371e475250339911845443a61
-  data.tar.gz: 7be6505ef893717f5e939e1cf74500f4de6feac1
+  metadata.gz: b47e4ea0d0d5419c1ec4e655f0abd9c753ce3a9a
+  data.tar.gz: 520193860d1a8ad24df4cb19c860c812cd34d9cc
 SHA512:
-  metadata.gz: 15be5b802d0f5688eae9d662fccc2aa26b09d645ddacff62af317018e68e4bac8d3d1421664b0563ba12a3ba1d4a47fec8317d3cc2544ccea6247bf3359bcdf0
-  data.tar.gz: 99dccdb8a0542f293c58810070c5574bd6e8b924c2db00539e285f36c1d4ee02eefb4a54cc5154f605797cfda748acbf64f32e98e65783b6983c5546f45df20b
+  metadata.gz: a469a5f7efbea7ed3f0c042e26da076d9de5262926675809d2f91d60b1e04150e053bbfc3048b83e88b54a7c1d2e13d3e4d347321273219082659c15228ea26c
+  data.tar.gz: f151570da2884259715c99c4dfa7b71b90d13e304191b059ab7d54c221d8c642d2264018f26d9f9d67e6020b6f0e6a62505ca0a981aa184e35855b606b597135

data/.ruby-gemset

@@ -0,0 +1 @@
+yard-cucumber

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
 gem 'redcarpet'
-gem 'gherkin', '~> 3'
+gem 'gherkin', '~> 4.0'
 
-gemspec
+gemspec

data/Gemfile.lock

@@ -3,37 +3,40 @@ PATH
   specs:
     yard-cucumber (3.0.0)
       cucumber (~> 2)
-      gherkin (~> 3)
+      gherkin (~> 4.0)
       yard (~> 0.8, >= 0.8.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     builder (3.2.2)
-    cucumber (2.3.2)
+    cucumber (2.4.0)
       builder (>= 2.1.2)
-      cucumber-core (~> 1.4.0)
+      cucumber-core (~> 1.5.0)
       cucumber-wire (~> 0.0.1)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 3.2.0)
+      gherkin (~> 4.0)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.1.2)
-    cucumber-core (1.4.0)
-      gherkin (~> 3.2.0)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
     cucumber-wire (0.0.1)
     diff-lcs (1.2.5)
-    gherkin (3.2.0)
-    multi_json (1.11.2)
+    gherkin (4.0.0)
+    multi_json (1.12.1)
     multi_test (0.1.2)
     rake (10.4.2)
     redcarpet (2.2.2)
-    yard (0.8.7.6)
+    yard (0.9.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  gherkin (~> 3)
+  gherkin (~> 4.0)
   rake (~> 10)
   redcarpet
   yard-cucumber!
+
+BUNDLED WITH
+   1.12.4

data/History.txt

@@ -1,8 +1,7 @@
-=== 3.0.0/ 2016-03-14
+=== 3.1.0/ 2016-12-06
 
-Happy PI day!
-
-* Cucumber 2 and Gherkin 3 support (idstein)
+* Updates to Gherkin 4.0 and Cucumber 2.4.0
+* Fixes issues with the formatting that comes from these changes
 
 === 2.3.2/ 2013-11-08
 

data/README.md

@@ -125,6 +125,16 @@ English step definitions. Even without specifying this feature files in other
 languages are found, this provides the ability for the step definitions to match
 correctly to step definitions.
 
+* Exclude features or scenarios from yardoc
+
+You can exclude any feature or scenario from the yardoc by adding a predefined tags to them.
+To define tags that will be excluded, again in yard configuration file:
+
+```yaml
+:"yard-cucumber":
+  exclude_tags: [ 'exclude-yardoc', 'also-exclude-yardoc' ]
+```
+
 ## Details
 
 There are two things that I enjoy: a test framework written in my own Domain
@@ -185,4 +195,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/cucumber/city_builder.rb

@@ -87,12 +87,15 @@ module Cucumber
       # This is once, as the gherking parser does not like multiple feature per
       # file.
       #
-      def feature(feature)
+      def feature(document)
         #log.debug "FEATURE"
+        feature = document[:feature]
+        return unless document[:feature]
+        return if has_exclude_tags?(feature[:tags].map { |t| t[:name].gsub(/^@/, '') })
 
         @feature = YARD::CodeObjects::Cucumber::Feature.new(@namespace,File.basename(@file.gsub('.feature','').gsub('.','_'))) do |f|
           f.comments = feature[:comments] ? feature[:comments].map{|comment| comment[:text]}.join("\n") : ''
-          f.description = ''#feature.description
+          f.description = feature[:description] || ''
           f.add_file(@file,feature[:location][:line])
           f.keyword = feature[:keyword]
           f.value = feature[:name]
@@ -100,8 +103,10 @@ module Cucumber
 
           feature[:tags].each {|feature_tag| find_or_create_tag(feature_tag[:name],f) }
         end
-        feature[:scenarioDefinitions].each { |s|
+        feature[:children].each { |s|
           case s[:type]
+            when :Background
+              background(s)
             when :ScenarioOutline
               scenario_outline(s)
             when :Scenario
@@ -113,21 +118,24 @@ module Cucumber
       #
       # Called when a background has been found
       #
-      # @see #scenario
+      # @see #feature
       def background(background)
         #log.debug "BACKGROUND"
 
         @background = YARD::CodeObjects::Cucumber::Scenario.new(@feature,"background") do |b|
-          b.comments = background.comments.map{|comment| comment.value}.join("\n")
-          b.description = background.description
-          b.keyword = background.keyword
-          b.value = background.name
-          b.add_file(@file,background.line)
+          b.comments = background[:comments] ? background[:comments].map{|comment| comment.value}.join("\n") : ''
+          b.description = background[:description] || ''
+          b.keyword = background[:keyword]
+          b.value = background[:name]
+          b.add_file(@file,background[:location][:line])
         end
 
         @feature.background = @background
         @background.feature = @feature
         @step_container = @background
+        background[:steps].each { |s|
+          step(s)
+        }
       end
 
       #
@@ -146,9 +154,11 @@ module Cucumber
       def scenario(statement)
         #log.debug "SCENARIO"
 
+        return if has_exclude_tags?(statement[:tags].map { |t| t[:name].gsub(/^@/, '') })
+
         scenario = YARD::CodeObjects::Cucumber::Scenario.new(@feature,"scenario_#{@feature.scenarios.length + 1}") do |s|
           s.comments = statement[:comments] ? statement[:comments].map{|comment| comment.value}.join("\n") : ''
-          s.description = ''#statement.description
+          s.description = statement[:description] || ''
           s.add_file(@file,statement[:location][:line])
           s.keyword = statement[:keyword]
           s.value = statement[:name]
@@ -174,9 +184,11 @@ module Cucumber
       def scenario_outline(statement)
         #log.debug "SCENARIO OUTLINE"
 
+        return if has_exclude_tags?(statement[:tags].map { |t| t[:name].gsub(/^@/, '') })
+
         outline = YARD::CodeObjects::Cucumber::ScenarioOutline.new(@feature,"scenario_#{@feature.scenarios.length + 1}") do |s|
           s.comments = statement[:comments] ? statement[:comments].map{|comment| comment.value}.join("\n") : ''
-          s.description = ''#statement.description
+          s.description = statement[:description] || ''
           s.add_file(@file,statement[:location][:line])
           s.keyword = statement[:keyword]
           s.value = statement[:name]
@@ -340,6 +352,12 @@ module Cucumber
         base.map {|row| row.map {|cell| cell.dup }}
       end
 
+      def has_exclude_tags?(tags)
+        if YARD::Config.options["yard-cucumber"] and YARD::Config.options["yard-cucumber"]["exclude_tags"]
+          return true unless (YARD::Config.options["yard-cucumber"]["exclude_tags"] & tags).empty?
+        end
+      end
+
     end
   end
 end

data/lib/templates/default/fulldoc/html/css/cucumber.css

@@ -81,7 +81,6 @@
 * ul.alpha ul { padding-left: 15px; }
 * ul small { color: #666; font-size: 0.7em; }
 
-
 .scenario .steps {
     margin: 0px 20px 0px 30px;
     font-size: 12px;
@@ -115,7 +114,7 @@ div.undefined { padding: 6px; }
 .step .defined .match { color: #346F97; }
 
 .multiline, .text { margin-top: 10px; margin-left: 20px; }
-.text { 
+.text {
     padding: 20px;
     background-color: #F8F8FF;
     color: #444444;
@@ -187,18 +186,18 @@ div.undefined { padding: 6px; }
     border: 1px solid #DEDEDE; -moz-border-radius: 3px; -webkit-border-radius: 3px;
 }
 
-#command_example { 
-    margin-top: 10px; 
-    margin-left: 0px; 
+#command_example {
+    margin-top: 10px;
+    margin-left: 0px;
     font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
     color: #333;
-    padding: 8px 10px; 
+    padding: 8px 10px;
     background: #A8E795; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
 }
 
 
-#cukes_links { 
-    margin: 10px auto 10px auto; 
+#cukes_links {
+    margin: 10px auto 10px auto;
     border-bottom: 1px solid #E3E3E3;
     width: 762px; text-align: center;
     padding: 10px;
@@ -224,4 +223,4 @@ div.undefined { padding: 6px; }
     width: 15px;
     height: 15px;
     background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAIAAAC0tAIdAAAACXBIWXMAAA86AAAPOgGXOdvCAAABWUlEQVQoFS2SvVEEMQyFJdkspFcCVAAVUREZXVAHHRAwZOQwQ3YM67X4nnwe3+3afn+S18/P9366s5yZ042R6c3c3bRKDw+WwZxf791Pt/3hMcev5QBpFtauPLoBYrYr6zcem/Xr8frUbc4c59zPPoekQeSesTm47IaD74kfTjnDbNqxC5pTzrJfQcCFBQClIh7bIdDc9S+6E8WIQXTl9somfA1S4iJVbUnJmyOhJT+51AMRkXVArMtBdUNLGcpmaReDdSIGHw4m2iyNIiMslTWqBvMuZSVZB4QhMRRp6IUjzYuPctvq3TpWumq2sIfNw/KQ3DwomfIv6aVBT+ZQMFKxhB8uLfhlzkO3Sstlwh1ja3+oEKVuqipGHhMztEGvvlZEQHwyMKPD1NDtrrpBR3jbalv90hWzo05FBr1vlKGXtvGF9fz5HG8vFRpK1a5yV0/KVuZSzO+Pf3G6tVs/+L00AAAAAElFTkSuQmCC) no-repeat center;
-}
+}

data/lib/templates/default/fulldoc/html/directories.erb

@@ -1,53 +1,27 @@
-<% n = 1 %>
-
-
+<% @row = @row == 'even' ? 'odd' : 'even' %>
 <% if @directory.children %>
 <ul>
   <% @directory.children.sort {|x,y| x.value.to_s <=> y.value.to_s }.each_with_index do |child,index| %>
-  <% if child.is_a?(YARD::CodeObjects::Cucumber::Feature) %>
-    <li class="r<%= n %>">
-      <%= linkify child, child.value %>
-  <!--
-      <span class='object_link'>
-         <a href="<%= url_for(child,"scenario_#{index}") %>"
-             title="<%= h child.value %>">
-           <%= h child.value %>
-         </a>
-       </span>
-   -->
-       <small><%= child.location %></small>
-    </li>
-  <% end %>
-  <% if child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory) %>
-    <li class="r<%= n %>">
-      <%= "<a class='toggle'></a>" unless child.features.empty? && child.subdirectories.empty? %>
-      <%= linkify child, child.value.to_s.capitalize  %>
-      <small><%= child.location %></small>
-    </li>
-    <%= directory_node child %>
-  <% end %>
-        <% n = n == 2 ? 1 : 2 %>
-  <% end %>
-</ul>
-<% end %>
+    <% if child.is_a?(YARD::CodeObjects::Cucumber::Feature) %>
+      <li class="<%= @row %>">
+        <div class="item" style="padding-left: <%= @padding %>px">
+          <%= linkify child, child.value %>
+          <small><%= child.location %></small>
+        </div>
+      </li>
+      <% @row = @row == 'even' ? 'odd' : 'even' %>
+    <% end %>
 
-<!--  YARD::CodeObjects::Cucumber::FeatureDirectory -->
-  
-<!-- 
-<% if @directory.subdirectories %>
-<ul>
-  <% @directory.subdirectories.each_with_index do |subdir,index| %>
-  <li class="r<%= n %>">
-    <span class='object_link'>
-       <a href="<%= url_for(subdir,"scenario_#{index}") %>"
-           title="<%= h subdir.value %>">
-         <%= h subdir.value %>
-       </a>
-     </span>
-     <small><%= subdir.location %></small>
-  </li>
-        <% n = n == 2 ? 1 : 2 %>
+    <% if child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory) %>
+      <li class="<%= @row %>">
+        <div class="item" style="padding-left: <%= @padding %>px">
+          <%= "<a class='toggle'></a>" unless child.features.empty? && child.subdirectories.empty? %>
+          <%= linkify child, child.value.to_s.capitalize  %>
+          <small><%= child.location %></small>
+        </div>
+        <%= directory_node child, @padding + 15, @row %>
+      </li>
+    <% end %>
   <% end %>
 </ul>
 <% end %>
- -->

data/lib/templates/default/fulldoc/html/full_list_featuredirectories.erb

@@ -1,11 +1,11 @@
-<% n = 1 %>
-<% n = n == 2 ? 1 : 2 %>
+<% n = 'odd' %>
 <% @items.each do |directory| %>
-<li class="r<%= n %>">
-  <%= "<a class='toggle'></a>" unless directory.features.empty? && directory.subdirectories.empty? %>
-  <%= linkify directory, directory.value %>
-  <small><%= directory.location %></small>
+<li class="<%= n %>">
+  <div class="item" style="padding-left: 30px">
+    <%= "<a class='toggle'></a>" unless directory.features.empty? && directory.subdirectories.empty? %>
+    <%= linkify directory, directory.value %>
+    <small><%= directory.location %></small>
+  </div>
+  <%= directory_node directory, 45, n %>
 </li>
-<% n = n == 2 ? 1 : 2 %>
-<%= directory_node directory %>
 <% end %>

data/lib/templates/default/fulldoc/html/full_list_features.erb

@@ -1,29 +1,37 @@
-<% n = 1 %>
-<li class="r<%= n %>">
-  <%= all_features_link %>
+<% n = 'odd' %>
+<li class="<%= n %>">
+  <div class="item" style="padding-left: 30px">
+    <%= all_features_link %>
+  </div>
 </li>
-<% n = n == 2 ? 1 : 2 %>
+<% n = n == 'odd' ? 'even' : 'odd' %>
 <% @items.each do |feature| %>
-<li class="r<%= n %>">
-  <%= "<a class='toggle'></a>" unless feature.scenarios.empty? %>
-  <%= linkify feature, feature.value %>
-  <small><%= feature.location %></small>
-</li>
-<% n = n == 2 ? 1 : 2 %>
-<% if feature.scenarios %>
-<ul>
-  <% feature.scenarios.each_with_index do |scenario,index| %>
-  <li class="r<%= n %>">
-    <span class='object_link'>
-       <a href="<%= url_for(scenario.feature,"scenario_#{index}") %>"
-           title="<%= h scenario.value %>">
-         <%= h scenario.value %>
-       </a>
-     </span>
-     <small><%= scenario.location %></small>
-  </li>
-        <% n = n == 2 ? 1 : 2 %>
+<li class="<%= n %>">
+  <div class="item" style="padding-left: 30px">
+    <%= "<a class='toggle'></a>" unless feature.scenarios.empty? %>
+    <%= linkify feature, feature.value %>
+    <small><%= feature.location %></small>
+  </div>
+
+  <% n = n == 'odd' ? 'even' : 'odd' %>
+  <% if feature.scenarios %>
+  <ul>
+    <% feature.scenarios.each_with_index do |scenario,index| %>
+    <li class="<%= n %>">
+      <div class="item" style="padding-left: 45px">
+        <span class='object_link'>
+           <a href="<%= url_for(scenario.feature,"scenario_#{index}") %>"
+               title="<%= h scenario.value %>">
+             <%= h scenario.value %>
+           </a>
+         </span>
+         <small><%= scenario.location %></small>
+       </div>
+    </li>
+    <% n = n == 'odd' ? 'even' : 'odd' %>
+    <% end %>
+  </ul>
   <% end %>
-</ul>
+
+</li>
 <% end %>
-<% end %>

data/lib/templates/default/fulldoc/html/full_list_stepdefinitions.erb

@@ -1,16 +1,20 @@
 <li>
-  <%= linkify YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE, "All Step Definitions" %>
+  <div class="item" style="padding-left: 30px">
+    <%= linkify YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE, "All Step Definitions" %>
+  </div>
 </li>
-<% n = 1 %>
+<% n = 'odd' %>
 <% @items.each do |stepdef| %>
-  <li class="r<%= n %>">
-  <span class='object_link'>
-    <span class="pre"><%= stepdef.keyword %></span>
-      <a href="<%= url_for stepdef %>" title="<%= h stepdef.value %>">
-        <span class="name"><%= h stepdef.literal_value %></span>
-      </a>&nbsp;&nbsp;
-  </span>
-  <small><%= h(stepdef.location) %></small>
+  <li class="<%= n %>">
+    <div class="item" style="padding-left: 30px">
+      <span class='object_link'>
+        <span class="pre"><%= stepdef.keyword %></span>
+          <a href="<%= url_for stepdef %>" title="<%= h stepdef.value %>">
+            <span class="name"><%= h stepdef.literal_value %></span>
+          </a>&nbsp;&nbsp;
+      </span>
+      <small><%= h(stepdef.location) %></small>
+    </div>
   </li>
-  <% n = n == 2 ? 1 : 2 %>
-<% end %>
+  <% n = n == 'even' ? 'odd' : 'even' %>
+<% end %>

data/lib/templates/default/fulldoc/html/full_list_steps.erb

@@ -1,17 +1,20 @@
-<li>
-  <%= linkify YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE, "All Defined Steps" %>
+<li class='odd'>
+  <div class="item" style="padding-left: 30px">
+    <%= linkify YARD::CodeObjects::Cucumber::CUCUMBER_STEPTRANSFORM_NAMESPACE, "All Defined Steps" %>
+  </div>
 </li>
-<% n = 1 %>
-
+<% n = 'even' %>
 <% @items.each do |step| %>
-  <li class="r<%= n %>">
-	<span class='object_link'>
-		<a href="<%= url_for step.scenario.feature %>" title="<%= h step.value %>">
-			<span class="pre"><%= step.keyword %></span>
-			<span class="name"><%= h(step.value) %></span>
-		</a>
-	</span>
-	<span class="">(<%= h(step.file) %>)<span>
+  <li class="<%= n %>">
+    <div class="item" style="padding-left: 30px">
+      <span class='object_link'>
+        <a href="<%= url_for step.scenario.feature %>" title="<%= h step.value %>">
+          <span class="pre"><%= step.keyword %></span>
+          <span class="name"><%= h(step.value) %></span>
+        </a>
+      </span>
+      <span class="">(<%= h(step.file) %>)<span>
+    </div>
   </li>
-  <% n = n == 2 ? 1 : 2 %>
-<% end %>
+  <% n = n == 'even' ? 'odd' : 'even' %>
+<% end %>

data/lib/templates/default/fulldoc/html/full_list_tags.erb

@@ -1,12 +1,16 @@
 <li>
-  <%= linkify YARD::CodeObjects::Cucumber::CUCUMBER_TAG_NAMESPACE, "All Tags" %>
+  <div class="item" style="padding-left: 30px;">
+    <%= linkify YARD::CodeObjects::Cucumber::CUCUMBER_TAG_NAMESPACE, "All Tags" %>
+  </div
 </li>
-<% n = 1 %>
 
+<% n = 'odd' %>
 <% @items.each do |tag| %>
-  <li class="r<%= n %>">
-	<%= linkify tag, tag.value %>
-	<small><%= tag.all_scenarios.size %></small>
+  <li class="<%= n %>">
+    <div class="item" style="padding-left: 30px;">
+      <%= linkify tag, tag.value %>
+      <small style="display: inline;"><%= tag.all_scenarios.size %></small>
+    </div>
   </li>
-  <% n = n == 2 ? 1 : 2 %>
-<% end %>
+  <% n = n == 'odd' ? 'even' : 'odd' %>
+<% end %>

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

@@ -111,7 +111,7 @@ end
 # See the layout template method that loads the menus
 def generate_featuredirectories_list
   directories_ordered_by_name = root_feature_directories.sort {|x,y| x.value.to_s <=> y.value.to_s }
-  generate_full_list directories_ordered_by_name, :featuredirectories, 
+  generate_full_list directories_ordered_by_name, :featuredirectories,
     :list_title => "Features by Directory",
     :list_filename => "featuredirectories_list.html"
 end
@@ -143,7 +143,7 @@ end
 # This method removes the namespace from the root node, generates the class list,
 # and then adds it back into the root node.
 #
-def class_list(root = Registry.root)
+def class_list(root = Registry.root, tree = TreeContext.new)
   return super unless root == Registry.root
 
   cucumber_namespace = YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE
@@ -169,7 +169,18 @@ def all_features_link
   end
 end
 
-def directory_node(directory)
+#
+# This method is used to generate a feature directory. This template may call
+# this method as well to generate any child feature directories as well.
+#
+# @param directory [FeatureDirectory] this is the FeatureDirectory to display
+# @param padding [Fixnum] this is the pixel value to ident as we want to keep
+#    pushing in the padding to show the parent relationship
+# @param row [String] 'odd' or 'even' to correctly color the row
+#
+def directory_node(directory,padding,row)
   @directory = directory
+  @padding = padding
+  @row = row
   erb(:directories)
 end

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

@@ -4,49 +4,57 @@ 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" ]
+  current_menu_lists.map {|menu_name| yard_cucumber_menus[menu_name] }.compact + super
+end
 
-  # 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
+#
+# 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-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
+    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_cucumber_menus
   { "features" => { :type => 'feature', :title => 'Features', :search_title => 'Features' },
     "directories" => { :type => 'featuredirectories', :title => 'Features by Directory', :search_title => 'Features by Directory' },
@@ -54,3 +62,70 @@ def yard_cucumber_menus
     "step definitions" => { :type => 'stepdefinition', :title => 'Step Definitions', :search_title => 'Step Defs' },
     "steps" => { :type => 'step', :title => 'Steps', :search_title => 'Steps' } }
 end
+
+#
+# @note 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-Cucumber objects this will default to the class_list.html.
+# which is not what we want for features, tags, etc.
+#
+# 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_cucumber_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.
+#
+# @note 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.
+#
+# @return [Boolean] true if the object's class name is one of the CodeObjects
+#
+def is_yard_cucumber_object?(object)
+  YARD::CodeObjects::Cucumber.constants.any? {|constant| object.class.name == "YARD::CodeObjects::Cucumber::#{constant}" }
+end
+
+#
+# The re-write rules will only change the nav link to a new menu if it is a
+# a Cucumber 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::Cucumber::Feature) && current_menu_lists.include?('features')
+    nav_url.gsub('class_list.html','feature_list.html')
+  elsif object.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory) && current_menu_lists.include?('directories')
+    nav_url.gsub('class_list.html','featuredirectories_list.html')
+  elsif object.is_a?(YARD::CodeObjects::Cucumber::Tag) && current_menu_lists.include?('tags')
+    nav_url.gsub('class_list.html','tag_list.html')
+  elsif object.is_a?(YARD::CodeObjects::Cucumber::Step) && current_menu_lists.include?('steps')
+    nav_url.gsub('class_list.html','step_list.html')
+  elsif object.is_a?(YARD::CodeObjects::Cucumber::StepTransformersObject) && current_menu_lists.include?('step definitions')
+    nav_url.gsub('class_list.html','stepdefinition_list.html')
+  else
+    nav_url
+  end
+end

data/lib/yard-cucumber/version.rb

@@ -1,3 +1,3 @@
 module CucumberInTheYARD
-  VERSION = '3.0.0'
-end
+  VERSION = '3.1.0'
+end

data/yard-cucumber.gemspec

@@ -56,7 +56,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake', '~> 10'
 
-  s.add_dependency 'gherkin', '~> 3'
+  s.add_dependency 'gherkin', '~> 4.0'
   s.add_dependency 'cucumber', '~> 2'
   s.add_dependency 'yard', '~> 0.8', '>= 0.8.1'
 

metadata

@@ -1,75 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: yard-cucumber
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Franklin Webber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: gherkin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.1
 description: "\n    YARD-Cucumber is a YARD extension that processes Cucumber Features,
@@ -84,8 +84,10 @@ extra_rdoc_files:
 - README.md
 - History.txt
 files:
-- ".gitignore"
-- ".rspec"
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - Gemfile.lock
 - History.txt
@@ -178,28 +180,28 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
-  (::) (::) (::)\n\n  Thank you for installing yard-cucumber 3.0.0 / 2016-03-14.\n\n
-  \ Changes:\n    \n  Happy PI day!\n  \n  * Cucumber 2 and Gherkin 3 support (idstein)\n
-  \ \n\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
+  (::) (::) (::)\n\n  Thank you for installing yard-cucumber 3.1.0 / 2016-12-06.\n\n
+  \ Changes:\n    \n  * Updates to Gherkin 4.0 and Cucumber 2.4.0\n  * Fixes issues
+  with the formatting that comes from these changes\n  \n\n(::) (::) (::) (::) (::)
+  (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
 rdoc_options:
-- "--charset=UTF-8"
+- --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Cucumber Features in YARD
 test_files: []
-has_rdoc: