macros4cuke 0.3.35 → 0.3.37

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTZmMjEwNjcwZGI3OTBhMTgxZmYzY2M2MDg1ZWI2YjVhNGFhZTkyZQ==
+    NGI3ZmQ3ZjBhZjE1MjY0ZTNkNmQ3YzVlZDdiZGUxMzJmZGViNzVhNA==
   data.tar.gz: !binary |-
-    NzM5YWMyYjM3MzY0NjkxMjNhZmUwMjlkYjBlZmRmYzU3ODY5MDg0ZA==
+    OGM1ZTRjNzUyNGZmYTNhYmMxZDYwM2ViNGYxNDc3NTA1YWYzZDMzMA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTkzNWQ5MjQyYmRkY2I3NzA4MzM4YTc0ZWNlZDlhOGRhZGZjNjU4NDgwY2Zj
-    ZjQzNzI2ZDA3MTYyN2VjODZmZjY2NDM3OTJlNzZiY2FkZWNkMzczMTkxOGM2
-    YjE5Y2VkZTJkOTUwMWRkYzRmN2EyYzMwODBhZGI2MThlYjVmM2Q=
+    MmQ3MjM3ZWU4MjVmZjg0NmMwOWQyYWRkMjBiNjMxYmYyZjdhNDI1NzhlMzRk
+    ODAyMDdlM2NkOGZmZjVjM2YwMDE4NDMyNjVmNzNiMTAwMDMxNDM3NjZjZjQz
+    YTFhZWRkZTFiZDlkNTQwNjhhYjVlYjJjYzg4YTUxMzc2MjA4OWY=
   data.tar.gz: !binary |-
-    YjEyODc4ODlhMTk1ZjAwZGQyMzZmMTVmNjdjMjNkZTFlNjI1OGU2OWFhNjRi
-    MjQ5ZDZmNDk0NDVkZTQ0YTk4MTEyOWRlNTRiNTEwOWNjZmYyODQyZWU1YWY3
-    ZDA4OTY3NWFlMmFmZGJjOWYyOWMxYzJlOTZkYjYzODE2NzNhZTI=
+    YWZjMWJkOThhMjIxMDVjNzYyNmI3ZTM0NzM1ZTQwYmQ1Nzk3ZmY4YWE3M2Y0
+    ODQzMzk0YjZmZjM0MzJhNTU1MTQ3MmM4NWMxMzc4MDgzY2QyOWE4N2IwYmYz
+    ZjRkZjE1ZTNmZTMyOTIzOTQxMWFhMTU2MDM3M2Q5OTlkNTU3ZTE=

data/.yardopts

@@ -1,4 +1,4 @@
---exclude features
+--exclude examples --exclude features --exclude spec
 --no-private
 --markup markdown
 -

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 0.3.37 / 2013-06-27
+* [FIX] File `macros4cuke.gemspec`: added README.md in extra_rdoc_files option.
+* [CHANGE] File `README.md`: Re-formatting so that it is better rendered with darkfish (from YARD).
+* [CHANGE] File `.yardopts` : grouped the exclude options on one line. 
+
+### 0.3.36 / 2013-06-27
+* [FIX] File `macros4cuke.gemspec`: corrected the rdoc_options to exclude doc from examples, features and spec folders.
+  This was necessary because all but the latest versions of RDoc have difficulties to cope with utf-8.
+* [CHANGE] File `.yardopts` : added more folders to exclude from documentation generation. 
+
 ### 0.3.35 / 2013-06-27
 * [CHANGE] File `macros4cuke.gemspec`: added rdoc_options to exclude doc from examples, features and spec folders.
   This was necessary because all but the latest versions of RDoc have difficulties to cope with utf-8. 

data/README.md

@@ -23,6 +23,7 @@ __Macros4Cuke__ is a lightweight library that adds a macro facility your Cucumbe
 
 ## A quick example ##
 Here is a macro-step example taken from our demo files:  
+
 ```cucumber
     Given I define the step "When I [enter my userid <userid> and password <password>]" to mean:  
     """  
@@ -41,11 +42,13 @@ the macro-step is invoked(used) elsewhere in a feature file.
 
 
 That macro-step can then be used in a scenario like this:  
+
 ```cucumber 
     When I [enter my userid "jdoe" and password "hello-world"]
 ```
 
 Once it is executing, the macro-step as the same effect as:  
+
 ```cucumber 
     Given I landed in the homepage  
     When I click "Sign in"  
@@ -107,6 +110,7 @@ Let's begin by taking a closer look at the definition part.
 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:  
   """  
@@ -139,6 +143,7 @@ A few remarks about the __phrase__ part:
 Besides that, the text inside the phrase can be arbitrary (well, almost).
 
 A phrase can be without argument as in:  
+
 ```cucumber
   # A phrase without argument
   [enter my credentials]
@@ -146,6 +151,7 @@ A phrase can be without argument as in:
   
 Alternatively, a phrase can have one or more arguments enclosed between chevrons <...>.
 For instance, the next first phrase has two arguments, the second has three arguments:  
+
 ```cucumber
   [enter my <userid> and <password>]
   [travel from <origin> to <destination> via <waypoint>]
@@ -159,6 +165,7 @@ the argument names are: _origin_ and _destination_. Notice that _origin_ and _de
 #### Specifying the sub-steps of a macro-step ####
 The sub-steps are placed in a Gherkin multiline text, that is, a text that is enclosed between 
  triple quotes ("""). In the next example,  
