gloo 1.4.2 → 2.0.0

data/lib/gloo/app/settings.rb

@@ -0,0 +1,202 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Application and user settings.
+#
+
+require 'yaml'
+
+module Gloo
+  module App
+    class Settings
+
+      attr_reader :user_root, :log_path,
+        :config_path, :project_path,
+        :start_with, :list_indent, :tmp_path,
+        :debug_path, :debug
+
+      #
+      # Load setting from the yml file.
+      # The mode parameter is used to determine if we are running in TEST.
+      #
+      def initialize( engine, root=nil )
+        @engine = engine
+        # @mode = mode
+        init_root( root )
+
+        init_path_settings
+        init_user_settings
+      end
+
+      #
+      # Show the current application settings.
+      # Can be seen in app with 'help settings'
+      #
+      def show
+        puts "\nApplication Settings:"
+        puts '  Startup with:  ' + @start_with
+        puts '  Indent in Listing:  ' + @list_indent.to_s
+        puts '  Screen Lines:  ' + Gloo::App::Settings.lines( @engine ).to_s
+        puts '  Page Size:  ' + Gloo::App::Settings.page_size( @engine ).to_s
+        puts ''
+        self.show_paths
+        puts ''
+      end
+
+      #
+      # Show path settings
+      #
+      def show_paths
+        puts '  User Root Path is here:  ' + @user_root
+        puts '  Projects Path:  ' + @project_path
+        puts '  Tmp Path:  ' + @tmp_path
+        puts '  Debug Path:  ' + @debug_path
+      end
+
+      # #
+      # # Show the current application settings.
+      # # Can be seen in app with 'help settings'
+      # #
+      # def show
+      #   puts "\nApplication Settings:".blue
+      #   puts '  Startup with:  '.yellow + @start_with.white
+      #   puts '  Indent in Listing:  '.yellow + @list_indent.to_s.white
+      #   puts '  Screen Lines:  '.yellow + Gloo::App::Settings.lines.to_s.white
+      #   puts '  Page Size:  '.yellow + Gloo::App::Settings.page_size.to_s.white
+      #   puts ''
+      #   self.show_paths
+      #   puts ''
+      # end
+      #
+      # #
+      # # Show path settings
+      # #
+      # def show_paths
+      #   puts '  User Root Path is here:  '.yellow + @user_root.white
+      #   puts '  Projects Path:  '.yellow + @project_path.white
+      #   puts '  Tmp Path:  '.yellow + @tmp_path.white
+      #   puts '  Debug Path:  '.yellow + @debug_path.white
+      # end
+
+      #
+      # Get the number of vertical lines on screen.
+      #
+      def self.lines engine
+        engine.platform.lines
+      end
+
+      #
+      # Get the number of horizontal columns on screen.
+      #
+      def self.cols engine
+        engine.platform.cols
+      end
+
+      #
+      # Get the default page size.
+      # This is the number of lines of text we can show.
+      #
+      def self.page_size engine
+        Settings.lines( engine ) - 3
+      end
+
+      #
+      # How many lines should we use for a preview?
+      #
+      def self.preview_lines
+        return 7
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Initialize gloo's root path.
+      #
+      def init_root root
+        if root
+          @user_root = root
+        # if in_test_mode?
+        #   path = File.dirname( File.dirname( File.absolute_path( __FILE__ ) ) )
+        #   path = File.dirname( File.dirname( path ) )
+        #   path = File.join( path, 'test', 'gloo' )
+        #   @user_root = path
+        else
+          @user_root = File.join( Dir.home, 'gloo' )
+        end
+      end
+
+      #
+      # Get the app's required directories.
+      #
+      def init_path_settings
+        Dir.mkdir( @user_root ) unless File.exist?( @user_root )
+
+        @log_path = File.join( @user_root, 'logs' )
+        Dir.mkdir( @log_path ) unless File.exist?( @log_path )
+
+        @config_path = File.join( @user_root, 'config' )
+        Dir.mkdir( @config_path ) unless File.exist?( @config_path )
+
+        @tmp_path = File.join( @user_root, 'tmp' )
+        Dir.mkdir( @tmp_path ) unless File.exist?( @tmp_path )
+
+        @debug_path = File.join( @user_root, 'debug' )
+        Dir.mkdir( @debug_path ) unless File.exist?( @debug_path )
+      end
+
+      #
+      # Initialize the user settings for the currently
+      # running environment.
+      #
+      def init_user_settings
+        settings = get_settings
+
+        @project_path = settings[ 'gloo' ][ 'project_path' ]
+        if @project_path.blank?
+          @project_path = File.join( @user_root, 'projects' )
+        end
+
+        @start_with = settings[ 'gloo' ][ 'start_with' ]
+        @list_indent = settings[ 'gloo' ][ 'list_indent' ]
+
+        @debug = settings[ 'gloo' ][ 'debug' ]
+      end
+
+      #
+      # Get the app's required directories.
+      #
+      def get_settings
+        f = File.join( @config_path, 'gloo.yml' )
+        create_settings( f ) unless File.exist?( f )
+        return YAML.load_file f
+      end
+
+      #
+      # Create settings file.
+      #
+      def create_settings( file )
+        IO.write( file, get_default_settings )
+      end
+
+      #
+      # Get the value for default settings.
+      #
+      def get_default_settings
+        projects = File.join( @user_root, 'projects' )
+        str = <<~TEXT
+          gloo:
+            project_path: #{projects}
+            start_with:
+            list_indent: 1
+            debug: false
+        TEXT
+        return str
+      end
+
+    end
+  end
+end

