yard-cucumber2 2.3.3

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+
+task :default => :gendoc
+
+desc "Clean out any existing documentation"
+task :clean do
+  `rm -rf doc`
+  `rm -rf .yardoc`
+end
+
+desc "Generate documentation from the example data"
+task :gendoc => :clean do
+  puts `yardoc -e ./lib/yard-cucumber.rb 'example/**/*' --debug`
+end
+
+desc "Run the YARD Server"
+task :server => :gendoc do
+  puts `yard server -e ./lib/yard-cucumber.rb`
+end
+
+desc "Create the yard-cucumber gem"
+task :gem do
+  puts `gem build city.gemspec`
+end
+

data/example/README.md

@@ -0,0 +1,8 @@
+This collection of features are really just to test some of the varied cases
+that CITY may come in contact with while parsing a series of features.  All
+of the features, tags, and directories displayed here are contained in this 
+directory and all subdirectories.
+
+* First, the features which are broken down alphabetically and displayed
+* Second, the tags, used by all the features and scenarios
+* Third, the subdirectories, contained in this directory and in the subdirectories.

data/example/child_feature/README.md

@@ -0,0 +1,21 @@
+Child Features
+==============
+
+Synopsis
+--------
+
+This collection of features are contained in this folder.  The description README
+allows a user to place a description for entire directory of the features and appears
+in the output to assist with understanding about the collection of features.
+
+Resources
+---------
+
+Links to particular resources like the links to the stories, tasks, or other areas
+can also be represented.
+
+The implemented example has been deployed at [http://recursivegames.com/cukes/](http://recursivegames.com/cukes/).
+
+**1. An Item** [example](http://recursivegames.com/cukes/requirements/)
+
+

data/example/child_feature/child.feature

@@ -0,0 +1,11 @@
+@scenarios
+Feature: Child Feature
+  As a reader of the documentation I expect that scenario are documented correctly
+
+  Background:
+    Given this background step
+
+  Scenario: Child Scenario
+    Given this first step
+	  When this second step
+	  Then this third step

data/example/child_feature/grandchild_feature/grandchild.feature

@@ -0,0 +1,12 @@
+@scenarios
+Feature: Grandchild Feature
+  As a reader of the documentation I expect that scenario are documented correctly
+
+  Background:
+    Given this background step
+
+  @first
+  Scenario: Grandchild Scenario
+    Given this first step
+  	When this second step
+	  Then this third step

data/example/empty.feature

@@ -0,0 +1,2 @@
+# This is a feature that has not been written
+# However, I don't want parser to fail when reaching this file

data/example/french.feature

@@ -0,0 +1,18 @@
+# language: fr
+Fonctionnalité: Addition
+  Afin de gagner du temps lors du calcul de la facture
+  En tant que commerçant
+  Je souhaite pouvoir faire une addition
+
+  Plan du Scénario: Addition de deux nombres
+    Soit une calculatrice
+    Et que j'entre <a> pour le premier nombre
+    Et que je tape sur la touche "+"
+    Et que j'entre <b> pour le second nombre
+    Lorsque je tape sur la touche "="
+    Alors le résultat affiché doit être <somme>
+
+    Exemples:
+      | a | b | somme |
+      | 2 | 2 | 4     |
+      | 2 | 3 | 5     |

data/example/scenario.feature

@@ -0,0 +1,63 @@
+# Comments that appear before the feature are associated with the feature
+@scenarios
+Feature: Displaying Scenarios
+  As a reader of the documentation I expect that scenario are documented correctly
+  
+  # Comments after the feature description belong to the background or first scenario
+  Background:
+    Given this background step
+
+  @first @bvt
+  Scenario: No Step Scenario
+
+  @second @bvt
+  Scenario: Scenario With Steps
+    Given this first step
+	When this second step
+	Then this third step
+	
+  @third @optional_parameters
+  Scenario: Optional Parameter Step Definition
+    # This step definition has some optional parameters
+    Given a project
+    And an inactive project
+    And a project with the name 'optional', start date 10/26/2010, nicknamed 'norman'
+
+  @fourth @highlight
+  Scenario: Matched Term Highlighting
+    Given a duck that has a bill
+    Then I expect the duck to quack
+
+  @fifth @table
+  Scenario: Scenario With Table
+    Given the following table:
+      | column 1 | column 2 | column 3 |
+      | value 1  | value 2  | value 3  |
+
+  @sixth @text
+  Scenario: Scenario With Text
+    Given the following text:
+    """
+    Oh what a bother!
+    That this text has to take up two lines
+      This line should be indented 2 spaces
+        This line should be indented 4 spaces      
+    """
+
+  # Comments before the scenario
+  @seventh @comments
+  Scenario: Scenario with comments and a description
+    There once was a need for information to be displayed alongside all the
+    entities that I hoped to test
+    # First Comment
+    Given this first step
+    # Second Comment that
+    # spans a few lines
+    And this second step
+    # Third Comment
+    And this third step
+    # Comments after the last step, where do they go?
+
+  Scenario: Step ending with a match with double-quotes
+    When searching the log for the exact match of the message "Entering application."
+    When the step definition has HTML escaped characters like: "<>&"

data/example/scenario_outline.feature

@@ -0,0 +1,94 @@
+@scenario_outlines @bvt
+Feature: Displaying Scenario Outlines
+  As a reader of the documentation I expect that scenario outlines are documented correctly
+
+  @first
+  Scenario Outline: Three Examples
+    Given that <Customer> is a valid customer
+    And that the product, named '<Product>', is a valid product
+    When the customer has purchased the product
+    Then I expect the customer to be a member of the '<Product>' group
+
+    Examples:
+     | Customer   | Product   |
+     | Customer A | Product A |
+     | Customer A | Product B |
+     | Customer A | Product C |
+
+  @second
+  Scenario Outline: Step contains a text block
+    Given the following text:
+    """
+    The <noun> jumped over the <place>
+    """
+    When I click on an example row
+ 	  Then I expect <noun> to be replaced by the example noun
+    And I expect <place> to be replaced by the example place
+    
+    Examples:
+     | noun  | place |
+     | cow   | moon  |
+     | horse | spoon |
+
+  @third
+  Scenario Outline: Step contains a table
+    Given the following table:
+      | name   | price   | quantity |
+      | <name> | <price> | 100000   |
+    When I click on an example row
+ 	  Then I expect <name> to be replaced by the example name
+    And I expect <price> to be replaced by the example price
+
+    Examples:
+     | name | price |
+     | toy  | $99   |
+     | game | $49   |
+
+  @fourth
+  Scenario Outline: Step contains a table; table header uses an example
+    Given the following table:
+      | name   | <denomination> | quantity |
+      | <name> | <price>        | 100000   |
+	  When I click on an example row
+    Then I expect <name> to be replaced by the example name
+    And I expect <price> to be replaced by the example price
+    And I expect <denomination> to be replaced by the example denomination
+
+    Examples:
+     | name | price | denomination    |
+     | toy  | 99    | cost in euros   |
+     | game | 49    | cost in dollars |
+     
+  # This is an example of a scenario outline in development.
+  # The example table has not been defined yet
+  Scenario Outline: Example Table Missing
+    When I click on an example row
+    Then I expect <name> to be replaced by the example name
+    And I expect <price> to be replaced by the example price
+    And I expect <denomination> to be replaced by the example denomination
+      
+    
+  # This is an example of a scenario outline in development.  
+  # The examples table has been defined, but is missing data.
+  Scenario Outline: Empty Example Table
+    When I click on an example row
+    Then I expect <name> to be replaced by the example name
+    And I expect <price> to be replaced by the example price
+    And I expect <denomination> to be replaced by the example denomination
+    
+    Examples:
+      | name | price | denomination |
+
+  Scenario Outline: Multiple Example Table
+    Given that <Customer> is a valid customer
+    And that the product, named '<Product>', is a valid product
+    When the customer has purchased the product
+    Then I expect the customer to be a member of the '<Product>' group
+
+    Examples: Example group A
+     | Customer   | Product   |
+     | Customer A | Product A |
+
+    Examples: Example group B
+     | Customer   | Product   |
+     | Customer B | Product A |

data/example/scenario_outline_multi.feature

@@ -0,0 +1,15 @@
+Feature: My Feature
+
+Scenario Outline: Multiple Example Table
+  Given that <Customer> is a valid customer
+  And that the product, named '<Product>', is a valid product
+  When the customer has purchased the product
+  Then I expect the customer to be a member of the '<Product>' group
+
+  Examples: Example group A
+   | Customer   | Product   |
+   | Customer A | Product A |
+
+  Examples: Example group B
+   | Customer   | Product   |
+   | Customer B | Product A |

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|
+  puts "step #{order}"
+end

data/example/step_definitions/french_steps.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+Soit /^une calculatrice$/ do
+  @calc = Calculatrice.new
+end
+
+Etantdonné /^qu'on tape (.*)$/ do |n|
+  @calc.push n.to_i
+end
+
+Etantdonné /^que j'entre (\d+) pour le (.*) nombre/ do |n, x|
+  @calc.push n.to_i
+end
+
+Lorsque /^je tape sur la touche "="$/ do
+  @expected_result = @calc.additionner
+end
+
+Lorsqu /on tape additionner/ do
+  @expected_result = @calc.additionner
+end
+
+Alors /le résultat affiché doit être (\d*)/ do |result|
+  result.to_i.should == @expected_result
+end
+
+Alors /le résultat doit être (\d*)/ do |result|
+  result.to_i.should == @expected_result
+end
+
+Soit /^que je tape sur la touche "\+"$/ do
+  # noop
+end