gloo-lang 0.9.2 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cf5f126ee8c3c4198d6532c443098e3e7943473ea6fe79d70b01bc01b997253
-  data.tar.gz: e57eae5fcc2d910d576092c740d8c6d0907ef01ecbfd85443cc6277ce26429c3
+  metadata.gz: d19934c8b9f0ae7c4b7770b353555c19c4acb4b755775222e14cde8aa1a4bbee
+  data.tar.gz: b88f21b0a86cf71b92fcc3fe8c018884109b83293e54db266bb17cef5111e7c0
 SHA512:
-  metadata.gz: 10eb7ea0801448637295f4edabdf8a7d5255d4f484ef96d418c5f821116f422f2ad4129a0589cac0b23b9a53309cd683193a1a5a20a88f56c63ab2c542b682e6
-  data.tar.gz: 19d9f88b7ddf70ef89bc5a722e55f268d84cc8d4bbdaa95e429bd56a4a2d4ba9150a2e93b323876c129d51fd99a23b02df360a52d1461e207f4b8c2414b44459
+  metadata.gz: f3475c8c03da31aa4a05feb948b10a89a3b0fae818800ef14329c5028add3e5a788f3a6e7fff7b21c762c53fb67619ffa875dd6586044373110316e78c494480
+  data.tar.gz: 27d759c5e86633db59786a3a7db230c4f26c2e54d94a3d339af759983799fd6a4dccb21b84f0dd4cd8de80f1f3a46650c0d3bb283cee246ce95f5cca439ace4e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gloo-lang (0.9.0)
+    gloo-lang (0.9.4)
       chronic (~> 0.10, >= 0.10.2)
       json (~> 2.1, >= 2.1.0)
       net-ssh (~> 6.1, >= 6.1.0)

data/gloo-lang.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json', '~> 2.1', '>= 2.1.0'
   spec.add_dependency 'openssl', '~> 2.1', '>= 2.1.0'
   spec.add_dependency 'net-ssh', '~> 6.1', '>= 6.1.0'
+  spec.add_dependency 'tty-platform', '~> 0.3', '>= 0.3.0'
   # spec.add_dependency 'mysql2', '~> 0.5', '>= 0.5.3'
   # spec.add_dependency 'sqlite3', '~> 1.4', '>= 1.4.2'
 end

data/lib/VERSION

@@ -1 +1 @@
-0.9.2
+0.9.5

data/lib/dependencies.rb

@@ -11,8 +11,8 @@ files = []
 #
 # We want to start with these to avoid dependency errors later on.
 #
-# files << File.join( path, 'gloo_lang', 'core', 'baseo.rb' )
-# files << File.join( path, 'gloo_lang', 'core', 'obj.rb' )
+files << File.join( path, 'gloo_lang', 'core', 'baseo.rb' )
+files << File.join( path, 'gloo_lang', 'core', 'obj.rb' )
 
 root = File.join( path, 'gloo_lang', '**/*.rb' )
 Dir.glob( root ).each do |ruby_file|

data/lib/gloo-lang.rb

@@ -9,13 +9,9 @@ path = File.dirname( File.absolute_path( __FILE__ ) )
 require File.join( path, 'dependencies.rb' )
 
 module GlooLang
-
-  ERROR_MSG = 'Error:  the gloo_lang gem is not runnable!'.freeze
-  puts ERROR_MSG
-
   # def self.run
   #   params = []
   #   ( params << '--cli' ) if ARGV.count.zero?
-  #   Gloo::App::Engine.new( params ).start
+  #   GlooLang::App::Engine.new( params ).start
   # end
 end

data/lib/gloo_lang/app/args.rb

