gloo 4.7.0 → 5.0.1

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

@@ -1,370 +0,0 @@
-# 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
-      TITLE = 'title'.freeze
-      TITLE_COLOR = 'green'.freeze
-      QUIT_ITEM_NAME = 'q'.freeze
-
-      @@menu_stack = []
-
-      #
-      # 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?
-        return false unless @engine.running
-
-        o = find_child LOOP
-        return false unless o
-
-        return o.value
-      end
-
-      # 
-      # If there is no loop child, add it.
-      # 
-      def add_loop_child
-        o = find_child LOOP
-        if o
-          o.set_value true
-          return 
-        end
-
-        fac = @engine.factory
-        fac.create_bool LOOP, true, self
-      end
-
-      # 
-      # Add a Quit menu item
-      # 
-      def add_quit_item
-        items = find_child ITEMS
-        q = items.find_child QUIT_ITEM_NAME
-        return if q
-
-        fac = @engine.factory
-        fac.create_bool LOOP, true, self
-
-        params = { :name => QUIT_ITEM_NAME,
-          :type => 'mitem',
-          :value => 'Quit',
-          :parent => items }
-        mitem = fac.create params
-        script = "put false into #{self.pn}.loop"
-        fac.create_script 'do', script, mitem
-      end
-
-      # 
-      # Add any required children not specified in the source.
-      # 
-      def lazy_add_children
-        add_loop_child
-        add_quit_item
-      end
-
-      #
-      # Does the menu have a title?
-      #
-      def title?
-        o = find_child TITLE
-        return o ? true : false
-      end
-
-      #
-      # Get the Menu's Title.
-      #
-      def title
-        obj = find_child TITLE
-        return obj.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
-
-      # ---------------------------------------------------------------------
-      #    Menu Stack
-      # ---------------------------------------------------------------------
-
-      # 
-      # Show the bread-crumbs for the menu stack.
-      # 
-      def show_menu_stack
-        if @@menu_stack.count < 2
-          puts '...'
-        else
-          msg = ''
-          @@menu_stack[0..-2].each do |menu|
-            msg << ' | ' unless msg.blank?
-            msg << menu.title
-          end
-          msg << ' | ... '
-          puts msg
-        end
-      end
-
-      # 
-      # Add a menu to the stack.
-      # 
-      def push_menu obj
-        @@menu_stack << obj
-      end
-
-      # 
-      # Pop a menu from the stack.
-      # If the last item isn't the given menu,
-      # it won't be popped.
-      # 
-      def pop_menu menu
-        if @@menu_stack[-1] == menu
-          @@menu_stack.pop
-        end
-      end
-
-      # 
-      # Quit all menus and drop into gloo.
-      # 
-      def pop_to_top_level_menu
-        @engine.log.debug 'Quitting to top level menu'
-        while @@menu_stack.count > 1
-          menu = @@menu_stack.pop
-          o = menu.find_child LOOP
-          o.set_value( false ) if o
-        end
-      end
-
-      # 
-      # Quit all menus and drop into gloo.
-      # 
-      def quit_all_menus
-        @engine.log.debug 'Dropping into Gloo'
-        @@menu_stack.each do |menu|
-          o = menu.find_child LOOP
-          o.set_value( false ) if o
-        end
-        @engine.loop
-      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
-        lazy_add_children
-        push_menu self
-        run_default
-        loop do
-          begin_menu
-          if prompt_value.empty?
-            dt = DateTime.now
-            d = dt.strftime( '%Y.%m.%d' )
-            t = dt.strftime( '%I:%M:%S' )
-            cmd = @engine.platform.prompt.ask( "#{d.yellow} #{t.white} >" )
-          else
-            cmd = @engine.platform.prompt.ask( prompt_value )
-          end
-          cmd ? run_command( cmd ) : run_default
-          break unless loop?
-        end
-        pop_menu self
-      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( @engine, '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( @engine, 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( @engine, 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
-        if obj
-          s = Gloo::Exec::Script.new( @engine, obj )
-          s.run
-        elsif title?
-          run_default_title
-        end
-      end
-
-      # 
-      # There is a title, so show it.
-      # 
-      def run_default_title
-        @engine.platform&.clear_screen
-        show_menu_stack
-
-        title_text = @engine.platform.table.box( title )
-        puts title_text.colorize( :color => :white, :background => :black )
-      end
-
-      #
-      # Run the selected command.
-      #
-      def run_command( cmd )
-        @engine.log.info "Menu Command: #{cmd}"
-        obj = find_cmd cmd
-
-        if obj
-          script = obj.do_script
-          return unless script
-  
-          s = Gloo::Exec::Script.new( @engine, script )
-          s.run
-        else
-          if cmd == '?'
-            @engine.log.debug 'Showing options'
-            show_options
-          elsif cmd == 'q!'
-            @engine.log.debug 'Quitting Gloo'
-            @engine.stop_running
-          elsif cmd == 'qq'
-            @engine.log.debug 'Quitting to top level menu'
-            pop_to_top_level_menu
-          elsif cmd.starts_with? ':'
-            gloo_cmd = cmd[1..-1].strip
-            if gloo_cmd.blank?
-              @engine.log.debug 'Quitting all menus and dropping into Gloo'
-              quit_all_menus
-            else
-              @engine.log.debug "Running Gloo command: #{gloo_cmd}"
-              @engine.process_cmd gloo_cmd
-            end
-          else
-            msg = "#{cmd} is not a valid option"
-            @engine.log.warn msg
-          end
-          return
-        end
-
-      end
-
-    end
-  end
-end

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

@@ -1,95 +0,0 @@
-# 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
-
-    end
-  end
-end

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

@@ -1,110 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# Show a CLI prompt and collect user input.
-#
-
-module Gloo
-  module Objs
-    class Prompt < Gloo::Core::Obj
-
-      KEYWORD = 'prompt'.freeze
-      KEYWORD_SHORT = 'ask'.freeze
-      PROMPT = 'prompt'.freeze
-      RESULT = 'result'.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 prompt from the child object.
-      # Returns nil if there is none.
-      #
-      def prompt_value
-        o = find_child PROMPT
-        return nil unless o
-
-        return o.value
-      end
-
-      #
-      # Set the result of the system call.
-      #
-      def set_result( data )
-        r = find_child RESULT
-        return nil unless r
-
-        r.set_value data
-      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_string RESULT, nil, self
-      end
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + %w[run multiline]
-      end
-
-      #
-      # Show a multiline prompt and get the user's input.
-      #
-      def msg_multiline
-        prompt = prompt_value
-        return unless prompt
-
-        result = @engine.platform.prompt.multiline( prompt )
-        set_result result.join
-      end
-
-      #
-      # Show the prompt and get the user's input.
-      #
-      def msg_run
-        prompt = prompt_value
-        return unless prompt
-
-        result = @engine.platform.prompt.ask( prompt )
-        set_result result
-      end
-
-    end
-  end
-end

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

@@ -1,127 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
-#
-# Show a CLI prompt and user selection from a list.
-#
-
-module Gloo
-  module Objs
-    class Select < Gloo::Core::Obj
-
-      KEYWORD = 'select'.freeze
-      KEYWORD_SHORT = 'sel'.freeze
-      PROMPT = 'prompt'.freeze
-      OPTIONS = 'options'.freeze
-      RESULT = 'result'.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 prompt from the child object.
-      # Returns nil if there is none.
-      #
-      def prompt_value
-        o = find_child PROMPT
-        return nil unless o
-
-        return o.value
-      end
-
-      #
-      # Get the list of options for selection.
-      #
-      def options
-        o = find_child OPTIONS
-        return [] unless o
-
-        return o.children.map( &:name )
-      end
-
-      #
-      # Get the value of the selected item.
-      #
-      def key_for_option( selected )
-        o = find_child OPTIONS
-        return nil unless o
-
-        o.children.each do |c|
-          return c.value if c.name == selected
-        end
-
-        return nil
-      end
-
-      #
-      # Set the result of the system call.
-      #
-      def set_result( data )
-        r = find_child RESULT
-        return nil unless r
-
-        r.set_value data
-      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 OPTIONS, self
-        fac.create_string RESULT, nil, self
-      end
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + %w[run]
-      end
-
-      #
-      # Show the prompt and get the user's selection.
-      #
-      def msg_run
-        prompt = prompt_value
-        return unless prompt
-
-        # Page size was part of the tty-prompt but not used now.
-        # per = Gloo::App::Settings.page_size( @engine )
-        result = @engine.platform.prompt.select( prompt, options )
-        set_result self.key_for_option( result )
-      end
-
-    end
-  end
-end