yard-cucumber 2.0.0

data/example/step_definitions/example.step.rb

@@ -0,0 +1,109 @@
+
+Transform /^#{CUSTOMER}$/ do |customer|
+  "a transformed customer"
+end
+
+Transform /^an? customer$/ do |customer|
+  "a transformed customer"
+end
+
+Transform /^the customer$/ do |customer|
+  "the transformed customer"
+end
+
+Transform /^(#{ORDER}) customer$/ do |order|
+  "#{order} customer"
+end
+
+Transform /^#{TEDDY_BEAR}$/ do |teddy|
+  "the tranformed teddy bear"
+end
+
+#
+# This is a complicated Transform with a comment
+#
+Transform /^((?:\d{1,2}[\/-]){2}(?:\d\d){1,2})?\s*(\w{3})?\s*(\d{1,2}:\d{2}\s*(?:AM|PM)?)$/ do |date,day,time|
+  "#{date} #{day} #{time}"
+end
+
+Given /^that (#{CUSTOMER}) is a valid customer$/ do |customer|
+  pending "Customer #{customer} validation"  
+end
+
+#
+# This comment will likely blow {things up}!
+#
+When /^a customer logs in as username '([^']+)' with password '([^']+)'$/ do |username,password|
+  Given "that the customer is a valid customer"
+  pending "Customer logs in with #{username} and #{password}"
+end
+
+Then /^I expect them to have logged in (successfully|miserably)$/ do |success|
+  pending "Validation that the customer has logged in #{success}"
+end
+
+When /^the customer logs out$/ do
+  pending
+end
+
+Then /^I expect the customer to be shown the logout page$/ do 
+  pending
+end
+
+And /^this (third) defined step definition$/ do |number|
+  pending
+end
+
+And /^the customer has the following details:$/ do |table|
+  pending "Table of data #{table.hashes}"
+end
+
+And /^edits their the (biography) to state:$/ do |section,text|
+  pending "text_field not present for #{section} #{bio} for this release"
+end
+
+Then /I expect (#{CUSTOMER}) to be a member of the '([^']+)' group/ do |customer,product|
+  pending "Customer #{customer} with product #{product}"
+end
+
+#
+# Complicated step definition with optional parameters
+#
+Given /^(?:I create )?an? (?:(active|deactive|inactive|simulated)d?)? ?project(?:[\s,]*(?:with)? ?(?:an?|the)? (?:(?:the size? (?:at|of)? ?(\d+)|named? (?:of )?'([^']+)'|start date (?:of )?((?:(?:\d{1,2}[\/-]){2}(?:\d\d){1,2}))|end date (?:of )?((?:(?:\d{1,2}[\/-]){2}(?:\d\d){1,2}))|user range (?:of )?(\d+-\d+)|description (?:of )?'([^']+)'|nicknamed? (?:of )?'([^']+)')[,\s]*)* ?)?$/ do |state,size,name,start_date,end_date,user_range,description,nickname|
+  pending "#{state} #{size} #{name} #{start_date} #{end_date} #{user_range} #{description} #{nickname}"
+end
+
+
+#
+# The highlighting replacement uses a span which had trouble when blindly using
+# a gsub replacement.
+#
+Given /(a|\d+) ducks? that ha(?:s|ve) (a|\d+) bills?/ do |duck_count,bills_count|
+  pending
+end
+
+Then /I expect the (duck|bird) to (\w+)/ do |animal,verb|
+  pending
+end
+
+#
+# This double-quoted step definition caused some problems when being rendered
+#
+When /^searching the log for the exact match of the message "([^"]+)"$/ do |message|
+  pending message
+end
+
+#
+#
+#
+When /^the step definition has HTML escaped characters like: "([^"]+)"$/ do |characters|
+  pending characters
+end
+
+
+#
+# Some details about the helper method that might be picked up in the documentation.
+#
+def a_helper_method
+  puts "performs some operation"
+end

data/example/step_definitions/first.step.rb

@@ -0,0 +1,21 @@
+Transform /^#{ORDER}$/ do |order|
+  order
+end
+
+Transform /^background$/ do |background|
+  "background"
+end
+
+#
+# This step transform converts "scenario" to "scenario"
+# 
+Transform /^scenario$/ do |scenario|
+  "scenario"
+end
+
+#
+# This step definition is all about steps
+# 
+Given /^this (scenario|background|#{ORDER}) step$/ do |step|
+  pending "step #{order}"
+end

data/example/step_definitions/support/env.rb

@@ -0,0 +1,7 @@
+
+module Environment
+  module Database
+    class Connection
+    end
+  end
+end

data/example/step_definitions/support/env_support.rb

@@ -0,0 +1,12 @@
+
+class SupportClass
+  
+end
+
+module Web
+  module Interface
+   class CachedReference
+     
+   end 
+  end
+end

data/example/step_definitions/support/support.rb

@@ -0,0 +1,6 @@
+
+ORDER = /(?:first|second|third)/
+
+TEDDY_BEAR = /teddy bear/
+
+CUSTOMER = /(?:(?:an?|the|#{ORDER}) customer|#{TEDDY_BEAR})/

data/example/tags.feature

@@ -0,0 +1,18 @@
+@tags
+Feature: Tags
+  As a developer of the test suite I expect that various tags will be supported
+
+  @tag
+  Scenario: Basic Tag
+
+  @tag123456  
+  Scenario: Tag With Numbers
+  
+  @tag_with_underscore
+  Scenario: Tag With Underscore
+
+  @tag-with-dash
+  Scenario: Tag With Dash
+  
+  @tag+with+plus
+  Scenario: Tag With Plus

data/example/transform.feature

@@ -0,0 +1,13 @@
+@scenarios @bvt
+Feature: Step Transforms
+  As a developer of the test suite I expect that step transforms are documented correctly
+
+  @first
+  Scenario: Step with step transformation
+    Given this scenario step
+    Then I expect that the step, on the step transformer page, will link to the step transform
+
+  @second
+  Scenario: Step Transform uses a constant
+    Given this first step
+    Then I expect that the step, on the step transformer page, will link to the step transform

data/lib/cucumber/city_builder.rb

@@ -0,0 +1,209 @@
+
+module Cucumber
+  module Parser
+    class CityBuilder
+      include Gherkin::Rubify
+
+      def initialize(file)
+        @namespace = YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE
+        find_or_create_namespace(file)
+        @file = file
+      end
+
+      def ast
+        @feature || @multiline_arg
+      end
+
+      def find_or_create_namespace(file)
+        @namespace = YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE
+        
+        File.dirname(file).split('/').each do |directory|
+          @namespace = @namespace.children.find {|child| child.is_a?(YARD::CodeObjects::Cucumber::FeatureDirectory) && child.name.to_s == directory } ||
+            @namespace = YARD::CodeObjects::Cucumber::FeatureDirectory.new(@namespace,directory) {|dir| dir.add_file(directory)}
+        end
+
+        if @namespace.description == "" && File.exists?("#{File.dirname(file)}/README.md")
+          @namespace.description = File.read("#{File.dirname(file)}/README.md")
+        end
+      end
+
+      def find_or_create_tag(tag_name,parent)
+        #log.debug "Processing tag #{tag_name}"
+        tag_code_object = YARD::Registry.all(:tag).find {|tag| tag.value == tag_name } ||
+          YARD::CodeObjects::Cucumber::Tag.new(YARD::CodeObjects::Cucumber::CUCUMBER_TAG_NAMESPACE,tag_name.gsub('@','')) {|t| t.owners = [] ; t.value = tag_name }
+
+        tag_code_object.add_file(@file,parent.line)
+
+        parent.tags << tag_code_object unless parent.tags.find {|tag| tag == tag_code_object }
+        tag_code_object.owners << parent unless tag_code_object.owners.find {|owner| owner == parent}
+      end
+
+      def feature(feature)
+        #log.debug "FEATURE"
+        
+        @feature = YARD::CodeObjects::Cucumber::Feature.new(@namespace,File.basename(@file.gsub('.feature','').gsub('.','_'))) do |f|
+          f.comments = feature.comments.map{|comment| comment.value}.join("\n")
+          f.description = feature.description
+          f.add_file(@file,feature.line)
+          f.keyword = feature.keyword
+          f.value = feature.name
+          f.tags = []
+
+          feature.tags.each {|feature_tag| find_or_create_tag(feature_tag.name,f) }
+        end
+      end
+
+      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)
+        end
+
+        @feature.background = @background
+        @background.feature = @feature
+        @step_container = @background
+      end
+
+      def scenario(statement)
+        #log.debug "SCENARIO"
+
+        scenario = YARD::CodeObjects::Cucumber::Scenario.new(@feature,"scenario_#{@feature.scenarios.length + 1}") do |s|
+          s.comments = statement.comments.map{|comment| comment.value}.join("\n")
+          s.description = statement.description
+          s.add_file(@file,statement.line)
+          s.keyword = statement.keyword
+          s.value = statement.name
+
+          statement.tags.each {|scenario_tag| find_or_create_tag(scenario_tag.name,s) }
+        end
+
+        scenario.feature = @feature
+        @feature.scenarios << scenario
+        @step_container = scenario
+      end
+
+      def scenario_outline(statement)
+        #log.debug "SCENARIO OUTLINE"
+        
+        outline = YARD::CodeObjects::Cucumber::ScenarioOutline.new(@feature,"scenario_#{@feature.scenarios.length + 1}") do |s|
+          s.comments = statement.comments.map{|comment| comment.value}.join("\n")
+          s.description = statement.description
+          s.add_file(@file,statement.line)
+          s.keyword = statement.keyword
+          s.value = statement.name
+
+          statement.tags.each {|scenario_tag| find_or_create_tag(scenario_tag.name,s) }
+        end
+
+        outline.feature = @feature
+        @feature.scenarios << outline
+        @step_container = outline
+      end
+
+      def examples(examples)
+        #log.debug "EXAMPLES"
+
+        @step_container.examples = { :keyword => examples.keyword,
+          :name => examples.name,
+          :line => examples.line,
+          :comments => examples.comments.map{|comment| comment.value}.join("\n"),
+          :rows => matrix(examples.rows) }
+
+        # For each example generate a scenario and steps
+        
+        @step_container.example_data.length.times do |row_index|
+
+          scenario = YARD::CodeObjects::Cucumber::Scenario.new(@step_container,"example_#{@step_container.scenarios.length + 1}") do |s|
+            s.comments = @step_container.comments
+            s.description = @step_container.description
+            s.add_file(@file,@step_container.line_number)
+            s.keyword = @step_container.keyword
+            s.value = "#{@step_container.value} (#{@step_container.scenarios.length + 1})"
+          end
+
+          @step_container.steps.each do |step|
+            step_instance = YARD::CodeObjects::Cucumber::Step.new(scenario,step.line_number) do |s|
+              s.keyword = step.keyword.dup
+              s.value = step.value.dup
+              s.add_file(@file,step.line_number)
+
+              s.text = step.text.dup if step.has_text?
+              s.table = clone_table(step.table) if step.has_table?
+            end
+
+            @step_container.example_values_for_row(row_index).each do |key,text|
+              text ||= "" #handle empty cells in the example table
+              step_instance.value.gsub!("<#{key}>",text)
+              step_instance.text.gsub!("<#{key}>",text) if step_instance.has_text?
+              step_instance.table.each{|row| row.each{|col| col.gsub!("<#{key}>",text)}} if step_instance.has_table?
+            end
+
+            step_instance.scenario = scenario
+            scenario.steps << step_instance
+          end
+
+          # Scenario instances of an outline link to the feature but are not linked from the feature
+          # @feature.scenarios << scenario
+
+          scenario.feature = @feature
+          @step_container.scenarios << scenario
+          
+        end
+        
+      end
+
+      def step(step)
+        #log.debug "STEP"
+
+        @table_owner = YARD::CodeObjects::Cucumber::Step.new(@step_container,"#{step.line}") do |s|
+          s.keyword = step.keyword
+          s.value = step.name
+          s.add_file(@file,step.line)
+        end
+
+        @table_owner.comments = step.comments.map{|comment| comment.value}.join("\n")
+
+        multiline_arg = rubify(step.multiline_arg)
+        
+        case(multiline_arg)
+        when Gherkin::Formatter::Model::PyString
+          @table_owner.text = multiline_arg.value
+        when Array
+          #log.info "Matrix: #{matrix(multiline_arg).collect{|row| row.collect{|cell| cell.class } }.flatten.join("\n")}"
+          @table_owner.table = matrix(multiline_arg)
+        end
+        
+        @table_owner.scenario = @step_container
+        @step_container.steps << @table_owner
+      end
+
+      def eof
+      end
+
+      def syntax_error(state, event, legal_events, line)
+        # raise "SYNTAX ERROR"
+      end
+
+      private
+      def matrix(gherkin_table)
+        gherkin_table.map do |gherkin_row|
+          row = gherkin_row.cells
+          class << row
+            attr_accessor :line
+          end
+          row.line = gherkin_row.line
+          row
+        end
+      end
+
+      def clone_table(base)
+        base.map {|row| row.map {|cell| cell.dup }}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+function cucumberSearchFrameLinks() {
+	$('#features_list_link').click(function() {
+		toggleSearchFrame(this, '/' + library + '/features');
+	});
+	$('#tags_list_link').click(function() {
+		toggleSearchFrame(this, '/' + library + '/tags');
+	});
+}
+
+$(cucumberSearchFrameLinks);
+
+
+
+function toggleScenarioExample(id,example) {
+
+	var element = $("#" + id + "Example" + example + "Steps")[0];
+
+	$('#' + id + ' tr').each(function(index) {
+		this.style.backgroundColor = (index % 2 == 0 ? '#FFFFFF' : '#F0F6F9' );
+	});
+
+	if (element.style.display != 'none') {
+		element = $("#" + id + "Steps")[0];
+	} else {
+		$('#' + id + ' .outline * tr')[example].style.backgroundColor = '#FFCC80';
+	}
+
+	$('#' + id + ' .steps').each(function(index) {
+		this.style.display = 'none';
+	});
+
+	element.style.display = 'block';
+
+}
+
+function determine_tags_used_in_formula(tag_string)  {
+	//$("#tag_debug")[0].innerHTML = "";
+	
+	tag_string = tag_string.replace(/^(\s+)|(\s+)$/,'').replace(/\s{2,}/,' ');
+
+	var tags = tag_string.match(/@\w+/g);
+
+	var return_tags = [];
+
+	if (tags != null) {
+		tags.forEach(function(tag, index, array) {
+			//$("#tag_debug")[0].innerHTML += tag + " ";
+			if (tag_list.indexOf(tag) != -1) { return_tags.push(tag); }
+		});
+	}
+
+	return return_tags;
+}
+
+
+function display_example_command_line(tags) {
+	$("#command_example")[0].innerHTML = "cucumber ";
+
+	if (tags.length > 0)  {
+		$("#command_example")[0].innerHTML += "--tags " + tags.join(" --tags ");
+	}
+}
+
+function display_qualifying_features_and_scenarios(tags) {
+	//$("#tag_debug")[0].innerHTML = "";
+
+	if (tags.length > 0) {
+		
+		$(".feature,.scenario").each(function(feature){
+			this.style.display = "none";
+		});
+
+		$(".feature.\\" + tags.join(".\\") + ",.scenario.\\" + tags.join(".\\")).each(function(feature) {
+			//$("#tag_debug")[0].innerHTML += feature + " " + this;
+			this.style.display = "block";
+		});
+
+		
+	}  else {
+		$(".feature,.scenario").each(function(feature){
+			this.style.display = "block";
+		});
+	}
+
+}

data/lib/docserver/default/layout/html/headers.erb

@@ -0,0 +1,13 @@
+<meta name="Content-Type" content="text/html; charset=UTF-8" />
+<title><%= @page_title %></title>
+<link rel="stylesheet" href="/css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="/css/custom.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="/css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/autocomplete.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/app.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/live.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/cucumber.js"></script>
+<script type="text/javascript" charset="utf-8">
+  library = '<%= base_path(router.list_prefix) %>';
+</script>

data/lib/docserver/doc_server/full_list/html/full_list.erb

@@ -0,0 +1,37 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta name="Content-Type" content="text/html; charset=<%= charset %>" />
+    <link rel="stylesheet" href="/css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+    <link rel="stylesheet" href="/css/common.css" type="text/css" media="screen" charset="utf-8" />
+    <script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
+    <script type="text/javascript" charset="utf-8" src="/js/full_list.js"></script>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames';
+      }
+    </script>
+    <div id="content">
+      <h1 id="full_list_header"><%= @list_title %></h1>
+      <div id="nav">
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/features">Features</a> | 
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/tags">Tags</a> | 
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/class">Classes</a> | 
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/methods">Methods</a> |
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/files">Files</a>
+      </div>
+      <div id="search">Search: <input type="text" /></div>
+
+
+      <ul id="full_list" class="<%= @list_class || @list_type %>">
+        <%= erb "full_list_#{@list_type}" %>
+      </ul>
+    </div>
+  </body>
+</html>
+

data/lib/docserver/doc_server/full_list/html/setup.rb

@@ -0,0 +1,18 @@
+include T('default/fulldoc/html')
+
+def init
+  # This is the css class type; here we just default to class
+  @list_class = "class"
+  case @list_type.to_sym
+  when :features; @list_title = "Features"
+  when :tags; @list_title = "Tags"
+  when :class; @list_title = "Class List"
+  when :methods; @list_title = "Method List"
+  when :files; @list_title = "File List"
+  end
+  sections :full_list
+end
+
+def all_features_link
+  linkify YARD::CodeObjects::Cucumber::CUCUMBER_NAMESPACE, "All Features"
+end

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

@@ -0,0 +1,39 @@
+<script type="text/javascript" charset="utf-8">
+$(function() {
+  $(".developer").hide();
+  $(".scenario .title").css('cursor','pointer');
+});
+</script>
+
+<div class="feature">
+  <div class="title">
+    <a id="view" class="control" href="#">[More Detail]</a>
+    <a id="expand" class="control" href="#">[Collapse All]</a>
+    <div style="clear: right;"></div>
+    <span class="pre"><%= @feature.keyword %>:</span>
+    <span class="name"><%= @feature.value %></span>
+  </div>
+
+  <% if @feature.comments.length > 0 %>
+  <div class="comments developer">
+    <%= htmlify_with_newlines @feature.comments %>  
+  </div>
+  <% end %>
+
+  <div class="description">
+    <%= htmlify_with_newlines @feature.description %>
+  </div>
+
+  <div class="meta">
+    <div class="file developer"><%= h(@feature.file) %></div>
+    <div style="clear: right;"></div>
+    <div class="tags developer">
+      <% @feature.tags.each do |tag| %>
+      <a href="<%= url_for tag %>"><%= tag.value %></a>
+      <% end %>
+    </div>
+  </div>
+
+  <%= yieldall %>
+</div>
+

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

@@ -0,0 +1 @@
+<div class="none">No Steps Defined</div>

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

@@ -0,0 +1,42 @@
+<% @scenario.scenarios.each_with_index do |scenario,example_index| %>
+  <div style="display: none;" class="steps <%= "example#{example_index + 1}" %>">
+    <% @scenario_outline = @scenario ; @scenario = scenario ; @steps = scenario.steps %>
+    <%= erb(:steps) %>
+    <% @scenario = @scenario_outline %>
+  </div>
+<% end %>
+
+<div class="outline">
+  
+  <% if @scenario.examples? %>
+  <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>
+    <% unless @scenario.example_data.empty? %>
+      <% @scenario.example_data.each_with_index do |row,row_index| %>
+      <tr class="<%= (row_index + 1) % 2 == 0 ? "even example#{row_index +1}" : "odd example#{row_index +1}" %>">
+        <% row.each_with_index do |column,column_index| %>
+          <td><%= h(column.to_s.strip) %></td>
+        <% end %>
+      </tr>
+      <% end %>
+    <% else %>
+      <!-- Scenario Outline example table is empty -->
+      <tr class="odd">
+        <td colspan="<%= @scenario.example_headers.length %>" style="text-align: center;">
+          No Examples Defined
+        </td>
+      </tr>
+    <% end %>
+  </table>
+  <% else %>
+  <div class="keyword">No Example Table Defined</div>
+  <div class="keyword suggestion developer">[!] Did you mean to create a Scenario?</div>
+  <% end %>
+</div>

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

@@ -0,0 +1,3 @@
+<div class="text">
+  <%= htmlify_with_newlines @step.text %>
+</div>