gloo 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9de5e123f6f642dc630d72e3988eb37c1f877076560fac9056d9b0ebf2ebf211
-  data.tar.gz: 39562aea1825d050bfba660372ce9ef92f9fc17716927499e3a38a4c56ba6db1
+  metadata.gz: 2dc6eeb25e3bf4c7facfb697ba8329768c028160a1784eb28f164cb7b4003385
+  data.tar.gz: 8fe4173c140780a134f19b48e253f3144434cce1c9724c2a4ffa26c5c511c7de
 SHA512:
-  metadata.gz: 576ab94bdf41fd411a87304677fa70c369a0c4f0f67d77f568f7e0cda3fad8b1e63e76a5e65017e43ad95452d2c5e5927fd18170fcb851925e3a81585ad8d94e
-  data.tar.gz: d3072df02df96ea54e67a8c43a8fe5da39f6ca4f37e39b7b60ef9f33a5981b7a12d226a1d583c8575dfd93c5aaa6d705e3cc999528429908c8c4d2e11b8c82b3
+  metadata.gz: 8b3abba9ee1fe27d7c089314726c368bc7be08ba418572ee15193a2be81f3cad34cb7fdf4c1abe314da186bae5bc27d5b0bae18dc28f1a61ef77ed18f510a5b5
+  data.tar.gz: 56a36064fbf90ade2952b695c51a8a338ec1f43219c9302c2b66f6bf487d20aa29b2f72dfb9fb59d30264be38c4a4cf76f504015ffb6cd981629528b122d0b35

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gloo (0.6.0)
+    gloo (0.7.0)
       activesupport (~> 5.2, >= 5.2.4.3)
       chronic (~> 0.10, >= 0.10.2)
       colorize (~> 0.8, >= 0.8.1)

data/lib/gloo/app/args.rb

@@ -12,8 +12,14 @@ module Gloo
   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 = []
@@ -22,9 +28,39 @@ module Gloo
         ARGV.each { |o| process_one_arg( o ) }
       end
 
+      #
       # Was the --quiet arg passed?
+      #
       def quiet?
-        return @switches.include?( 'quiet' )
+        return @switches.include?( QUIET )
+      end
+
+      #
+      # Is the version switch set?
+      #
+      def version?
+        @switches.include?( Gloo::App::Mode::VERSION.to_s )
+      end
+
+      #
+      # Is the help switch set?
+      #
+      def help?
+        @switches.include?( Gloo::App::Mode::HELP.to_s )
+      end
+
+      #
+      # Is the cli switch set?
+      #
+      def cli?
+        @switches.include?( Gloo::App::Mode::CLI.to_s )
+      end
+
+      #
+      # Is the embed switch set?
+      #
+      def embed?
+        @switches.include?( Gloo::App::Mode::EMBED.to_s )
       end
 
       #
@@ -34,15 +70,15 @@ module Gloo
       # Then finally use the default: embedded mode.
       #
       def detect_mode
-        mode = if ENV[ 'GLOO_ENV' ] == 'test'
+        mode = if ENV[ GLOO_ENV ] == Gloo::App::Mode::TEST.to_s
                  Mode::TEST
-               elsif @switches.include?( 'version' )
+               elsif version?
                  Mode::VERSION
-               elsif @switches.include?( 'help' )
+               elsif help?
                  Mode::HELP
-               elsif @switches.include?( 'cli' )
+               elsif cli?
                  Mode::CLI
-               elsif @switches.include?( 'embed' )
+               elsif embed?
                  Mode::EMBED
                elsif @files.count.positive?
                  Mode::SCRIPT
@@ -54,9 +90,15 @@ module Gloo
         return mode
       end
 
+      # ---------------------------------------------------------------------
+      #    Private
+      # ---------------------------------------------------------------------
+
       private
 
+      #
       # Process one argument or parameter.
+      #
       def process_one_arg( arg )
         if arg.start_with? '--'
           switches << arg[ 2..-1 ]

data/lib/gloo/app/engine.rb

@@ -2,6 +2,9 @@
 # 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.
 #
 
 require 'tty-prompt'
@@ -15,9 +18,11 @@ module Gloo
       attr_reader :args, :mode, :running
       attr_reader :dictionary, :parser, :heap, :factory
       attr_accessor :last_cmd, :persist_man, :event_manager
-      attr_accessor :exec_env
+      attr_accessor :exec_env, :help, :converter
 
+      #
       # Set up the engine with basic elements.
+      #
       def initialize( params = [] )
         $engine = self
         @args = Args.new( params )
@@ -27,7 +32,10 @@ module Gloo
         $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
@@ -43,7 +51,10 @@ module Gloo
         @event_manager = Gloo::Core::EventManager.new
 
         @exec_env = Gloo::Exec::ExecEnv.new
+        @help = Gloo::App::Help.new
+        @converter = Gloo::Convert::Converter.new
 
