yard-cucumber2 2.3.3

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-cucumber.rb

@@ -0,0 +1,47 @@
+require 'cucumber/platform'
+require 'gherkin/parser/parser'
+require 'gherkin/formatter/tag_count_formatter'
+
+require File.dirname(__FILE__) + "/yard-cucumber/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/step_transform.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"
+
+if RUBY19
+  require File.dirname(__FILE__) + "/yard/handlers/step_definition_handler.rb"
+  require File.dirname(__FILE__) + "/yard/handlers/step_transform_handler.rb"
+end
+
+require File.dirname(__FILE__) + "/yard/handlers/legacy/step_definition_handler.rb"
+require File.dirname(__FILE__) + "/yard/handlers/legacy/step_transform_handler.rb"
+
+#require File.dirname(__FILE__) + "/yard/parser/source_parser.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"

data/lib/yard-cucumber/version.rb

@@ -0,0 +1,3 @@
+module CucumberInTheYARD
+  VERSION = '2.3.2'
+end

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

@@ -0,0 +1,32 @@
+
+module YARD::CodeObjects::Cucumber
+
+  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/cucumber/feature.rb

@@ -0,0 +1,18 @@
+
+
+module YARD::CodeObjects::Cucumber
+
+  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/cucumber/namespace_object.rb

@@ -0,0 +1,49 @@
+
+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

@@ -0,0 +1,26 @@
+
+
+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)
+      @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

@@ -0,0 +1,75 @@
+
+
+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)
+      @comments = @description = @value = @feature = nil
+      @steps = []
+      @tags = []
+      @scenarios = []
+      @examples = []
+    end
+
+    def background?
+      false
+    end
+
+    def outline?
+      true
+    end
+    
+    def examples?
+      @examples.find {|example| example.rows }
+    end
+    
+    
+    class Examples
+      
+      attr_accessor :name, :line, :keyword, :comments, :rows
+      
+      # 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|
+          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] }
+        end
+
+        hash
+      end
+      
+      def initialize(parameters = {})
+        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

@@ -0,0 +1,38 @@
+
+
+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)
+      @comments = @definition = @description = @keyword = @table = @text = @value = nil
+      @examples = {}
+      @transforms = []
+    end
+
+    def has_table?
+      !@table.nil?
+    end
+
+    def has_text?
+      !@text.nil?
+    end
+
+    def definition=(stepdef)
+      @definition = stepdef
+
+      unless stepdef.steps.map(&:files).include?(files)
+        stepdef.steps << self
+      end
+    end
+
+    def transformed?
+      !@transforms.empty?
+    end
+
+  end
+
+end

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

@@ -0,0 +1,27 @@
+
+
+module YARD::CodeObjects::Cucumber
+
+  class Tag < NamespaceObject
+
+    attr_accessor :value, :owners
+    
+    def features
+      @owners.find_all{|owner| owner.is_a?(Feature) }
+    end
+    
+    def scenarios
+      @owners.find_all{|owner| owner.is_a?(Scenario) || owner.is_a?(ScenarioOutline) }
+    end
+        
+    def indirect_scenarios
+      @owners.find_all{|owner| owner.is_a?(Feature) }.collect {|feature| feature.scenarios }.flatten
+    end
+    
+    def all_scenarios
+      scenarios + indirect_scenarios
+    end
+    
+  end
+
+end

data/lib/yard/code_objects/step_definition.rb

@@ -0,0 +1,7 @@
+
+
+module YARD::CodeObjects
+
+  class StepDefinitionObject < StepTransformerObject ; end
+
+end

data/lib/yard/code_objects/step_transform.rb

@@ -0,0 +1,7 @@
+
+
+module YARD::CodeObjects
+
+  class StepTransformObject < StepTransformerObject ; end
+  
+end

data/lib/yard/code_objects/step_transformer.rb

@@ -0,0 +1,97 @@
+
+module YARD::CodeObjects
+
+  class StepTransformerObject < Base
+
+    include Cucumber::LocationHelper
+
+    attr_reader :constants, :keyword, :source, :value, :literal_value
+    attr_accessor :steps, :pending, :substeps
+
+    # This defines an escape pattern within a string or regex:
+    #     /^the first #{CONSTANT} step$/
+    #
+    # This is used below in the value to process it if there happen to be
+    # constants defined here.
+    #
+    # @note this does not handle the result of method calls
+    # @note this does not handle multiple constants within the same escaped area
+    #
+    def escape_pattern
+      /#\{\s*(\w+)\s*\}/
+    end
+
+    #
+    # When requesting a step tranformer object value, process it, if it hasn't
+    # alredy been processed, replacing any constants that may be lurking within
+    # the value.
+    #
+    # Processing it means looking for any escaped characters that happen to be
+    # CONSTANTS that could be matched and then replaced. This is done recursively
+    # as CONSTANTS can be defined with more CONSTANTS.
+    #
+    def value
+      unless @processed
+        @processed = true
+        until (nested = constants_from_value).empty?
+          nested.each {|n| @value.gsub!(value_regex(n),find_value_for_constant(n)) }
+        end
+      end
+
+      @value
+    end
+
+    #
+    # Set the literal value and the value of the step definition.
+    #
+    # The literal value is as it appears in the step definition file with any
+    # constants. The value, when retrieved will attempt to replace those
+    # constants with their regex or string equivalents to hopefully match more
+    # steps and step definitions.
+    #
+    #
+    def value=(value)
+      @literal_value = format_source(value)
+      @value = format_source(value)
+
+      @steps = []
+      value
+    end
+
+    # Generate a regex with the step transformers value
+    def regex
+      @regex ||= /#{strip_regex_from(value)}/
+    end
+
+    # Look through the specified data for the escape pattern and return an array
+    # of those constants found. This defaults to the @value within step transformer
+    # as it is used internally, however, it can be called externally if it's
+    # needed somewhere.
+    def constants_from_value(data=@value)
+      data.scan(escape_pattern).flatten.collect { |value| value.strip }
+    end
+
+    protected
+
+    #
+    # Looking through all the constants in the registry and returning the value
+    # with the regex items replaced from the constnat if present
+    #
+    def find_value_for_constant(name)
+      constant = YARD::Registry.all(:constant).find{|c| c.name == name.to_sym }
+      log.warn "StepTransformer#find_value_for_constant : Could not find the CONSTANT [#{name}] using the string value." unless constant
+      constant ? strip_regex_from(constant.value) : name
+    end
+
+    # Return a regex of the value
+    def value_regex(value)
+      /#\{\s*#{value}\s*\}/
+    end
+
+    # Step the regex starting / and ending / from the value
+    def strip_regex_from(value)
+      value.gsub(/^\/|\/$/,'')
+    end
+  end
+
+end