macros4cuke 0.4.02 → 0.4.03

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmI3NDI4NzIzZjFiYjEwNjAyNjZhZTdlMTc0MzcwY2EyMWJlNzQyOA==
+    NmEwYWE3ZGQxYzQ3MzdiMzhmMDAxNDk1YWJkMGZhMmVlZWVlMTdhNA==
   data.tar.gz: !binary |-
-    ZDU1NzNjYjk0MjFkYjFmYzE0NTAyZTM5NTk4MmY0MDc1NjUyN2FiZQ==
+    NjYwZDQwNDg0MmQ1MzlkN2QyNjVkNWU5OWZmODFkMmI4NDY3ZmRlNQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YjZjMWViYzg0NjdhNDA5YTlhMzU0YWQ1M2FiOTk1ZjJmZmU4YWVlMWEzOWU2
-    OTRkZTlmYzU0M2I4YzFmZWU1NGEyNmQ5MjgwYTIzYzU4MjI0YmZhOGNkODAz
-    N2Y1ZmI5NTcxMzI3MTljODJiZGQ5YTJhYWJhYmZkZjU5ODdkMDc=
+    NjMxYzAxMDYyNmNiMmFhZjEyNTRkNDAxMDk3NDc4MmQ2MmRjOTZiN2I2MDgx
+    YmRmMTljODRiMmNmYmU0NzE4ZjU3MGZmNTI5MDNmYTg1MDk2ZDRlZDk1ZWZm
+    MmRiMDYxZTJlYjI5YjkxOWFjMGQ1ZTgwZjVlMjkwODc2MzYzNjM=
   data.tar.gz: !binary |-
-    MWI0YTkzZWMzMGQ0YjliNWJiMmEyNzYzYjY2YThmNjZkNDM1MTJmMTljMGMx
-    N2Y4YmVkYjJlM2Y2YzAyM2U3Y2M3ZmE5NWE4MTI1YmEyMWNkMmNhZGI2NjA5
-    OGIwY2JmMDAzY2U2MjNkOGI4N2I4MTlkMjQwNjU4OTc4Y2ZmNDI=
+    NTRiNTkwYjY2ODBmNmJlNDdiYmMwNDliNjQ3MDA3YzA3MmE2YWMwMWIzYmU4
+    NDBjZWE3OWY2OTYzNDgxNjEzZmYzYTVjYzE2MWVjMzA2ZjFiMWMwNDhhNWNh
+    NzM1YWE1ZTZlNDBmNTA1MDJiOTcwYTJiNDgyYTgyYjA3MWYyNDA=

data/CHANGELOG.md

@@ -1,8 +1,13 @@
-### 0.4.02 / 2013-11_17
+### 0.4.03 / 2013-12-11
+* [CHANGE] File `engine.rb`: Monolithic file splitted into more class-specific files.
+* [CHANGE] File `constants.rb`: Removal of legacy app in comment.
+
+
+### 0.4.02 / 2013-11-17
 * [CHANGE] File `README.md`: Added section on new feature: capability to list all macros.
 * [CHANGE] Files from `macro_steps.rb`: Added the `require` to enable the new step.
 
-### 0.4.01 / 2013-11_17
+### 0.4.01 / 2013-11-17
 * [CHANGE] File `.rubocop.yml`: Disabled a few new 0.15.0 cops
 * [CHANGE] Files from `lib` and `spec` dirs updated for Rubocop 0.15.0
 

data/features/support/env.rb

@@ -5,9 +5,6 @@
 # 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...

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

@@ -3,6 +3,7 @@
 
 require_relative 'macro-collection'
 
+
 module Macros4Cuke # Module used as a namespace
 
 

data/lib/macros4cuke/constants.rb

@@ -3,12 +3,12 @@
 
 module Macros4Cuke # Module used as a namespace
   # The version number of the gem.
-  Version = '0.4.02'
+  Version = '0.4.03'
 
   # Brief description of the gem.
   Description = 'Macro-steps for Cucumber'
 
-  # Constant Macros4Cuke::RootDir contains the absolute path of Rodent's
+  # Constant Macros4Cuke::RootDir contains the absolute path of Macro4Cuke's
   # root directory. Note: it also ends with a slash character.
   unless defined?(RootDir)
   # The initialisation of constant RootDir is guarded in order 

data/lib/macros4cuke/templating/engine.rb

@@ -1,9 +1,13 @@
 # File: engine.rb
-# Purpose: Implementation of the MacroStep class.
+# Purpose: Implementation of the Engine class.
 
 require 'strscan' # Use the StringScanner for lexical analysis.
 require_relative '../exceptions' # Load the custom exception classes.
 
