macros4cuke 0.1.04 → 0.1.06

data/HISTORY.md

@@ -1,13 +1,28 @@
+## [0.1.06]
+
+### Documentation:
+* Format fix in README.md
+* HISTORY.md file updated
+
+## [0.1.05]
+### Changes:
+* demo_steps.rb: A few step definitions emits output to the screen (so that at least something is shown in the demo).  
+* MacroStep class: regexp slightly reworked to accept escaped double quotes in actual values. 
+* travelling_demo.feature: added one example with escaped quotes in actual value.
+
+
 ## [0.1.04]
-## New features:
+### New features:
 * Gherkin comments are allowed in sub-steps sequence. Previous version supported only Mustache comments.
-## Changes:
+
+### Changes:
 * Added a few more examples in the 'travelling-demo.feature' file.
 
 
 ## [0.1.03]
 ### Documentation
-* README.md: slightly reworked and added link to Mustache.  
+* README.md: slightly reworked and added link to Mustache.
+
 ### Changes:
 * env.rb: All dependencies on Macros4Cuke were moved to the file macro_support.rb
 * travelling-demo.feature: Demo feature file with output on the screen (the other demos don't display any result).

data/README.md

@@ -38,27 +38,43 @@ That macro-step can then be used in a scenario like this:
   When I [enter my userid "jdoe" and password "hello-world"]
 ```
 
+When it is executed, the last macro-step (invokation) as the same effect as:
+```cucumber 
+  Given I landed in the homepage  
+  When I click "Sign in"  
+  And I fill in "Username" with "jdoe"  
+  And I fill in "Password" with "hello-world"  
+  And I click "Submit"  
+  """  
+```
+
+In other words, this sequence of 5 steps can be replaced by just one.
+Macros4Cuke not only helps in getting rid of the repeated step sequences,
+ it allows the feature writers to create themselves higher-level steps
+ that are closer to the business logic.  
+
 See also the working examples in the features folder.
 
 ## Install and setup ##
 * Step 1: Install the macros4cuke gem:
 ```bash  
-gem install macros4cuke
+[sudo] gem install macros4cuke
 ```
 
   
 * Step 2: Add support for macros in your Cucumber project  
 In your /features/support/ folder:    
   - Create a Ruby file (e.g. 'macro\_support.rb') with the following contents:  
+  
 ```ruby
 require 'macros4cuke'  
-
 World(Macros4Cuke::MacroStepSupport)
 ```  
   
 * Step 3: Import the macro-management steps  
 In your /features/step_definitions/ folder:  
   - Create a ruby file (say, 'use\_macro\_steps.rb') with the following line:  
+  
 ```ruby  
 require 'macros4cuke/../macro_steps'
 ```  

data/features/travelling-demo.feature

@@ -19,6 +19,11 @@ Scenario: Do a simple travel
   # You should see the output:
   # I leave Brussels
   # I arrive in Rome
+  
+  # Actual values can have embedded double quotes provided they are escaped.
+  When I [travel from "Tampa" to "\"Little Italy\""]  
+  
+  # Notice the HTML-escaping done by Mustache
 
 
 

data/lib/macros4cuke/constants.rb

@@ -3,7 +3,7 @@
 
 module Macros4Cuke # Module used as a namespace
 	# This constant keeps the current version of the gem.
-	Version = '0.1.04'
+	Version = '0.1.06'
   
   Description = "Macros for Cucumber"
 	

data/lib/macros4cuke/macro-step.rb

@@ -50,6 +50,7 @@ class MacroStep
   # In invokation mode, a placeholder is delimited by double quotes.
   # The rule for building the identifier are:
   # - Leading and trailing space(s) are removed.
+  # - Each underscore character is removed.
   # - Every sequence of one or more space(s) is converted into an underscore
   # - Each placeholder (i.e. = delimiters + enclosed text) is converted into a letter X.
   # - The endings are transformed as follows: ] => '', ]: => _T 
@@ -59,17 +60,20 @@ class MacroStep
   def self.macro_key(aMacroPhrase, mode)
     stripped_phrase = aMacroPhrase.strip # Remove leading ... trailing space(s)
     
+    # Remove every underscore
+    stripped_phrase.gsub!(/_/, '')
     
     # Replace all consecutive whitespaces by an underscore    
     stripped_phrase.gsub!(/\s+/, '_')
     
     
-    # Determine the pattern to isolate each argument/paramter with its delimiters
+    # Determine the pattern to isolate each argument/parameter with its delimiters
     pattern = case mode
       when :definition
         /\{{2,3}[^}]*\}{2,3}/
       when :invokation
-        /"[^"]*"/
+        /"([^\\"]|\\.)*"/
+
     end
     
     # Each text between quotes or mustaches is replaced by the letter X
@@ -144,7 +148,7 @@ private
       when :definition
         /{{{([^}]*)}}}|{{([^}]*)}}/ # Two capturing groups!...
       when :invokation
-        /"([^"]*)"/
+        /"((?:[^\\"]|\\.)*)"/
       else
         raise InternalError, "Internal error: Unknown mode argument #{mode}"
     end

data/lib/macros4cuke/template-engine.rb

@@ -0,0 +1,64 @@
+# File: template-engine.rb
+# Purpose: Implementation of the MacroStep class.
+
+require 'strscan' # Use the StringScanner for lexical analysis.
+
+module Macros4Cuke # Module used as a namespace
+
+
+class TemplateEngine
+
+  def self.parse(aTextLine)
+    #return [] if aTextLine.empty?
+    scanner = StringScanner.new(aTextLine)
+    result = []
+    
+    until scanner.eos?
+      # Scan tag at current position...
+      tag_literal = scanner.scan(/<(?:[^\\<>]|\\.)*>/)
+      result << [:dynamic, tag_literal.gsub(/^<|>$/, '')] unless tag_literal.nil?
+      # TODO: remove next line
+      p tag_literal unless tag_literal.nil?
+      
+      # ... or scan plain text at current position
+      text_literal = scanner.scan(/(?:[^\\<>]|\\.)+/)
+      result << [:static, text_literal] unless text_literal.nil?
+      # TODO: remove next line
+      p 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...
+        p aTextLine
+        no_escaped = aTextLine.gsub(/\\<|\\>/, "--")  # First: replace escaped chevron(s)
+        p no_escaped
+        unbalance = 0 # = count of < -  count of > (can only be 0 or -temporarily- 1)
+
+        no_escaped.scan(/(.)/) do |match|
+          p match
+          case match[0]
+            when '<'
+              p "found <"
+              unbalance += 1 
+            when '>'  
+              p 'found >'
+              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, "Internal error[unbalance=#{unbalance}]. Cannot parse:\n'#{aTextLine}'"
+      end
+    end
+    
+    return result
+  end
+
+end # class
+
+end # module
+
+# End of file

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.1.04
+  version: 0.1.06
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -78,6 +78,7 @@ files:
 - lib/macros4cuke/macro-collection.rb
 - lib/macros4cuke/macro-step-support.rb
 - lib/macros4cuke/macro-step.rb
+- lib/macros4cuke/template-engine.rb
 - features/demo01.feature
 - features/demo02.feature
 - features/demo03.feature