@@ -0,0 +1,111 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Arguments (parameters) used to specify functionality.
+# These might have come from the CLI or as parameters
+# in the constructor.
+#
+require 'active_support'
+
+module GlooLang
+  module App
+    class Args
+
+      QUIET = 'quiet'.freeze
+      GLOO_ENV = 'GLOO_ENV'.freeze
+
+      attr_reader :switches, :files
+
+      #
+      # Create arguments and setup.
+      #
+      def initialize( params = [] )
+        @switches = []
+        @files = []
+
+        params.each { |o| process_one_arg( o ) }
+        ARGV.each { |o| process_one_arg( o ) }
+      end
+
+      #
+      # Was the --quiet arg passed?
+      #
+      def quiet?
+        return @switches.include?( QUIET )
+      end
+
+      #
+      # Is the version switch set?
+      #
+      def version?
+        @switches.include?( GlooLang::App::Mode::VERSION.to_s )
+      end
+
+      #
+      # Is the help switch set?
+      #
+      def help?
+        @switches.include?( GlooLang::App::Mode::HELP.to_s )
+      end
+
+      #
+      # Is the cli switch set?
+      #
+      def cli?
+        @switches.include?( GlooLang::App::Mode::CLI.to_s )
+      end
+
+      #
+      # Is the embed switch set?
+      #
+      def embed?
+        @switches.include?( GlooLang::App::Mode::EMBED.to_s )
+      end
+
+      #
+      # Detect the mode to be run in.
+      # Start by seeing if a mode is specified.
+      # Then look for the presence of files.
+      # Then finally use the default: embedded mode.
+      #
+      def detect_mode
+        mode = if ENV[ GLOO_ENV ] == GlooLang::App::Mode::TEST.to_s
+                 Mode::TEST
+               elsif version?
+                 Mode::VERSION
+               elsif help?
+                 Mode::HELP
+               elsif cli?
+                 Mode::CLI
+               elsif embed?
+                 Mode::EMBED
+               elsif @files.count.positive?
+                 Mode::SCRIPT
+               else
+                 Mode.default_mode
+               end
+        $log.debug "running in #{mode} mode"
+
+        return mode
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Process one argument or parameter.
+      #
+      def process_one_arg( arg )
+        if arg.start_with? '--'
+          switches << arg[ 2..-1 ]
+        else
+          files << arg
+        end
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/app/engine.rb

@@ -0,0 +1,200 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# The Gloo Script Engine.
+# The Engine aggregates all the elements needed to run gloo.
+# The Engine runs the main event loop and delegates processing
+# to the relevant element.
+#
+
+module GlooLang
+  module App
+    class Engine
+
+      attr_reader :args, :mode, :running, :platform,
+                  :dictionary, :parser, :heap, :factory
+      attr_accessor :last_cmd, :persist_man, :event_manager,
+                    :exec_env, :help, :converter
+
+      #
+      # Set up the engine with basic elements.
+      #
+      def initialize( params = [], platform=nil )
+        $engine = self
+        @args = Args.new( params )
+        $settings = Settings.new( ENV[ 'GLOO_ENV' ] )
+        $log = Log.new( @args.quiet? )
+        @platform = platform ? platform : Platform.new
+        $log.debug 'engine intialized...'
+      end
+
+      #
+      # Start the engine.
+      # Load object and verb definitions and setup engine elements.
+      #
+      def start
+        $log.debug 'starting the engine...'
+        $log.debug Info.display_title
+        @mode = @args.detect_mode
+        @running = true
+
+        @dictionary = GlooLang::Core::Dictionary.instance
+        @dictionary.init
+        @parser = GlooLang::Core::Parser.new
+        @heap = GlooLang::Core::Heap.new
+        @factory = GlooLang::Core::Factory.new
+        @persist_man = GlooLang::Persist::PersistMan.new
+        @event_manager = GlooLang::Core::EventManager.new
+
+        @exec_env = GlooLang::Exec::ExecEnv.new
+        @help = GlooLang::App::Help.new
+        @converter = GlooLang::Convert::Converter.new
+
+        $log.debug 'the engine has started'
+        run_mode
+      end
+
+      # ---------------------------------------------------------------------
+      #    Run
+      # ---------------------------------------------------------------------
+
+      #
+      # Run gloo in the selected mode.
+      #
+      def run_mode
+        $log.debug "running gloo in #{@mode} mode"
+
+        if @mode == Mode::VERSION
+          run_version
+        elsif @mode == Mode::HELP
+          show_help_and_quit
+        elsif @mode == Mode::SCRIPT
+          run_files
+        else
+          run
+        end
+      end
+
+      #
+      # Run files specified on the CLI.
+      # Then quit.
+      #
+      def run_files
+        @args.files.each { |f| @persist_man.load( f ) }
+        quit
+      end
+
+      #
+      # Run in interactive mode.
+      #
+      def run
+        # Open default file(s)
+        self.open_start_file
+
+        # TODO: open any files specifed in args
+
+        unless @mode == Mode::SCRIPT || @args.quiet?
+          @cursor = TTY::Cursor
+          self.loop
+        end
+
+        quit
+      end
+
+      #
+      # Get the setting for the start_with file and open it.
+      #
+      def open_start_file
+        name = $settings.start_with
+        @persist_man.load( name ) if name
+      end
+
+      #
+      # Is the last command entered blank?
+      #
+      def last_cmd_blank?
+        return true if @last_cmd.nil?
+        return true if @last_cmd.strip.empty?
+
+        return false
+      end
+
+      #
+      # Prompt, Get input, process.
+      #
+      def loop
+        while @running
+          @last_cmd = @platform.prompt_cmd
+          process_cmd
+        end
+      end
+
+      #
+      # Process the command.
+      #
+      def process_cmd
+        if last_cmd_blank?
+          @platform.clear_screen
+          return
+        end
+
+        @parser.run @last_cmd
+      end
+
+      #
+      # Request the engine to stop running.
+      #
+      def stop_running
+        @running = false
+      end
+
+      #
+      # Do any clean up and quit.
+      #
+      def quit
+        $log.debug 'quitting...'
+      end
+
+      # ---------------------------------------------------------------------
+      #    Helpers
+      # ---------------------------------------------------------------------
+
+      #
+      # Show the version information and then quit.
+      #
+      def run_version
+        @platform.show Info.display_title unless @args.quiet?
+        quit
+      end
+
+      #
+      # Show the help information and then quit.
+      #
+      def show_help_and_quit
+        @help.show_app_help
+        quit
+      end
+
+      # ---------------------------------------------------------------------
+      #    Error Handling
+      # ---------------------------------------------------------------------
+
+      #
+      # Did the last command result in an error?
+      #
+      def error?
+        return !@heap.error.value.nil?
+      end
+
+      #
+      # Report an error.
+      # Write it to the log and set the heap error value.
+      #
+      def err( msg )
+        $log.error msg
+        self.heap.error.set_to msg
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/app/help.rb