data/lib/gloo/convert/converter.rb

@@ -0,0 +1,42 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Data conversion manager.
+#
+
+module Gloo
+  module Convert
+    class Converter
+
+      #
+      # Initializer.
+      #
+      def initialize( engine )
+        @engine = engine
+      end
+
+      # ---------------------------------------------------------------------
+      #    Convert
+      # ---------------------------------------------------------------------
+
+      #
+      # Convert the given value to the specified type,
+      # or if no conversion is available, revert to default.
+      #
+      def convert( value, to_type, default = nil )
+        begin
+          name = "Gloo::Convert::#{value.class}To#{to_type}"
+          clazz = name.split( '::' ).inject( Object ) { |o, c| o.const_get c }
+          o = clazz.new
+          return o.convert( value )
+        rescue => e
+          @engine.log.error e.message
+          @engine.heap.error.set_to e.message
+        end
+
+        return default
+      end
+
+    end
+  end
+end

data/lib/gloo/convert/string_to_date.rb

@@ -0,0 +1,21 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2023 Eric Crane.  All rights reserved.
+#
+# Conversion tool:  String to Date.
+#
+require 'chronic'
+
+module Gloo
+  module Convert
+    class StringToDate
+
+      #
+      # Convert the given string value to date.
+      #
+      def convert( value )
+        return Chronic.parse( value )
+      end
+
+    end
+  end
+end

data/lib/gloo/convert/string_to_datetime.rb

@@ -0,0 +1,21 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Conversion tool:  String to Date Time.
+#
+require 'chronic'
+
+module Gloo
+  module Convert
+    class StringToDateTime
+
+      #
+      # Convert the given string value to a date and time.
+      #
+      def convert( value )
+        return Chronic.parse( value )
+      end
+
+    end
+  end
+end

data/lib/gloo/convert/string_to_decimal.rb

@@ -0,0 +1,20 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Conversion tool:  String to Decimal.
+#
+
+module Gloo
+  module Convert
+    class StringToDecimal
+
+      #
+      # Convert the given string value to an integer.
+      #
+      def convert( value )
+        return value.to_f
+      end
+
+    end
+  end
+end

data/lib/gloo/convert/string_to_integer.rb

@@ -0,0 +1,20 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Conversion tool:  String to Integer.
+#
+
+module Gloo
+  module Convert
+    class StringToInteger
+
+      #
+      # Convert the given string value to an integer.
+      #
+      def convert( value )
+        return value.to_i
+      end
+
+    end
+  end
+end

data/lib/gloo/convert/string_to_time.rb

@@ -0,0 +1,21 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2023 Eric Crane.  All rights reserved.
+#
+# Conversion tool:  String to Time.
+#
+require 'chronic'
+
+module Gloo
+  module Convert
+    class StringToTime
+
+      #
+      # Convert the given string value to time.
+      #
+      def convert( value )
+        return Chronic.parse( value )
+      end
+
+    end
+  end
+end

data/lib/gloo/core/baseo.rb

@@ -0,0 +1,31 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# An abstract base object.
+# All objects and verbs derive from this.
+#
+
+module Gloo
+  module Core
+    class Baseo
+
+      attr_accessor :name
+
+      NOT_IMPLEMENTED_ERR = 'Not implemented yet!'.freeze
+
+      # Set up the object.
+      def initialize( engine )
+        @engine = engine
+        @name = ''
+      end
+
+      #
+      # The object type, suitable for display.
+      #
+      def type_display
+        raise 'this method should be overriden'
+      end
+
+    end
+  end
+end

data/lib/gloo/core/dictionary.rb

