gloo 0.3.0 → 0.4.0

data/lib/gloo/core/event_manager.rb

@@ -8,39 +8,37 @@
 module Gloo
   module Core
     class EventManager
-            
+
       # Set up the event manager.
-      def initialize()
-        $log.debug "event manager intialized..."        
+      def initialize
+        $log.debug 'event manager intialized...'
       end
-      
-      # 
+
+      #
       # Run on_load scripts in the recently loaded object
       # If no obj is given the script will be run in root.
-      # 
-      def on_load obj=nil, in_heap=false
+      #
+      def on_load( obj = nil, in_heap = false )
         return unless obj || in_heap
-        arr = Gloo::Core::ObjFinder.by_name "on_load", obj
+
+        arr = Gloo::Core::ObjFinder.by_name 'on_load', obj
         arr.each do |o|
-          if o.can_receive_message? "run"
-            o.send_message "run"
-          end
+          o.send_message 'run' if o.can_receive_message? 'run'
         end
       end
 
-      # 
+      #
       # Run on_unload scripts in the object that will be unloaded.
-      # 
-      def on_unload obj
+      #
+      def on_unload( obj )
         return unless obj
-        arr = Gloo::Core::ObjFinder.by_name "on_unload", obj
+
+        arr = Gloo::Core::ObjFinder.by_name 'on_unload', obj
         arr.each do |o|
-          if o.can_receive_message? "run"
-            o.send_message "run"
-          end
+          o.send_message 'run' if o.can_receive_message? 'run'
         end
       end
-      
+
     end
   end
 end

data/lib/gloo/core/factory.rb

@@ -7,61 +7,114 @@
 module Gloo
   module Core
     class Factory < Baseo
-            
+
+      # ---------------------------------------------------------------------
+      #    Initializer
+      # ---------------------------------------------------------------------
+
+      #
       # Set up the object factory.
-      def initialize()
-        $log.debug "object factory intialized..."
+      #
+      def initialize
+        $log.debug 'object factory intialized...'
       end
