proteus 0.9.0

data/test/spec/ComponentClass_spec.rb

@@ -0,0 +1,44 @@
+################################################################################
+# (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/ComponentClass.rb' )
+
+include Proteus
+
+
+describe ComponentClass do
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Input Constants
+  #  
+  #-----------------------------------------------------------------------------
+
+  #-----------------------------------------------------------------------------
+  #  
+  #  Set up, tear down
+  #  
+  #-----------------------------------------------------------------------------
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Tests
+  #  
+  #-----------------------------------------------------------------------------
+  
+end

data/test/spec/ComponentInstance_spec.rb

@@ -0,0 +1,50 @@
+################################################################################
+# (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/ComponentInstance.rb' )
+
+include Proteus
+
+
+describe ComponentInstance do
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Input Constants
+  #  
+  #-----------------------------------------------------------------------------
+
+  #-----------------------------------------------------------------------------
+  #  
+  #  Set up, tear down
+  #  
+  #-----------------------------------------------------------------------------
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Tests
+  #  
+  #-----------------------------------------------------------------------------
+  
+  it "should override its class's default properties"
+  
+  
+  it "should drop its class's children in favour of its own, if present"
+  
+  
+end

data/test/spec/DefinitionHelper_spec.rb

@@ -0,0 +1,134 @@
+################################################################################
+# (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/DefinitionHelper.rb' )
+require File.expand_path( 'lib/exceptions.rb' )
+
+include Proteus
+
+
+describe DefinitionHelper do
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Input Constants
+  #  
+  #-----------------------------------------------------------------------------
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Set up, tear down
+  #  
+  #-----------------------------------------------------------------------------
+  
+  #------------------------------
+  #  before(:all)
+  #------------------------------
+  
+  before(:all) do
+    
+    # Instance parser
+    @instance_parser = InstanceParser.new
+    
+    # Class parser
+    @class_parser = ClassParser.new
+    
+    # Definition parser
+    @definition_parser = DefinitionParser.new
+    @definition_parser.class_parser = @class_parser
+    
+    # Definition helper
+    @definition_helper = DefinitionHelper.new
+    @definition_helper.definition_parser = @definition_parser
+    @definition_helper.path = "test/spec/lib"
+    
+    @definition_parser.definition_helper = @definition_helper
+    
+    # Input parser
+    @input_parser = InputParser.new
+    @input_parser.instance_parser = @instance_parser
+    @input_parser.definition_helper = @definition_helper
+    
+    @definition_parser.input_parser = @input_parser
+    
+  end
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Tests
+  #  
+  #-----------------------------------------------------------------------------
+  
+  it "should use the current namespace if no namespace is given" do
+    result = @definition_helper.get_class( ["TestComponent4"], ["NS1"] )
+    result.name.should == "TestComponent4"
+  end
+  
+  
+  it "should use the given namespace if present" do
+    result = @definition_helper.get_class( ["NS2", "TestComponent6"], ["NS1"] )
+    result.name.should == "TestComponent6"
+  end
+  
+  
+  it "should return classes that have already been loaded" do
+    result = @definition_helper.get_class( ["TestComponent4"], ["NS1"] )
+    result.name.should == "TestComponent4"
+    
+    result2 = @definition_helper.get_class( ["TestComponent4"], ["NS1"] )
+    result2.should == result
+  end
+  
+  
+  it "should fail if it can't find the class definition" do
+    begin
+      result = @definition_helper.get_class( ["TestComponent7"], ["NS1"] )
+    rescue Exceptions::DefinitionUnavailable
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+  
+  it "should be able to handle recursive classes" do
+    result = @definition_helper.get_class( ["TestComponent8"], ["NS1"] )
+    result.is_a?( ComponentClass ).should == true
+    result.name.should == "TestComponent8"
+    result.parent.should == result
+    
+    result = @definition_helper.get_class( ["TestComponent9"], ["NS1"] )
+    result.is_a?( ComponentClass ).should == true
+    result.name.should == "TestComponent9"
+    result.parent.is_a?( ComponentClass ).should == true
+    result.parent.name.should == "TestComponent10"
+    result.parent.parent.should == result
+    
+  end
+  
+  it "should fail if the definition's class name doesn't match its filename" do
+    begin
+      result = @definition_helper.get_class( ["TestComponent11"], ["NS1"] )
+    rescue Exceptions::DefinitionMalformed
+      success = true
+    end
+    
+    success.should == true
+  end
+  
+end

data/test/spec/DefinitionParser_spec.rb

