proteus 0.9.0

data/lib/ComponentInstance.rb

@@ -0,0 +1,76 @@
+################################################################################
+# ComponentInstance.rb
+#
+# Represents an instance of a component.
+# -----------------------------------------------------------------------------
+# (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( File.join(File.dirname(__FILE__), 'ComponentClass.rb') )
+
+
+module Proteus
+  
+  class ComponentInstance
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Constructor
+    #  
+    #---------------------------------------------------------------------------
+    
+    def initialize( kind = ComponentClass::DEFAULT_CLASS,
+      properties = {}, children = [] )
+      
+      @kind = kind
+      @properties = properties
+      @children = children
+      
+    end
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Properties
+    #  
+    #---------------------------------------------------------------------------
+    
+    attr_accessor :kind, :children, :properties
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+    #
+    # Merges the component's properties with the class's and returns the result.
+    #
+    def final_properties
+      return kind.properties.merge( @properties )
+    end
+    
+    #
+    # Merges the component's children with the class's and returns the result.
+    #
+    def final_children
+      return kind.children.merge( @children )
+    end
+    
+  end
+  
+end
+

data/lib/DefinitionHelper.rb

@@ -0,0 +1,157 @@
+################################################################################
+# DefinitionHelper.rb
+#
+# Responsible for loading definitions and maintaining the set of loaded classes.
+# -----------------------------------------------------------------------------
+# (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 'yaml'
+
+require File.expand_path( File.join(File.dirname(__FILE__), 'DefinitionParser.rb') )
+require File.expand_path( File.join(File.dirname(__FILE__), 'FileHelper.rb') )
+require File.expand_path( File.join(File.dirname(__FILE__), 'exceptions.rb') )
+
+
+module Proteus
+
+  class DefinitionHelper
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Constructor
+    #  
+    #---------------------------------------------------------------------------
+    
+    def initialize( definition_parser = nil, path = nil )
+      @path = path
+      @definition_parser = definition_parser
+      
+      @loaded_classes = {}
+      @loading = []
+    end
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Properties
+    #  
+    #---------------------------------------------------------------------------
+  
+  public
+    
+    attr_accessor :path, :definition_parser
+  
+  private
+  
+    attr_accessor :loaded_classes
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    #
+    # Returns the given class.
+    # 
+    # class_path: an array containing the namespaces and class id of the class
+    # current_ns: the current namespace, an array of namespace identifiers
+    #
+    def get_class( class_path, current_ns )
+      
+      current_ns = current_ns || []
+      
+      # 1. Search the current namespace
+      # 2. Search the default namespace
+      begin
+        result = find_class( current_ns.concat(class_path) )
+      rescue Exceptions::DefinitionUnavailable
+        result = find_class( class_path )
+      end
+      
+    end
+    
+    
+  private
+  
+    #
+    # Searches for the given class and loads it if not found.
+    #
+    # class_path: the fully qualified class path, including ALL namespaces.
+    #
+    def find_class( class_path )
+      
+      # If it's already loaded, return it.
+      if @loaded_classes.has_key?( class_path )
+        return @loaded_classes[ class_path ]
+      end
+      
+      # Otherwise create it,
+      new_class = ComponentClass.new
+      
+      # add it to the dictionary,
+      @loaded_classes[ class_path ] = new_class
+      
+      # load its definition,
+      begin
+        new_class = load_class( class_path, new_class )
+      rescue Exception => exception
+        # Load failed so delete it from the dictionary
+        # TODO: consider dropping entire dictionary, since linked classes might
+        # also be affected
+        @loaded_classes.delete( class_path )
+        
+        raise exception
+      end
+      
+      # and return it.
+      return new_class
+      
+    end
+    
+    #
+    # Loads the given class.
+    #
+    # class_path: the full path of the class, including all namespaces
+    #
+    def load_class( class_path, new_class )
+      
+      file = FileHelper.find_definition( class_path, @path )
+      
+      if file.nil?
+        raise Exceptions::DefinitionUnavailable,
+          "File not found for class path: '" + class_path.inspect + "'"
+      end
+      
+      yaml = YAML.load_file( file )
+      
+      @definition_parser.parse_yaml( yaml, new_class, class_path.slice(0..-2) )
+      
+      if new_class.name != class_path[ class_path.length - 1 ]
+        raise Exceptions::DefinitionMalformed,
+          "Definition class name ('" + new_class.name +
+          "') does not match file name ('" +
+          class_path[ class_path.length - 1 ] + "')."
+      end
+      
+      return new_class
+    end
+    
+  end
+end

