proteus 0.9.0

data/lib/FileHelper.rb

@@ -0,0 +1,80 @@
+################################################################################
+# FileHelper.rb
+#
+# Provides functions for locating and handling 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/>.
+################################################################################
+
+
+module Proteus
+
+  class FileHelper
+    
+    # The default path to search for definitions
+    DEFAULT_PATH = File.expand_path( File.join(File.dirname(__FILE__), 'defs') )
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+    #
+    # Find a file on the path.
+    # 
+    # target: the file to search for
+    # path: the path (standard UNIX path variable) to search
+    #
+    # @return Returns the path to the file.
+    #
+    def self.find_file( target, path = nil )
+      path = path || DEFAULT_PATH
+      
+      path = path.split(':')
+      
+      for filepath in path
+        
+        candidate = File.join( filepath, target )
+        
+        if ( File.file?(candidate) )
+          return candidate
+        end
+        
+      end
+      
+      return nil
+    end
+    
+    #
+    # Find a definition file.
+    # 
+    # class_path: the full path of the class, including all namespaces
+    #
+    def self.find_definition( class_path, path = nil )
+      path = path || DEFAULT_PATH
+      
+      file_path = class_path.join('/') + '.def'
+      
+      # Search the PATH for the file
+      return self.find_file( file_path, path )
+    end
+    
+  end
+  
+end
+

data/lib/InputParser.rb

@@ -0,0 +1,241 @@
+################################################################################
+# InputParser.rb
+#
+# Parses input YAML and returns instances.
+# -----------------------------------------------------------------------------
+# (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__), 'ComponentInstance.rb') )
+require File.expand_path( File.join(File.dirname(__FILE__), 'InstanceParser.rb') )
+require File.expand_path( File.join(File.dirname(__FILE__), 'exceptions.rb') )
+
+module Proteus
+  
+  # 
+  # Parses input YAML.
+  # 
+  class InputParser
+    
+    # A regex defining valid component identifiers
+    @@COMPONENT_RE = /^([a-zA-Z_0-9]+:)*([A-Z][a-zA-Z_0-9]*)$/
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Constructor
+    #  
+    #---------------------------------------------------------------------------
+    
+    def initialize( instance_parser = nil, definition_helper = nil )
+      
+      @instance_parser = instance_parser
+      @definition_helper = definition_helper
+      
+    end
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Properties
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    attr_accessor :instance_parser, :definition_helper
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    #------------------------------
+    #  parse_yaml
+    #------------------------------
+    
+    # 
+    # Parses yaml and returns the document tree.
+    # 
+    def parse_yaml( yaml, current_ns = nil )
+      
+      case
+        when yaml.is_a?( Array ):
+          # Parse each node it contains and return the resultant array
+          return parse_yaml_seq( yaml, current_ns )
+          
+        when yaml.is_a?( Hash ):
+          return parse_yaml_map( yaml, current_ns )
+        
+        when yaml.nil?:
+          return parse_yaml_nil()
+          
+        else
+          return parse_yaml_scalar( yaml, current_ns )
+      end
+      
+    end
+    
+    #------------------------------
+    #  parse_instance
+    #------------------------------
+    
+    #
+    # Parses the values of a component instance.
+    #
+    def parse_instance( instance, current_ns = nil )
+    
+      # Parse its properties
+      for property in instance.properties
+        instance.properties[ property[0] ] = 
+          parse_yaml( property[1], current_ns  )
+      end
+      
+      # Parse its children
+      instance.children.length.times do |i|
+        instance.children[i] = parse_yaml( instance.children[i], current_ns )
+      end
+      
+    end
+    
+    #------------------------------
+    #  parse_component_id
+    #------------------------------
+    
+    # 
+    # Parses a component identifier for the class path.
+    # 
+    def parse_component_id( component_id )
+      return component_id.split(':')
+    end
+    
+  private
+    
+    #------------------------------
+    #  parse_yaml_seq
+    #------------------------------
+    
+    # 
+    # Parses a YAML sequence (Array) returning the resultant array.
+    # 
+    def parse_yaml_seq( yaml, current_ns )
+      
+      return yaml.map { |elem| parse_yaml(elem, current_ns) }
+      
+    end
+    
+    #------------------------------
+    #  parse_yaml_map
+    #------------------------------
+    
+    # 
+    # Parses a YAML map (Hash) returning a component or a hash.
+    # 
+    def parse_yaml_map( yaml, current_ns )
+      
+      # If the hash has only one element and it's a valid component name,
+      # parse it as a component.
+      
+      if yaml.length == 1 and @@COMPONENT_RE === yaml.keys.first
+        
+        # Parse the value mapped to the key
+        value = parse_yaml( yaml.values.first, current_ns )
+        
+        # Parse the component
+        begin
+          return parse_component( yaml.keys.first, value, current_ns )
+        rescue Exceptions::DefinitionUnavailable
+        end
+        
+      end
+      
+      # Otherwise return the hash, parsing each value.
+      return yaml.inject({}) do |acc, pair|
+        acc[pair[0]] = parse_yaml( pair[1], current_ns )
+        acc
+      end
+      
+    end
+    
+    #------------------------------
+    #  parse_yaml_scalar
+    #------------------------------
+    
+    # 
+    # Parses a YAML scalar.
+    # 
+    def parse_yaml_scalar( yaml, current_ns )
+      
+      if @@COMPONENT_RE === yaml then
+        begin
+          return parse_component( yaml, nil, current_ns )
+        rescue Exceptions::DefinitionUnavailable
+        end
+      end
+      
+      return yaml
+      
+    end
+    
+    #------------------------------
+    #  parse_yaml_nil
+    #------------------------------
+    
+    # 
+    # Parses a nil value.
+    # 
+    def parse_yaml_nil()
+      
+      return nil
+      
+    end
+    
+    #------------------------------
+    #  parse_component
+    #------------------------------
+    
+    # 
+    # Parses a component.
+    # 
+    # component_id: a component identifier (e.g. HTML:div)
+    # yaml: the YAML describing the instance
+    # 
+    def parse_component( component_id, yaml, current_ns )
+      
+      result = ComponentInstance.new
+      
+      # Parse the id for namespaces and type
+      class_path = parse_component_id( component_id )
+      
+      # Get the class of the component
+      result.kind = @definition_helper.get_class( class_path, current_ns )
+      
+      # Parse the YAML into the instance
+      @instance_parser.parse_yaml( yaml, result )
+      
+      # Parse the values of the instance
+      parse_instance( result, current_ns )
+      
+      return result
+      
+    end
+    
+  end
+  
+end