@@ -0,0 +1,245 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# A dictionary of Objects and Verbs.
+#
+require 'singleton'
+
+module Gloo
+  module Core
+    class Dictionary
+
+      include Singleton
+
+      attr_reader :verbs, :objs, :keywords
+
+      #
+      # Set up the object dictionary.
+      #
+      def initialize
+        @verbs = {}
+        @objs = {}
+        @verb_references = []
+        @obj_references = []
+        @keywords = []
+      end
+
+      #
+      # Get the singleton Dictionary and Initialize
+      # if this is the first time.
+      #
+      def self.get
+        o = Gloo::Core::Dictionary.instance
+        o.init if o.verbs.count == 0
+        return o
+      end
+
+      #
+      # Register a verb.
+      #
+      def register_verb( subclass )
+        @verb_references << subclass
+      end
+
+      #
+      # Register an object type.
+      #
+      def register_obj( subclass )
+        @obj_references << subclass
+      end
+
+      #
+      # Initialize verbs and objects in the dictionary.
+      #
+      def init
+        # @engine.log.debug 'initializing dictionaries'
+        init_verbs
+        init_objs
+      end
+
+      #
+      # Is the given word an object type?
+      #
+      def obj?( word )
+        return false unless word
+
+        return @objs.key?( word.downcase )
+      end
+
+      #
+      # Find the object type by name.
+      #
+      def find_obj( word )
+        return nil unless word
+        return nil unless obj?( word )
+
+        return @objs[ word.downcase ]
+      end
+
+      #
+      # Is the given word a verb?
+      #
+      def verb?( word )
+        return false unless word
+
+        return @verbs.key?( word.downcase )
+      end
+
+      #
+      # Find the verb by name.
+      #
+      def find_verb( verb )
+        return nil unless verb
+        return nil unless verb?( verb )
+
+        return @verbs[ verb.downcase ]
+      end
+
+      #
+      # Get the list of verbs, sorted.
+      #
+      def get_obj_types
+        return @obj_references.sort { |a, b| a.typename <=> b.typename }
+      end
+
+      #
+      # Get the list of verbs, sorted.
+      #
+      def get_verbs
+        return @verb_references.sort { |a, b| a.keyword <=> b.keyword }
+      end
+
+      #
+      # Lookup the keyword by name or shortcut.
+      # Return the keyword (name) or nil if it is not found.
+      #
+      def lookup_keyword( key )
+        v = find_verb key
+        return v.keyword if v
+
+        o = find_obj key
+        return o.typename if o
+
+        return nil
+      end
+
+      #
+      # Show a list of all keywords.
+      # This includes verbs and objects, names and shortcuts.
+      #
+      def show_keywords
+        str = ''
+        @keywords.sort.each_with_index do |k, i|
+          str << k.ljust( 20, ' ' )
+          if ( ( i + 1 ) % 6 ).zero?
+            puts str
+            str = ''
+          end
+        end
+      end
+
+      # ---------------------------------------------------------------------
+      #    Register after start up
+      # ---------------------------------------------------------------------
+
+      #
+      # Register a verb after start up.
+      #
+      def register_verb_post_start( verb_class )
+        add_verb verb_class
+      end
+
+      #
+      # Register an object type after start up.
+      #
+      def register_obj_post_start( obj_class )
+        add_object obj_class
+      end
+
+      #
+      # Un-Register a verb.
+      #
+      def unregister_verb( verb_class )
+        @verbs.delete( verb_class.keyword )
+        @verbs.delete( verb_class.keyword_shortcut )
+
+        @keywords.delete( verb_class.keyword )
+        @keywords.delete( verb_class.keyword_shortcut )
+      end
+
+      #
+      # Un-Register an object.
+      #
+      def unregister_obj( obj_class )
+        @objs.delete( obj_class.typename )
+        @objs.delete( obj_class.short_typename )
+
+        @keywords.delete( obj_class.typename )
+        @keywords.delete( obj_class.short_typename )
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Add a keyword to the keyword list.
+      # Report an error if the keyword is already in the list.
+      #
+      def add_key( keyword )
+        if @keywords.include?( keyword )
+          # @engine.log.error "duplicate keyword '#{keyword}'"
+          return
+        end
+
+        @keywords << keyword
+      end
+
+      #
+      # Init the list of objects.
+      #
+      def init_objs
+        # @engine.log.debug "initializing #{@obj_references.count} objects"
+        @obj_references.each do |o|
+          add_object o
+        end
+      end
+
+      #
+      # Init the list of verbs.
+      #
+      def init_verbs
+        # @engine.log.debug "initializing #{@verb_references.count} verbs"
+        @verb_references.each do |v|
+          add_verb v
+        end
+      end
+
+      # 
+      # Add an object to the dictionary
+      # 
+      def add_object o
+        # @engine.log.debug o
+        @objs[ o.typename ] = o
+        @objs[ o.short_typename ] = o
+        add_key o.typename
+        add_key o.short_typename if o.typename != o.short_typename
+      end
+
+      # 
+      # Add a verb to the dictionary
+      # 
+      def add_verb v
+        # @engine.log.debug v
+        @verbs[ v.keyword ] = v
+        @verbs[ v.keyword_shortcut ] = v
+        # v.send( :new ).run
+        add_key v.keyword
+        add_key v.keyword_shortcut if v.keyword != v.keyword_shortcut
+      end
+
+    end
+  end
+end

data/lib/gloo/core/error.rb

@@ -0,0 +1,61 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# If the last command to run generated an error it will be here.
+#
+
+module Gloo
+  module Core
+    class Error
+
+      attr_accessor :value, :error_count
+
+      #
+      # Set up the error object.
+      #
+      def initialize
+        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
+
+      #
+      # 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
+
+    end
+  end
+end