gloo 0.3.0 → 0.4.0

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

@@ -7,36 +7,35 @@
 module Gloo
   module Objs
     class Container < Gloo::Core::Obj
-      
-      KEYWORD = 'container'
-      KEYWORD_SHORT = 'can'
 
-      # 
+      KEYWORD = 'container'.freeze
+      KEYWORD_SHORT = 'can'.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 + [ "count" ]
+        return super + [ 'count' ]
       end
-      
+
       # Count the number of children in the container.
       def msg_count
         i = child_count
@@ -44,6 +43,35 @@ module Gloo
         return i
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          CONTAINER OBJECT TYPE
+            NAME: container
+            SHORTCUT: can
+
+          DESCRIPTION
+            A container of other objects.
+            A container is similar to a folder in a file system.
+            It can contain any number of objects including other containers.
+            The container structure provides direct access to any object
+            within it through the object.object.object path-name structure.
+
+          CHILDREN
+            None by default.  But any container can have any number of
+            objects added to it.
+
+          MESSAGES
+            count - Count the number of children objects in the container.
+                    The result is put in <it>.
+        TEXT
+      end
 
     end
   end

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

@@ -7,43 +7,42 @@
 module Gloo
   module Objs
     class Integer < Gloo::Core::Obj
-      
-      KEYWORD = 'integer'
-      KEYWORD_SHORT = 'int'
 
-      # 
+      KEYWORD = 'integer'.freeze
+      KEYWORD_SHORT = 'int'.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
 
-      # 
+      #
       # Set the value with any necessary type conversions.
-      # 
-      def set_value new_value
+      #
+      def set_value( new_value )
         self.value = new_value.to_i
       end
-      
-      
+
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "inc", "dec" ]
+        return super + %w[inc dec]
       end
-      
+
       # Increment the integer
       def msg_inc
         i = value + 1
@@ -60,6 +59,31 @@ module Gloo
         return i
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          INTEGER OBJECT TYPE
+            NAME: integer
+            SHORTCUT: int
+
+          DESCRIPTION
+            An integer (numeric) value.
+
+          CHILDREN
+            None
+
+          MESSAGES
+            inc - Increment the integer value by 1.
+            dec - Decrement the integer value by 1.
+        TEXT
+      end
+
     end
   end
 end

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

@@ -8,43 +8,43 @@
 module Gloo
   module Objs
     class Script < Gloo::Core::Obj
-      
-      KEYWORD = 'script'
-      KEYWORD_SHORT = 'cmd'
 
-      # 
+      KEYWORD = 'script'.freeze
+      KEYWORD_SHORT = 'cmd'.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
 
-      # 
+      #
       # Set the value with any necessary type conversions.
-      # 
-      def set_value new_value
+      #
+      def set_value( new_value )
         self.value = new_value.to_s
       end
-      
-      # 
+
+      #
       # Set the value as an array.
-      # 
-      def set_array_value arr
+      #
+      def set_array_value( arr )
         self.value = arr
       end
-      
-      # 
+
+      #
       # Add a line (cmd) to the script.
-      # 
-      def add_line line
-        if self.value_is_string?
+      #
+      def add_line( line )
+        if self.value_string?
           first = self.value
           self.set_array_value []
           self.value << first unless first.empty?
@@ -54,48 +54,72 @@ module Gloo
         self.value << line.strip
       end
 
-      # 
+      #
       # Does this object support multi-line values?
       # Initially only true for scripts.
-      # 
-      def has_multiline_value?
+      #
+      def multiline_value?
         return true
       end
-      
-      # 
+
+      #
       # Get the number of lines in this script.
-      # 
+      #
       def line_count
-        if self.value_is_array?
-          return self.value.count
-        elsif self.value_is_string?
-          return 0 if ( self.value.strip.empty? )
-          return 1
-        else
-          return 0
+        return self.value.count if self.value_is_array?
+
+        if self.value_string?
+          return self.value.strip.empty? ? 0 : 1
         end
+
+        return 0
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + [ 'run' ]
       end
 
-      # 
+      #
       # Send the object the unload message.
-      # 
+      #
       def msg_run
         s = Gloo::Core::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

@@ -7,43 +7,42 @@
 module Gloo
   module Objs
     class String < Gloo::Core::Obj
-      
-      KEYWORD = 'string'
-      KEYWORD_SHORT = 'str'
 
-      # 
+      KEYWORD = 'string'.freeze
+      KEYWORD_SHORT = 'str'.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
 
-      # 
+      #
       # Set the value with any necessary type conversions.
-      # 
-      def set_value new_value
+      #
+      def set_value( new_value )
         self.value = new_value.to_s
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "up", "down" ]
+        return super + %w[up down]
       end
-      
+
       # Convert string to upper case
       def msg_up
         s = value.upcase
@@ -60,6 +59,31 @@ 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.
+        TEXT
+      end
+
     end
   end
 end

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

@@ -7,58 +7,81 @@
 module Gloo
   module Objs
     class Text < Gloo::Core::Obj
-      
-      KEYWORD = 'text'
-      KEYWORD_SHORT = 'txt'
 
-      # 
+      KEYWORD = 'text'.freeze
+      KEYWORD_SHORT = 'txt'.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
 
-      # 
+      #
       # Set the value with any necessary type conversions.
-      # 
-      def set_value new_value
+      #
+      def set_value( new_value )
         self.value = new_value.to_s
       end
 
-      # 
+      #
       # Does this object support multi-line values?
       # Initially only true for scripts.
-      # 
-      def has_multiline_value?
+      #
+      def multiline_value?
         return false
       end
-      
-      # 
+
+      #
       # Get the number of lines of text.
-      # 
+      #
       def line_count
         return value.split( "\n" ).count
       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
+          TEXT OBJECT TYPE
+            NAME: text
+            SHORTCUT: txt
+
+          DESCRIPTION
+            A longer, multi-line text string.
+
+          CHILDREN
+            None
+
+          MESSAGES
+            None
+        TEXT
+      end
+
     end
   end
 end