macros4cuke 0.3.42 → 0.4.00

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2ExZjg4MDU0MGUwOTdjYjRmNGI1Yjg2OTk5MzRhMjM3YWNkZjFmYQ==
+    OGE0ZDcxMWQxOTgxYTljYThhY2ViYzg5NzIxN2E1OTNlMDU2OTk1ZQ==
   data.tar.gz: !binary |-
-    MDgxZTMyMWI5MTU1NzI5NzlmMGU4ZDhiZmY1NjQ4MWEzNDQzMmJkOQ==
+    ZjhmNjQ0NWVlMzVkMWU0N2Y0ZDE2Y2Y1YmNiYWFiMDk1NTdlYjU0Nw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MzlhNDE3NWUwZTYyZDNjMmMxZTVlNWY1NjNhMmY2NjU4ZjQ0YWI1M2Y5MDlh
-    NmNmYTZiNzAwZThhYTM1MWRjYTQ0MmYwMzIyNmRkZmNhOWU1OWFmMTIyZjU1
-    ODMwMDFiODFiNjE0OTljZTlmOWQxOWIyNGU3N2RmOGQ3ZjA0YWI=
+    M2MwYjllOWYxY2QxZDBlYTc0OWJkOGE4ZGQ3N2IwYjJhOGU0MzViMDc2ZWMx
+    ZGQ4N2FhYTU3ZWNjYmJkMjY5NzRiZmFjN2NmYjVjZmQxMDI0NDM2NDkzZjli
+    MWQ2MDlmYzljOWM2NmQzMGRmMDVkYjAwOTYxZDdmY2Q5YjBlNTY=
   data.tar.gz: !binary |-
-    MjczZTNjNGY3YzM0Njk3ZGM4OTBkMDYwNmQ4ZDYyNjg0ZDdlYTU5ZjE3ZThh
-    M2E3YjI1Y2IxYTVjODcyN2UzMzkwYjMyMmY1NmY0YWRmMGQ3ZjgwM2I5NjUw
-    ZGI2NWRkNzZkOTY3YmI4ODE3OWE3ZTY1MDIwM2YyZDlhMDY3ZTY=
+    ZjcyOWZlZWI0ZjU0Yzk4MjJkNGYwODAwMTU3YjE5YTc0N2VlZGZjNzRkZDQ0
+    YjVmYTNmNzhkMWY4ZDNiZmJlNWFiMzQ0NTQ5ZGE5NmM0MmU1MWM3ZTM4Yzhj
+    NDMzMzBlMDllNzg1NGNiN2Y1NzU2NWRkMzMzY2I0Zjk5Yjg5MDM=

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   Excludes:
     - '*/examples/**'
-    - '*/spec/**'
+    - '*/features/**'
 
 
 AccessControl:
@@ -14,21 +14,38 @@ AsciiComments:
 CaseIndentation:
   Enabled: false
 
+ClassLength:
+  Max: 200
+  CountComments: false  
+
 ConstantName:  
   Enabled: false
   
 DefWithParentheses:  
   Enabled: false
   
+Documentation:
+  Enabled: false
+  
 EmptyLines:
   Enabled: false
 
 Encoding:
   Enabled: false
   
-# Avoid methods longer than 30 lines of code
+IndentationWidth :
+  Enabled: false
+  
+# Avoid methods longer than 50 lines of code
 MethodLength:
-  Max: 30
+  Max: 50
+  CountComments: false
+
+NumericLiterals:
+  Enabled: false
+  
+RaiseArgs:
+  Enabled: false
   
 RedundantReturn:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,20 @@
+### 0.4.00 / 2013-11-17 
+#### Version number bumped. New feature: to list all encountered macro definitions into a single feature file.
+* [NEW] Sample `demo07.feature` file illustrates the new step that will list all macro definitions. 
+* [NEW] Class CollWalkerFactory. Creates specialized Enumerators that walk over the macro collection.
+* [NEW] Module Formatter. Purpose: Grouping of all classes that render macro definitions
+* [NEW] File `all-notifications.rb` List of macro collection visit events.
+* [NEW] Class `ToGherkin` A macro-step formatter that outputs back into Gherkin format.
+* [NEW] Class `ToNull` A macro-step formatter that outputs nothing.
+* [NEW] Class `ToTrace` A macro-step formatter that outputs the macro collection visit events.
+* [NEW] Class `Comment` to represent comments appearing in sub-steps source.
+* [CHANGE] Method `Engine#parse` parses Gherkin comments into Comment objects.
+* [CHANGE] File `.rubocop.yml`: Allow checks of spec files, override settings of some new cops.
+* [CHANGE] Replaced calls to Kernel#raise by Kernel#fail
+
 ### 0.3.42 / 2013-10-04
 * [CHANGE] File `macro_steps.rb`: Regular expression for defining step uses now the /x option.
-* [FIX] File `.simplecov` Removal of premataure dependency to 'coveralls' gem
+* [FIX] File `.simplecov` Removal of premature dependency to 'coveralls' gem
 
 ### 0.3.41 / 2013-10-03
 * [CHANGE] File `env.rb`: Updated the exception handler when requiring `simplecov` to prevent the

