proteus 0.9.0

data/lib/PropertyHash.rb

@@ -0,0 +1,64 @@
+################################################################################
+# PropertyHash.rb
+#
+# Wraps the properties of an instance used in the InstanceProxy, rendering its
+# values before returning them.
+# -----------------------------------------------------------------------------
+# (C) Copyright 2009 William Madden
+# 
+# This file is part of Proteus.
+# 
+# Proteus is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# Proteus is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along with
+# Proteus.  If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+
+module Proteus
+  
+  #
+  # Wraps the properties of an instance used in the InstanceProxy, rendering its
+  # values before returning them.
+  #
+  class PropertyHash < Hash
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Constructor
+    #  
+    #---------------------------------------------------------------------------
+    
+    def initialize( properties, renderer )
+      super( properties )
+      @renderer = renderer
+    end
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    #
+    # Overrides the default [] operator to render values before they're
+    # returned.
+    #
+    def []( val )
+      result = super[val]
+      return @renderer.render( result )
+    end
+    
+  end
+  
+end
+

data/lib/TemplateRenderer.rb

@@ -0,0 +1,128 @@
+################################################################################
+# TemplateRenderer.rb
+#
+# Renders the document tree using component templates and ERB.
+# -----------------------------------------------------------------------------
+# (C) Copyright 2009 William Madden
+# 
+# This file is part of Proteus.
+# 
+# Proteus is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# Proteus is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along with
+# Proteus.  If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+require 'erb'
+
+require File.expand_path( File.join(File.dirname(__FILE__), 'ComponentInstance.rb') )
+require File.expand_path( File.join(File.dirname(__FILE__), 'InstanceProxy.rb') )
+
+
+module Proteus
+  
+  # 
+  # Renders a document tree.
+  # 
+  class TemplateRenderer
+    
+    TEMPLATE_PROPERTY = "template"
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    #
+    # Renders a document tree.
+    #
+    def render( tree )
+      
+      case
+        when tree.is_a?( ComponentInstance ):
+          return render_instance( tree )
+        
+        when tree.is_a?( Array ):
+          return render_array( tree )
+          
+        when tree.is_a?( Hash ):
+          return render_hash( tree )
+        
+        when tree.nil?:
+          return ''
+          
+        else
+          return render_scalar( tree )
+      end
+      
+    end
+    
+  private
+    
+    #
+    # Renders a hash.
+    #
+    def render_hash( hash )
+      
+      for pair in hash
+        hash[ pair[0] ] = render( pair[1] )
+      end
+      
+      return hash.to_s
+      
+    end
+    
+    #
+    # Renders an array.
+    #
+    def render_array( array )
+      
+      result = ''
+      
+      array.each do |elem|
+        result += render( elem )
+      end
+      
+      return result
+      
+    end
+    
+    #
+    # Renders a scalar.
+    #
+    def render_scalar( scalar )
+      return scalar.to_s
+    end
+    
+    #
+    # Renders an instance.
+    #
+    def render_instance( instance )
+      
+      result = ''
+      template = instance.final_properties[ TEMPLATE_PROPERTY ]
+      
+      if template != nil
+        proxy = InstanceProxy.new( self, instance )
+        
+        e = ERB.new( template )
+        result = e.result( proxy.instance_env() )
+      end
+      
+      return result
+      
+    end
+    
+  end
+  
+end

data/lib/exceptions.rb

@@ -0,0 +1,50 @@
+################################################################################
+# Exceptions.rb
+#
+# Provides exception definitions.
+# -----------------------------------------------------------------------------
+# (C) Copyright 2009 William Madden
+# 
+# This file is part of Proteus.
+# 
+# Proteus is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# Proteus is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along with
+# Proteus.  If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+module Proteus
+
+  module Exceptions
+  
+    class DefinitionMalformed < Exception
+    end
+    
+    class RenderError < Exception
+    end
+    
+    class RecursiveDefinition < Exception
+    end
+    
+    #
+    # Raised when a component identifier can't be properly parsed.
+    #
+    class InvalidComponentIdentifier < Exception
+    end
+    
+    #
+    # Raised when the definition of a component can't be found.
+    #
+    class DefinitionUnavailable < Exception
+    end
+    
+  end
+  
+end

data/test/spec/ClassParser_spec.rb