@@ -0,0 +1,236 @@
+################################################################################
+# (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/InputParser.rb' )
+
+include Proteus
+
+
+describe DefinitionParser do
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Input Constants
+  #  
+  #-----------------------------------------------------------------------------
+
+  class DummyInputParser
+    
+    attr_accessor :called, :inputs
+    
+    def initialize
+      @inputs = []
+    end
+    
+    def parse_yaml( yaml, current_ns )
+      @called = true
+      @inputs.push( yaml )
+    end
+    
+  end
+
+  class DummyClassParser
+    
+    attr_accessor :called, :yaml, :component_class
+    
+    def initialize()
+      @called = false
+    end
+    
+    def parse_yaml( yaml, component_class )
+      @called = true
+      
+      @yaml = yaml
+      @component_class = component_class
+      
+      component_class.name = "SomeComponent"
+      component_class.parent = "SomeParent"
+      component_class.children = [
+        "child1",
+        "child2",
+        "child3"
+      ]
+      component_class.properties = {
+        "prop1" => "value1",
+        "prop2" => "value2",
+        "prop3" => "value3"
+      }
+      
+      return component_class
+    end
+    
+  end
+
+  class DummyDefinitionHelper
+    
+    attr_accessor :called, :class_id
+    
+    def get_class( class_id, current_ns )
+      @called = true
+      @class_id = class_id
+      
+      return nil
+    end
+    
+  end
+  
+  @@PARENT_NAME = "SomeParent"
+  @@UNKNOWN_PARENT_NAME = "UnknownParent"
+  
+  @@COMPONENT_NAME = "SomeComponent"
+  @@COMPONENT_CHILDREN = [
+    "child1",
+    "child2",
+    "child3"
+  ]
+  @@COMPONENT_PROPS = {
+    "prop1" => "value1",
+    "prop2" => "value2",
+    "prop3" => "value3"
+  }
+
+  @@COMPONENT_FULL_PROPS = {
+    "prop1" => "value1",
+    "prop2" => "value2",
+    "prop3" => "value3",
+    "children" => @@COMPONENT_CHILDREN
+  }
+
+  @@EXPECTED_INPUTS = [
+    "value1",
+    "value2",
+    "value3",
+    "child1",
+    "child2",
+    "child3"
+  ]
+
+  @@DEFINITION = {
+    @@COMPONENT_NAME + " < " + @@PARENT_NAME => @@COMPONENT_FULL_PROPS
+  }
+  
+  @@UNKNOWN_PARENT_DEFINITION = {
+    @@COMPONENT_NAME + " < " + @@UNKNOWN_PARENT_NAME => @@COMPONENT_FULL_PROPS
+  }
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Set up, tear down
+  #  
+  #-----------------------------------------------------------------------------
+  
+  #------------------------------
+  #  before(:each)
+  #------------------------------
+  
+  before(:each) do
+    @dummy_dh = DummyDefinitionHelper.new
+    @dummy_cp = DummyClassParser.new
+    @dummy_ip = DummyInputParser.new
+    
+    @definition_parser = 
+      DefinitionParser.new( @dummy_dh, @dummy_cp, @dummy_ip )
+  end
+  
+  #-----------------------------------------------------------------------------
+  #  
+  #  Tests
+  #  
+  #-----------------------------------------------------------------------------
+  
+  it "should use the class parser to parse the file" do
+    
+    component_class = ComponentClass.new
+    
+    @definition_parser.parse_yaml( @@DEFINITION, component_class )
+    
+    @dummy_cp.called.should == true
+    @dummy_cp.component_class.should == component_class
+    @dummy_cp.yaml.should == @@DEFINITION
+    
+  end
+  
+  
+  it "should use the input parser to parse the class's values" do
+    
+    component_class = ComponentClass.new
+    
+    @definition_parser.parse_yaml( @@DEFINITION, component_class )
+    
+    @dummy_ip.called.should == true
+    @dummy_ip.inputs.should == @@EXPECTED_INPUTS
+    
+  end
+  
+  
+  it "should use the definition helper to get the parent" do
+    
+    component_class = ComponentClass.new
+    
+    @definition_parser.parse_yaml( @@DEFINITION, component_class )
+    
+    @dummy_dh.called.should == true
+    @dummy_dh.class_id.should == [ @@PARENT_NAME ]
+    
+  end
+  
+  
+  it "should fail if the parent is unavailable" do
+    
+    component_class = ComponentClass.new
+    
+    # Set up real parsers
+    
+    # Instance parser
+    @instance_parser = InstanceParser.new
+    
+    # Class parser
+    @class_parser = ClassParser.new
+    
+    # Definition parser
+    @definition_parser = DefinitionParser.new
+    @definition_parser.class_parser = @class_parser
+    
+    # Definition helper
+    @definition_helper = DefinitionHelper.new
+    @definition_helper.definition_parser = @definition_parser
+    @definition_helper.path = "spec/lib"
+    
+    @definition_parser.definition_helper = @definition_helper
+    
+    # Input parser
+    @input_parser = InputParser.new
+    @input_parser.instance_parser = @instance_parser
+    @input_parser.definition_helper = @definition_helper
+    
+    @definition_parser.input_parser = @input_parser
+    
+    begin
+      @definition_parser.parse_yaml( @@UNKNOWN_PARENT_DEFINITION,
+        component_class )
+    rescue Exceptions::DefinitionUnavailable
+      success = true
+    end
+    
+    success.should == true
+    
+  end
+  
+  
+end
+