data/lib/DefinitionParser.rb

@@ -0,0 +1,107 @@
+################################################################################
+# DefinitionParser.rb
+#
+# Responsible for interpreting YAML for definition files.
+# -----------------------------------------------------------------------------
+# (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( File.join(File.dirname(__FILE__), 'ComponentClass.rb') )
+
+
+module Proteus
+  
+  class DefinitionParser
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Constructor
+    #  
+    #---------------------------------------------------------------------------
+    
+    def initialize( definition_helper = nil, class_parser = nil,
+      input_parser = nil )
+      
+      @definition_helper = definition_helper
+      @class_parser = class_parser
+      @input_parser = input_parser
+      
+    end
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Properties
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    attr_accessor :definition_helper, :class_parser, :input_parser
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    #------------------------------
+    #  parse_yaml
+    #------------------------------
+    
+    #
+    # Takes the YAML input read directly from the definition file and parses it,
+    # returning the loaded ComponentClass.
+    #
+    # yaml: The input YAML to be parsed.
+    # component_class: The component class to load.
+    #
+    def parse_yaml( yaml, component_class, current_ns = nil )
+      
+      result = component_class || ComponentClass.new
+      
+      # Let the class parser handle interpreting the YAML, then load the parent
+      # class and parse all the values in the children and properties of the new
+      # component class.
+      
+      @class_parser.parse_yaml( yaml, result )
+      
+      # Get the parent class
+      if result.parent != nil
+        result.parent = @definition_helper.get_class( result.parent.split(':'),
+          current_ns )
+      end
+      
+      # Parse properties
+      for property in result.properties
+        result.properties[ property[0] ] =
+          @input_parser.parse_yaml( property[1], current_ns )
+      end
+      
+      # Parse children
+      result.children.length.times do |i|
+        result.children[i] = @input_parser.parse_yaml( result.children[i],
+          current_ns )
+      end
+      
+      return result
+    end
+    
+  end
+  
+end

data/lib/Facade.rb

@@ -0,0 +1,116 @@
+################################################################################
+# Facade.rb
+#
+# An implementation of the Facade pattern. Provides an easy way to handle the
+# parser and helper classes.
+# -----------------------------------------------------------------------------
+# (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( File.join(File.dirname(__FILE__), 'DefinitionHelper.rb') )
+
+require File.expand_path( File.join(File.dirname(__FILE__), 'InstanceParser.rb') )
+require File.expand_path( File.join(File.dirname(__FILE__), 'ClassParser.rb') )
+require File.expand_path( File.join(File.dirname(__FILE__), 'InputParser.rb') )
+require File.expand_path( File.join(File.dirname(__FILE__), 'DefinitionParser.rb') )
+
+module Proteus
+  
+  class Facade
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Constructor
+    #  
+    #---------------------------------------------------------------------------
+    
+    def initialize( )
+      
+      # 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_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
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Properties
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    # Parsers
+    attr_accessor :class_parser, :instance_parser, :definition_parser,
+      :input_parser
+    
+    # Helpers
+    attr_accessor :definition_helper
+    
+    # Properties
+    attr_reader :path
+    
+    def path=( value )
+      @path = value
+      @definition_helper.path = value
+    end
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    #
+    # Parses the given input YAML.
+    #
+    def parse_input( yaml, current_ns = [] )
+      return @input_parser.parse_yaml( yaml )
+    end
+    
+    #
+    # Parses the given input file.
+    #
+    def parse_file( file, current_ns = [] )
+      return @input_parser.parse_yaml( YAML.load_file(file) )
+    end
+    
+  end
+  
+end
+