macros4cuke 0.3.29 → 0.3.30

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.3.30 / 2013-06-13
+* [CHANGE] File `README.md`: Added section `A word on Step Argument Transforms`.
+* [CHANGE] File `engine.rb`: Changed a few case statements in order to please Rubocop.
+* [CHANGE] `engine_spec.rb`: A test assertion was missing in a test.
+* [TESTED] Regression testing with Cucumber 1.3.2. Pass.
+
 ### 0.3.29 / 2013-06-05
 * [CHANGE] `MacroStep#validate_params` method: `Extract Method` Refactoring, resulting in new method `MacroStep#validate_row`.
 * [CHANGE] `README.md`: Few editorial changes. Added section `More resources`.

data/README.md

@@ -410,6 +410,19 @@ text in an entry field may be noticeably different than skipping that same entry
 Think of specific UI-events that can trigger some special system response.
 
 
+## A word on Step Argument Transforms##
+Cucumber provides a handy facility that helps to convert implicitly the values of step arguments.
+A first description of this lesser-known functionality is available at 
+[Step Argument Transforms] (https://github.com/cucumber/cucumber/wiki/Step-Argument-Transforms).  
+Does Macros4Cuke provide such a facility for its own macro-step arguments?  
+The answer is no: if macro-steps had their own kind of transformations, then these would have interfere with the ones defined directly in Cucumber.
+In fact, Cucumber will happily apply transformations on any step, including the macro definition steps and the
+steps invoking macros. Stated otherwise, the rules pertaining the Step Argument Transforms work as usual. Or almost. 
+There is one very specific case where Cucumber behaves slightly differently: the transforms aren't applied when a sub-step is executed.
+Internally, Macros4Cuke calls the `Cucumber::RbSupport::RbWorld::#steps` method that allows to run a Gherkin snippet (the substeps),
+and it appears that this method does not trigger the transforms. In practice, this doesn't prevent the use of transforms together
+with Macros4Cuke. In the vast majority of cases both will work fine as expected.
+
 
 ## FAQ ##
 __Q__: Can I define a macro in one scenario and invoke it in another scenario in the same feature file?  
@@ -440,6 +453,7 @@ __Q__: Can I __invoke/call__ a macro-step in a `Background` or `Scenario Outline
 __A__: Yes. As a macro-step can be invoked multiple times.
 
 
+
 ## Changelog
 
 Macros4Cuke's changelog is available [here](CHANGELOG.md).
@@ -450,7 +464,7 @@ Macros4Cuke's changelog is available [here](CHANGELOG.md).
 -   [**Report a bug**](https://github.com/famished-tiger/Macros4Cuke/issues)
 
 
-## With great power comes great responsibility. ##
+### With great power comes great responsibility. ###
 _Stan Lee_  
 
 Our experience is that macro-steps change deeply the way one designs and writes feature files.  

data/lib/macros4cuke/constants.rb

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

data/lib/macros4cuke/templating/engine.rb

@@ -142,12 +142,12 @@ public
   def variables()
     all_vars = children.each_with_object([]) do |a_child, subResult|
       case a_child
-        when Placeholder
-          subResult << a_child.name
-        when Section
-          subResult.concat(a_child.variables)
-        else
-          # Do nothing
+      when Placeholder
+        subResult << a_child.name
+      when Section
+        subResult.concat(a_child.variables)
+      else
+        # Do nothing
       end
     end
     
@@ -277,14 +277,14 @@ public
     @variables ||= begin
       vars = @representation.each_with_object([]) do |element, subResult|
         case element
-          when Placeholder          
-            subResult << element.name
-          
-          when Section
-            subResult.concat(element.variables)
-          
-          else
-            # Do nothing
+        when Placeholder          
+          subResult << element.name
+        
+        when Section
+          subResult.concat(element.variables)
+        
+        else
+          # Do nothing
         end
       end
       
@@ -333,10 +333,8 @@ private
 
     no_escaped.each_char do |ch|
       case ch
-        when '<'
-          unbalance += 1 
-        when '>'  
-          unbalance -= 1              
+      when '<' then unbalance += 1 
+      when '>' then unbalance -= 1              
       end
       
       raise StandardError, "Nested opening chevron '<'." if unbalance > 1
@@ -379,18 +377,18 @@ private
     section_item = nil
     line_to_squeeze = line_rep.all? do |item|
       case item
-        when StaticText
-          item.source =~ /\s+/
-          
-        when Section, SectionEndMarker
-          if section_item.nil?
-            section_item = item
-            true
-          else
-            false
-          end
+      when StaticText
+        item.source =~ /\s+/
+        
+      when Section, SectionEndMarker
+        if section_item.nil?
+          section_item = item
+          true
         else
           false
+        end
+      else
+        false
       end
     end
     if line_to_squeeze && ! section_item.nil?
@@ -423,12 +421,9 @@ private
     (kind, text) = aCouple
     
     result = case kind
-      when :static
-        StaticText.new(text)
-        
-      when :dynamic
-        parse_tag(text)
-      end
+    when :static then StaticText.new(text)
+    when :dynamic then parse_tag(text)
+    end
 
     return result
   end
@@ -465,20 +460,19 @@ private
     
     compiled = flat_sequence.each_with_object([]) do |element, subResult|
       case element
-        when Section
-          open_sections << element
-        
-        when SectionEndMarker           
-          validate_section_end(element, open_sections)
-          subResult << open_sections.pop()
-         
+      when Section
+        open_sections << element
+      
+      when SectionEndMarker           
+        validate_section_end(element, open_sections)
+        subResult << open_sections.pop()
+       
+      else
+        if open_sections.empty?
+          subResult << element
         else
-          if open_sections.empty?
-            subResult << element
-          else
-            open_sections.last.add_child(element)
-          end
-
+          open_sections.last.add_child(element)
+        end
       end 
     end
     

data/spec/macros4cuke/macro-step-support_spec.rb

@@ -29,7 +29,7 @@ describe MacroStepSupport do
   # Rule to build a custom world object
   let(:world) { MyWorld.new }
   
-  let(:m1_phrase) { 'enter the credentials' }
+  let(:phrase1) { 'enter the credentials' }
   
   let(:m1_substeps) do
       ssteps = <<-SNIPPET
@@ -44,13 +44,13 @@ SNIPPET
   
   context 'Defining macro(s):' do
     it 'should add valid new macro' do
-      expect { world.add_macro m1_phrase, m1_substeps, true }.not_to raise_error
+      expect { world.add_macro phrase1, m1_substeps, true }.not_to raise_error
     end
     
     it 'should complain when entering the same macro again' do
       # Error case: trying to register another macro with same key/phrase.
       msg = "A macro-step with phrase 'enter the credentials' already exist."
-      expect { world.add_macro(m1_phrase, m1_substeps, true) }.to raise_error(
+      expect { world.add_macro(phrase1, m1_substeps, true) }.to raise_error(
         Macros4Cuke::DuplicateMacroError, msg)
     end
     

data/spec/macros4cuke/templating/engine_spec.rb

@@ -251,7 +251,7 @@ SNIPPET
 
     it 'should know the variable(s) it contains' do
       # Case using the sample template
-      subject.variables == [:userid, :password]
+      expect(subject.variables).to be == ['userid', 'password']
 
       # Case of an empty source template text
       instance = Engine.new ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.3.29
+  version: 0.3.30
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber