gloo 0.3.0 → 0.4.0

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

@@ -7,36 +7,61 @@
 module Gloo
   module Objs
     class Untyped < Gloo::Core::Obj
-      
-      KEYWORD = 'untyped'
-      KEYWORD_SHORT = 'un'
 
-      # 
+      KEYWORD = 'untyped'.freeze
+      KEYWORD_SHORT = 'un'.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
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
         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/colorize.rb

@@ -8,24 +8,23 @@ require 'colorized_string'
 module Gloo
   module Objs
     class Colorize < Gloo::Core::Obj
-      
-      KEYWORD = 'colorize'
-      KEYWORD_SHORT = 'color'
 
-      # 
+      KEYWORD = 'colorize'.freeze
+      KEYWORD_SHORT = 'color'.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
-                  
 
       # ---------------------------------------------------------------------
       #    Children
@@ -37,37 +36,68 @@ module Gloo
       def add_children_on_create?
         return true
       end
-      
+
       # Add children to this object.
-      # This is used by containers to add children needed 
+      # This is used by containers to add children needed
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create "white", "string", "", self
+        fac.create( { :name => 'white',
+                      :type => 'string',
+                      :value => '',
+                      :parent => self } )
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + [ 'run' ]
       end
-      
+
       # Run the system command.
       def msg_run
-				msg = ""
-				children.each do |o|
-					msg += ColorizedString[ o.value_display ].colorize( o.name.to_sym )
-				end
-				$log.show msg
-				$engine.heap.it.set_to msg.to_s
+        msg = ''
+        children.each do |o|
+          msg += ColorizedString[ o.value_display ].colorize( o.name.to_sym )
+        end
+        $log.show msg
+        $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

@@ -7,45 +7,46 @@
 module Gloo
   module Objs
     class Confirm < Gloo::Core::Obj
-      
-      KEYWORD = 'confirm'
-      KEYWORD_SHORT = 'confirm'
-      PROMPT = 'prompt'
-      RESULT = 'result'
 
-      # 
+      KEYWORD = 'confirm'.freeze
+      KEYWORD_SHORT = 'confirm'.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 URI from the child object.
       # Returns nil if there is none.
-      # 
-      def get_prompt
+      #
+      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
+      #
+      def set_result( data )
         r = find_child RESULT
         return nil unless r
+
         r.set_value data
       end
-            
 
       # ---------------------------------------------------------------------
       #    Children
@@ -57,36 +58,69 @@ module Gloo
       def add_children_on_create?
         return true
       end
-      
+
       # Add children to this object.
-      # This is used by containers to add children needed 
+      # This is used by containers to add children needed
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create "prompt", "string", "> ", self
-        fac.create "result", "boolean", nil, self
+        fac.create( { :name => 'prompt',
+                      :type => 'string',
+                      :value => '> ',
+                      :parent => self } )
+        fac.create( { :name => 'result',
+                      :type => 'boolean',
+                      :value => nil,
+                      :parent => self } )
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + [ 'run' ]
       end
-      
+
       # Run the system command.
       def msg_run
-        prompt = get_prompt
+        prompt = prompt_value
         return unless prompt
+
         result = $prompt.yes?( prompt )
         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/prompt.rb

@@ -7,45 +7,46 @@
 module Gloo
   module Objs
     class Prompt < Gloo::Core::Obj
-      
-      KEYWORD = 'prompt'
-      KEYWORD_SHORT = 'ask'
-      PROMPT = 'prompt'
-      RESULT = 'result'
 
-      # 
+      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 URI from the child object.
       # Returns nil if there is none.
-      # 
-      def get_prompt
+      #
+      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
+      #
+      def set_result( data )
         r = find_child RESULT
         return nil unless r
+
         r.set_value data
       end
-            
 
       # ---------------------------------------------------------------------
       #    Children
@@ -57,36 +58,69 @@ module Gloo
       def add_children_on_create?
         return true
       end
-      
+
       # Add children to this object.
-      # This is used by containers to add children needed 
+      # This is used by containers to add children needed
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create "prompt", "string", "> ", self
-        fac.create "result", "string", nil, self
+        fac.create( { :name => 'prompt',
+                      :type => 'string',
+                      :value => '> ',
+                      :parent => self } )
+        fac.create( { :name => 'result',
+                      :type => 'string',
+                      :value => nil,
+                      :parent => self } )
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + [ 'run' ]
       end
-      
+
       # Run the system command.
       def msg_run
-        prompt = get_prompt
+        prompt = prompt_value
         return unless prompt
+
         result = $prompt.ask( prompt )
         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.
+        TEXT
+      end
+
     end
   end
 end