data/examples/i18n/fr/features/step_definitions/use_macro_steps.rb

@@ -18,7 +18,7 @@ Quand(/^j(?:e |')\[([^\]]+)\]:$/) do |macro_phrase, table_argument|
   # Ensure that the second argument is of the correct type
   unless table_argument.kind_of?(Cucumber::Ast::Table)
     error_message = 'This step must have a data table as an argument.'
-    raise Macros4Cuke::DataTableNotFound, error_message
+    fail(Macros4Cuke::DataTableNotFound, error_message)
   end
 
   # This will call the macro with the given phrase.

data/features/demo06.feature

@@ -1,85 +1,85 @@
 # File: demo06.feature
 
-Feature: Show how to define conditional substeps in a macro-step.
+Feature: Define conditional substeps in a macro-step.
   As a Cuke user
-  So that I enjoy writing scenario.
+  So that I enjoy writing flexible scenarios.
 
 
-Scenario: Defining a macro with conditional substeps
-  Given I define the step "* I [fill in the form with]:" to mean:
-  """
-  When I fill in "first_name" with "<firstname>"
-  And I fill in "last_name" with "<lastname>"
-  And I fill in "street_address" with "<street_address>"
-  And I fill in "zip" with "<postcode>"
-  And I fill in "city" with "<city>"
-  And I fill in "country" with "<country>"
-  
-  # Let's assume that the e-mail field is optional.
-  # The step between the <?email>...<email> will be executed
-  # when the argument <email> has a value assigned to it.
-  <?email>
-  And I fill in "email" with "<email>"
-  </email>
-  
-  # Let's also assume that comment is also optional
-  # See the slightly different syntax: the conditional section
-  # <?comment>...<comment> may fit in a single line
-<?comment>  And I fill in "comment" with "<comment>"</comment>
-  And I click "Save"
-  """
-  
+  Scenario: Defining a macro with conditional substeps
+    Given I define the step "* I [fill in the form with]:" to mean:
+      """
+      When I fill in "first_name" with "<firstname>"
+      And I fill in "last_name" with "<lastname>"
+      And I fill in "street_address" with "<street_address>"
+      And I fill in "zip" with "<postcode>"
+      And I fill in "city" with "<city>"
+      And I fill in "country" with "<country>"
+      
+      # Let's assume that the e-mail field is optional.
+      # The step between the <?email>...<email> will be executed
+      # only when the argument <email> has a value assigned to it.
+      <?email>
+      And I fill in "email" with "<email>"
+      </email>
+      
+      # Let's also assume that comment is also optional
+      # See the slightly different syntax: the conditional section
+      # <?comment>...<comment> may fit in a single line
+    <?comment>  And I fill in "comment" with "<comment>"</comment>
+      And I click "Save"
+      """
+    
 
-Scenario: An exception is forced by invoking the above macro with a triple quote string instead of a data table.
-  When I generate a DataTableNotFound exception  
+  Scenario: An exception is forced by invoking the above macro with a triple quote string instead of a data table.
+    When I generate a DataTableNotFound exception  
 
-  
-Scenario: Let's use the macro-step WITHOUT the optional argument values.
-  When I [fill in the form with]:
-  |firstname|Alice|
-  |lastname| Inn |
-  |street_address| 11, No Street|
-  |city| Nowhere-City|
-  |country|Wonderland|
-  # No e-mail
-  # No comment
+    
+  Scenario: Let's use the macro-step WITHOUT the optional argument values.
+    When I [fill in the form with]:
+    |firstname|Alice|
+    |lastname| Inn |
+    |street_address| 11, No Street|
+    |city| Nowhere-City|
+    |country|Wonderland|
+    # No e-mail
+    # No comment
 
-  # 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"
-  """
-  
-  
-Scenario: Let's use the macro-step WITH the optional argument values.  
-  # Redo, now with e-mail and comment
-  When I [fill in the form with]:
-  |firstname|Alice|
-  |lastname| Inn |
-  |street_address| 11, No Street|
-  |city| Nowhere-City|
-  |country|Wonderland|
-  # Here come the optional values
-  |email|alice.inn@wonder.land|
-  |comment|No comment!|
+    # 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"
+      """
+    
+    
+  Scenario: Let's use the macro-step WITH the optional argument values.  
+    # Redo, now with e-mail and comment
+    When I [fill in the form with]:
+    |firstname|Alice|
+    |lastname| Inn |
+    |street_address| 11, No Street|
+    |city| Nowhere-City|
+    |country|Wonderland|
+    # Here come the optional values
+    |email|alice.inn@wonder.land|
+    |comment|No comment!|
 
-  # 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"
-  """
+    # 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"
+      """
   

data/features/demo07.feature

@@ -0,0 +1,15 @@
+# File: demo07.feature
+
+Feature: Save all encountered macro-step definitions in a single file
+  As a prolific macro-step writer
+  So that I have an list of all macro-steps in a single place.
+
+
+  Scenario: Listing all encountered macro-steps definitions
+  
+    # This step is bundled with Macro4Cuke as a convenience.
+    # The file "all_macros.feature" is created and saved when Cucumber completes.
+    # You should find the file in the folder where macros4cuke resides.
+    # If you use this step in your own Cucumber project, 
+    # then the file will be placed in the project's root folder.
+    When I want to list all the macros in the file "all_macros.feature"

data/features/support/env.rb

@@ -4,12 +4,18 @@
 # It also demonstrates what to do in your env.rb file 
 # to use the Macros4Cuke gem.
 
+require 'pp'
+require_relative '../../lib/macros4cuke/macro-collection'
+require_relative '../../lib/macros4cuke/formatting-service'
+require_relative '../../lib/macros4cuke/formatter/to-gherkin'
+
 begin
   require 'simplecov' # Development dependency only...
 rescue LoadError => mute
   mute # .... So gobble silently the exception if simplecov isn't installed.
 end
 
+
 module DemoMacros4Cuke  # Use the module as a namespace
 
  

data/features/support/macro_support.rb

@@ -1,7 +1,7 @@
 # File: macro_support.rb
-# Purpose: Add the support for macros in Cucumber.
+# Purpose: Add the support for macros in a Cucumber project.
 # This file is meant to be put next to the 'env.rb' file 
-# of your Cucumeber project.
+# of your Cucumber project.
 
 
 # Macros4Cuke step one: Load modules and classes from the gem.

data/lib/macro_steps.rb

@@ -26,7 +26,6 @@ Given(/^I\sdefine\sthe\sstep\s" # Fixed part of defining step
 end
 
 
-
 # This step is used to invoke a simple macro-step
 # Example:
 #  When I [log in as "guest"]
@@ -37,6 +36,8 @@ end
 
 
 # This step is used to invoke a macro-step with a data table argument.
+# Notice the presence of an ending colon character ':' 
+# after the closing bracket ']'
 # Example:
 #  When I [enter my credentials as]:
 #  |userid  |guest      |
@@ -44,7 +45,7 @@ end
 When(/^I \[([^\]]+)\]:$/) do |macro_phrase, table_argument|
   # Ensure that the second argument is of the correct type
   unless table_argument.kind_of?(Cucumber::Ast::Table)
-    raise Macros4Cuke::DataTableNotFound.new(macro_phrase)
+    fail(Macros4Cuke::DataTableNotFound.new(macro_phrase))
   end
 
   # This will call the macro with the given phrase.
@@ -54,4 +55,20 @@ When(/^I \[([^\]]+)\]:$/) do |macro_phrase, table_argument|
 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 
+# 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)
+  end
+end
+
+
 # End of file

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

@@ -0,0 +1,119 @@
+# File: coll-walker-factory.rb
+# Purpose: Implementation of the CollWalkerFactory class.
+
+require_relative 'macro-collection'
+
+module Macros4Cuke # Module used as a namespace
+
+
+# A Coll(ection)WalkerFactory object is a factory that creates
+# an enumerator that itself walks in the passed macro collection object.
+# The walker performs a depth-first visit and yields visit events.
+class CollWalkerFactory
+  # Structure used internally by the walker
+  StringNode = Struct.new(:event, :text, :extra)
+
+  def build_walker(aMacroCollection)
+    level = 0
+    collection = aMacroCollection
+    current_node = collection
+    backlog = collection.macro_steps.values
+
+    visitor = Enumerator.new do
+      |result_receiver|	# 'result_receiver' is a Yielder
+      loop do
+        case current_node
+        when MacroCollection
+          result_receiver << [:on_collection, level, current_node]
+          level += 1
+          backlog << StringNode.new(:on_collection_end, nil)
+
+        when MacroStep
+          result_receiver << emit_on_step(current_node, level, backlog)
+          level += 1
+
+        when StringNode
+          level -= 1 if current_node.event.to_s =~ /_end$/
+          event = [current_node.event, level, current_node.text]
+          event << current_node.extra unless current_node.extra.nil?
+          result_receiver << event
+
+        when Templating::Engine
+          result_receiver << emit_on_renderer(current_node, level, backlog)
+          level += 1
+
+        when Templating::StaticText
+          result_receiver << [:on_static_text, level, current_node.source]
+
+        when Templating::Comment
+          result_receiver << [:on_comment, level, current_node.source]
+
+        when Templating::EOLine
+          result_receiver << [:on_eol, level, nil]
+
+        when Templating::Placeholder
+          result_receiver << [:on_placeholder, level, current_node.name]
+
+        when Templating::Section
+          result_receiver << emit_on_section(current_node, level, backlog)
+          level += 1
+
+        else
+          err_msg = "Don't know how to format a #{current_node.class}."
+          fail(InternalError, err_msg)
+        end
+
+        current_node = backlog.shift
+        break if current_node.nil?
+      end
+    end
+
+
+    return visitor
+  end
+
+private
+  # Add children elements to the visit backlog
+  def add_children(anEnumerable, theBacklog)
+    anEnumerable.reverse.each do |elem|
+      theBacklog.unshift(elem)
+    end
+  end
+  
+  # Generate an on_step event
+  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]      
+  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]     
+  end
+  
+
+
+
+end # class
+
+end # module
+
+# End of file