gloo 0.4.0 → 0.5.0

data/lib/gloo/objs/cli/bar.rb

@@ -0,0 +1,141 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Show a CLI progress bar.
+#
+require 'tty-progressbar'
+
+module Gloo
+  module Objs
+    class Bar < Gloo::Core::Obj
+
+      KEYWORD = 'bar'.freeze
+      KEYWORD_SHORT = 'bar'.freeze
+      NAME = 'name'.freeze
+      TOTAL = 'total'.freeze
+
+      #
+      # 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
+
+      #
+      # Get the bar's name from the child object.
+      #
+      def name_value
+        o = find_child NAME
+        return '' unless o
+
+        return o.value
+      end
+
+      #
+      # Get the bar's total from the child object.
+      #
+      def total_value
+        o = find_child TOTAL
+        return 100 unless o
+
+        return o.value
+      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 true
+      end
+
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      def add_default_children
+        fac = $engine.factory
+        fac.create_string NAME, '', self
+        fac.create_int TOTAL, 100, self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[start advance stop]
+      end
+
+      #
+      # Start the progress bar.
+      #
+      def msg_start
+        msg = "#{name_value} [:bar] :percent"
+        @bar = TTY::ProgressBar.new( msg, total: total_value )
+      end
+
+      #
+      # Finish the progress bar.
+      #
+      def msg_stop
+        @bar.finish
+      end
+
+      #
+      # Advance the progress bar.
+      #
+      def msg_advance
+        x = 1
+        if @params&.token_count&.positive?
+          expr = Gloo::Expr::Expression.new( @params.tokens )
+          x = expr.evaluate.to_i
+        end
+
+        @bar.advance x
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          BAR OBJECT TYPE
+            NAME: bar
+            SHORTCUT: bar
+
+          DESCRIPTION
+            CLI progress bar
+
+          CHILDREN
+            name - string
+              The name of the progress bar.
+            total - integer - 100
+              The total for the bar.
+
+          MESSAGES
+            start - Start the bar.
+            advance <amount> - Advance by the given amount.
+            stop - Complete the bar.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/cli/colorize.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
 #
 # Show colorized output.
 #

data/lib/gloo/objs/cli/menu.rb

