gloo 0.5.3 → 0.7.1

data/lib/gloo/objs/basic/script.rb

@@ -90,36 +90,10 @@ module Gloo
       # Send the object the unload message.
       #
       def msg_run
-        s = Gloo::Core::Script.new self
+        s = Gloo::Exec::Script.new self
         s.run
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          SCRIPT OBJECT TYPE
-            NAME: script
-            SHORTCUT: cmd
-
-          DESCRIPTION
-            An exectutable script.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            run - Run the script.
-                  The script can be run by telling the object or run.
-                  It can all be executed with the run verb.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/basic/string.rb

@@ -43,14 +43,18 @@ module Gloo
         return super + %w[up down size]
       end
 
+      #
       # Get the size of the string.
+      #
       def msg_size
         s = value.size
         $engine.heap.it.set_to s
         return s
       end
 
+      #
       # Convert string to upper case
+      #
       def msg_up
         s = value.upcase
         set_value s
@@ -58,7 +62,9 @@ module Gloo
         return s
       end
 
+      #
       # Convert string to lower case
+      #
       def msg_down
         s = value.downcase
         set_value s
@@ -66,32 +72,6 @@ module Gloo
         return s
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          STRING OBJECT TYPE
-            NAME: string
-            SHORTCUT: str
-
-          DESCRIPTION
-            A string value.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            up - Convert the string to uppercase.
-            down - Convert the string to lowercase.
-            size - Get the size of the string.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/basic/text.rb

@@ -82,31 +82,6 @@ module Gloo
         set_value File.read( tmp )
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          TEXT OBJECT TYPE
-            NAME: text
-            SHORTCUT: txt
-
-          DESCRIPTION
-            A longer, multi-line text string.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            edit - Edit the text field in the default editor.
-            page - Show the text, paginated.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/basic/untyped.rb

@@ -36,32 +36,6 @@ module Gloo
         return super # + [ "run" ]
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          UNTYPED OBJECT TYPE
-            NAME: untyped
-            SHORTCUT: un
-
-          DESCRIPTION
-            An untyped object.
-            If no type is specified when an object is created it
-            will be of this type.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            None
-        TEXT
-      end
-
     end
   end
 end

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

@@ -103,35 +103,6 @@ module Gloo
         puts pastel.decorate( t, *c )
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          BANNER OBJECT TYPE
-            NAME: banner
-            SHORTCUT: ban
-
-          DESCRIPTION
-            Banner text in large, colored font.
-
-          CHILDREN
-            text - string
-              The text for the banner.
-            style - string
-              The banner style.  See tty-font for options.
-            color - string
-              The color for the banner.  See pastel for options.
-
-          MESSAGES
-            show - Show the text banner.
-        TEXT
-      end
-
     end
   end
 end

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

@@ -107,35 +107,6 @@ module Gloo
         @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

@@ -42,10 +42,7 @@ module Gloo
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create( { :name => 'white',
-                      :type => 'string',
-                      :value => '',
-                      :parent => self } )
+        fac.create_string 'white', '', self
       end
 
       # ---------------------------------------------------------------------
@@ -59,7 +56,9 @@ module Gloo
         return super + [ 'run' ]
       end
 
-      # Run the system command.
+      #
+      # Run the colorize command.
+      #
       def msg_run
         msg = ''
         children.each do |o|
@@ -69,35 +68,6 @@ module Gloo
         $engine.heap.it.set_to msg.to_s
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          COLORIZE OBJECT TYPE
-            NAME: colorize
-            SHORTCUT: color
-
-          DESCRIPTION
-            The Colorize object can be used to write output in color.
-            The Colorize container can contain multiple strings, each
-            one can have a different color as specified by the names
-            of the children.
-
-          CHILDREN
-            <color> - string - no default value
-              The name of the child or children is the color.
-              The string's value is what will be written out.
-
-          MESSAGES
-            run - Output the string in the color specified.
-        TEXT
-      end
-
     end
   end
 end

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

@@ -11,6 +11,7 @@ module Gloo
       KEYWORD = 'confirm'.freeze
       KEYWORD_SHORT = 'confirm'.freeze
       PROMPT = 'prompt'.freeze
+      DEFAULT_PROMPT = '> '.freeze
       RESULT = 'result'.freeze
 
       #
@@ -64,14 +65,8 @@ module Gloo
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create( { :name => 'prompt',
-                      :type => 'string',
-                      :value => '> ',
-                      :parent => self } )
-        fac.create( { :name => 'result',
-                      :type => 'boolean',
-                      :value => nil,
-                      :parent => self } )
+        fac.create_string PROMPT, DEFAULT_PROMPT, self
+        fac.create_bool RESULT, nil, self
       end
 
       # ---------------------------------------------------------------------
@@ -85,7 +80,9 @@ module Gloo
         return super + [ 'run' ]
       end
 
-      # Run the system command.
+      #
+      # Run the confirmation command.
+      #
       def msg_run
         prompt = prompt_value
         return unless prompt
@@ -94,33 +91,6 @@ module Gloo
         set_result result
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          CONFIRM OBJECT TYPE
-            NAME: confirm
-            SHORTCUT: confirm
-
-          DESCRIPTION
-            CLI confirmation prompt.
-
-          CHILDREN
-            prompt - string - '> '
-              The confirmation prompt.
-            result - boolean - none
-              The result of the prompt.
-
-          MESSAGES
-            run - Prompt the user and then set the result.
-        TEXT
-      end
-
     end
   end
 end

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

@@ -59,16 +59,20 @@ module Gloo
       #    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
@@ -171,7 +175,7 @@ module Gloo
         obj = find_child DEFAULT
         return unless obj
 
-        s = Gloo::Core::Script.new obj
+        s = Gloo::Exec::Script.new obj
         s.run
       end
 
@@ -193,44 +197,10 @@ module Gloo
         script = obj.do_script
         return unless script
 
-        s = Gloo::Core::Script.new script
+        s = Gloo::Exec::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

@@ -90,39 +90,6 @@ module Gloo
         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