cucumber-in-the-yard 1.3 → 1.4

data/lib/yard/rb_extensions.rb

@@ -1,156 +0,0 @@
-
-module YARD::CodeObjects
-
-
-  #
-  # StepDefinitions, as implemented in a ruby file
-  #
-  class StepDefinitionObject < Base
-    include Cucumber::LocationHelper
-    
-    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
-    
-    
-  end
-  
-
-  #
-  # Transforms
-  #
-  class StepTransformObject < Base
-    include Cucumber::LocationHelper
-    
-    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}") do |o| 
-      o.source = "#{keyword} #{step_definition} do #{statement.block.to_s =~ /^\s*\|.+/ ? '' : "\n  "}#{statement.block.to_s}\nend"
-      o.value = step_definition
-      o.keyword = keyword
-    end
-
-    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.debug "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

@@ -1,245 +0,0 @@
-<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) %>
-		</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.location ) %>)
-					</div>
-				</span>
-				<% else %>
-				<span class="undefined"><%= h(step.value) %></span>
-				<% end %>
-
-			</div>
-
-			<% 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) %></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>
-			<% end %>
-			
-			<% if step.has_text? %>
-			<div class="text">
-				<%= h(step.text) %>
-			</div>
-			<% end %>
-
-
-			<% 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) %>
-		</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 %>
-
-			</div>
-
-			<% 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) %></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>
-			<% end %>
-			
-			<% if step.has_text? %>
-			<div class="text">
-				<%= h(step.text) %>
-			</div>
-			<% end %>
-			
-
-
-			<% end %>
-			<% else %>
-			<span>No Steps Defined</span>
-			<% end %>
-		</div>
-
-		<% if scenario.outline? %>
-		<div class="outline">
-			<div class="keyword"> <%= h(scenario.example_keyword) %> </div>
-			<table>
-				<thead>
-					<tr>
-						<% scenario.example_headers.each_with_index do |header,header_index| %>
-						<th><%= h(header) %></th>
-						<% end %>
-					</tr>
-				</thead>
-				<% scenario.example_data.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.to_s.strip) %></td>
-					<% end %>
-				</tr>
-				<% end %>
-			</table>
-		</div>
-		<% end %>
-
-	</div>
-	<% end %>
-	<% end %>
-
-</div>
-

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

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

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

@@ -1,10 +0,0 @@
-<% n = 1 %>
-<% @items.each do |feature| %>
-  <li class="r<%= n %>">
-	<span class='object_link'>
-		<a href="<%= "#{feature.name}.html" %>"><%= h(feature.value) %></a>
-	</span>
-	<span class="">(<%= h(feature.file) %>)<span>
-  </li>
-  <% n = n == 2 ? 1 : 2 %>
-<% end %>

data/lib/yard/templates/default/fulldoc/html/full_list_scenarios.erb

@@ -1,10 +0,0 @@
-<% n = 1 %>
-<% @items.each do |scenario| %>
-  <li class="r<%= n %>">
-	<span class='object_link'>
-		<a href="<%= "#{scenario.feature.name}.html" %>"><%= h(scenario.value) %></a>
-	</span>
-	<span class="">(<%= h(scenario.location) %>)<span>
-  </li>
-  <% n = n == 2 ? 1 : 2 %>
-<% end %>

data/lib/yard/templates/default/fulldoc/html/full_list_tagusages.erb

@@ -1,10 +0,0 @@
-<% n = 1 %>
-<% @items.each do |usage| %>
-  <li class="r<%= n %>">
-	<span class='object_link'>
-		<a href="<%= "#{usage.name}.html" %>"><%= h(usage.value) %></a>
-	</span>
-	<small><%= usage.total_scenario_count %></small>
-  </li>
-  <% n = n == 2 ? 1 : 2 %>
-<% end %>

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

@@ -1,73 +0,0 @@
-include YARD::Templates::Helpers::HtmlHelper
-
-def init
-  super
-  asset("js/cucumber.js",file("js/cucumber.js",true))
-
-  @features = Registry.all(:feature)
-
-  if @features
-    @features.each {|feature| serialize(feature) } 
-    generate_full_list(@features)
-  end
-
-  
-  @tags = find_unique_tags(@tags)
-  
-  if @tags
-    @tags.each { |tag,tag_objects| serialize_tags(tag_objects) }
-    
-    @tagusage = @tags.values.sort {|x,y| y.total_scenario_count <=> x.total_scenario_count }
-    generate_full_list(@tagusage,"Tag Usage") if @tagusage
-  end
-
-  @scenarios = Registry.all(:scenario).find_all {|scenario| !scenario.background? }
-  generate_full_list(@scenarios) if @scenarios
-
-  @steps = Registry.all(:step)
-  generate_full_list(@steps) if @steps
-
-  @step_definitions = Registry.all(:stepdefinition)
-
-  if @step_definitions
-    generate_full_list(@step_definitions,"Step Definition") 
-    @step_transformers = YARD::CodeObjects::StepTransformersObject.new(:root,"steptransformers")
-    @step_definitions.each {|stepdef| @step_transformers << stepdef }
-    serialize(@step_transformers)
-  end
-
-
-end
-
-def generate_full_list(objects,friendly_name=nil)
-  if !objects.empty?
-    @items = objects
-    @list_type = "#{objects.first.type.to_s}s"
-    @list_title = "#{friendly_name || objects.first.type.to_s.capitalize} List"
-    asset("#{objects.first.type}_list.html",erb(:full_list))
-  else
-    log.warn "Full List: Failed to create a list because the objects array is empty."
-  end
-end
-
-def serialize_tags(tags)
-  options[:object] = tags
-  Templates::Engine.with_serializer("#{tags.name}.html", options[:serializer]) do
-    T('layout').run(options)
-  end
-end
-
-def find_unique_tags(tags)
-
-  tags_hash = {}
-
-  Registry.all(:tag).each do |tag|
-    unless tags_hash[tag.value]
-      tags_hash[tag.value] = YARD::CodeObjects::Cucumber::TagUsage.new(:root,"tag_#{tag.value}") {|t| t.value = tag.value } 
-    end
-    tags_hash[tag.value.to_s] << tag
-  end
-
-  tags_hash
-end
-