data/lib/InstanceParser.rb

@@ -0,0 +1,65 @@
+################################################################################
+# InstanceParser.rb
+#
+# Responsible for interpreting YAML for component instances.
+# -----------------------------------------------------------------------------
+# (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__), 'ComponentInstance.rb') )
+
+module Proteus
+ 
+  class InstanceParser
+    
+    @@CHILDREN = "children"
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    #
+    # Interprets pre-parsed yaml and returns the loaded component instance.
+    #
+    def parse_yaml( yaml, instance = nil )
+      result = instance || ComponentInstance.new
+      
+      case
+        when yaml.is_a?( Array ):
+          result.children = yaml
+          
+        when yaml.is_a?( Hash ):
+          result.properties.merge!( yaml )
+          result.children = result.properties.delete(@@CHILDREN) || []
+          
+        when yaml.nil?:
+          return result
+          
+        else
+          result.children = [yaml]
+      end
+      
+      return result
+    end
+    
+  end
+  
+end

data/lib/InstanceProxy.rb

@@ -0,0 +1,100 @@
+################################################################################
+# InstanceProxy.rb
+#
+# Provides the environment for rendering templates.
+# -----------------------------------------------------------------------------
+# (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__), 'PropertyHash.rb') )
+
+
+module Proteus
+  
+  #
+  # Provides the environment for rendering templates.
+  #
+  class InstanceProxy
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Constructor
+    #  
+    #---------------------------------------------------------------------------
+    
+    def initialize( renderer, instance )
+      @renderer = renderer
+      @instance = instance
+      
+      @kind = @instance.kind
+      @properties = @instance.final_properties
+      @props = PropertyHash.new( @properties, @renderer )
+      @children = @instance.children
+    end
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Properties
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    attr_accessor :renderer, :instance, :kind, :properties, :props, :children
+    
+    #---------------------------------------------------------------------------
+    #  
+    #  Methods
+    #  
+    #---------------------------------------------------------------------------
+    
+  public
+    
+    #
+    # Returns the binding in the scope of the proxy instance.
+    #
+    def instance_env( )
+      return binding()
+    end
+    
+    #
+    # Redirects missing method calls to the property hash.
+    #
+    def method_missing(m, *args)
+      @props[ m.to_s ]
+    end
+    
+    #
+    # Returns the next child, or nil.
+    #
+    def next_child
+      if @_last_child_index.nil?
+        @last_child = nil
+        @_last_child_index = 0
+        return renderer.render( children[0] )
+      end
+      
+      @last_child = children[ @_last_child_index ]
+      @_last_child_index += 1
+      
+      return renderer.render( children[ @_last_child_index ] )
+    end
+    
+  end
+
+end
+