@@ -0,0 +1,314 @@
+################################################################################
+# (C) Copyright 2009 William Madden
+# 
+# This file is part of Proteus.
+# 
+# Proteus is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# Proteus is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along with
+# Proteus.  If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+require File.expand_path( 'lib/ClassParser.rb' )
+
+include Proteus
+
+
+describe ClassParser do
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Input Constants
+  #  
+  #-----------------------------------------------------------------------------
+  
+  @@NIL = nil
+  
+  @@SCALAR_1 = "some scalar"
+  
+  @@LIST_1 = [ "a", "b", "c" ]
+  
+  @@VALID_NAME = "SomeComponent"
+  
+  @@VALID_PARENT = "ParentComponent"
+  
+  @@LONG_HASH = {
+    "key1" => "value1",
+    "key2" => "value2"
+  }
+  
+  @@HASH_MISSING_NAME = {
+    "" => {}
+  }
+  
+  @@HASH_BAD_NAME = {
+    "this name is invalid" => {}
+  }
+  
+  @@HASH_MISSING_PARENT = {
+    @@VALID_NAME + " < " => {}
+  }
+  
+  @@HASH_BAD_PARENT = {
+    @@VALID_NAME + " < bad parent" => {}
+  }
+  
+  @@HASH_OF_NIL = {
+    @@VALID_NAME => @@NIL
+  }
+  
+  @@HASH_OF_SCALAR = {
+    @@VALID_NAME => @@SCALAR_1
+  }
+  
+  @@HASH_OF_LIST = {
+    @@VALID_NAME => @@LIST_1
+  }
+  
+  @@HASH_OF_HASH = {
+    @@VALID_NAME => {}
+  }
+  
+  @@PROPERTIES = {
+    "property1" => "value1",
+    "property2" => "value2",
+    "property3" => "value3",
+  }
+  
+  @@CHILDREN = [
+    "child1",
+    "child2",
+    "child3"
+  ]
+  
+  @@PROPERTIES_WITH_CHILDREN = {
+    "property1" => "value1",
+    "property2" => "value2",
+    "property3" => "value3",
+    "children" => @@CHILDREN
+  }
+  
+  @@HASH_OF_PROPS = {
+    @@VALID_NAME => @@PROPERTIES
+  }
+  
+  @@HASH_WITH_PARENT = {
+    @@VALID_NAME + " < " + @@VALID_PARENT => {}
+  }
+  
+  @@HASH_WITH_CHILDREN = {
+    @@VALID_NAME => @@PROPERTIES_WITH_CHILDREN
+  }
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Set up, tear down
+  #  
+  #-----------------------------------------------------------------------------
+  
+  #------------------------------
+  #  before(:all)
+  #------------------------------
+  
+  before(:all) do
+    @class_parser = ClassParser.new()
+  end
+  
+  #------------------------------
+  #  after(:all)
+  #------------------------------
+  
+  after(:all) do
+  end
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Tests
+  #  
+  #-----------------------------------------------------------------------------
+  
+  # Only accept correctly formed definitions.
+  #
+  # Do not accept:
+  #   nil
+  #   scalar
+  #   list
+  #   empty name
+  #   malformed name
+  #   empty parent name
+  #   malformed parent name
+  #   hash of scalar
+  #   hash of list
+  #   hash longer than one element
+  # 
+  # Accept:
+  #   hash of nothing
+  #   hash of hash
+  #
+  
+  it "should reject nil" do
+    begin
+      @class_parser.parse_yaml( @@NIL )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should reject scalar" do
+    begin
+      @class_parser.parse_yaml( @@SCALAR_1 )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should reject list" do
+    begin
+      @class_parser.parse_yaml( @@LIST_1 )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should reject hash longer than one element" do
+    begin
+      @class_parser.parse_yaml( @@LONG_HASH )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should reject missing name" do
+    begin
+      @class_parser.parse_yaml( @@HASH_MISSING_NAME )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should reject malformed name" do
+    begin
+      @class_parser.parse_yaml( @@HASH_BAD_NAME )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should reject empty parent name" do
+    begin
+      @class_parser.parse_yaml( @@HASH_MISSING_PARENT )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should reject malformed parent name" do
+    begin
+      @class_parser.parse_yaml( @@HASH_BAD_PARENT )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should reject hash of scalar" do
+    begin
+      @class_parser.parse_yaml( @@HASH_OF_SCALAR )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should reject hash of list" do
+    begin
+      @class_parser.parse_yaml( @@HASH_OF_LIST )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  
+  it "should accept valid empty hash" do
+    
+    result = @class_parser.parse_yaml( @@HASH_OF_NIL )
+    
+  end
+  
+  
+  it "should accept a hash of a hash" do
+    
+    result = @class_parser.parse_yaml( @@HASH_OF_HASH )
+    
+  end
+  
+  
+  it "should parse names in the form 'Name < Parent'" do
+    
+    result = @class_parser.parse_yaml( @@HASH_WITH_PARENT )
+    
+    result.name.should == @@VALID_NAME
+    result.parent.should == @@VALID_PARENT
+    
+  end
+  
+  
+  it "should interpret the inner hash as properties" do
+    
+    result = @class_parser.parse_yaml( @@HASH_OF_PROPS )
+    
+    result.properties.should == @@PROPERTIES
+    
+  end
+  
+  it "should interpret the 'children' property as children" do
+    
+    result = @class_parser.parse_yaml( @@HASH_WITH_CHILDREN )
+    
+    result.children.should ==  [
+      "child1",
+      "child2",
+      "child3"
+    ]
+    result.properties.should == @@PROPERTIES
+    
+  end
+  
+  
+end
+