gloo 0.6.1 → 0.7.0

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
@@ -197,40 +201,6 @@ module Gloo
         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

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

@@ -52,16 +52,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 TEXT, '', self
@@ -88,33 +92,6 @@ module Gloo
         puts pastel.decorate( self.text_value, *c )
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          PASTEL OBJECT TYPE
-            NAME: pastel
-            SHORTCUT: pastel
-
-          DESCRIPTION
-            Show colorized text with the pastel gem.
-
-          CHILDREN
-            text - string
-              The text that will be colorized.
-            color - string
-              The colors.  See pastel for options.
-
-          MESSAGES
-            show - Show the colorized text.
-        TEXT
-      end
-
     end
   end
 end

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

@@ -52,16 +52,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
@@ -101,34 +105,6 @@ module Gloo
         set_result result
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          PROMPT OBJECT TYPE
-            NAME: prompt
-            SHORTCUT: ask
-
-          DESCRIPTION
-            CLI prompt for user input.
-
-          CHILDREN
-            prompt - string - '> '
-              The prompt displayed to the user.
-            result - string - none
-              The result with the user's input.
-
-          MESSAGES
-            run - Prompt the user and then set the result.
-            multiline - Show a multiline prompt.
-        TEXT
-      end
-
     end
   end
 end

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

@@ -77,16 +77,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
@@ -117,37 +121,6 @@ module Gloo
         set_result self.key_for_option( result )
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          SELECT OBJECT TYPE
-            NAME: select
-            SHORTCUT: sel
-
-          DESCRIPTION
-            Prompt for user to select from a list of options.
-
-          CHILDREN
-            prompt - string - '> '
-              The prompt displayed to the user.
-            options - container
-              The list of options for the selection list.
-              The name of each option will be presented to the user, but
-              the value will be put in the result.
-            result - string - none
-              The result with the user's selection.
-
-          MESSAGES
-            run - Prompt the user for a selection and then set the result.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/ctrl/each.rb

@@ -46,7 +46,9 @@ module Gloo
         return o ? o.value : nil
       end
 
+      #
       # Run the do script once.
+      #
       def run_do
         o = find_child DO
         return unless o
@@ -58,16 +60,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 WORD, '', self
@@ -103,16 +109,20 @@ module Gloo
       #    Child Object
       # ---------------------------------------------------------------------
 
+      #
       # Is it set up to run for each word?
       # If there is a child object by the name "word"
       # then we will loop for each word in the string.
+      #
       def each_child?
         return true if contains_child? CHILD
 
         return false
       end
 
+      #
       # Run for each word.
+      #
       def run_each_child
         o = find_child IN
         return unless o
@@ -124,7 +134,9 @@ module Gloo
         end
       end
 
+      #
       # Set the child alias.
+      #
       def set_child( obj )
         o = find_child CHILD
         return unless o
@@ -136,16 +148,20 @@ module Gloo
       #    Word
       # ---------------------------------------------------------------------
 
+      #
       # Is it set up to run for each word?
       # If there is a child object by the name "word"
       # then we will loop for each word in the string.
+      #
       def each_word?
         return true if find_child WORD
 
         return false
       end
 
+      #
       # Run for each word.
+      #
       def run_each_word
         str = in_value
         return unless str
@@ -156,7 +172,9 @@ module Gloo
         end
       end
 
+      #
       # Set the value of the word.
+      #
       def set_word( word )
         o = find_child WORD
         return unless o
@@ -168,16 +186,20 @@ module Gloo
       #    Line
       # ---------------------------------------------------------------------
 
+      #
       # Is it set up to run for each line?
       # If there is a child object by the name "line"
       # then we will loop for each line in the string.
+      #
       def each_line?
         return true if find_child LINE
 
         return false
       end
 
+      #
       # Run for each line.
+      #
       def run_each_line
         str = in_value
         return unless str
@@ -188,7 +210,9 @@ module Gloo
         end
       end
 
+      #
       # Set the value of the word.
+      #
       def set_line( line )
         o = find_child LINE
         return unless o
@@ -200,15 +224,20 @@ module Gloo
       #    Git Repo
       # ---------------------------------------------------------------------
 
+      #
       # Is it set up to run for each git repo?
       # If there is a child object by the name "repo"
       # then we will loop for each repo in the directory.
+      #
       def each_repo?
         return true if find_child REPO
 
         return false
       end
 
+      #
+      # Find all git projects in a path.
+      #
       def find_all_git_projects( path )
         path.children.collect do |f|
           if f.directory? && ( File.basename( f ) == '.git' )
@@ -219,7 +248,9 @@ module Gloo
         end.flatten.compact
       end
 
+      #
       # Run for each line.
+      #
       def run_each_repo
         path = in_value
         return unless path
@@ -232,8 +263,10 @@ module Gloo
         end
       end
 
+      #
       # Set the value of the repo.
       # This is a path to the repo.
+      #
       def set_repo( path )
         o = find_child REPO
         return unless o
@@ -241,39 +274,6 @@ module Gloo
         o.set_value path
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          EACH OBJECT TYPE
-            NAME: each
-            SHORTCUT: each
-
-          DESCRIPTION
-            Perform an action for each item in a collection.
-
-          CHILDREN
-            child | word | line | repo - string - none
-              The entity we want to loop for.
-              It will hold the current value while the script is running.
-            in - string - none
-              The collection we will iterate in.
-              In the case of <word> or <line> this will be a string or text.
-              In the case of <repo> this will be the root path.
-            do - script - none
-              The action we want to perform for each found item.
-
-          MESSAGES
-            run - Look through the collecion and perform this for each
-              found item.
-        TEXT
-      end
-
     end
   end
 end