macros4cuke 0.3.09 → 0.3.10

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.10 / 2013-05-14
+* [CHANGE] File `README.md`: Expanded section on conditional section.
+* [CHANGE] Method `Templating::Engine::parse` slightly refactored in order to decrease its complexity.
+
 ## 0.3.09 / 2013-05-13
 * [CHANGE] File `.travis.yml`: Added jruby as a target Ruby
 

data/README.md

@@ -338,7 +338,32 @@ When invoked like this:
   |country|Wonderland|
 ```
 
-the substep concerning the email address won't be executed since the email argument isn't used at invokation.
+the following substep sequence is executed:
+```cucumber
+  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 click "Save"
+```
+
+A few remarks concerning the executed sequence:  
+1. Every macro argument (say, firstname) that takes a value (say, "Alice"), is replaced
+ that by that value in the substeps.  
+2. Every macro argument (say, zip) that doesn't have a corresponding row in the data table,
+ is replaced by an empty text (look at the substep for the zip code entry).  
+3. The substep with the email entry doesn't appear at all. This can be explained by the conditional
+section <?email>...</email> that prevents the enclosed substep(s) to be generated in absence of a value for
+the email macro argument.
+
+
+A typical use case for conditional sections is to prevent the execution of one or more steps in
+absence of a given data item. This simulates, for instance, the behaviour of a user that skips 
+one or more widgets in a page/screen. From a user interface testing viewpoint, entering an empty
+text in an entry field may be noticeably different than skipping that same entry field.
+Think of specific UI-events that can trigger some special system response.
+
 
 
 

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.09'
+	Version = '0.3.10'
 
   # Brief description of the gem.
   Description = "Macros for Cucumber"

data/lib/macros4cuke/templating/engine.rb

@@ -288,35 +288,40 @@ public
       
       # ... or scan plain text at current position
       text_literal = scanner.scan(/(?:[^\\<>]|\\.)+/)
-      result << [:static, text_literal] unless text_literal.nil?
-      
-      if tag_literal.nil? && text_literal.nil?
-        # Unsuccessful scanning: we have improperly balanced chevrons.
-        # We will analyze the opening and closing chevrons...
-        no_escaped = aTextLine.gsub(/\\[<>]/, "--")  # First: replace escaped chevron(s)
-        unbalance = 0 # = count of < -  count of > (can only be 0 or -temporarily- 1)
-
-        no_escaped.scan(/(.)/) do |match|
-          case match[0]
-            when '<'
-              unbalance += 1 
-            when '>'  
-              unbalance -= 1              
-          end
-          
-          raise StandardError, "Nested opening chevron '<'." if unbalance > 1
-          raise StandardError, "Missing opening chevron '<'." if unbalance < 0
-        end
-        
-        raise StandardError, "Missing closing chevron '>'." if unbalance == 1
-        raise StandardError, "Cannot parse:\n'#{aTextLine}'"
-      end
+      result << [:static, text_literal] unless text_literal.nil? 
+      identify_parse_error(aTextLine) if tag_literal.nil? && text_literal.nil?
     end
     
     return result
   end
 
 private
+  # Called when the given text line could not be parsed.
+  # Raises an exception with the syntax issue identified.
+  # @param aTextLine [String] A text line from the template.  
+  def self.identify_parse_error(aTextLine)
+    # Unsuccessful scanning: we typically have improperly balanced chevrons.
+    # We will analyze the opening and closing chevrons...
+    no_escaped = aTextLine.gsub(/\\[<>]/, "--")  # First: replace escaped chevron(s)
+    unbalance = 0 # This variable equals: count of < -  count of > (can only be 0 or -temporarily- 1)
+
+    no_escaped.scan(/(.)/) do |match|
+      case match[0]
+        when '<'
+          unbalance += 1 
+        when '>'  
+          unbalance -= 1              
+      end
+      
+      raise StandardError, "Nested opening chevron '<'." if unbalance > 1
+      raise StandardError, "Missing opening chevron '<'." if unbalance < 0
+    end
+    
+    raise StandardError, "Missing closing chevron '>'." if unbalance == 1
+    raise StandardError, "Cannot parse:\n'#{aTextLine}'"  
+  end
+  
+  
   # Create the internal representation of the given template.
   def compile(aSourceTemplate)
     # Split the input text into lines.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.3.09
+  version: 0.3.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -75,7 +75,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.5.0
-description: Create your own macros in your Cucumber scenarios.
+description: Create your own macro-steps directly in Cucumber scenarios.
 email: 
 executables: []
 extensions: []