yard-cucumber 3.1.0 → 4.0.0

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

@@ -10,7 +10,7 @@
   <div class="item" style="padding-left: 30px">
     <%= "<a class='toggle'></a>" unless feature.scenarios.empty? %>
     <%= linkify feature, feature.value %>
-    <small><%= feature.location %></small>
+    <small style="display: inline;"><%= feature.total_scenarios %></small>
   </div>
 
   <% n = n == 'odd' ? 'even' : 'odd' %>

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

@@ -9,7 +9,7 @@
   <li class="<%= n %>">
     <div class="item" style="padding-left: 30px;">
       <%= linkify tag, tag.value %>
-      <small style="display: inline;"><%= tag.all_scenarios.size %></small>
+      <small style="display: inline;"><%= tag.total_scenarios %></small>
     </div>
   </li>
   <% n = n == 'odd' ? 'even' : 'odd' %>

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

@@ -277,6 +277,15 @@ function displayQualifyingFeaturesAndScenarios(tags) {
 
 }
 
+function updateScenarioCount() {
+    var count = 0;
+    $(".scenario:visible").each(function(index) {
+        count += parseInt($(this).attr("count"))
+    });
+    count_header = " (" + count + ")";
+    document.getElementById("scenario_count").innerHTML = count_header;
+}
+
 function generateCssSelectorFromTags(tagGroups) {
 
     var tagSelectors = [ "" ];

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

@@ -73,7 +73,6 @@ def serialize_feature_directories_recursively(namespaces)
   end
 end
 
-
 # Generate feature list
 # @note this method is called automatically by YARD based on the menus defined in the layout
 def generate_feature_list
@@ -82,11 +81,32 @@ def generate_feature_list
   generate_full_list features_ordered_by_name, :features
 end
 
+# Count scenarios for features
+def record_feature_scenarios(features)
+  count_with_examples = 0
+  features.each do |f|
+    count_with_examples += f.total_scenarios
+  end
+  return count_with_examples
+end
+
+# Count scenarios for tags
+def record_tagged_scenarios(tags)
+  scenario_count = 0
+  count_with_examples = 0
+  tags.each do |t|
+    scenario_count += t.all_scenarios.size
+    count_with_examples += t.total_scenarios
+  end
+end
+
 # Generate tag list
 # @note this method is called automatically by YARD based on the menus defined in the layout
 def generate_tag_list
   tags = Registry.all(:tag)
-  tags_ordered_by_use = Array(tags).sort {|x,y| y.all_scenarios.size <=> x.all_scenarios.size }
+  tags_ordered_by_use = Array(tags).sort {|x,y| y.total_scenarios <=> x.total_scenarios }
+
+  record_tagged_scenarios(tags)
 
   generate_full_list tags_ordered_by_use, :tags
 end
@@ -162,10 +182,12 @@ end
 # When there are is just one feature directory then we want to link to that directory
 #
 def all_features_link
+  features = Registry.all(:feature)
+  count_with_examples = record_feature_scenarios(features)
   if root_feature_directories.length == 0 || root_feature_directories.length > 1
-    linkify YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE, "All Features"
+    linkify YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE, "All Features (#{count_with_examples})"
   else
-    linkify root_feature_directories.first, "All Features"
+    linkify root_feature_directories.first, "All Features (#{count_with_examples})"
   end
 end
 

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

@@ -14,7 +14,8 @@
               <% 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]}") %>">
+                    <% index = obj.path[(/.+_(\d+)$/),1].to_i - 1 %>
+                    <a href="<%= url_for(obj.feature,"scenario_#{index}") %>">
                  		  <%= h obj.value %>
                  		</a>
                   <% else %>

data/lib/yard-cucumber.rb

@@ -25,6 +25,7 @@ require File.dirname(__FILE__) + "/yard/handlers/cucumber/feature_handler.rb"
 if RUBY19
   require File.dirname(__FILE__) + "/yard/handlers/step_definition_handler.rb"
   require File.dirname(__FILE__) + "/yard/handlers/step_transform_handler.rb"
+  require File.dirname(__FILE__) + "/yard/handlers/constant_transform_handler.rb"
 end
 
 require File.dirname(__FILE__) + "/yard/handlers/legacy/step_definition_handler.rb"

data/lib/yard-cucumber/version.rb

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

data/lib/yard/code_objects/cucumber/base.rb

@@ -1,6 +1,4 @@
-
 module YARD::CodeObjects::Cucumber
-
   module LocationHelper
 
     def line_number
@@ -14,19 +12,13 @@ module YARD::CodeObjects::Cucumber
     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/cucumber/feature.rb

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

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

@@ -1,49 +1,55 @@
-
-module YARD::CodeObjects::Cucumber
-  
-  class NamespaceObject < YARD::CodeObjects::NamespaceObject
-    include LocationHelper
-    def value ; nil ; end
-  end
-
-  class Requirements < 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
-
-  CUCUMBER_NAMESPACE = Requirements.new(:root, "requirements") unless defined?(CUCUMBER_NAMESPACE)
-  
-  CUCUMBER_TAG_NAMESPACE = FeatureTags.new(CUCUMBER_NAMESPACE, "tags") unless defined?(CUCUMBER_TAG_NAMESPACE)
-  
-  CUCUMBER_STEPTRANSFORM_NAMESPACE = StepTransformersObject.new(CUCUMBER_NAMESPACE, "step_transformers") unless defined?(CUCUMBER_STEPTRANSFORM_NAMESPACE)
-  
-end
+module YARD::CodeObjects::Cucumber
+  class NamespaceObject < YARD::CodeObjects::NamespaceObject
+    include LocationHelper
+
+    def value;
+      nil;
+    end
+  end
+
+  class Requirements < 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
+
+  CUCUMBER_NAMESPACE = Requirements.new(:root, "requirements") unless defined?(CUCUMBER_NAMESPACE)
+
+  CUCUMBER_TAG_NAMESPACE = FeatureTags.new(CUCUMBER_NAMESPACE, "tags") unless defined?(CUCUMBER_TAG_NAMESPACE)
+
+  CUCUMBER_STEPTRANSFORM_NAMESPACE = StepTransformersObject.new(CUCUMBER_NAMESPACE, "step_transformers") unless defined?(CUCUMBER_STEPTRANSFORM_NAMESPACE)
+
+end

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

@@ -1,26 +1,22 @@
-
-
 module YARD::CodeObjects::Cucumber
 
   class Scenario < NamespaceObject
-        
+
     attr_accessor :value, :comments, :keyword, :description, :steps, :tags, :feature
-    
-    def initialize(namespace,name)
-      super(namespace,name.to_s.strip)
+
+    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

data/lib/yard/code_objects/cucumber/scenario_outline.rb

@@ -1,14 +1,11 @@
-
-
 module YARD::CodeObjects::Cucumber
-
   class ScenarioOutline < NamespaceObject
 
     attr_accessor :value, :comments, :keyword, :description, :steps, :tags, :feature
     attr_accessor :scenarios, :examples
 
-    def initialize(namespace,name)
-      super(namespace,name.to_s.strip)
+    def initialize(namespace, name)
+      super(namespace, name.to_s.strip)
       @comments = @description = @value = @feature = nil
       @steps = []
       @tags = []
@@ -23,53 +20,49 @@ module YARD::CodeObjects::Cucumber
     def outline?
       true
     end
-    
+
     def examples?
-      @examples.find {|example| example.rows }
+      @examples.find { |example| example.rows }
     end
-    
-    
+
     class Examples
-      
-      attr_accessor :name, :line, :keyword, :comments, :rows
-      
+
+      attr_accessor :name, :line, :keyword, :comments, :rows, :tags, :scenario
+
       # The first row of the rows contains the headers for the table
       def headers
         rows.first
       end
-      
+
       # The data of the table starts at the second row. When there is no data then
       # return a empty string.
       def data
         rows ? rows[1..-1] : ""
       end
-      
+
       def values_for_row(row)
         hash = {}
 
-        headers.each_with_index do |header,index|
+        headers.each_with_index do |header, index|
           hash[header] = data[row][index]
         end
 
         hash
       end
-      
+
       def to_hash
         hash = {}
 
-        rows.each_with_index do |header,index|
-          hash[header] = rows.collect {|row| row[index] }
+        rows.each_with_index do |header, index|
+          hash[header] = rows.collect { |row| row[index] }
         end
 
         hash
       end
-      
+
       def initialize(parameters = {})
-        parameters.each {|key,value| send("#{key.to_sym}=",value) if respond_to? "#{key.to_sym}=" }
+        parameters.each { |key, value| send("#{key.to_sym}=", value) if respond_to? "#{key.to_sym}=" }
       end
-      
     end
-    
   end
-
 end

data/lib/yard/code_objects/cucumber/step.rb

@@ -1,13 +1,18 @@
-
-
 module YARD::CodeObjects::Cucumber
-
   class Step < Base
 
-    attr_accessor :comments, :definition, :examples, :keyword, :scenario, :table, :text, :transforms, :value
-
-    def initialize(namespace,name)
-      super(namespace,name.to_s.strip)
+    attr_accessor :comments,
+                  :definition,
+                  :examples,
+                  :keyword,
+                  :scenario,
+                  :table,
+                  :text,
+                  :transforms,
+                  :value
+
+    def initialize(namespace, name)
+      super(namespace, name.to_s.strip)
       @comments = @definition = @description = @keyword = @table = @text = @value = nil
       @examples = {}
       @transforms = []
@@ -32,7 +37,5 @@ module YARD::CodeObjects::Cucumber
     def transformed?
       !@transforms.empty?
     end
-
   end
-
 end

data/lib/yard/code_objects/cucumber/tag.rb

@@ -1,27 +1,31 @@
-
-
 module YARD::CodeObjects::Cucumber
-
   class Tag < NamespaceObject
 
-    attr_accessor :value, :owners
-    
+    attr_accessor :value, :owners, :total_scenarios
+
     def features
-      @owners.find_all{|owner| owner.is_a?(Feature) }
+      @owners.find_all { |owner| owner.is_a?(Feature) }
     end
-    
+
     def scenarios
-      @owners.find_all{|owner| owner.is_a?(Scenario) || owner.is_a?(ScenarioOutline) }
+      all = @owners.find_all do |owner|
+        owner.is_a?(Scenario) || owner.is_a?(ScenarioOutline) || ()
+      end
+
+      @owners.each do |owner|
+        if owner.is_a?(ScenarioOutline::Examples) && !all.include?(owner.scenario)
+          all << owner.scenario
+        end
+      end
+      all
     end
-        
+
     def indirect_scenarios
-      @owners.find_all{|owner| owner.is_a?(Feature) }.collect {|feature| feature.scenarios }.flatten
+      @owners.find_all { |owner| owner.is_a?(Feature) }.collect { |feature| feature.scenarios }.flatten
     end
-    
+
     def all_scenarios
       scenarios + indirect_scenarios
     end
-    
   end
-
 end