macros4cuke 0.2.18 → 0.2.19

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.19 / 2013-05-06
+* [CHANGE] Added validation of macro argument names in new `Engine::parse_tag` method.
+* [CHANGE] InvalidCharError exception added.
+* [CHANGE] File `engine_spec.rb`: Added one RSpec example for an invalid argument name.
+* [CHANGE] File `README.md`: added a new section on naming macro arguments.
+
 ## 0.2.18 / 2013-05-06
 * [CHANGE] Amended spec files and added a new demo feature. SimpleCov code coverage raised to more than 97%.
 * [CHANGE] Macro-step arguments can be multivalued (experimental)

data/README.md

@@ -245,6 +245,14 @@ Here are few observations worth noticing:
 the value "Main Street, 22".  
 - Data rows don't have to follow strictly the order of the arguments in the sub-step sequence. 
 
+## Naming macro-step arguments ##
+In line with most computer languages, Macros4Cuke accepts argument names containing alphanumeric characters and 
+underscores.  
+In fact, the only characters that are not allowed in argument names are the following punctuation or delimiting
+signs:  
+__\!"'\#$%\&\*\+\-/,\.\:\;\=\?\(\)\<\>\[\]\{\}\\\^\`\|\~__
+
+
 ## With great power comes great responsibility. ##
 _Stan Lee_  
 

data/lib/macros4cuke/constants.rb

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

data/lib/macros4cuke/exceptions.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8 -- You should see a paragraph character: § 
+# encoding: utf-8 -- You should see a paragraph character: §
 # File: exceptions.rb
 
 module Macros4Cuke # Module used as a namespace
@@ -8,7 +8,7 @@ module Macros4Cuke # Module used as a namespace
 class Macros4CukeError < StandardError
 end # class
 
-# Raised when one attempts to define a new macro 
+# Raised when one attempts to define a new macro
 # that has the same phrase as an existing macro.
 class DuplicateMacroError < Macros4CukeError
   def initialize(aPhrase)
@@ -44,7 +44,15 @@ class EmptyArgumentError < Macros4CukeError
 end # class
 
 
-# Raised when one invokes a macro-step with an unknown phrase. 
+# Raised when an argument name contains invalid characters.
+class InvalidCharError < Macros4CukeError
+  def initialize(aText, aWrongChar)
+    super("The invalid sign '#{aWrongChar}' occurs in the argument/tag '#{aText}'.")
+  end
+end # class
+
+
+# Raised when one invokes a macro-step with an unknown phrase.
 class UnknownMacroError < Macros4CukeError
   def initialize(aPhrase)
     super("Unknown macro-step with phrase: '#{aPhrase}'.")
@@ -54,7 +62,7 @@ end # class
 
 
 # Raised when one invokes a macro-step with an argument
-# that has an unknown name. 
+# that has an unknown name.
 class UnknownArgumentError < Macros4CukeError
   def initialize(argName)
     super("Unknown macro-step argument '#{argName}'.")

data/lib/macros4cuke/templating/engine.rb

@@ -101,6 +101,15 @@ end # class
 #     while Mustache use !{{...}} delimiters),  
 # - Feature files are meant to be simple, so should the template engine be. 
 class Engine
+  # The regular expression that matches any punctuation sign or delimiter that is forbidden between chevrons <...> template tags.
+  DisallowedSigns = begin 
+    forbidden =  '!"#' + "$%&'()*+,-./:;<=>?[\\]^`{|}~" # Used concatenation (+) to work around Ruby bug!
+    all_escaped = [] 
+    forbidden.each_char() { |ch| all_escaped << Regexp.escape(ch) }
+    pattern = all_escaped.join("|")
+    Regexp.new(pattern)
+  end
+
   # The original text of the template is kept here.
   attr_reader(:source)
   
@@ -140,7 +149,6 @@ public
     return @variables
   end
 
-
   # Class method. Parse the given line text into a raw representation.
   # @return [Array] Couples of the form:
   # [:static, text] or [:dynamic, tag text]
@@ -211,7 +219,7 @@ private
   end
 
   
-  # [aCouple] a two-element array of the form: [kind, text]
+  # @param aCouple [Array] a two-element array of the form: [kind, text]
   # Where kind must be one of :static, :dynamic
   def compile_couple(aCouple)
     (kind, text) = aCouple
@@ -221,14 +229,24 @@ private
         StaticText.new(text)
         
       when :dynamic
-        Placeholder.new(text)
+        parse_tag(text)
       else
         raise StandardError, "Internal error: Don't know template element of kind #{kind}"
       end
-    
+
     return result
   end
   
+  # Parse the contents of a tag entry.
+  # @param aText [String] The text that is enclosed between chevrons.
+  def parse_tag(aText)
+    # Disallow punctuation and delimiter signs in tags.
+    matching = DisallowedSigns.match(aText)
+    raise InvalidCharError.new(aText, matching[0]) if matching
+
+    return Placeholder.new(aText)    
+  end
+ 
 end # class
 
 end # module

data/spec/macros4cuke/templating/engine_spec.rb

@@ -4,6 +4,7 @@
 require_relative '../../spec_helper'
 require_relative '../../../lib/macros4cuke/templating/engine'	# Load the class under test
 
+
 module Macros4Cuke
 
 module Templating # Open this namespace to get rid of module qualifier prefixes
@@ -171,9 +172,14 @@ SNIPPET
       text_w_empty_arg = sample_template.sub(/userid/, '')
       error_message = %Q|An empty or blank argument occurred in 'And I fill in "Username" with "<>"'.|
       lambda { Engine.new text_w_empty_arg }.should raise_error(Macros4Cuke::EmptyArgumentError, error_message)
+    end
 
+    it "should complain when a placeholder contains an invalid character" do
+      text_w_empty_arg = sample_template.sub(/userid/, 'user%id')
+      error_message = "The invalid sign '%' occurs in the argument/tag 'user%id'."
+      lambda { Engine.new text_w_empty_arg }.should raise_error(Macros4Cuke::InvalidCharError, error_message)
     end
-  end
+  end # context
 
   context "Provided services" do
 
@@ -208,7 +214,7 @@ SNIPPET
 SNIPPET
 
       rendered_text.should == expected
-      
+
       # Case of an actual that's not a String
       locals = {'userid' => "johndoe", "password" => 12345678 }
       rendered_text = subject.render(Object.new, locals)
@@ -220,8 +226,8 @@ SNIPPET
   And I click "Sign in"
 SNIPPET
 
-      rendered_text.should == expected      
-      
+      rendered_text.should == expected
+
 
       # Place actual value in context object
       Context = Struct.new(:userid, :password)
@@ -236,7 +242,7 @@ SNIPPET
 SNIPPET
 
       rendered_text.should == expected
-      
+
 
       # 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.2.18
+  version: 0.2.19
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber