gloo 0.6.0 → 0.7.3

data/lib/gloo/core/error.rb

@@ -8,39 +8,50 @@ module Gloo
   module Core
     class Error
 
-      attr_accessor :value
+      attr_accessor :value, :error_count
 
+      #
       # Set up the error object.
+      #
       def initialize
-        @value = nil
+        clear
+      end
+
+      #
+      # Clear out the error message.
+      #
+      def clear
         @error_count = 0
+        @value = nil
       end
 
+      #
       # Set the value of error.
+      #
       def set_to( new_value )
         @error_count += 1
         @value = new_value
       end
 
-      # Clear out the error message.
-      def clear
-        @error_count = 0
-        @value = nil
-      end
-
+      #
       # Start counting errors.
       # We're looking to see if we get any new ones during
       # a script or an immediate command.
+      #
       def start_tracking
         @error_count = 0
       end
 
+      #
       # Clear out error if we didn't add any new ones.
+      #
       def clear_if_no_errors
         self.clear if @error_count.zero?
       end
 
+      #
       # Get the string representation of the error.
+      #
       def to_s
         return @value.to_s
       end

data/lib/gloo/core/event_manager.rb

@@ -9,7 +9,9 @@ module Gloo
   module Core
     class EventManager
 
+      #
       # Set up the event manager.
+      #
       def initialize
         $log.debug 'event manager intialized...'
       end
@@ -21,6 +23,7 @@ module Gloo
       def on_load( obj = nil, in_heap = false )
         return unless obj || in_heap
 
+        $log.debug 'on_load event'
         arr = Gloo::Core::ObjFinder.by_name 'on_load', obj
         arr.each { |o| Gloo::Exec::Dispatch.message 'run', o }
       end
@@ -31,6 +34,7 @@ module Gloo
       def on_unload( obj )
         return unless obj
 
+        $log.debug 'on_unload event'
         arr = Gloo::Core::ObjFinder.by_name 'on_unload', obj
         arr.each { |o| Gloo::Exec::Dispatch.message 'run', o }
       end

data/lib/gloo/core/factory.rb

@@ -45,6 +45,17 @@ module Gloo
         create params
       end
 
+      #
+      # Helper shortcut to create a text child object.
+      #
+      def create_text( name, value, parent )
+        params = { :name => name,
+                   :type => 'text',
+                   :value => value,
+                   :parent => parent }
+        create params
+      end
+
       #
       # Helper shortcut to create an integer child object.
       #

data/lib/gloo/core/gloo_system.rb

@@ -166,7 +166,7 @@ module Gloo
         return $settings.user_root
       end
 
-      # Get the Gloo home directory
+      # Get the Gloo configuration directory
       def msg_gloo_config
         return $settings.config_path
       end

data/lib/gloo/core/heap.rb

@@ -14,12 +14,11 @@ module Gloo
       # 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, :error
 
+      #
       # Set up the object heap.
+      #
       def initialize
         $log.debug 'object heap intialized...'
 
@@ -31,7 +30,9 @@ module Gloo
         @error = Error.new
       end
 
+      #
       # Unload the given obj--remove it from the heap.
+      #
       def unload( obj )
         can = obj.parent.nil? ? @root : obj.parent
         return unless can
@@ -39,6 +40,13 @@ module Gloo
         can.remove_child obj
       end
 
+      #
+      # Is there one or more errors?
+      #
+      def error?
+        return @error.error_count.positive?
+      end
+
     end
   end
 end

data/lib/gloo/core/it.rb

@@ -10,17 +10,23 @@ module Gloo
 
       attr_accessor :value
 
+      #
       # Set up the object.
+      #
       def initialize
         @value = nil
       end
 
+      #
       # Set the value of it.
+      #
       def set_to( new_value )
         @value = new_value
       end
 
+      #
       # Get the string representation of it.
+      #
       def to_s
         return @value.to_s
       end

data/lib/gloo/core/literal.rb

@@ -2,6 +2,7 @@
 # Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
 #
 # A Literal value.
+# Base class for all literal values.
 #
 
 module Gloo
@@ -10,12 +11,16 @@ module Gloo
 
       attr_reader :value
 
+      #
       # Create the expression from a list of tokens.
+      #
       def initialize( value )
         set_value( value )
       end
 
+      #
       # Set the literal value.
+      #
       def set_value( value )
         @value = value
       end

data/lib/gloo/core/obj.rb

@@ -12,14 +12,18 @@ module Gloo
       attr_accessor :value
       attr_reader :children, :parent
 
+      #
       # Set up the object.
+      #
       def initialize
         @value = ''
         @children = []
         @parent = nil
       end
 
+      #
       # Register object types when they are loaded.
+      #
       def self.inherited( subclass )
         Dictionary.instance.register_obj( subclass )
       end
@@ -45,7 +49,9 @@ module Gloo
         @parent = obj
       end
 
+      #
       # Is this the root object?
+      #
       def root?
         return false if @parent
         return false unless name.downcase == 'root'