@@ -0,0 +1,236 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A CLI menu.
+# The menu contains a collection of menu items, a prompt
+# and an option to loop until done.
+#
+
+module Gloo
+  module Objs
+    class Menu < Gloo::Core::Obj
+
+      KEYWORD = 'menu'.freeze
+      KEYWORD_SHORT = 'menu'.freeze
+      PROMPT = 'prompt'.freeze
+      ITEMS = 'items'.freeze
+      LOOP = 'loop'.freeze
+      HIDE_ITEMS = 'hide_items'.freeze
+      BEFORE_MENU = 'before_menu'.freeze
+      DEFAULT = 'default'.freeze
+
+      #
+      # 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
+
+      #
+      # Get the value of the prompt child object.
+      # Returns nil if there is none.
+      #
+      def prompt_value
+        o = find_child PROMPT
+        return '' unless o
+
+        return o.value
+      end
+
+      #
+      # Get the value of the loop child object.
+      # Should we keep looping or should we stop?
+      #
+      def loop?
+        o = find_child LOOP
+        return false unless o
+
+        return o.value
+      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 true
+      end
+
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      def add_default_children
+        fac = $engine.factory
+        fac.create_string PROMPT, '> ', self
+        fac.create_can ITEMS, self
+        fac.create_bool LOOP, true, self
+        fac.create_script DEFAULT, '', self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'run' ]
+      end
+
+      #
+      # Show the menu options, and prompt for user input.
+      #
+      def msg_run
+        loop do
+          begin_menu
+          if prompt_value.empty?
+            dt = DateTime.now
+            d = dt.strftime( '%Y.%m.%d' )
+            t = dt.strftime( '%I:%M:%S' )
+            cmd = $prompt.ask( "#{d.yellow} #{t.white} >" )
+          else
+            cmd = $prompt.ask( prompt_value )
+          end
+          cmd ? run_command( cmd ) : run_default
+          break unless loop?
+        end
+      end
+
+      # ---------------------------------------------------------------------
+      #    Menu actions
+      # ---------------------------------------------------------------------
+
+      #
+      # Begin the menu execution.
+      # Run the before menu script if there is one,
+      # then show options unless we are hiding them by default.
+      #
+      def begin_menu
+        run_before_menu
+
+        # Check to see if we should show items at all.
+        o = find_child HIDE_ITEMS
+        return if o && o.value == true
+
+        show_options
+      end
+
+      #
+      # If there is a before menu script, run it now.
+      #
+      def run_before_menu
+        o = find_child BEFORE_MENU
+        return unless o
+
+        Gloo::Exec::Dispatch.message 'run', o
+      end
+
+      #
+      # Show the list of menu options.
+      #
+      def show_options
+        o = find_child ITEMS
+        return unless o
+
+        o.children.each do |mitem|
+          mitem = Gloo::Objs::Alias.resolve_alias( mitem )
+          puts "  #{mitem.shortcut_value} - #{mitem.description_value}"
+        end
+      end
+
+      #
+      # Find the command matching user input.
+      #
+      def find_cmd( cmd )
+        o = find_child ITEMS
+        return nil unless o
+
+        o.children.each do |mitem|
+          mitem = Gloo::Objs::Alias.resolve_alias( mitem )
+          return mitem if mitem.shortcut_value.downcase == cmd.downcase
+        end
+
+        return nil
+      end
+
+      #
+      # Run the default option.
+      #
+      def run_default
+        obj = find_child DEFAULT
+        return unless obj
+
+        s = Gloo::Core::Script.new obj
+        s.run
+      end
+
+      #
+      # Run the selected command.
+      #
+      def run_command( cmd )
+        obj = find_cmd cmd
+
+        unless obj
+          if cmd == '?'
+            show_options
+          else
+            puts "#{cmd} is not a valid option"
+          end
+          return
+        end
+
+        script = obj.do_script
+        return unless script
+
+        s = Gloo::Core::Script.new script
+        s.run
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          MENU OBJECT TYPE
+            NAME: menu
+            SHORTCUT: menu
+
+          DESCRIPTION
+            A CLI menu.
+            This can be used for the main loop of a CLI application.
+
+          CHILDREN
+            prompt - string - '> '
+              The shortcut may be used to select the  menu item.
+            items - container
+              A textual description of the menu item action.
+            loop - boolean
+              The script that will be run if the menu item is selected.
+            default - script
+              Optional script element. Run this if no other option selected.
+
+          MESSAGES
+            run - Show the options and the the prompt.
+              Then run the script for the user's selection.
+              Optionally repeat as long as the loop child is true.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/cli/menu_item.rb

@@ -0,0 +1,128 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A CLI menu item.  One element in a CLI menu.
+#
+
+module Gloo
+  module Objs
+    class MenuItem < Gloo::Core::Obj
+
+      KEYWORD = 'menu_item'.freeze
+      KEYWORD_SHORT = 'mitem'.freeze
+      SHORTCUT = 'shortcut'.freeze
+      DESCRIPTION = 'description'.freeze
+      DO = 'do'.freeze
+
+      #
+      # 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
+
+      #
+      # Get the value of the menu item shortcut.
+      # Returns nil if there is none.
+      #
+      def shortcut_value
+        o = find_child SHORTCUT
+        return self.name unless o
+
+        return o.value
+      end
+
+      #
+      # Get the action's description.
+      # Returns nil if there is none.
+      #
+      def description_value
+        o = find_child DESCRIPTION
+        return self.value unless o
+
+        return o.value
+      end
+
+      #
+      # Get the action's script.
+      # Returns nil if there is none.
+      #
+      def do_script
+        return find_child DO
+      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 true
+      end
+
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      def add_default_children
+        fac = $engine.factory
+        fac.create_string SHORTCUT, '', self
+        fac.create_string DESCRIPTION, '', self
+        fac.create_script DO, '', self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          MENU_ITEM OBJECT TYPE
+            NAME: menu_item
+            SHORTCUT: mitem
+
+          DESCRIPTION
+            A CLI menu item.  One element in a CLI menu.
+
+          CHILDREN
+            shortcut - string
+              The shortcut may be used to select the  menu item.
+              The shortcut child is optional.  If it is not provided,
+              the name of the menu item will be used instead.
+            description - string
+              A textual description of the menu item action.
+              The description child is optional.  If it is not provided,
+              the value of the menu item will be used instead.
+            do - script
+              The script that will be run if the menu item is selected.
+
+          MESSAGES
+            None
+        TEXT
+      end
+
+    end
+  end
+end