+require_relative 'template-element'
+require_relative 'placeholder'
+require_relative 'section'  # Load the Section and ConditionalSection
+
 
 module Macros4Cuke # Module used as a namespace
 
@@ -81,170 +85,6 @@ class EOLine
 end # class
 
 
-# Base class used internally by the template engine.  
-# The generalization of any element from a template that has one variable
-# whose actual value influences the rendition.
-class UnaryElement
-  # The name of the placeholder/variable.
-  attr_reader(:name)
-  
-  # @param aVarName [String] The name of the placeholder from a template.
-  def initialize(aVarName)
-    @name = aVarName
-  end
-
-  protected
-
-  # This method has the same signature as the {Engine#render} method.
-  # @return [Object] The actual value from the locals or context
-  # that is assigned to the variable.
-  def retrieve_value_from(aContextObject, theLocals)
-    actual_value = theLocals[name]
-    if actual_value.nil? && aContextObject.respond_to?(name.to_sym)
-      actual_value = aContextObject.send(name.to_sym)
-    end
-    
-    return actual_value
-  end  
-  
-end # class
-
-
-
-# Class used internally by the template engine.  
-# Represents a named placeholder in a template, that is, 
-# a name placed between <..> in the template.  
-# At rendition, a placeholder is replaced by the text value
-# that is associated with it. 
-class Placeholder < UnaryElement
-
-  public
-
-  # Render the placeholder given the passed arguments.
-  # This method has the same signature as the {Engine#render} method.
-  # @return [String] The text value assigned to the placeholder. 
-  #   Returns an empty string when no value is assigned to the placeholder.
-  def render(aContextObject, theLocals)
-    actual_value = retrieve_value_from(aContextObject, theLocals)
-    
-    result = case actual_value
-      when NilClass
-        ''
-      
-      when Array
-        # TODO: Move away from hard-coded separator.
-        actual_value.join('<br/>')
-        
-      when String
-        actual_value
-      else
-        actual_value.to_s
-    end
-        
-    return result
-  end  
-
-end # class
-
-
-# Base class used internally by the template engine.  
-# Represents a section in a template, that is, 
-# a set of template elements for which its rendition depends
-# on the value of a variable.
-class Section  < UnaryElement
-  # The child elements of the section
-  attr_reader(:children)
-  
-  # @param aVarName [String] The name of the placeholder from a template.
-  def initialize(aVarName)
-    super(aVarName)
-    @children = []
-  end
-
-  public
-
-  # Add a child element as member of the section
-  def add_child(aChild)
-    children << aChild
-  end
-  
-  # Retrieve all placeholder names that appear in the template.
-  # @return [Array] The list of placeholder names.
-  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
-      end
-    end
-    
-    return all_vars.flatten.uniq
-  end
-
-
-  # Render the placeholder given the passed arguments.
-  # This method has the same signature as the {Engine#render} method.
-  # @return [String] The text value assigned to the placeholder. 
-  #   Returns an empty string when no value is assigned to the placeholder.
-  def render(aContextObject, theLocals)
-    msg = "Method Section.#{__method__} must be implemented in subclass."
-    fail(NotImplementedError, msg)
-  end    
-
-end # class
-
-
-# A specialized section in a template for which its rendition
-# depends on the (in)existence of an actual value bound to the variable name.
-class ConditionalSection < Section
-  # A boolean that indicates whether the rendition condition is 
-  # the existence of a value for the variable (true)
-  # or its inexistence (false).
-  attr_reader(:existence)
-
-  # @param aVarName [String] The name of the placeholder from a template.
-  # @param renderWhenExisting [boolean] When true, render the children elements
-  #   if a value exists for the variable.  
-  def initialize(aVarName, renderWhenExisting = true)
-    super(aVarName)
-    @existence = renderWhenExisting
-  end
-  
-  public
-
-  # Render the placeholder given the passed arguments.
-  # This method has the same signature as the {Engine#render} method.
-  # @return [String] The text value assigned to the placeholder. 
-  #   Returns an empty string when no value is assigned to the placeholder.
-  def render(aContextObject, theLocals)
-    actual_value = retrieve_value_from(aContextObject, theLocals)
-    if (!actual_value.nil? && existence) || (actual_value.nil? && !existence)
-      # Let render the children
-      result = children.each_with_object('') do |a_child, sub_result|
-        sub_result << a_child.render(aContextObject, theLocals)
-      end
-    else
-      result = ''
-    end
-    
-    return result
-  end
-
-
-  # @return [String] The original text representation of the tag.
-  def to_s()
-    return "<?#{name}>"
-  end
-
-end # class
-
-
-SectionEndMarker = Struct.new(:name)
-
 
 # A very simple implementation of a templating engine.  
 # Earlier versions of Macros4Cuke relied on the logic-less 

