gloo 0.5.4 → 0.7.2

data/lib/gloo/objs/snd/play.rb

@@ -36,36 +36,13 @@ module Gloo
         return super + [ 'run' ]
       end
 
+      #
       # Play the audio file.
+      #
       def msg_run
         system "afplay #{value}"
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          PLAY OBJECT TYPE
-            NAME: play
-            SHORTCUT: play
-
-          DESCRIPTION
-            Play an audio file, an MP3 for example.
-            The value of the play object is the path to the audio file.
-
-          CHILDREN
-            None.
-
-          MESSAGES
-            run - Play the audio file.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/snd/say.rb

@@ -13,6 +13,7 @@ module Gloo
       KEYWORD_SHORT = 'say'.freeze
       VOICE = 'voice'.freeze
       MSG = 'message'.freeze
+      DEFAULT_MSG = 'talk to me'.freeze
 
       #
       # The name of the object type.
@@ -52,20 +53,24 @@ 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 VOICE, '', self
-        fac.create_string MSG, 'talk to me', self
+        fac.create_string MSG, DEFAULT_MSG, self
       end
 
       # ---------------------------------------------------------------------
@@ -79,42 +84,15 @@ module Gloo
         return super + [ 'run' ]
       end
 
-      # Run the system command.
+      #
+      # Have the computer 'speak' the message.
+      #
       def msg_run
         v = voice_value.empty? ? '' : "-v '#{voice_value}'"
         cmd = "say #{v} '#{msg_value}'"
         system cmd
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          SAY OBJECT TYPE
-            NAME: say
-            SHORTCUT: say
-
-          DESCRIPTION
-            Use the Mac text to speach function to say the .
-            From the Mac CLI, run this to get a list of voices:
-              say -v '?'
-
-          CHILDREN
-            voice - string
-              The Voice to use.  If left blank, the default voice will be used.
-            message - string - 'talk to me'
-              The message to speak.
-
-          MESSAGES
-            run - Speak the message, optionally in the voice specified.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/system/file_handle.rb

@@ -124,44 +124,6 @@ module Gloo
         $engine.heap.it.set_to result
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          FILE OBJECT TYPE
-            NAME: file
-            SHORTCUT: dir
-
-          DESCRIPTION
-            Reference to a file or folder (directory) on disk.
-            The string value of the file object is the path and name
-            of the file.
-
-          CHILDREN
-            None.
-
-          MESSAGES
-            read <into.obj> - Read file and put data in the specified object.
-              If the <into.obj> is not specified, the data will be in <it>.
-            write <from.obj> - Write the data in the <from.object> into
-              the file.
-            show - Show the contents of the file.
-            page - Show the contents of the file, paginated
-            open - Open the file with the default application for the type.
-            check_exists - Check to see if the file exists.
-              <It> will be true or false.
-            check_is_file - Check to see if the file specified is a
-              regular file.  <It> will be true or false.
-            check_is_dir - Check to see if the file specified is a
-              diretory.  <It> will be true or false.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/system/system.rb

@@ -11,6 +11,7 @@ module Gloo
       KEYWORD = 'system'.freeze
       KEYWORD_SHORT = 'sys'.freeze
       CMD = 'command'.freeze
+      DEFAULT_CMD = 'date'.freeze
       RESULT = 'result'.freeze
       GET_OUTPUT = 'get_output'.freeze
 
@@ -65,30 +66,25 @@ 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( { :name => 'command',
-                      :type => 'string',
-                      :value => 'date',
-                      :parent => self } )
-        fac.create( { :name => 'get_output',
-                      :type => 'boolean',
-                      :value => true,
-                      :parent => self } )
-        fac.create( { :name => 'result',
-                      :type => 'string',
-                      :value => nil,
-                      :parent => self } )
+        fac.create_string CMD, DEFAULT_CMD, self
+        fac.create_bool GET_OUTPUT, true, self
+        fac.create_string RESULT, nil, self
       end
 
       # ---------------------------------------------------------------------
@@ -102,7 +98,9 @@ module Gloo
         return super + [ 'run' ]
       end
 
+      #
       # Run the system command.
+      #
       def msg_run
         if output?
           run_with_output
@@ -111,6 +109,9 @@ module Gloo
         end
       end
 
+      #
+      # Run the command and collect output.
+      #
       def run_with_output
         cmd = cmd_value
         return unless cmd
@@ -119,6 +120,9 @@ module Gloo
         set_result result
       end
 
+      #
+      # Run the command and set the result.
+      #
       def run_with_result
         cmd = cmd_value
         return unless cmd
@@ -127,40 +131,6 @@ module Gloo
         set_result result
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          SYSTEM OBJECT TYPE
-            NAME: system
-            SHORTCUT: sys
-
-          DESCRIPTION
-            Execute a system command.
-
-          CHILDREN
-            command - string - 'date'
-              The command that will be sent to the system.
-            get_output - boolean - true
-              Should executing the command get the output and put it
-              in the result object?
-            result - string
-              The result of running the command.
-              The result will only be set if the 'get_output' child
-              is set to true.
-
-          MESSAGES
-            run - Run the system level command.
-              Set the result value to the output of the command if the
-              'get_output' child is marked as true.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/web/http_get.rb

@@ -15,6 +15,7 @@ module Gloo
       KEYWORD = 'http_get'.freeze
       KEYWORD_SHORT = 'get'.freeze
       URL = 'uri'.freeze
+      DEFAULT_URL = 'https://web.site/'.freeze
       PARAMS = 'params'.freeze
       RESULT = 'result'.freeze
       SKIP_SSL_VERIFY = 'skip_ssl_verify'.freeze
@@ -33,82 +34,29 @@ module Gloo
         return KEYWORD_SHORT
       end
 
-      #
-      # Get the URI from the child object.
-      # Returns nil if there is none.
-      #
-      def uri_value
-        uri = find_child URL
-        return nil unless uri
-
-        return uri.value
-      end
-
-      #
-      # Should we skip SSL verification during the request?
-      #
-      def skip_ssl_verify?
-        skip = find_child SKIP_SSL_VERIFY
-        return false unless skip
-
-        return skip.value
-      end
-
-      #
-      # Set the result of the API call.
-      #
-      def update_result( data )
-        r = find_child RESULT
-        return nil unless r
-
-        r.set_value data
-      end
-
-      #
-      # Get the URL for the service including all URL params.
-      #
-      def full_url_value
-        p = ''
-        params = find_child PARAMS
-        params.children.each do |child|
-          p << ( p.empty? ? '?' : '&' )
-
-          child = Gloo::Objs::Alias.resolve_alias( child )
-
-          # TODO: Quote URL params for safety
-          p << "#{child.name}=#{child.value}"
-        end
-        return "#{uri_value}#{p}"
-      end
-
       # ---------------------------------------------------------------------
       #    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( { :name => 'uri',
-                      :type => 'string',
-                      :value => 'https://web.site/',
-                      :parent => self } )
-        fac.create( { :name => 'params',
-                      :type => 'container',
-                      :value => nil,
-                      :parent => self } )
-        fac.create( { :name => 'result',
-                      :type => 'string',
-                      :value => nil,
-                      :parent => self } )
+        fac.create_string URL, DEFAULT_URL, self
+        fac.create_can PARAMS, self
+        fac.create_string RESULT, nil, self
       end
 
       # ---------------------------------------------------------------------
@@ -122,11 +70,13 @@ module Gloo
         return super + [ 'run' ]
       end
 
+      #
       # Post the content to the endpoint.
+      #
       def msg_run
         url = full_url_value
         $log.debug url
-        r = Gloo::Objs::HttpGet.invoke_request( url, self.skip_ssl_verify? )
+        r = Gloo::Objs::HttpGet.invoke_request( url, skip_ssl_verify? )
         update_result r
       end
 
@@ -134,7 +84,9 @@ module Gloo
       #    Static functions
       # ---------------------------------------------------------------------
 
+      #
       # Post the content to the endpoint.
+      #
       def self.invoke_request( url, skip_ssl_verify = false )
         uri = URI( url )
         params = { use_ssl: uri.scheme == 'https' }
@@ -149,35 +101,57 @@ module Gloo
       end
 
       # ---------------------------------------------------------------------
-      #    Help
+      #    Private functions
       # ---------------------------------------------------------------------
 
+      private
+
       #
-      # Get help for this object type.
+      # Get the URI from the child object.
+      # Returns nil if there is none.
       #
-      def self.help
-        return <<~TEXT
-          HTTP_GET OBJECT TYPE
-            NAME: http_get
-            SHORTCUT: get
+      def uri_value
+        uri = find_child URL
+        return nil unless uri
 
-          DESCRIPTION
-            Perform an HTTP Get.
+        return uri.value
+      end
+
+      #
+      # Should we skip SSL verification during the request?
+      #
+      def skip_ssl_verify?
+        skip = find_child SKIP_SSL_VERIFY
+        return false unless skip
 
-          CHILDREN
-            uri - string - 'https://web.site/'
-              The URI for the HTTP Get request.
-            params - container
-              Collection of parameters for the HTTP Get.
-            result - string
-              The result of the request.  Whatever was returned from
-              the HTTP Get call.
-            skip_ssl_verify - boolean (optional)
-              Skip the SSL verification as part of the request.
+        return skip.value
+      end
 
-          MESSAGES
-            run - Run the HTTP Get and update the result.
-        TEXT
+      #
+      # Set the result of the API call.
+      #
+      def update_result( data )
+        r = find_child RESULT
+        return nil unless r
+
+        r.set_value data
+      end
+
+      #
+      # Get the URL for the service including all URL params.
+      #
+      def full_url_value
+        p = ''
+        params = find_child PARAMS
+        params.children.each do |child|
+          p << ( p.empty? ? '?' : '&' )
+
+          child = Gloo::Objs::Alias.resolve_alias( child )
+
+          # TODO: Quote URL params for safety
+          p << "#{child.name}=#{child.value}"
+        end
+        return "#{uri_value}#{p}"
       end
 
     end