macros4cuke 0.2.02 → 0.2.04

data/HISTORY.md

@@ -1,8 +1,16 @@
+## [0.2.04]
+### Fixes:
+* Class MacroCollection#add_macro: typo correction.
+
+## [0.2.03]
+### Changes:
+* Regexp of defining step is more general: it accepts the Gherkin adverbs Given, When, Then, And.
+
+
 ## [0.2.02]
 ### Changes:
 * Added an example in template-engine_spec.rb file. 
 
-
 ### Documentation:
 * Expanded the README.md file.
 

data/README.md

@@ -4,11 +4,10 @@ Macros4Cuke
 _Add macros to your Cucumber scenarios._  
 [Homepage](https://github.com/famished-tiger/Macros4Cuke)
 
-__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.
-
+__Macros4Cuke__ is a lightweight library that adds a macro facility your Cucumber scenarios.  
+  In short, you can create any new step that replaces a sequence of lower-level steps.
+  All this can be done directly in your feature files without programming step definitions.
+ 
 ### Highlights ###
 * Works with out-of-the-box Cucumber
 * Simple installation and setup (no programming required),
@@ -37,7 +36,7 @@ That macro-step can then be used in a scenario like this:
   When I [enter my userid "jdoe" and password "hello-world"]
 ```
 
-When it is executed, the last macro-step (invokation) as the same effect as:  
+Once it is executing, the macro-step as the same effect as:  
 ```cucumber 
   Given I landed in the homepage  
   When I click "Sign in"  
@@ -85,15 +84,29 @@ That's it! Now you can start writing macros in your Cucumber project.
 
 ## Getting started ##
 Working with a macro-step is a two-stages process:  
-1. First, the definition of a new macro-step  
-2. Second, the use of that macro-step in a scenario.
+1. Defining a new macro-step  
+2. Using that macro-step in a scenario.
 
-Let's begin by taking a closer look at the definition step.
+Let's begin by taking a closer look at the definition part.
 ### Defining a macro-step ###
-There are three questions to keep in mind when creating a new macro-step:  
-1. What is its syntax?  
-2. What are its substeps?     
-3. Does it need arguments?  
+To create a macro-step, you'll need to use a _defining_ step bundled with Macros4Cuke.
+It is a rather unusual Cucumber step in the sense that its sole purpose is to build another step!  
+The defining step follows the general pattern:
+```cucumber
+  Given I define the step "When I [some phrase]" to mean:  
+  """  
+  # A sequence of sub-steps comes here
+  """  
+```
+
+The defining step has two key components:  
+1. The quoted sentence ```"When I [some phrase]"```. That part
+ specifies the syntax of your future macro-step.  
+2. The multiline text enclosed between the triple quotes (""") and immediately follows the
+ the defining step. It is the place where the sub-steps are listed.
+
+These points are detailed 
+
 
 #### Specifying the syntax of a macro-step ####
 Let's begin with a simple example: 
@@ -164,9 +177,13 @@ enumerates the sub-steps associated with the macro-step. A pleasing aspect is th
   And I click "Sign in"  
   """  
 ``` 
- 
+TODO
+ There are three questions to keep in mind when creating a new macro-step:  
+1. What is its syntax?  
+2. What are its substeps?     
+3. Does it need arguments?  
 ---
 
 Copyright
 ---------
-Copyright (c) 2013, Dimitri Geshef. See [LICENSE.txt](https://github.com/famished-tiger/Macros4Cuke/blob/master/LICENSE.txt) for details.
+Copyright (c) 2013, Dimitri Geshef. Macros4Cuke is released under the MIT License see [LICENSE.txt](https://github.com/famished-tiger/Macros4Cuke/blob/master/LICENSE.txt) for details.

data/lib/macro_steps.rb

@@ -13,8 +13,7 @@
 #  And I fill in "Password" with "unguessable"
 #  And I click "Submit"
 #  """
-
-Given(/^I define the step "When I \[((?:[^\\\]]|\\.)+\]:?)" to mean:$/) do |macro_phrase, template|
+Given(/^I define the step "(?:When|Given|Then|And) I \[((?:[^\\\]]|\\.)+\]:?)" to mean:$/) do |macro_phrase, template|
   add_macro(macro_phrase, template)
 end
 

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.2.02'
+	Version = '0.2.04'
   
   Description = "Macros for Cucumber"
 	

data/lib/macros4cuke/macro-collection.rb

@@ -38,10 +38,7 @@ public
     # Prevent collision of macros (macros with same phrase).
     # This can occur if a macro was defined in a background section.
     # An exception is raised if the phrase syntax of both macros are the     
-    if find_macro(aPhrase)
-      pp find_macro(aPhrase)
-      raise DuplicateMacroError.new(aPhrase)
-    end
+    raise DuplicateMacroError.new(aPhrase) if find_macro(aPhrase)
     
     @macro_steps[new_macro.name] = new_macro    
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.2.02
+  version: 0.2.04
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-26 00:00:00.000000000 Z
+date: 2013-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,10 +59,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.00'
-description: ! "\tMacros4Cuke is a lightweight library that adds a macro facility
-  your Cucumber scenarios.\n  In short, you can create any new step that replaces
-  a sequence of lower-level steps.\n  All this can be done directly in your feature
-  files without programming step definitions.\n"
+description: Create your own macros in your Cucumber scenarios.
 email: famished.tiger@yahoo.com
 executables: []
 extensions: []