+
 ```cucumber 
   Given I define the step "When I [enter my credentials]" to mean:  
   """  
@@ -173,6 +180,7 @@ the text between triple quotes enumerates the sub-steps associated with the macr
  A pleasing aspect is the familiar syntax the sub-steps have: they closely look to genuine steps of a scenario.  
 Sub-steps can also have macro arguments. 
  For instance, the previous step sequence could have two arguments called _userid_ and _password_:  
+ 
 ```cucumber  
   """  
   Given I landed in the homepage   
@@ -190,6 +198,7 @@ The syntax rules for using a given macro-step in a scenario are pretty straightf
 
 #### Example 1: ####
 Consider the following macro-step definition:  
+
 ```cucumber
   Given I define the step "When I [log in as <userid>]" to mean: 
   """
@@ -199,6 +208,7 @@ Consider the following macro-step definition:
 
 Its quoted sentence is ```"When I [log in as <userid>]"```, therefore
  the macro-step can be invoked in a scenario like this:  
+ 
 ```cucumber
   Given I do this ...
   When I [log in as "jdoe"]
@@ -207,6 +217,7 @@ Its quoted sentence is ```"When I [log in as <userid>]"```, therefore
 
 #### Example 2: ####
 Here is another -partial- macro-step definition:  
+
 ```cucumber
   Given I define the step "When I [travel from <origin> to <destination> via <stop>]" to mean: 
   """
@@ -215,6 +226,7 @@ Here is another -partial- macro-step definition:
 ```
 
 This macro-step can occur in a scenario as:  
+
 ```cucumber
   When I [travel from "San Francisco" to "New-York" via "Las Vegas"]
 ```
@@ -231,6 +243,7 @@ To enable this mechanism for a given macro, ensure that in its definition the qu
 a terminating colon (:) character.
 
 The next example is based on one of the demo feature files:  
+
 ```cucumber
   # Next step has a colon ':'  after the ']': data can be passed with a table
   Given I define the step "When I [enter my address as follows]:" to mean:
@@ -245,6 +258,7 @@ The next example is based on one of the demo feature files:
 ```
 
 This step can be used like this:  
+
 ```cucumber
   When I [enter my address as follows]:"  
   |lastname|Doe|  
@@ -273,6 +287,7 @@ __\!"'\#$%\&\*\+\-/,\.\:\;\=\?\(\)\<\>\[\]\{\}\\\^\`\|\~__
 ### Assigning a value to an argument ###
 An argument appearing in the phrase MUST always be bound to a value at the step invokation.
 Taking again a previous example of a -partial- macro-step definition:  
+
 ```cucumber
   Given I define the step "When I [travel from <origin> to <destination> via <stop>]" to mean: 
   """
@@ -281,12 +296,14 @@ Taking again a previous example of a -partial- macro-step definition:
 ```
 
 The following step invokation is invalid:  
+
 ```cucumber
   When I [travel from "San Francisco" to via "Las Vegas"]
 ```
 
 The issue is: the destination value is missing, Macros4Cuke won't be able to find a step with that syntax.  
 The next invokation is syntactically correct for Macros4Cuke:  
+
 ```cucumber
   When I [travel from "San Francisco" to "" via "Las Vegas"]
 ```
@@ -304,6 +321,7 @@ For any argument that can receive a value through a data table, three situations
 - __Answer__: Yes but there is a catch.
 
 Consider the following attempt of a macro-step definition:  
+
 ```cucumber
   Given I define the step "* I [make a long journey]" to mean:
   """
@@ -327,6 +345,7 @@ is set to a triple quote sequence """.
 - Use it everywhere you want to place nested triple quotes.
 
 Thus to make the previous example work, one must change it like follows:  
+
 ```cucumber
   Given I define the step "* I [make a long journey]" to mean:
   """
@@ -342,7 +361,8 @@ Thus to make the previous example work, one must change it like follows:
 
 ## Conditional sections in substeps. ##
 To make the macros more flexible, it is possible to define conditional sections in the substep sequence.  
-The general pattern for the conditional section is:  
+The general pattern for the conditional section is: 
+ 
 ```cucumber
   <?foobar>
   substep1
@@ -376,7 +396,8 @@ Consider the following example:
   """
 ```
 
-When invoked like this:  
+When invoked like this:
+  
 ```cucumber
   When I [fill in the form with]:
   |firstname     |Alice|

data/lib/macros4cuke/constants.rb

@@ -3,7 +3,7 @@
 
 module Macros4Cuke # Module used as a namespace
   # The version number of the gem.
-  Version = '0.3.35'
+  Version = '0.3.37'
 
   # Brief description of the gem.
   Description = 'Macros for Cucumber'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.3.35
+  version: 0.3.37
 platform: ruby
 authors:
 - Dimitri Geshef
@@ -84,7 +84,8 @@ description: Create your own macro-steps directly in Cucumber scenarios.
 email: famished.tiger@yahoo.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - .rubocop.yml
 - .rspec
@@ -151,7 +152,7 @@ post_install_message: ! '~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 '
 rdoc_options:
-- --exclude=examples --exclude=features --exclude=spec
+- --exclude="examples|features|spec"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement