macros4cuke 0.4.08 → 0.4.09

data/lib/macros4cuke/templating/section.rb

@@ -1,116 +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 non-existence (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
+# 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 non-existence (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

@@ -1,88 +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
+# 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

@@ -1,37 +1,37 @@
-# File: unary-element.rb
-# Purpose: Implementation of the Section and ConditionalSection classes.
-
-
-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
+# File: unary-element.rb
+# Purpose: Implementation of the Section and ConditionalSection classes.
+
+
+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/lib/macros4cuke.rb

@@ -1,5 +1,5 @@
 # File: macros4cuke.rb
-# This file acts as a jumping-off point for loading dependencies expected 
+# This file acts as a jumping-off point for loading dependencies expected
 # for a Macros4Cuke user.
 
 require_relative './macros4cuke/constants'