gloo 0.8.0 → 1.0.0

data/lib/gloo/app/args.rb

@@ -1,112 +0,0 @@
-# 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'
-require 'colorize'
-
-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 = []
-
-        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?( 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
-
-      #
-      # 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 ] == Gloo::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/app/engine.rb

@@ -1,230 +0,0 @@
-# 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.
-#
-
-require 'tty-prompt'
-require 'tty-cursor'
-require 'colorize'
-
-module Gloo
-  module App
-    class Engine
-
-      attr_reader :args, :mode, :running,
-                  :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 = [] )
-        $engine = self
-        @args = Args.new( params )
-        $settings = Settings.new( ENV[ 'GLOO_ENV' ] )
-        $log = Log.new( @args.quiet? )
-        $prompt = TTY::Prompt.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 = Gloo::Core::Dictionary.instance
-        @dictionary.init
-        @parser = Gloo::Core::Parser.new
-        @heap = Gloo::Core::Heap.new
-        @factory = Gloo::Core::Factory.new
-        @persist_man = Gloo::Persist::PersistMan.new
-        @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
-
-      # ---------------------------------------------------------------------
-      #    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
-
-      #
-      # 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' )
-        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
-          process_cmd
-        end
-      end
-
-      #
-      # Process the command.
-      #
-      def process_cmd
-        if last_cmd_blank?
-          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
-        puts 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
-
-      #
-      # Clear the screen.
-      #
-      def clear_screen
-        @cursor ||= TTY::Cursor
-        print @cursor.clear_screen
-        print @cursor.move_to( 0, 0 )
-      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/app/help.rb

@@ -1,156 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# Help system.
-#
-
-require 'tty-markdown'
-require 'tty-pager'
-
-module Gloo
-  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
-        if topic_is_md?( topic )
-          show_markdown_data( data, page )
-        else
-          show_text_data( data, page )
-        end
-      end
-
-      #
-      # Show a help topic.
-      #
-      def show_topic( topic )
-        return if $engine.args.quiet?
-
-        data = self.get_topic_data( topic )
-        if topic_is_md?( topic )
-          show_markdown_data data
-        else
-          show_text_data data
-        end
-      end
-
-      #
-      # 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
-
-      #
-      # 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|
-          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/app/mode.rb

@@ -1,27 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# Mode the Application is running in.
-#
-
-module Gloo
-  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

data/lib/gloo/app/settings.rb

@@ -1,186 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# Application and user settings.
-#
-
-require 'yaml'
-require 'tty-screen'
-require 'colorize'
-
-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( mode )
-        @mode = mode
-        init_root
-        init_path_settings
-        init_user_settings
-      end
-
-      #
-      # Are we in test mode?
-      #
-      def in_test_mode?
-        return @mode == 'TEST'
-      end
-
-      #
-      # Get the project path for the current mode.
-      #
-      def project_path_for_mode( settings )
-        return File.join( @user_root, 'projects' ) if in_test_mode?
-
-        return settings[ 'gloo' ][ 'project_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
-        TTY::Screen.rows
-      end
-
-      #
-      # Get the number of horizontal columns on screen.
-      #
-      def self.cols
-        TTY::Screen.cols
-      end
-
-      #
-      # Get the default page size.
-      # This is the number of lines of text we can show.
-      #
-      def self.page_size
-        Settings.lines - 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
-        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 = project_path_for_mode settings
-        @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