data/lib/macros4cuke/templating/placeholder.rb

@@ -0,0 +1,52 @@
+# File: placeholder.rb
+# Purpose: Implementation of the Placeholder class.
+
+require_relative 'unary-element' # Load the superclass
+
+
+module Macros4Cuke # Module used as a namespace
+
+# Module containing all classes implementing the simple template engine
+# used internally in Macros4Cuke. 
+module Templating
+
+  # Class used internally by the template engine.  
+  # Represents a named placeholder in a template, that is, 
+  # a name placed between <..> in the template.  
+  # At rendition, a placeholder is replaced by the text value
+  # that is associated with it. 
+  class Placeholder < UnaryElement
+
+    public
+
+    # Render the placeholder given the passed arguments.
+    # This method has the same signature as the {Engine#render} method.
+    # @return [String] The text value assigned to the placeholder. 
+    #   Returns an empty string when no value is assigned to the placeholder.
+    def render(aContextObject, theLocals)
+      actual_value = retrieve_value_from(aContextObject, theLocals)
+      
+      result = case actual_value
+        when NilClass
+          ''
+        
+        when Array
+          # TODO: Move away from hard-coded separator.
+          actual_value.join('<br/>')
+          
+        when String
+          actual_value
+        else
+          actual_value.to_s
+      end
+          
+      return result
+    end  
+
+  end # class
+
+end # module
+
+end # module
+
+# End of file

data/lib/macros4cuke/templating/section.rb

@@ -0,0 +1,116 @@
+# File: section.rb
+# Purpose: Implementation of the Section and ConditionalSection classes.
+
+require_relative 'unary-element' # Load the superclass
+
+
+module Macros4Cuke # Module used as a namespace
+
+
+# Module containing all classes implementing the simple template engine
+# used internally in Macros4Cuke. 
+module Templating
+
+# Base class used internally by the template engine.  
+# Represents a section in a template, that is, 
+# a set of template elements for which its rendition depends
+# on the value of a variable.
+class Section  < UnaryElement
+  # The child elements of the section
+  attr_reader(:children)
+  
+  # @param aVarName [String] The name of the placeholder from a template.
+  def initialize(aVarName)
+    super(aVarName)
+    @children = []
+  end
+
+  public
+
+  # Add a child element as member of the section
+  def add_child(aChild)
+    children << aChild
+  end
+  
+  # Retrieve all placeholder names that appear in the template.
+  # @return [Array] The list of placeholder names.
+  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
+      end
+    end
+    
+    return all_vars.flatten.uniq
+  end
+
+
+  # Render the placeholder given the passed arguments.
+  # This method has the same signature as the {Engine#render} method.
+  # @return [String] The text value assigned to the placeholder. 
+  #   Returns an empty string when no value is assigned to the placeholder.
+  def render(aContextObject, theLocals)
+    msg = "Method Section.#{__method__} must be implemented in subclass."
+    fail(NotImplementedError, msg)
+  end    
+
+end # class
+
+
+# A specialized section in a template for which its rendition
+# depends on the (in)existence of an actual value bound to the variable name.
+class ConditionalSection < Section
+  # A boolean that indicates whether the rendition condition is 
+  # the existence of a value for the variable (true)
+  # or its inexistence (false).
+  attr_reader(:existence)
+
+  # @param aVarName [String] The name of the placeholder from a template.
+  # @param renderWhenExisting [boolean] When true, render the children elements
+  #   if a value exists for the variable.  
+  def initialize(aVarName, renderWhenExisting = true)
+    super(aVarName)
+    @existence = renderWhenExisting
+  end
+  
+  public
+
+  # Render the placeholder given the passed arguments.
+  # This method has the same signature as the {Engine#render} method.
+  # @return [String] The text value assigned to the placeholder. 
+  #   Returns an empty string when no value is assigned to the placeholder.
+  def render(aContextObject, theLocals)
+    actual_value = retrieve_value_from(aContextObject, theLocals)
+    if (!actual_value.nil? && existence) || (actual_value.nil? && !existence)
+      # Let render the children
+      result = children.each_with_object('') do |a_child, sub_result|
+        sub_result << a_child.render(aContextObject, theLocals)
+      end
+    else
+      result = ''
+    end
+    
+    return result
+  end
+
+
+  # @return [String] The original text representation of the tag.
+  def to_s()
+    return "<?#{name}>"
+  end
+
+end # class
+
+
+SectionEndMarker = Struct.new(:name)
+
+end # module
+
+end # module
+
+# End of file

data/lib/macros4cuke/templating/template-element.rb

