gloo 0.8.0 → 1.0.0

data/lib/gloo/core/gloo_system.rb

@@ -1,266 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# The System Object.
-# A virtual Object: the system object can be used to access
-# system level variables and functions.  But it is not
-# actually an object in the normal sense of the word.
-#
-require 'tty-platform'
-
-module Gloo
-  module Core
-    class GlooSystem < Obj
-
-      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 root?
-        return false
-      end
-
-      # Can this object be created?
-      # This is true by default and only false for some special cases
-      # such as the System object.
-      def self.can_create?
-        false
-      end
-
-      # ---------------------------------------------------------------------
-      #    Value
-      # ---------------------------------------------------------------------
-
-      #
-      # Get the parameter.
-      #
-      def param
-        return nil unless @pn && @pn.segments.count > 1
-
-        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 )
-        # 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_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
-      # ---------------------------------------------------------------------
-
-      # Does this object have children to add when an object
-      # is created in interactive mode?
-      # This does not apply during obj load, etc.
-      def add_children_on_create?
-        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 )
-        o = "msg_#{msg}"
-        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' ]
-      end
-
-      # Get the user's home directory.
-      def msg_user_home
-        return File.expand_path( '~' )
-      end
-
-      # 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
-      end
-
-      # Get the Gloo configuration directory
-      def msg_gloo_config
-        return $settings.config_path
-      end
-
-      # Get the Gloo projects directory
-      def msg_gloo_projects
-        return $settings.project_path
-      end
-
-      # Get the Gloo log directory
-      def msg_gloo_log
-        return $settings.log_path
-      end
-
-      # ---------------------------------------------------------------------
-      #    Special chars
-      # ---------------------------------------------------------------------
-
-      # Carriage return (line feed)
-      def msg_line
-        return "\n"
-      end
-
-      # ---------------------------------------------------------------------
-      #    Screen Messages
-      # ---------------------------------------------------------------------
-
-      # Get the number of lines on screen.
-      def msg_screen_lines
-        return Gloo::App::Settings.lines
-      end
-
-      # Get the number of columns on screen.
-      def msg_screen_cols
-        return Gloo::App::Settings.cols
-      end
-
-      # ---------------------------------------------------------------------
-      #    Platform Messages
-      # ---------------------------------------------------------------------
-
-      # Get the platform CPU
-      def msg_platform_cpu
-        platform = TTY::Platform.new
-        return platform.cpu
-      end
-
-      # Get the platform Operating System
-      def msg_platform_os
-        platform = TTY::Platform.new
-        return platform.os
-      end
-
-      # Get the platform version
-      def msg_platform_version
-        platform = TTY::Platform.new
-        return platform.version
-      end
-
-      # Is the platform Windows?
-      def msg_platform_windows?
-        platform = TTY::Platform.new
-        return platform.windows?
-      end
-
-      # Is the platform Unix?
-      def msg_platform_unix?
-        platform = TTY::Platform.new
-        return platform.unix?
-      end
-
-      # Is the platform Linux?
-      def msg_platform_linux?
-        platform = TTY::Platform.new
-        return platform.linux?
-      end
-
-      # Is the platform Mac?
-      def msg_platform_mac?
-        platform = TTY::Platform.new
-        return platform.mac?
-      end
-
-      #
-      # Get the command to open a file on this platform.
-      #
-      def self.open_for_platform
-        platform = TTY::Platform.new
-        return 'open' if platform.mac?
-        return 'xdg-open' if platform.linux?
-
-        return nil
-      end
-
-    end
-  end
-end

data/lib/gloo/core/heap.rb

@@ -1,52 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# The Object Heap.
-# The collection of objects that are currently in play in
-# the running engine.
-#
-
-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
-
-      attr_reader :it, :root, :error
-
-      #
-      # Set up the object heap.
-      #
-      def initialize
-        $log.debug 'object heap intialized...'
-
-        @root = Gloo::Objs::Container.new
-        @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 )
-        can = obj.parent.nil? ? @root : obj.parent
-        return unless can
-
-        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/here.rb

@@ -1,36 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
-#
-# Here helper class,
-# used to resolve relative referencing.
-#
-
-module Gloo
-  module Core
-    class Here
-
-      HERE = '^'.freeze
-
-      #
-      # Does the pathname start with here reference?
-      #
-      def self.includes_here_ref?( elements )
-        return elements.first.start_with?( HERE )
-      end
-
-      #
-      # Expand here reference if present.
-      #
-      def self.expand_here( pn )
-        target = $engine.exec_env.here_obj
-
-        here = pn.elements.first
-        remainder = pn.elements[ 1..-1 ].join( '.' )
-
-        here.length.times { target = target.parent }
-        pn.set_to "#{target.pn}.#{remainder}"
-      end
-
-    end
-  end
-end

data/lib/gloo/core/it.rb

@@ -1,36 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# It is the value of the last command that was run.
-#
-
-module Gloo
-  module Core
-    class It
-
-      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
-
-    end
-  end
-end

data/lib/gloo/core/literal.rb

@@ -1,30 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# A Literal value.
-# Base class for all literal values.
-#
-
-module Gloo
-  module Core
-    class Literal
-
-      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
-
-    end
-  end
-end

data/lib/gloo/core/obj.rb

@@ -1,303 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# An data/value object.
-# Derives from the Baseo object.  Is not a verb.
-#
-
-module Gloo
-  module Core
-    class Obj < Baseo
-
-      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
-
-      #
-      # The name of the object type.
-      #
-      def self.typename
-        raise 'this method should be overriden'
-      end
-
-      #
-      # The object type, suitable for display.
-      #
-      def type_display
-        return self.class.typename
-      end
-
-      #
-      # Set the parent for the object.
-      #
-      def set_parent( obj )
-        @parent = obj
-      end
-
-      #
-      # Is this the root object?
-      #
-      def root?
-        return false if @parent
-        return false unless name.downcase == 'root'
-
-        return true
-      end
-
-      # Can this object be created?
-      # This is true by default and only false for some special cases
-      # such as the System object.
-      def self.can_create?
-        true
-      end
-
-      #
-      # Get the path and name to this object.
-      #
-      def pn
-        str = self.name
-        p = self.parent
-        while p && !p.root?
-          str = "#{p.name}.#{str}"
-          p = p.parent
-        end
-        return str
-      end
-
-      #
-      # Generic function to get display value.
-      # Can be used for debugging, etc.
-      #
-      def display_value
-        return self.pn
-      end
-
-      # ---------------------------------------------------------------------
-      #    Value
-      # ---------------------------------------------------------------------
-
-      #
-      # Set the value with any necessary type conversions.
-      #
-      def set_value( new_value )
-        self.value = new_value
-      end
-
-      #
-      # Get the value for display purposes.
-      #
-      def value_display
-        return self.value.to_s
-      end
-
-      #
-      # Does this object support multi-line values?
-      # Initially only true for scripts.
-      #
-      def multiline_value?
-        return false
-      end
-
-      #
-      # Is the value a String?
-      #
-      def value_string?
-        return self.value.is_a? String
-      end
-
-      #
-      # Is the value an Array?
-      #
-      def value_is_array?
-        return self.value.is_a? Array
-      end
-
-      #
-      # Is the value a blank string?
-      #
-      def value_is_blank?
-        return true if value.nil?
-
-        return self.value.to_s.strip.empty?
-      end
-
-      # ---------------------------------------------------------------------
-      #    Children
-      # ---------------------------------------------------------------------
-
-      #
-      # Find a child of the given name.
-      # If found, return it.  If not found create it.
-      #
-      def find_add_child( name, type )
-        child = self.find_child( name )
-        return child if child
-
-        params = { :name => name,
-                   :type => type,
-                   :value => nil,
-                   :parent => self }
-        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
-        end
-        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 ]
-        end
-
-        @children.each do |o|
-          return o if name.downcase == o.name.downcase
-        end
-
-        if self.type_display == Gloo::Objs::Alias.typename
-          ln = Gloo::Core::Pn.new( self.value )
-          redirect = ln.resolve
-          return redirect.find_child( name )
-        end
-        return nil
-      end
-
-      #
-      # Delete all children from the container.
-      #
-      def delete_children
-        @children.reverse.each do |o|
-          self.remove_child o
-        end
-      end
-
-      #
-      # Remove the object from the children collection.
-      #
-      def remove_child( obj )
-        @children.delete obj
-      end
-
-      # Does this object have children to add when an object
-      # is created in interactive mode?
-      # This does not apply during obj load, etc.
-      def add_children_on_create?
-        return false
-      end
-
-      # Add children to this object.
-      # This is used by containers to add children needed
-      # for default configurations.
-      def add_default_children
-        # Override this.
-      end
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return %w[unload]
-      end
-
-      #
-      # Can this object receive a message?
-      #
-      def can_receive_message?( msg )
-        msgs = self.class.messages
-        return msgs.include?( msg.strip.downcase )
-      end
-
-      #
-      # Sent this object the given message.
-      #
-      def send_message( msg, params = nil )
-        @params = params
-        return self.dispatch msg if self.can_receive_message? msg
-
-        $log.error "Object #{self.name} cannot receive message #{msg}"
-        return false
-      end
-
-      #
-      # Dispatch the message to the object.
-      #
-      def dispatch( msg )
-        o = "msg_#{msg}"
-        if self.respond_to? o
-          self.public_send( o )
-          return true
-        else
-          $log.error "Message #{msg} not implemented"
-          return false
-        end
-      end
-
-      #
-      # Send the object the unload message.
-      #
-      def msg_unload
-        if self.root?
-          $log.error 'Cannot unload the root object.'
-          return
-        end
-
-        $engine.event_manager.on_unload self
-        $engine.heap.unload self
-      end
-
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object.
-      #
-      def self.help
-        return 'No help found.'
-      end
-
-    end
-  end
-end