@@ -149,18 +155,24 @@ module Gloo
         return $engine.factory.create params
       end
 
+      #
       # Add a child object to the container.
+      #
       def add_child( obj )
         @children << obj
         obj.set_parent self
       end
 
+      #
       # Get the number of children.
+      #
       def child_count
         return @children.count
       end
 
+      #
       # Does this object contain an object with the given name?
+      #
       def contains_child?( name )
         @children.each do |o|
           return true if name.downcase == o.name.downcase
@@ -168,7 +180,9 @@ module Gloo
         return false
       end
 
+      #
       # Find a child object with the given name.
+      #
       def find_child( name )
         if name.end_with?( Gloo::Objs::Alias::ALIAS_REFERENCE )
           name = name[ 0..-2 ]

data/lib/gloo/core/op.rb

@@ -2,18 +2,23 @@
 # Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
 #
 # An Operator; part of an expression.
+# A static helper class.
 #
 
 module Gloo
   module Core
     class Op
 
+      #
       # Is the token an operator?
+      #
       def self.op?( token )
         return [ '+', '-', '*', '/' ].include?( token.strip )
       end
 
+      #
       # Create the operator for the given token.
+      #
       def self.create_op( token )
         return Gloo::Expr::OpMinus.new if token == '-'
         return Gloo::Expr::OpMult.new if token == '*'
@@ -23,7 +28,9 @@ module Gloo
         return default_op
       end
 
+      #
       # Get the default operator (+).
+      #
       def self.default_op
         return Gloo::Expr::OpPlus.new
       end

data/lib/gloo/core/parser.rb

@@ -9,12 +9,16 @@ module Gloo
   module Core
     class Parser
 
+      #
       # Set up the parser.
+      #
       def initialize
         $log.debug 'parser intialized...'
       end
 
+      #
       # Parse a command from the immediate execution context.
+      #
       def parse_immediate( cmd )
         cmd, params = split_params cmd
         params = Gloo::Core::Tokens.new( params ) if params
@@ -27,8 +31,10 @@ module Gloo
         return nil
       end
 
+      #
       # If additional params were provided, split them out
       # from the token list.
+      #
       def split_params( cmd )
         params = nil
         i = cmd.rindex( '(' )

data/lib/gloo/core/pn.rb

@@ -15,43 +15,59 @@ module Gloo
 
       attr_reader :src, :elements
 
+      #
       # Set up the object given a source string,
       # ie: the full path and name.
+      #
       def initialize( src )
         set_to src
       end
 
+      #
       # Reference to the root object path.
+      #
       def self.root
         return Pn.new( ROOT )
       end
 
+      #
       # Reference to it.
+      #
       def self.it
         return Pn.new( IT )
       end
 
+      #
       # Reference to the error message.
+      #
       def self.error
         return Pn.new( ERROR )
       end
 
+      #
       # Does the pathname reference refer to the root?
+      #
       def root?
         return @src.downcase == ROOT
       end
 
+      #
       # Does the pathname reference refer to it?
+      #
       def it?
         return @src.downcase == IT
       end
 
+      #
       # Does the pathname reference refer to error?
+      #
       def error?
         return @src.downcase == ERROR
       end
 
+      #
       # Does the pathname reference refer to the gloo system object?
+      #
       def gloo_sys?
         return false unless @elements&.count&.positive?
 
@@ -62,40 +78,54 @@ module Gloo
         return false
       end
 
+      #
       # Get the string representation of the pathname.
+      #
       def to_s
         return @src
       end
 
+      #
       # Set the object pathname to the given value.
+      #
       def set_to( value )
         @src = value.nil? ? nil : value.strip
         @elements = @src.nil? ? [] : @src.split( '.' )
       end
 
+      #
       # Convert the raw string to a list of segments.
+      #
       def segments
         return @elements
       end
 
+      #
       # Get the name element.
+      #
       def name
         return '' unless self.named?
 
         return @elements.last
       end
 
+      #
       # Does the value include path elements?
+      #
       def named?
         return @elements.count.positive?
       end
 
+      #
       # Does the value include a name?
+      #
       def includes_path?
         return @elements.count > 1
       end
 
+      #
       # Get the parent that contains the object referenced.
+      #
       def get_parent
         o = $engine.heap.root
 
@@ -112,7 +142,9 @@ module Gloo
         return o
       end
 
+      #
       # Does the object at the path exist?
+      #
       def exists?
         return true if self.root?
         return true if self.it?
@@ -124,14 +156,18 @@ module Gloo
         return parent.contains_child? name
       end
 
+      #
       # Is the reference to a color?
+      #
       def named_color?
         colors = %w[red blue green white black yellow]
         return true if colors.include?( @src.downcase )
       end
 
+      #
       # Resolve the pathname reference.
       # Find the object referenced or return nil if it is not found.
+      #
       def resolve
         return $engine.heap.root if self.root?
         return $engine.heap.it if self.it?