cucumber-in-the-yard 1.0

data/lib/yard/extensions.rb

@@ -0,0 +1,38 @@
+
+module YARD::CodeObjects
+  
+  NamespaceObject.class_eval do
+
+    attr_accessor :features
+
+    def features(opts = {})
+      children.select {|child| child.type == :feature }
+    end
+
+    attr_accessor :scenarios
+
+    def scenarios(opts = {})
+      children.select {|child| child.type == :scenario }
+    end
+
+    attr_accessor :steps
+
+    def steps(opts = {})
+      children.select {|child| child.type == :step }
+    end
+
+    attr_accessor :step_definitions
+
+    def step_definitions(opts = {})
+      children.select {|child| child.type == :stepdefinition }
+    end
+
+    attr_accessor :step_transforms
+
+    def step_transforms(opts = {})
+      children.select {|child| child.type == :steptransform }
+    end
+
+  end
+
+end

data/lib/yard/handlers/base.rb

@@ -0,0 +1,21 @@
+module YARD
+  module Handlers
+    module Cucumber
+
+      class Base < Handlers::Base
+        class << self
+          include Parser::Cucumber
+          def handles?(node)
+            handlers.any? do |a_handler|
+              log.debug "YARD::Handlers::Cucumber::Base#handles?"
+            end
+          end
+          include Parser::Cucumber
+        end
+
+      end
+
+      Processor.register_handler_namespace :feature, Cucumber
+    end 
+  end
+end

data/lib/yard/handlers/feature_handler.rb