@@ -0,0 +1,117 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Help system.
+#
+
+module GlooLang
+  module App
+    class Help
+
+      APPLICATION = 'application'.freeze
+
+      attr_accessor :topics
+
+      #
+      # Set up the help system.
+      # We won't load help topics until we know we need them.
+      #
+      def initialize
+        @topics = nil
+      end
+
+      #
+      # Show application help.
+      # This is the what is shown when help is run from the CLI.
+      #
+      def show_app_help
+        puts Info.display_title unless $engine.args.quiet?
+        self.show_topic APPLICATION
+      end
+
+      #
+      # Check to see if there is a topic by the given name.
+      #
+      def topic?( name )
+        lazy_load_index
+
+        return @topics.key?( name )
+      end
+
+      #
+      # Is the current topic Markdown?
+      #
+      def topic_is_md?( name )
+        lazy_load_index
+
+        topic_file = @topics[ name ]
+        return topic_file.end_with? '.md'
+      end
+
+      #
+      # Show a help topic, optionally paginaged.
+      # If the content of the help page fits on a single
+      # screen, it won't paginate.
+      #
+      def page_topic( topic )
+        return if $engine.args.quiet?
+
+        data = self.get_topic_data( topic )
+        page = data.lines.count > Settings.page_size
+        $engine.platform.show( data, topic_is_md?( topic ), page )
+      end
+
+      #
+      # Show a help topic.
+      #
+      def show_topic( topic )
+        return if $engine.args.quiet?
+
+        data = self.get_topic_data( topic )
+        $engine.platform.show( data, topic_is_md?( topic ), false )
+      end
+
+      #
+      # Get topic data.
+      #
+      def get_topic_data( topic )
+        lazy_load_index
+
+        topic_file = @topics[ topic ]
+        return nil unless topic_file
+
+        File.read topic_file
+      end
+
+      #
+      # Lazy load topic index.
+      # We'll only load the index the first time a help topic
+      # is requested.  After that we'll use the cached index.
+      #
+      def lazy_load_index
+        return if @topics
+
+        @topics = {}
+        $log.debug 'loading help file index...'
+
+        pn = File.dirname( File.absolute_path( __FILE__ ) )
+        pn = File.dirname( pn )
+
+        root = File.join( pn, 'help', '**/*.txt' )
+        Dir.glob( root ).each do |txt_file|
+          key = File.basename( txt_file, '.txt' )
+          @topics[ key ] = txt_file
+        end
+
+        root = File.join( pn, 'help', '**/*.md' )
+        Dir.glob( root ).each do |md_file|
+          key = File.basename( md_file, '.md' )
+          @topics[ key ] = md_file
+        end
+
+        $log.debug "Found #{@topics.count} help files"
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/app/info.rb

