macros4cuke 0.4.08 → 0.4.09

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjExN2JjMDk1OTE2MDAyODlmNzFlYjU5MjBhNzBjM2U3MTYwNjA1MA==
+    NzVhNDZmNmRmNzk0MDExYTMzOGM2NTVhNzA1OGEyOWNkZmNkZmRjYw==
   data.tar.gz: !binary |-
-    M2NhYzE4ZjkxOGExNGZkODNjYTI0YWEyYTA0MzJiY2I4MzkwNzdjOA==
+    ZmM2MDc4NzJkODk0YzkyZjVlOTdlZGZlMThjZGQzNTg5ODRmOGE5OA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDliNGIyNDBmZjhlOGNjMjg2ZjRhNGRiZWY0NjM2ZTc2N2IzMzUxNTg1Mzgz
-    NGE3OTVkMTM3YzMyMTc1MTQwODk3YjhjMzdhOWQzMmNjNDE5MjE1MjIzOGEx
-    NmY0NjIwM2ExMzBkOTBmNDg1YWMyYTU3YmM1ZWNjOGYwNDYxMjQ=
+    ZGZkZjkxZGRlMzRiMGNkMGVhOWVlZmFlMWIzZTk0YjcyYTYzY2Y5OTU1YzQw
+    NzFiYWE3Nzg1MDg2MThkYzk3NTQ2ODE2MzYzYzMyNGVkMmY4ZGQ5NDYwNWYx
+    MTJjNzViYzVmMjQwOGY4NTM5Yzk4NWE4NmZjZjM5MDYyMTFhNzE=
   data.tar.gz: !binary |-
-    M2QwZjk4ZTA2YTEyYWQxYjNhN2RlNDBkY2M5ZmI0MTM3ODA1YTFkMDQ1MDZl
-    M2UxNTllM2E1MWUyNTBlYjhhMjg0MzFiNDQ1NTExYmQ2N2NhZjdmZTc1MGFj
-    YmNhNzQyMzYyMDMwZTE2Y2Y5ZWQwNmE0ZjJiMThmMzUyMjk4MGI=
+    ZGFiYjI0NWI3ODdmMTcwMzY5ZmNhM2IwYjY2ZWQ2OTBiMWYyOTFkMjdmNjJk
+    YWRhNWMzZTFkYTY2NjkxYTk2OGZiMzY3YjIwY2JkZDZiNTcyOWNiMGQ5ZGE0
+    ZjQyMDA0MzQwZGNkMWU3YmIzOWEzMzMwYjVhNzZhMzUwOGRmYzQ=

data/.rubocop.yml

@@ -36,6 +36,9 @@ EmptyLinesAroundBody:
 
 Encoding:
   Enabled: false
+
+FileName:
+  Enabled: false
   
 IndentationWidth :
   Enabled: false

data/.travis.yml

@@ -6,6 +6,12 @@ rvm:
   - 1.9.2
   - jruby-19mode
   - jruby-head
