lib/gloo/objs/basic/string.rb in gloo-0.3.0 vs lib/gloo/objs/basic/string.rb in gloo-0.4.0

@@ -5,47 +5,46 @@
 #
 
 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
         set_value s
         $engine.heap.it.set_to s
@@ -56,9 +55,34 @@
       def msg_down
         s = value.downcase
         set_value s
         $engine.heap.it.set_to s
         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