@@ -8,6 +8,14 @@ module GlooLang
   module App
     class Info
 
+      #
+      # Register other Info classes when they are loaded.
+      #
+      def self.inherited( subclass )
+        $infos = [] unless $infos
+        $infos << subclass
+      end
+
       #
       # Load the version from the VERSION file.
       #
@@ -28,6 +36,32 @@ module GlooLang
         return "#{APP_NAME}, version #{VERSION}"
       end
 
+      #
+      # Get the full application version information,
+      # including engine version.
+      #
+      def self.full_version
+        str = "#{display_title}"
+        if $infos
+          $infos.each do |o|
+            str << "\n#{o.display_title}"
+          end
+        end
+        return str
+      end
+
     end
+
+    #
+    # Add the ruby version information.
+    #
+    class RubyInfo < Info
+
+      def self.display_title
+        return "Ruby version: #{RUBY_VERSION}"
+      end
+
+    end
+
   end
 end

data/lib/gloo_lang/app/log.rb

@@ -0,0 +1,81 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Application Logging wrapper.
+#
+require 'active_support'
+require 'colorize'
+require 'colorized_string'
+
+module GlooLang
+  module App
+    class Log
+
+      attr_reader :logger, :quiet
+
+      #
+      # Set up a logger.
+      # If quiet is true, then message are written to the log
+      # but not to the console.
+      #
+      def initialize( quiet )
+        f = File.join( $settings.log_path, 'gloo.log' )
+        @logger = Logger.new( f )
+        @logger.level = Logger::DEBUG
+        @quiet = quiet
+      end
+
+      #
+      # Show a message unless we're in quite mode.
+      #
+      def show( msg )
+        puts msg unless @quiet
+      end
+
+      #
+      # Write a debug message to the log.
+      #
+      def debug( msg )
+        @logger.debug msg
+      end
+
+      #
+      # Write an information message to the log.
+      # Also write to the console unless quiet.
+      #
+      def info( msg )
+        @logger.info msg
+        puts msg.blue unless @quiet
+      end
+
+      #
+      # Write a warning message to the log.
+      # Also write to the console unless quiet.
+      #
+      def warn( msg )
+        @logger.warn msg
+        puts msg.yellow unless @quiet
+      end
+
+      #
+      # Write an error message to the log and set the error
+      # in the engine's data heap.
+      # Also write to the console unless quiet.
+      #
+      def error( msg, ex = nil, engine = nil )
+        engine&.heap&.error&.set_to msg
+        @logger.error msg
+        if ex
+          @logger.error ex.message
+          @logger.error ex.backtrace
+          puts msg.red unless @quiet
+          puts ex.message.red unless @quiet
+          puts ex.backtrace unless @quiet
+        else
+          puts msg.red unless @quiet
+        end
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/app/mode.rb

@@ -0,0 +1,27 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Mode the Application is running in.
+#
+
+module GlooLang
+  module App
+    class Mode
+
+      EMBED = :embed      # Run as embedded script processor
+      CLI = :cli          # Run in interactive (CLI) mode
+      SCRIPT = :script    # Run a script
+      VERSION = :version  # Show version information
+      HELP = :help        # Show the help screen
+      TEST = :test        # Running in Unit Test mode.
+
+      #
+      # Get the default mode.
+      #
+      def self.default_mode
+        return EMBED
+      end
+
+    end
+  end
+end