+  - rbx
+
+# Workaround issue of jruby-19mode configuration on Travis CI 
+matrix:
+  allow_failures:
+    - rvm: rbx
 
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.4.09 / 2014-03-13
+* [CHANGE] Updated source files to comply to Rubocop 0.19.
+* [CHANGE] File `.rubocop.yml`: Disabled FileName cop.
+
 ### 0.4.08 / 2014-02-08
 * [NEW] Added some tutorial material in [Relish] (https://www.relishapp.com/famished-tiger/macros4cuke/docs)
 * [CHANGE] `features` dir and feature files re-designed for publishing on Relish website.

data/README.md

@@ -1,13 +1,14 @@
 Macros4Cuke
 ===========
+_Extend Cucumber with macro-steps._  
+[Homepage](https://github.com/famished-tiger/Macros4Cuke)  
+[Documentation] (https://www.relishapp.com/famished-tiger/macros4cuke/docs)
+
 [![Build Status](https://travis-ci.org/famished-tiger/Macros4Cuke.png?branch=master)](https://travis-ci.org/famished-tiger/Macros4Cuke)
 [![Code Climate](https://codeclimate.com/github/famished-tiger/Macros4Cuke.png)](https://codeclimate.com/github/famished-tiger/Macros4Cuke.png)
 [![Gem Version](https://badge.fury.io/rb/macros4cuke.png)](http://badge.fury.io/rb/macros4cuke)
 [![Dependency Status](https://gemnasium.com/famished-tiger/Macros4Cuke.png)](https://gemnasium.com/famished-tiger/Macros4Cuke)
 
-_Add macros to your Cucumber scenarios._  
-[Homepage](https://github.com/famished-tiger/Macros4Cuke)
-[Documentation] (https://www.relishapp.com/famished-tiger/macros4cuke/docs)
 
 __Macros4Cuke__ is a Cucumber extension that adds a macro facility for your Cucumber scenarios.  
   With it, you can create any new step that replaces a sequence of sub-steps.
@@ -68,6 +69,7 @@ Macros4Cuke not only helps in getting rid of the repeated step sequences,
  that are closer to the business logic.  
 
 See also the working examples in the ```features/``` folder.
+Nicely formatted documentation extracted from these feature files is also available on the [Relish website](https://www.relishapp.com/famished-tiger/macros4cuke/docs)
 
 ## Setup ##
 ### Pre-requisites ###

data/features/{1_Basics → 1_the_basics}/demo01.feature

@@ -27,9 +27,9 @@ Scenario: Let's use the macro we created above
   # The next step verifies that the steps from the macro were effectively executed.
   Then I expect the following step trace:
   """
-Invoked step: ... I landed in the homepage
-Invoked step: ... I click "Sign in"
-Invoked step: ... I fill in "Username" with "johndoe"
-Invoked step: ... I fill in "Password" with "unguessable"
-Invoked step: ... I click "Submit"
+  Given I landed in the homepage
+  When I click "Sign in"
+  And I fill in "Username" with "johndoe"
+  And I fill in "Password" with "unguessable"
+  And I click "Submit"
   """

data/features/{2_Macros_with_arguments → 2_macros_with_arguments}/demo02.feature

@@ -29,11 +29,11 @@ Scenario: Use the macro created above pass it a user id
   # The next step verifies that the steps from the macro were effectively executed.
   Then I expect the following step trace:
   """
-Invoked step: ... I landed in the homepage
-Invoked step: ... I click "Sign in"
-Invoked step: ... I fill in "Username" with "guest"
-Invoked step: ... I fill in "Password" with "unguessable"
-Invoked step: ... I click "Submit"
+  Given I landed in the homepage
+  When I click "Sign in"
+  And I fill in "Username" with "guest"
+  And I fill in "Password" with "unguessable"
+  And I click "Submit"
   """
   
   
@@ -43,9 +43,9 @@ Scenario: Use the macro with another user id
   # The next step verifies that the steps from the macro were effectively executed.
   Then I expect the following step trace:
   """
-Invoked step: ... I landed in the homepage
-Invoked step: ... I click "Sign in"
-Invoked step: ... I fill in "Username" with "me-again"
-Invoked step: ... I fill in "Password" with "unguessable"
-Invoked step: ... I click "Submit"
+  Given I landed in the homepage
+  When I click "Sign in"
+  And I fill in "Username" with "me-again"
+  And I fill in "Password" with "unguessable"
+  And I click "Submit"
   """

data/features/{2_Macros_with_arguments → 2_macros_with_arguments}/demo03.feature

@@ -26,10 +26,10 @@ Scenario: Using the macro with multiple arguments
   # The next step verifies that the steps from the macro were effectively executed.
   Then I expect the following step trace:
   """
-Invoked step: ... I landed in the homepage
-Invoked step: ... I click "Sign in"
-Invoked step: ... I fill in "Username" with "jdoe"
-Invoked step: ... I fill in "Password" with "cosmic"
-Invoked step: ... I click "Submit"
+  Given I landed in the homepage
+  When I click "Sign in"
+  And I fill in "Username" with "jdoe"
+  And I fill in "Password" with "cosmic"
+  And I click "Submit"
   """
 

data/features/{3_Macros_with_table_arguments → 3_macros_with_table_arguments}/demo04.feature

@@ -29,9 +29,9 @@ Scenario: Using the macro we created above
   # The next step verifies that the steps from the macro were effectively executed.
   Then I expect the following step trace:
   """
-Invoked step: ... I landed in the homepage
-Invoked step: ... I click "Sign in"
-Invoked step: ... I fill in "Username" with "guest"
-Invoked step: ... I fill in "Password" with "unguessable"
-Invoked step: ... I click "Submit"
+  Given I landed in the homepage
+  When I click "Sign in"
+  And I fill in "Username" with "guest"
+  And I fill in "Password" with "unguessable"
+  And I click "Submit"
   """

data/features/{3_Macros_with_table_arguments → 3_macros_with_table_arguments}/demo05.feature

@@ -31,8 +31,8 @@ Scenario: Using the macro we created above
   # The next step verifies that the steps from the macro were effectively executed.
   Then I expect the following step trace:
   """
-  Invoked step: ... I fill in "location" with "Nowhere-City"
-  Invoked step: ... I fill in "email" with "nobody@example.com"
-  Invoked step: ... I fill in "comment" with "First comment line<br/>Second comment line<br/>Third comment line"
-  Invoked step: ... I click "Save"
+  And I fill in "location" with "Nowhere-City"
+  And I fill in "email" with "nobody@example.com"
+  And I fill in "comment" with "First comment line<br/>Second comment line<br/>Third comment line"
+  And I click "Save"
   """

data/features/{4_Conditional_steps → 4_conditional_steps}/demo06.feature

@@ -47,13 +47,14 @@ Feature: Define conditional substeps in a macro-step.
     # The next step verifies that the optional steps from the macro were ignored.
     Then I expect the following step trace:
       """
-      Invoked step: ... I fill in "first_name" with "Alice"
-      Invoked step: ... I fill in "last_name" with "Inn"
-      Invoked step: ... I fill in "street_address" with "11, No Street"
-      Invoked step: ... I fill in "zip" with ""
-      Invoked step: ... I fill in "city" with "Nowhere-City"
-      Invoked step: ... I fill in "country" with "Wonderland"
-      Invoked step: ... I click "Save"
+      When I fill in "first_name" with "Alice"
+      And I fill in "last_name" with "Inn"
+      And I fill in "street_address" with "11, No Street"
+      And I fill in "zip" with ""
+      And I fill in "city" with "Nowhere-City"
+      And I fill in "country" with "Wonderland"
+
+      And I click "Save"
       """
     
     
@@ -72,14 +73,15 @@ Feature: Define conditional substeps in a macro-step.
     # The next step verifies that the optional steps from the macro were ignored.
     Then I expect the following step trace:
       """
-      Invoked step: ... I fill in "first_name" with "Alice"
-      Invoked step: ... I fill in "last_name" with "Inn"
-      Invoked step: ... I fill in "street_address" with "11, No Street"
-      Invoked step: ... I fill in "zip" with ""
-      Invoked step: ... I fill in "city" with "Nowhere-City"
-      Invoked step: ... I fill in "country" with "Wonderland"
-      Invoked step: ... I fill in "email" with "alice.inn@wonder.land"
-      Invoked step: ... I fill in "comment" with "No comment!"
-      Invoked step: ... I click "Save"
+      When I fill in "first_name" with "Alice"
+      And I fill in "last_name" with "Inn"
+      And I fill in "street_address" with "11, No Street"
+      And I fill in "zip" with ""
+      And I fill in "city" with "Nowhere-City"
+      And I fill in "country" with "Wonderland"
+      And I fill in "email" with "alice.inn@wonder.land"
+
+        And I fill in "comment" with "No comment!"
+      And I click "Save"
       """
   

data/features/{5_Goodies → 5_goodies}/demo07.feature

@@ -21,9 +21,10 @@ Scenario: Invoking the coarse-grained macro
   # Check that the nested macro still works
   Then I expect the following step trace:
   """
-Invoked step: ... I landed in the homepage
-Invoked step: ... I click "Sign in"
-Invoked step: ... I fill in "Username" with "guest"
-Invoked step: ... I fill in "Password" with "unguessable"
-Invoked step: ... I click "Submit"
+  When I [enter my userid "guest" and password "unguessable"]
+  Given I landed in the homepage
+  When I click "Sign in"
+  And I fill in "Username" with "guest"
+  And I fill in "Password" with "unguessable"
+  And I click "Submit"
   """

data/features/step_definitions/demo_steps.rb

@@ -2,21 +2,22 @@
 # A few step definitions for demo and testing purpose.
 
 When(/^I landed in the homepage$/) do
-  trace_steps << 'Invoked step: ... I landed in the homepage'
+  #trace_steps << 'Invoked step: ... I landed in the homepage'
 end
 
 When(/^I click "([^"]*)"$/) do |element|
-  trace_steps << "Invoked step: ... I click \"#{element}\""
+  #trace_steps << "Invoked step: ... I click \"#{element}\""
 end
 
 
 When(/^I fill in "(.*?)" with "(.*?)"$/) do |element, text|
-  trace_steps << "Invoked step: ... I fill in \"#{element}\" with \"#{text}\""
+  #trace_steps << "Invoked step: ... I fill in \"#{element}\" with \"#{text}\""
 end
 
 
 Then(/^I expect the following step trace:$/) do |step_text|
-  trace_steps.should == step_text.split(/\r?\n|\n/)
+  #trace_steps.should == step_text.split(/\r?\n|\n/)
+  substeps_trace.chomp.should == step_text
 end
 
 

data/lib/macro_steps.rb

@@ -1,5 +1,5 @@
 # File: macro_steps.rb
-# Purpose: step definitions that help to build macro-steps 
+# Purpose: step definitions that help to build macro-steps
 # (i.e. a Cucumber step that is equivalent to a sequence of sub-steps)
 
 require_relative './macros4cuke/macro-collection'
@@ -17,7 +17,7 @@ require_relative './macros4cuke/formatter/to-gherkin'
 #  And I fill in "Password" with "unguessable"
 #  And I click "Submit"
 #  """
-# The regexp has two capturing group: one for the phrase, 
+# The regexp has two capturing group: one for the phrase,
 # a second for the terminating colon (:)
 # The regular expression uses the /x option in order to split it in pieces
 Given(/^I\sdefine\sthe\sstep\s" # Fixed part of defining step
@@ -39,7 +39,7 @@ end
 
 
 # This step is used to invoke a macro-step with a data table argument.
-# Notice the presence of an ending colon character ':' 
+# Notice the presence of an ending colon character ':'
 # after the closing bracket ']'
 # Example:
 #  When I [enter my credentials as]:
@@ -52,7 +52,7 @@ When(/^I \[([^\]]+)\]:$/) do |macro_phrase, table_argument|
   end
 
   # This will call the macro with the given phrase.
-  # The second argument consists of an array 
+  # The second argument consists of an array
   # with couples of the kind: [argument name, actual value]
   invoke_macro(macro_phrase, table_argument.raw)
 end
@@ -60,13 +60,13 @@ end
 
 # This step will list all the encountered macro-step definitions
 # and will collect them in a single feature file.
-# the file is saved in the current working directory 
+# the file is saved in the current working directory
 # when Cucumber is closing down.
 When(/I want to list all the macros in the file "([^"]+)"$/) do |filepath|
   at_exit do
     output = File.open(filepath, 'w')
     formatter = Macros4Cuke::Formatter::ToGherkin.new(output)
-    
+
     service = Macros4Cuke::FormattingService.new
     service.register(formatter)
     service.start!(Macros4Cuke::MacroCollection.instance)

data/lib/macros4cuke/coll-walker-factory.rb

@@ -21,7 +21,7 @@ class CollWalkerFactory
     backlog = collection.macro_steps.values
 
     visitor = Enumerator.new do
-      |result_receiver|	# 'result_receiver' is a Yielder
+      |result_receiver| # 'result_receiver' is a Yielder
       loop do
         case current_node
           when MacroCollection
@@ -81,36 +81,36 @@ class CollWalkerFactory
       theBacklog.unshift(elem)
     end
   end
-  
+
   # Generate an on_step event
-  def emit_on_step(current_node, nesting_level, backlog)  
+  def emit_on_step(current_node, nesting_level, backlog)
     backlog.unshift(StringNode.new(:on_step_end, nil))
     backlog.unshift(current_node.renderer)
     # Does the step use a table argument?
     use_table = current_node.key =~ /_T$/ ? true : false
     backlog.unshift(StringNode.new(:on_phrase, current_node.phrase, use_table))
-    
+
     return [:on_step, nesting_level, current_node]
   end
-  
+
   # Generate an on_renderer event
   def emit_on_renderer(current_node, nesting_level, backlog)
     backlog.unshift(StringNode.new(:on_renderer_end, nil))
     add_children(current_node.representation, backlog)
     backlog.unshift(StringNode.new(:on_source, current_node.source))
-          
-    return [:on_renderer, nesting_level, current_node]      
+
+    return [:on_renderer, nesting_level, current_node]
   end
-  
-  
+
+
     # Generate an on_section event
   def emit_on_section(current_node, nesting_level, backlog)
     backlog.unshift(StringNode.new(:on_section_end, nil))
     add_children(current_node.children, backlog)
-          
-    return [:on_section, nesting_level, current_node.name]     
+
+    return [:on_section, nesting_level, current_node.name]
   end
-  
+
 
 
 

data/lib/macros4cuke/constants.rb

@@ -3,7 +3,7 @@
 
 module Macros4Cuke # Module used as a namespace
   # The version number of the gem.
-  Version = '0.4.08'
+  Version = '0.4.09'
 
   # Brief description of the gem.
   Description = 'Macro-steps for Cucumber'
@@ -11,14 +11,14 @@ module Macros4Cuke # Module used as a namespace
   # Constant Macros4Cuke::RootDir contains the absolute path of Macro4Cuke's
   # root directory. Note: it also ends with a slash character.
   unless defined?(RootDir)
-  # The initialisation of constant RootDir is guarded in order 
+  # The initialisation of constant RootDir is guarded in order
   # to avoid multiple initialisation (not allowed for constants)
 
     # The root folder of Macros4Cuke.
     RootDir = begin
-      require 'pathname'	# Load Pathname class from standard library
+      require 'pathname' # Load Pathname class from standard library
       rootdir = Pathname(__FILE__).dirname.parent.parent.expand_path
-      rootdir.to_s + '/'	# Append trailing slash character to it
+      rootdir.to_s + '/' # Append trailing slash character to it
     end
   end
 end # module

data/lib/macros4cuke/formatter/all-notifications.rb

@@ -7,19 +7,19 @@ module Formatter
 
   # The list of all formatting notifications
   AllNotifications = [
-    :on_collection, 
-    :on_collection_end, 
-    :on_step, 
+    :on_collection,
+    :on_collection_end,
+    :on_step,
     :on_step_end,
-    :on_phrase, 
-    :on_renderer, 
+    :on_phrase,
+    :on_renderer,
     :on_renderer_end,
-    :on_source, 
+    :on_source,
     :on_static_text,
-    :on_eol, 
+    :on_eol,
     :on_comment,
     :on_placeholder,
-    :on_section, 
+    :on_section,
     :on_section_end
     ]
 

data/lib/macros4cuke/formatter/to-gherkin.rb

@@ -51,12 +51,12 @@ class ToGherkin
   def on_phrase(aLevel, aPhraseText, useTable)
     suffix = useTable ? ':' : ''
     io.print "#{indentation(aLevel)}Given I define the step "
-    io.puts %Q|"* I [#{aPhraseText}]#{suffix}" to mean:|
+    io.puts %Q("* I [#{aPhraseText}]#{suffix}" to mean:)
   end
 
   def on_source(aLevel, aSourceText)
     ljust = indentation(aLevel)
-    triple_quotes = %Q|#{ljust}"""|
+    triple_quotes = %Q(#{ljust}""")
     io.puts triple_quotes
 
     # Indent source text

data/lib/macros4cuke/formatter/to-null.rb

@@ -20,11 +20,11 @@ class ToNull
   def implements()
     return Formatter::AllNotifications
   end
-  
+
   def on_collection(aLevel, aMacroCollection)
     ; # Do nothing
   end
-  
+
   def on_collection_end(aLevel)
     ; # Do nothing
   end
@@ -32,7 +32,7 @@ class ToNull
   def on_step(aLevel, aMacroStep)
     ; # Do nothing
   end
-  
+
   def on_step_end(aLevel)
     ; # Do nothing
   end
@@ -44,7 +44,7 @@ class ToNull
   def on_renderer(aLevel, aRenderer)
     ; # Do nothing
   end
-  
+
   def on_renderer_end(aLevel)
     ; # Do nothing
   end
@@ -52,27 +52,27 @@ class ToNull
   def on_source(aLevel, aSourceText)
     ; # Do nothing
   end
-  
+
   def on_static_text(aLevel, aText)
     ; # Do nothing
   end
-  
+
   def on_comment(aLevel, aComment)
     ; # Do nothing
   end
-  
+
   def on_eol(aLevel)
     ; # Do nothing
   end
-  
+
   def on_placeholder(aLevel, aPlaceHolderName)
     ; # Do nothing
   end
-  
+
   def on_section(aLevel, aSectionName)
     ; # Do Nothing
   end
-  
+
   def on_section_end(aLevel)
     ; # Do Nothing
   end