@@ -0,0 +1,41 @@
+module YARD
+  module Handlers
+    module Cucumber
+
+      class FeatureHandler < Base
+
+        handles CodeObjects::Cucumber::Feature
+
+        def process 
+                    
+          # For the background and the scenario, find the steps that have definitions
+          process_scenario(statement.background) if statement.background
+          
+          statement.scenarios.each do |scenario|
+            process_scenario(scenario)
+          end
+          
+        rescue YARD::Handlers::NamespaceMissingError
+        end
+        
+        
+        def process_scenario(scenario)
+          scenario.steps.each do |step|
+            owner.step_definitions.each do |stepdef|
+              if %r{#{stepdef.compare_value}}.match(step.value)
+                step.definition = stepdef
+                stepdef.steps << step
+                log.info "STEP #{step} has found its definition #{stepdef}"
+                break
+              end
+            end
+          end
+            
+        end
+        
+
+      end
+
+    end
+  end
+end

data/lib/yard/parser/feature.rb

@@ -0,0 +1,46 @@
+module YARD::Parser::Cucumber
+
+  class FeatureParser < YARD::Parser::Base
+
+    def initialize(source, file = '(stdin)')
+
+      @builder = Cucumber::Parser::CityBuilder.new(file)
+      @tag_counts = {}
+      @tag_formatter = Gherkin::Formatter::TagCountFormatter.new(@builder, @tag_counts)
+      @parser = Gherkin::Parser::Parser.new(@tag_formatter, true, "root", false)
+
+      @source = source
+      @file = file
+
+      @feature = nil
+    end
+
+    def parse
+      begin
+        @parser.parse(@source, @file, 0)
+        @feature = @builder.ast
+        return nil if @feature.nil? # Nothing matched
+        @feature.language = @parser.i18n_language
+      rescue Gherkin::Lexer::LexingError, Gherkin::Parser::ParseError => e
+        e.message.insert(0, "#{@file}: ")
+        raise e
+      end
+
+      self
+    end
+
+    def tokenize
+      
+    end
+
+
+    def enumerator
+      [@feature]
+    end
+
+  end
+
+
+  YARD::Parser::SourceParser.register_parser_type :feature, FeatureParser, 'feature'
+
+end

data/lib/yard/rake/city_task.rb

@@ -0,0 +1,12 @@
+module YARD::Rake
+  
+  class CitydocTask < YardocTask
+  
+    def initialize(name = :yard)
+      super
+      self.options += [ "-e", "#{ File.dirname(__FILE__)}/../../city.rb", "-p", "#{File.dirname(__FILE__)}/../templates" ]
+    end
+    
+  end
+  
+end

data/lib/yard/rb_extensions.rb

@@ -0,0 +1,152 @@
+
+module YARD::CodeObjects
+
+
+  #
+  # StepDefinitions, as implemented in a ruby file
+  #
+  class StepDefinitionObject < Base
+    
+    attr_reader :keyword, :value, :compare_value, :source 
+    attr_accessor :constants, :steps
+    
+    def value=(value)
+      @value = format_source(value)
+      @constants = {}
+      @steps = []
+    end
+    
+    def compare_value
+      base_value = value.gsub(/^\/|\/$/,'')
+      @constants.each do |name,value|
+        base_value.gsub!(/\#\{\s*#{name.to_s}\s*\}/,value.gsub(/^\/|\/$/,''))
+      end
+      base_value
+    end
+    
+    def _value_constants(data=@value)
+      #Hash[*data.scan(/\#\{([^\}]+)\}/).flatten.collect {|value| [value.strip,nil]}.flatten]
+      data.scan(/\#\{([^\}]+)\}/).flatten.collect { |value| value.strip }
+    end
+    
+    def constants=(value)
+      value.each do |val| 
+        @constants[val.name.to_s] = val if val.respond_to?(:name) && val.respond_to?(:value)
+      end
+    end    
+    
+  end 
+  
+  class StepTransformersObject < Base
+    
+    attr_reader :source
+    attr_accessor :definitions, :transforms
+    
+    def push(stepobject)
+      if stepobject.is_a?(StepDefinitionObject)
+        @definitions = [] unless @definitions
+        @definitions << stepobject
+      elsif stepobject.ia_a?(StepTransformObject)
+        @transforms = [] unless @transforms
+        @transforms << stepobject
+      end
+    end
+    
+    alias_method :<< , :push
+    
+    def filename
+      "#{name}.html"
+    end
+    
+  end
+  
+
+  #
+  # Transforms
+  #
+  class StepTransformObject < Base
+    attr_reader :value
+
+    def value=(value)
+      @value = format_source(value)
+    end
+  end
+
+
+
+
+end
+
+
+class StepDefinitionHandler < YARD::Handlers::Ruby::Legacy::Base
+  MATCH = /^((When|Given|And|Then)\s*(\/[^\/]+\/).+)$/
+  handles MATCH
+
+  @@unique_name = 0
+
+  def process
+
+    keyword = statement.tokens.to_s[MATCH,2]
+    step_definition = statement.tokens.to_s[MATCH,3]
+    @@unique_name = @@unique_name + 1
+
+    stepdef_instance = StepDefinitionObject.new(namespace, "StepDefinition_#{@@unique_name}") {|o| o.source = statement.block.to_s ; o.value = step_definition ; o.keyword = keyword}
+
+    begin
+      # Look for all constants within the step definitions
+      stepdef_instance.constants = stepdef_instance._value_constants.each do |stepdef_constant| 
+        owner.constants.each do |constant|
+          if stepdef_constant.to_sym == constant.name
+            log.info "Replacing #{constant.name} with its value in the step definition #{stepdef_instance.value}"
+            stepdef_instance.constants[constant.name] = unpack_constants(constant.value)
+          end
+        end
+      end
+      
+    rescue Exception => e
+      log.error "Failed to link step definition to constants. This will make step definition to step linking impossible if constants are present.  #{e}"
+    end
+    
+
+    obj = register stepdef_instance 
+
+
+    parse_block :owner => obj
+  rescue YARD::Handlers::NamespaceMissingError
+  end
+  
+  
+  def unpack_constants(constant_value)
+    constant_value.scan(/\#\{([^\}]+)\}/).flatten.collect { |value| value.strip }.each do |inner_constant|
+      inner_constant_match = owner.constants.find {|constant| constant.name.to_s == inner_constant }
+      if inner_constant_match
+        constant_value.gsub!(/\#\{#{inner_constant}\}/,unpack_constants(inner_constant_match.value))
+      end
+    end
+    
+    constant_value.gsub!(/^('|"|\/)|('|"|\/)$/,'')
+    constant_value
+  end
+  
+end
+
+
+class StepTransformHandler < YARD::Handlers::Ruby::Legacy::Base
+  MATCH = /^Transform\s*(\/[^\/]+\/).+$/
+  handles MATCH
+
+  @@unique_name = 0
+
+  def process
+    transformDefinition = statement.tokens.to_s[MATCH,1]
+    #log.debug "#process - transformDefinition = #{transformDefinition}"
+    @@unique_name = @@unique_name + 1
+
+    obj = register StepTransformObject.new(namespace, "StepTransform_#{@@unique_name}") {|o| o.source = statement.block.to_s ; o.value = transformDefinition }
+
+    parse_block :owner => obj
+
+  rescue YARD::Handlers::NamespaceMissingError
+  end
+end
+

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

@@ -0,0 +1,243 @@
+<div class="feature">
+	<div class="title">
+		<span class="pre"><%= @feature.keyword %>:</span>
+		<span class="name"><%= @feature.value %></span>
+	</div>
+
+	<div class="meta">
+		<div class="file"><%= h(@feature.file) %></div>
+		<div class="tags">
+			<% @feature.tags.each do |tag| %>
+			<a href="tag_<%= tag.value %>.html"><%= tag.value %></a>
+			<% end %>
+		</div>		
+	</div>
+
+	<div class="description">
+		<%= @feature.description %>
+	</div>
+
+	<% if @feature.background %>
+
+	<script type="text/javascript" charset="utf-8">
+	$(function() {
+		$('#background .toggle').click(function() {
+			$("#backgroundSteps").toggle('blind');
+
+			var stateIndicator = $('#background a.toggle')[0]
+
+			stateIndicator.innerHTML = (stateIndicator.innerHTML === '+' ? '-' : '+'); 
+			return false;
+		});
+	});
+	</script>
+
+	<div id="background">
+		<div class="title">
+			<a class="toggle">-</a>
+			<span class="pre">Background</span>
+		</div>
+		<% unless @feature.background.description.empty? %>
+		<div class="description">
+			<%= h(@feature.background.description.join("\n<br/>")) %>
+		</div>
+		<% end %>
+
+		<!-- Background and scenario should have the same display with some minor changes -->
+
+		<div id="backgroundSteps" class="steps">
+			<% if @feature.background.steps %>
+			<%  @feature.background.steps.each_with_index do |step,index| %>
+			<div <%= "id='backgroundStep#{index}'" %> class="step <%= (index + 1) % 2 == 0 ? 'even' : 'odd' %>">
+				<span class="predicate"><%= step.keyword %></span>
+
+				<% if step.definition %>
+				<script type="text/javascript" charset="utf-8">
+				$('<%= "#backgroundStep#{index}" %>').hover(
+					function () { $('<%= "#backgroundStep#{index} div.details" %>').toggle('slide'); },
+					function () { $('<%= "#backgroundStep#{index} div.details" %>').toggle('slide'); }
+				);
+
+				$('<%= "#backgroundStep#{index} div.details" %>').show();
+
+				</script>
+				<span class="defined">
+					<a href="steptransformers.html#<%= step.definition.name %>"><%= h(step.value) %></a>
+					<div class="details" style="display: none;">
+						(<%= h("#{step.definition.files.first.first}:#{step.definition.files.first.last}") %>)
+					</div>
+				</span>
+				<% else %>
+				<span class="undefined"><%= h(step.value) %></span>
+				<% end %>
+
+				<% if step.has_text? %>
+				<div class="text">
+					<%= h(step.text) %>
+				</div>
+				<% end %>
+
+				<% if step.has_table? %>
+				<div class="multiline">
+					<table style="">
+
+						<thead>
+							<tr>
+								<% step.table.each_with_index do |column,column_index| %>
+								<th class="<%= (column_index + 1) % 2 == 0 ? 'even' : 'odd' %>"><%= h(column.to_s.strip) %></td>
+									<% end %>
+								</tr>
+							</thead>
+
+							<% step.table[1..-1].each do |row| %>
+							<tr>
+								<% row.split("|").each_with_index do |column,column_index| %>
+								<td class="<%= (column_index + 1) % 2 == 0 ? 'even' : 'odd' %>"><%= h(column.to_s.strip) %></td>
+								<% end %>
+							</tr>
+							<% end %>
+						</table>
+					</div>
+
+					<% end %>
+
+				</div>
+
+				<% end %>
+				<% else %>
+				<span>No Steps Defined</span>
+				<% end %>
+			</div>
+
+		</div>
+		<% end %> 
+
+		<% if @feature.scenarios %>
+		<% @feature.scenarios.each_with_index do |scenario,scenario_index| %>
+
+		<script type="text/javascript" charset="utf-8">
+		$(function() {
+			$('#scenario<%=scenario_index%> .toggle').click(function() {
+				$("#scenario<%=scenario_index%>Steps").toggle('blind');
+
+				var stateIndicator = $('#scenario<%=scenario_index%> a.toggle')[0]
+
+				stateIndicator.innerHTML = (stateIndicator.innerHTML === '+' ? '-' : '+'); 
+				return false;
+			});
+		});
+		</script>
+
+		<div <%= "id='scenario#{scenario_index}'" %>  class="scenario">
+			<div class="title">
+				<a class="toggle">-</a>
+				<span class="pre">Scenario<%= !scenario.examples.empty? ? " Outline" : "" %>:</span>
+				<span class="name"><%= h(scenario.value) %></span>
+			</div>
+			<div class="meta">
+				<div class="file">Line: <%= scenario.files.first.last %></div>
+				<% unless scenario.tags.empty? %>
+				<div class="tags">
+					<% scenario.tags.each do |tag| %>
+					<a href="tag_<%= tag.value %>.html"><%= tag.value %></a>
+					<% end %>
+				</div>
+				<% end%>
+			</div>
+			<% unless scenario.description.empty? %>
+			<div class="description">
+				<%= h(scenario.description.join("\n<br/>")) %>
+			</div>
+			<% end %>
+
+			<div <%= "id='scenario#{scenario_index}Steps'" %> class="steps">
+				<% if scenario.steps %>
+				<% scenario.steps.each_with_index do |step,index| %>
+				<div <%= "id='scenario#{scenario_index}Step#{index}'" %> class="step <%= (index + 1) % 2 == 0 ? 'even' : 'odd' %>">
+					<span class="predicate"><%= step.keyword %></span>
+
+					<% if step.definition %>
+					<script type="text/javascript" charset="utf-8">
+					$('<%= "#scenario#{scenario_index}Step#{index}" %>').hover(
+						function () { $('<%= "#scenario#{scenario_index}Step#{index} div.details" %>').toggle('slide'); },
+						function () { $('<%= "#scenario#{scenario_index}Step#{index} div.details" %>').toggle('slide'); }
+					);
+
+					$('<%= "#scenario#{scenario_index}Step#{index} div.details" %>').show();
+
+					</script>
+					<span class="defined">
+						<a href="steptransformers.html#<%= step.definition.name %>"><%= h(step.value) %></a>
+						<div class="details" style="display: none;">
+							(<%= h("#{step.definition.files.first.first}:#{step.definition.files.first.last}") %>)
+						</div>
+					</span>
+					<% else %>
+					<span class="undefined"><%= h(step.value) %></span>
+					<% end %>
+					
+					<% if step.has_text? %>
+					<div class="text">
+						<%= h(step.text) %>
+					</div>
+					<% end %>
+
+					<% if step.has_table? %>
+					<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) %></td>
+										<% end %>
+									</tr>
+								</thead>
+
+								<% step.table[1..-1].each do |row| %>
+								<tr>
+									<% row.each_with_index do |column,column_index| %>
+									<td class="<%= (column_index + 1) % 2 == 0 ? 'even' : 'odd' %>"><%= h(column.strip) %></td>
+									<% end %>
+								</tr>
+								<% end %>
+							</table>
+						</div>
+
+						<% end %>
+
+
+					</div>
+
+					<% end %>
+					<% else %>
+					<span>No Steps Defined</span>
+					<% end %>
+				</div>
+
+				<% if scenario.examples && !scenario.examples.empty? %>
+				<div class="outline">
+					<table>
+						<thead>
+							<tr>
+								<th class="odd" colspan="10"><%= h(scenario.examples.first.first.to_s.strip) %></td>
+							</tr>
+						</thead>
+						<% scenario.examples.first.find {|example| example.is_a?(Array) }.each_with_index do |row,row_index| %>
+					    	<tr>
+								<% row.each do |column| %>
+									<td class="<%= (row_index + 1) % 2 == 0 ? 'even' : 'odd' %>"><%= h(column.to_s.strip) %></td>
+								<% end %>
+							</tr>
+						<% end %>
+						</table>
+					</div>
+
+					<% end %>
+
+				</div>
+				<% end %>
+				<% end %>
+
+			</div>
+

data/lib/yard/templates/default/feature/setup.rb

@@ -0,0 +1,5 @@
+def init
+  super
+  sections.push :feature
+  @feature = object
+end