-      
+
+      # ---------------------------------------------------------------------
+      #    Factory Helpers
+      # ---------------------------------------------------------------------
+
+      # Helper shortcut to create a string.
+      def create_string( name, value, parent )
+        params = { :name => name,
+                   :type => 'string',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
+      # ---------------------------------------------------------------------
+      #    Object Factory
+      # ---------------------------------------------------------------------
+
       # Create object with given name, type and value.
       # One of either name or type is required.
       # All values are optional when considered on their own.
-      def create name=nil, type=nil, value=nil, parent=nil, squash_dups=true
-        objtype = find_type( type )
-        pn = Gloo::Core::Pn.new name
+      # Parameter hash keys:
+      #  :name - the name of the object
+      #  :type - the name of the type
+      #  :value - the initial object value
+      #  :parent - the parent object
+      #  :squash_duplicates - if the object exists, use it rather
+      #                       than creating a new one?  Default = true
+      def create( params )
+        objtype = find_type params[ :type ]
+        return nil unless objtype
+
+        pn = Gloo::Core::Pn.new params[ :name ]
+        parent = params[ :parent ]
         if parent.nil?
           parent = pn.get_parent
           obj_name = pn.name
         else
-          obj_name = name
+          obj_name = params[ :name ]
         end
 
-        if objtype
-          unless objtype.can_create?
-            $log.error "'#{type}' cannot be created."
-            return nil
-          end
-          if pn.exists? && squash_dups
-            o = pn.resolve
-            o.set_value value
-            return o
-          else
-            o = objtype.new
-            o.name = obj_name
-            o.set_value value
-            
-            if parent
-              parent.add_child( o )
-              return o          
-            else
-              $log.error "Could not create object.  Bad path: #{name}"
-              return nil
-            end
-          end
-        else
-          $log.warn "Could not find type, '#{type}'"
+        if pn.exists? && params[ :squash_duplicates ]
+          $log.debug "Updating existing object: #{name}"
+          return self.update_existing pn, params[ :value ]
+        end
+
+        $log.debug "Creating new object: #{name}"
+        return create_new obj_name, params[ :value ], objtype, parent
+      end
+
+      #
+      # Create a new object.
+      #
+      def create_new( name, value, type, parent )
+        unless parent
+          $log.error "Could not create object.  Bad path: #{name}"
           return nil
-        end        
+        end
+
+        o = type.new
+        o.name = name
+        o.set_value value
+        parent.add_child( o )
+        return o
+      end
+
+      #
+      # Find and Update an existing object.
+      #
+      def update_existing( pn, value )
+        o = pn.resolve
+        o.set_value value
+        return o
       end
-      
+
+      #
       # Find the object type by name.
-      def find_type type_name
-        if type_name.nil? || type_name.strip.empty?
-          type_name = "untyped"
+      # Return nil if the object type cannot be found or
+      # cannot be created.
+      #
+      def find_type( type_name )
+        type_name = 'untyped' if type_name.nil? || type_name.strip.empty?
+        t = $engine.dictionary.find_obj( type_name )
+
+        if t.nil?
+          $log.warn "Could not find type, '#{type_name}'"
+          return nil
+        end
+
+        unless t.can_create?
+          $log.error "'#{type_name}' cannot be created."
+          return nil
         end
-        return $engine.dictionary.find_obj( type_name )
+
+        return t
       end
-            
+
     end
   end
 end

data/lib/gloo/core/gloo_system.rb

@@ -10,42 +10,40 @@
 module Gloo
   module Core
     class GlooSystem < Obj
-      
-      KEYWORD = 'gloo'
-      KEYWORD_SHORT = '$'
-      
-      attr_reader :pn
 
+      KEYWORD = 'gloo'.freeze
+      KEYWORD_SHORT = '$'.freeze
+
+      attr_reader :pn
 
       # Set up the object.
       def initialize( pn )
         @pn = pn
       end
-        
-      # 
+
+      #
       # The name of the object type.
-      # 
+      #
       def self.typename
         return KEYWORD
       end
 
-      # 
+      #
       # The short name of the object type.
-      # 
+      #
       def self.short_typename
         return KEYWORD_SHORT
       end
 
-      # 
+      #
       # The object type, suitable for display.
-      # 
+      #
       def type_display
         return self.class.typename
       end
 
-      
       # Is this the root object?
-      def is_root?
+      def root?
         return false
       end
 
@@ -56,61 +54,61 @@ module Gloo
         false
       end
 
-      
       # ---------------------------------------------------------------------
       #    Value
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get the parameter.
-      # 
+      #
       def param
         return nil unless @pn && @pn.segments.count > 1
-        return @pn.segments[1..-1].join( "_" )
+
+        return @pn.segments[ 1..-1 ].join( '_' )
       end
-      
+
       #
       # Get the system value.
-      # 
+      #
       def value
         return dispatch param
       end
-      
-      # 
+
+      #
       # There is no value object in the system.
-      # 
-      def set_value new_value
+      #
+      def set_value( new_value )
+        # overriding base functionality with dummy function
       end
-      
-      # 
+
+      #
       # Get the value for display purposes.
-      # 
+      #
       def value_display
         return value
       end
-            
-      # 
+
+      #
       # Is the value a String?
-      # 
-      def value_is_string?
+      #
+      def value_string?
         return true
       end
 
-      # 
+      #
       # Is the value an Array?
-      # 
+      #
       def value_is_array?
         return false
       end
-      
-      # 
+
+      #
       # Is the value a blank string?
-      # 
+      #
       def value_is_blank?
         return true
       end
 
-
       # ---------------------------------------------------------------------
       #    Children
       # ---------------------------------------------------------------------
@@ -122,34 +120,31 @@ module Gloo
         return false
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
         return []
       end
-      
+
       # Dispatch the message and get the value.
-      def dispatch msg
+      def dispatch( msg )
         o = "msg_#{msg}"
-        if self.respond_to? o 
-          return self.public_send( o ) 
-        else
-          $log.error "Message #{msg} not implemented"
-          return false
-        end
-      end
-      
+        return self.public_send( o ) if self.respond_to? o
+
+        $log.error "Message #{msg} not implemented"
+        return false
+      end
+
       # Get the system hostname.
       def msg_hostname
         return Socket.gethostname
       end
-      
+
       # Get the logged in User.
       def msg_user
         return ENV[ 'USER' ]
@@ -157,14 +152,14 @@ module Gloo
 
       # Get the user's home directory.
       def msg_user_home
-        return File.expand_path( "~" )
+        return File.expand_path( '~' )
       end
 
-			# Get the working directory.
+      # Get the working directory.
       def msg_working_dir
         return Dir.pwd
       end
-      
+
       # Get the Gloo home directory
       def msg_gloo_home
         return $settings.user_root

data/lib/gloo/core/heap.rb

@@ -9,34 +9,36 @@
 module Gloo
   module Core
     class Heap
-      
+
       # The context is a reference to an object, usually a container.
       # The context will be the root by default.
       attr_reader :context
-      
+
       # TODO:  Do I need a running script context?
       # how to resolve relative reference.
-      
-      attr_reader :it, :root
-      
+
+      attr_reader :it, :root, :error
+
       # Set up the object heap.
-      def initialize()
-        $log.debug "object heap intialized..."
-        
+      def initialize
+        $log.debug 'object heap intialized...'
+
         @root = Gloo::Objs::Container.new
-        @root.name = "root"
-        
+        @root.name = 'root'
+
         @context = Pn.root
         @it = It.new
+        @error = Error.new
       end
-      
+
       # Unload the given obj--remove it from the heap.
-      def unload obj
+      def unload( obj )
         can = obj.parent.nil? ? @root : obj.parent
         return unless can
+
         can.remove_child obj
       end
-      
+
     end
   end
 end