@@ -0,0 +1,88 @@
+# File: template-element.rb
+# Purpose: Implementation of core classes used in the template engine.
+
+
+require_relative '../exceptions' # Load the custom exception classes.
+
+
+
+module Macros4Cuke # Module used as a namespace
+
+
+# Module containing all classes implementing the simple template engine
+# used internally in Macros4Cuke.  
+module Templating
+
+# Class used internally by the template engine.  
+# Represents a static piece of text from a template.  
+# A static text is a text that is reproduced verbatim 
+# when rendering a template.
+class StaticText
+  # The static text extracted from the original template.
+  attr_reader(:source)
+  
+
+  # @param aSourceText [String] A piece of text extracted 
+  #   from the template that must be rendered verbatim.
+  def initialize(aSourceText)
+    @source = aSourceText
+  end
+
+  public
+
+  # Render the static text.
+  # This method has the same signature as the {Engine#render} method.
+  # @return [String] Static text is returned verbatim ("as is")
+  def render(aContextObject, theLocals)
+    return source
+  end
+end # class
+
+
+# Class used internally by the template engine.  
+# Represents a comment from a template.  
+# A static text is a text that is reproduced verbatim 
+# when rendering a template.
+class Comment
+  # The comment as extracted from the original template.
+  attr_reader(:source)
+  
+
+  # @param aSourceText [String] A piece of text extracted 
+  #   from the template that must be rendered verbatim.
+  def initialize(aSourceText)
+    @source = aSourceText
+  end
+
+  public
+
+  # Render the comment.
+  # Comments are rendered as empty text. This is necessary because
+  # Cucumber::RbSupport::RbWorld#steps complains when it sees a comment.
+  # This method has the same signature as the {Engine#render} method.
+  # @return [String] Empty string ("as is")
+  def render(aContextObject, theLocals)
+    return ''
+  end
+end # class
+
+
+# Class used internally by the template engine.  
+# Represents an end of line that must be rendered as such.
+class EOLine
+
+  public
+  
+  # Render an end of line.
+  # This method has the same signature as the {Engine#render} method.
+  # @return [String] An end of line marker. Its exact value is OS-dependent.
+  def render(aContextObject, theLocals)
+    return "\n"
+  end
+end # class
+
+end # module
+
+end # module
+
+# End of file

data/lib/macros4cuke/templating/unary-element.rb

@@ -0,0 +1,39 @@
+# File: unary-element.rb
+# Purpose: Implementation of the Section and ConditionalSection classes.
+
+require_relative 'unary-element' # Load the superclass
+
+
+module Macros4Cuke # Module used as a namespace
+
+  # Base class used internally by the template engine.  
+  # The generalization of any element from a template that has one variable
+  # whose actual value influences the rendition.
+  class UnaryElement
+    # The name of the placeholder/variable.
+    attr_reader(:name)
+    
+    # @param aVarName [String] The name of the placeholder from a template.
+    def initialize(aVarName)
+      @name = aVarName
+    end
+
+    protected
+
+    # This method has the same signature as the {Engine#render} method.
+    # @return [Object] The actual value from the locals or context
+    # that is assigned to the variable.
+    def retrieve_value_from(aContextObject, theLocals)
+      actual_value = theLocals[name]
+      if actual_value.nil? && aContextObject.respond_to?(name.to_sym)
+        actual_value = aContextObject.send(name.to_sym)
+      end
+      
+      return actual_value
+    end  
+    
+  end # class
+
+end # module
+
+# End of file

data/spec/macros4cuke/templating/placeholder_spec.rb

@@ -3,7 +3,7 @@
 require_relative '../../spec_helper'
 
 # Load the classes under test
-require_relative '../../../lib/macros4cuke/templating/engine'
+require_relative '../../../lib/macros4cuke/templating/placeholder'
 
 module Macros4Cuke
 

data/spec/macros4cuke/templating/section_spec.rb

@@ -1,9 +1,12 @@
 # File: section_spec.rb
 
 require_relative '../../spec_helper'
+require_relative '../../../lib/macros4cuke/templating/template-element'
+require_relative '../../../lib/macros4cuke/templating/placeholder'
 
 # Load the classes under test
-require_relative '../../../lib/macros4cuke/templating/engine'
+require_relative '../../../lib/macros4cuke/templating/section'
+
 
 module Macros4Cuke
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.4.02
+  version: 0.4.03
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-17 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -114,6 +114,10 @@ files:
 - lib/macros4cuke/macro-step-support.rb
 - lib/macros4cuke/macro-step.rb
 - lib/macros4cuke/templating/engine.rb
+- lib/macros4cuke/templating/placeholder.rb
+- lib/macros4cuke/templating/section.rb
+- lib/macros4cuke/templating/template-element.rb
+- lib/macros4cuke/templating/unary-element.rb
 - examples/demo/cucumber.yml
 - examples/demo/features/basic.feature
 - examples/demo/features/multiline.feature