macros4cuke 0.1.02 → 0.1.03

data/HISTORY.md

@@ -1,3 +1,11 @@
+## [0.1.03]
+### Documentation
+* README.md: slightly reworked and added link to Mustache.  
+### Changes:
+* env.rb: All dependencies on Macros4Cuke were moved to the file macro_support.rb
+* travelling-demo.feature: Demo feature file with output on the screen (the other demos don't display any result).
+
+
 ## [0.0.02]
 ### Documentation
 * In README: added a reference to the features folder.

data/README.md

@@ -1,17 +1,24 @@
 Macros4Cuke
 ===========
 
-## Add macros to your Cucumber feature files. ##
+_Add macros to your Cucumber scenarios._  
 [Homepage](https://github.com/famished-tiger/Macros4Cuke)
 
-## What is it? ##
-Macros4Cuke gives you to ability to define a new Cucumber (macro-)step directly in a feature file
- and to associate with it a sequence of steps to execute when the macro-step is used in 
- a scenario.
+__Macros4Cuke__ gives you the opportunity to factor out repeated steps
+ in your Cucumber scenarios. You can create (macro-)steps directly in feature files.   
+To each macro-step, it is possible to associate a sequence of sub-steps
+ that will be executed every time a macro-step occurs in a scenario.
 
-## How can create such a macro? ##
-Here follows an example taken from our demo files:
+### Highlights ###
+* Works with out-of-the-box Cucumber
+* Simple installation and setup (no programming required),
+* Substep sequence can be of arbitrary length,
+* Macro-steps may have data arguments,
+* Data values can be passed to the sub-steps.
 
+## Synopsis ##
+Here is an example taken from our demo files:  
+```cucumber
   Given I define the step "When I [enter my userid {{userid}} and password {{password}}]" to mean:  
   """  
   Given I landed in the homepage  
@@ -20,35 +27,45 @@ Here follows an example taken from our demo files:
   And I fill in "Password" with "{{password}}"  
   And I click "Submit"  
   """  
-  
-That macro step  can be used in a scenario like this:  
-  When I [enter my userid "jdoe" and password "hello-world"]
+```
 
+Notice how the arguments are enclosed between curly braces {{..}}. In its current incarnation,
+Macros4Cuke relies on the [Mustache](http://mustache.github.io/mustache.5.html) template engine
+ for generating the sub-steps.
+
+That macro-step can then be used in a scenario like this:  
+```cucumber
+  When I [enter my userid "jdoe" and password "hello-world"]
+```
 
 See also the working examples in the features folder.
 
+## Install and setup ##
+* Step 1: Install the macros4cuke gem:
+```bash  
+gem install macros4cuke
+```
 
-## What do I need to start? ##
-* Install the macros4cuke gem:
-  - gem install macros4cuke
-  
-* In your 'env.rb' file  
-  - 1. Load the modules and classes from the gem:  
-  require 'macros4cuke'
-  
-  
-  - 2. Extend the world object like this:  
-  World(Macros4Cuke::MacroStepSupport)
   
+* Step 2: Add support for macros in your Cucumber project  
+In your /features/support/ folder:    
+  - Create a Ruby file (e.g. 'macro\_support.rb') with the following contents:  
+```ruby
+require 'macros4cuke'  
+
+World(Macros4Cuke::MacroStepSupport)
+```  
   
-* In your 'step_definitions' folder
-  - 3. Import the macro-management steps.  
-  Create a ruby file (say, 'use_macro_steps.rb').  
-  Add the following line:  
-  require 'macros4cuke/../macro_steps'
+* Step 3: Import the macro-management steps  
+In your /features/step_definitions/ folder:  
+  - Create a ruby file (say, 'use\_macro\_steps.rb') with the following line:  
+```ruby  
+require 'macros4cuke/../macro_steps'
+```  
   
-  Your can start writing macros in your Cucumber project.
+Now, you can start writing macros in your Cucumber project.
 
+---
 
 Copyright
 ---------

data/features/step_definitions/demo_steps.rb

@@ -21,17 +21,21 @@ end
 
 
 When(/^I leave (.+)$/) do |city|
-  trace_steps << %Q|Invoked step: ... I leave #{city}|
+  show "I leave #{city}"
 end
 
 
 When(/^I visit (.+)$/) do |city|
-  trace_steps << %Q|Invoked step: ... I visit #{city}|
+ show "I visit #{city}"
 end
 
 
 When(/^I arrive in (.+)$/) do |city|
-  trace_steps << %Q|Invoked step: ... I arrive in #{city}|
+  show "I arrive in #{city}"
+end
+
+When(/^I type (.+)$/) do |text|
+  show text
 end
 
 

data/features/support/env.rb

@@ -4,16 +4,13 @@
 # It also demonstrate what to do in your env.rb file to use the Macros4Cuke gem.
 
 
-# Macros4Cuke step one: Load modules and classes from the gem.
-require 'macros4cuke'  
 
+module DemoMacros4Cuke  # Use the module as a namespace
 
-module Macros4Cuke  # Use the module as a namespace
+ 
+# Class created just for testing and demonstration purposes.
+# Its instance, will record the output emitted by the steps.
 
-=begin 
- Class created just for testing and demonstration purposes.
- Its instance, will record the output emitted by the steps.
-=end
 class TracingWorld
   # Will contain the text emitted by the steps
   attr_reader(:trace_steps)
@@ -25,6 +22,11 @@ class TracingWorld
   end
   
 public
+  # Write the given text to the error console
+  
+  def show(someText)
+    $stderr.puts(someText)
+  end
 
   
 end # class
@@ -33,14 +35,8 @@ end # module
 
 # For testing purpose we override the default Cucumber behaviour
 # making our world object an instance of the TracingWorld class
-World { Macros4Cuke::TracingWorld.new }
-
-
-# Macros4Cuke step two: extend the world object with the mix-in module
-# that adds the support for macros in Cucumber.
-World(Macros4Cuke::MacroStepSupport)
+World { DemoMacros4Cuke::TracingWorld.new }
 
-# That's all folks!...
 
 
 # End of file

data/features/support/macro_support.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8	You should see a paragraph character: §
+# File: macro_support.rb
+# Purpose: Add the support for macros in Cucumber.
+# This file is meant to be put next to the 'env.rb' file of your Cucumeber project.
+
+
+# Macros4Cuke step one: Load modules and classes from the gem.
+require 'macros4cuke'
+
+
+# Macros4Cuke step two: extend the world object with the mix-in module
+# that adds the support for macros in Cucumber.
+World(Macros4Cuke::MacroStepSupport)
+
+
+# End of file

data/features/travelling-demo.feature

@@ -0,0 +1,65 @@
+# File: travelling-demo.feature
+
+Feature: Show -visually- the several ways to use macros
+  As a Cuke user
+  So that I enjoy writing scenario.
+
+
+Scenario: Definition of a simple macro-step with two arguments
+  Given I define the step "When I [travel from {{origin}} to {{destination}}]" to mean:
+  """
+  When I leave {{origin}}
+  And I arrive in {{destination}}
+  """
+
+Scenario: Do a simple travel
+  # Call a macro-step defined earlier
+  When I [travel from "Brussels" to "Rome"]
+
+  # You should see the output:
+  # I leave Brussels
+  # I arrive in Rome
+
+
+Scenario: Defining a macro calling other macro(s)
+  Given I define the step "When I [travel from {{origin}} to {{destination}} and back]" to mean:
+  """
+  {{! The next two steps are, in fact, macro-step invokations}}
+  When I [travel from "{{origin}}" to "{{destination}}"]
+  When I [travel from "{{destination}}" to "{{origin}}"]
+  """
+
+Scenario: Do a travel back and forth
+    When I [travel from "Paris" to "London" and back]
+
+  # You should see the output:
+  # I leave Paris
+  # I arrive in London
+  # I leave London
+  # I arrive in Paris
+
+
+Scenario: Defining a macro that requires a data table
+  Given I define the step "When I [fill in the form with]:" to mean:
+  """
+  When I type {{firstname}}
+  And I type {{lastname}}
+  And I type {{street_address}}
+  And I type {{city}}
+  And I type {{country}}
+  """
+
+Scenario: Using a macro-step with a data table
+  When I [fill in the form with]:
+  |firstname| Sherlock|
+  |lastname|Holmes|
+  |street_address| 221B, Baker Street|
+  |city|London|
+  |country|U.K.|
+
+  # You should see the output:
+  # Sherlock
+  # Holmes
+  # 221B, Baker Street
+  # London
+  # U.K.

data/lib/macros4cuke/constants.rb

@@ -3,7 +3,7 @@
 
 module Macros4Cuke # Module used as a namespace
 	# This constant keeps the current version of the gem.
-	Version = '0.1.02'
+	Version = '0.1.03'
   
   Description = "Macros for Cucumber"
 	

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.1.02
+  version: 0.1.03
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -82,9 +82,11 @@ files:
 - features/demo02.feature
 - features/demo03.feature
 - features/demo04.feature
+- features/travelling-demo.feature
 - features/step_definitions/demo_steps.rb
 - features/step_definitions/use_macro_steps.rb
 - features/support/env.rb
+- features/support/macro_support.rb
 homepage: https://github.com/famished-tiger/Macros4Cuke
 licenses: []
 post_install_message: ! '~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~