+        $log.debug 'the engine has started'
         run_mode
       end
 
@@ -51,12 +62,16 @@ module Gloo
       #    Run
       # ---------------------------------------------------------------------
 
-      # Run the selected mode.
+      #
+      # 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
-          run_help
+          show_help_and_quit
         elsif @mode == Mode::SCRIPT
           run_files
         else
@@ -64,19 +79,20 @@ module Gloo
         end
       end
 
+      #
       # Run files specified on the CLI.
       # Then quit.
+      #
       def run_files
-        @args.files.each do |f|
-          @persist_man.load( f )
-        end
-
+        @args.files.each { |f| @persist_man.load( f ) }
         quit
       end
 
-      # Run
+      #
+      # Run in interactive mode.
+      #
       def run
-        # Open default files
+        # Open default file(s)
         self.open_start_file
 
         # TODO: open any files specifed in args
@@ -89,28 +105,44 @@ module Gloo
         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
 
+      #
       # Prompt for the next command.
+      #
       def prompt_cmd
+        @last_cmd = $prompt.ask( default_prompt )
+      end
+
+      #
+      # Get the default prompt text.
+      #
+      def default_prompt
         dt = DateTime.now
         d = dt.strftime( '%Y.%m.%d' )
         t = dt.strftime( '%I:%M:%S' )
-
-        @last_cmd = $prompt.ask( "#{'gloo'.blue} #{d.yellow} #{t.white} >" )
+        return "#{'gloo'.blue} #{d.yellow} #{t.white} >"
       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
           prompt_cmd
@@ -118,7 +150,9 @@ module Gloo
         end
       end
 
+      #
       # Process the command.
+      #
       def process_cmd
         if last_cmd_blank?
           clear_screen
@@ -128,12 +162,16 @@ module Gloo
         @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
@@ -142,22 +180,25 @@ module Gloo
       #    Helpers
       # ---------------------------------------------------------------------
 
+      #
       # Show the version information and then quit.
+      #
       def run_version
         puts Info.display_title unless @args.quiet?
         quit
       end
 
+      #
       # Show the help information and then quit.
-      def run_help( keep_running = false )
-        out = "#{Info.display_title}\n"
-        out << Help.get_help_text
-        $engine.heap.it.set_to out
-        puts out unless @args.quiet?
-        quit unless keep_running
+      #
+      def show_help_and_quit
+        @help.show_app_help
+        quit
       end
 
+      #
       # Clear the screen.
+      #
       def clear_screen
         @cursor ||= TTY::Cursor
         print @cursor.clear_screen
@@ -184,28 +225,6 @@ module Gloo
         self.heap.error.set_to msg
       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
-          $log.error e.message
-          $engine.heap.error.set_to e.message
-        end
-
-        return default
-      end
-
     end
   end
 end

data/lib/gloo/app/help.rb

@@ -11,43 +11,144 @@ module Gloo
   module App
     class Help
 
-      # Get text to display when the application is run
-      # in HELP mode.
-      def self.get_help_text
-        load_help_files
+      APPLICATION = 'application'.freeze
 
-        return <<~TEXT
-          NAME
-          \tgloo
+      attr_accessor :topics
 
-          DESCRIPTION
-          \tGloo scripting language.  A scripting language built on ruby.
-          \tMore information coming soon.
+      #
+      # 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
+        if topic_is_md?( topic )
+          show_markdown_data( data, page )
+        else
+          show_text_data( data, page )
+        end
+      end
 
-          SYNOPSIS
-          \tgloo [global option] [file]
+      #
+      # Show a help topic.
+      #
+      def show_topic( topic )
+        return if $engine.args.quiet?
 
-          GLOBAL OPTIONS
-          \t--cli \t\t - Run in CLI mode
-          \t--version \t - Show application version
-          \t--help \t\t - Show this help page
+        data = self.get_topic_data( topic )
+        if topic_is_md?( topic )
+          show_markdown_data data
+        else
+          show_text_data data
+        end
+      end
 
-        TEXT
+      #
+      # Show the markdown data.
+      #
+      def show_text_data( data, page = false )
+        if page
+          pager = TTY::Pager.new
+          pager.page( data )
+        else
+          puts data.white
+          puts
+        end
       end
 
-      def self.load_help_files
+      #
+      # Show the markdown data.
+      #
+      def show_markdown_data( data, page = false )
+        md = TTY::Markdown.parse data
+
+        if page
+          pager = TTY::Pager.new
+          pager.page( md )
+        else
+          puts md
+          puts
+        end
+      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|
-          $log.debug md_file
-          data = File.read md_file
-
-          puts TTY::Markdown.parse data
-          # md = TTY::Markdown.parse data
-          # pager = TTY::Pager.new
-          # pager.page( md )
+          key = File.basename( md_file, '.md' )
+          @topics[ key ] = md_file
         end
+
+        $log.debug "Found #{@topics.count} help files"
       end
 
     end