gloo 6.0 → 6.1.0

data/lib/gloo/objs/str_utils/password.rb

@@ -159,6 +159,62 @@ module Gloo
         @engine.heap.it.set_to result
       end
 
+      # ---------------------------------------------------------------------
+      #    Object Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the object's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'A password object that can be generated, hashed, and compared.',
+          :children => [
+            'salt (string) — Optional salt to use when hashing and checking passwords.',
+            'password (string) — The password. generate puts a new random password here. Used in the hash and check messages.',
+            'hash (string) — The hashed value of the password. Created when the hash message is called, and compared when the check message is called.'
+          ],
+          :messages => [
+            'generate ({len}) — Generate a new password, put in the password child object. The {len} parameter is optional; the length is 7 if not specified.',
+            'hash — Hash the password in the child object. Put it in the hash child object.',
+            'check — Check the password in the child object. Is it the same as the hash?'
+          ],
+          :examples => <<~EXAMPLES.strip
+            #
+            # Password Hashing and checking.
+            #
+            password [can] :
+
+              pwd [password] :
+                salt [string] : MySalt
+                password [string] :
+                hash [string] :
+
+              on_load [script] :
+                show
+                show 'Generating a new password' (white)
+                tell ^.pwd to generate
+                show 'Password: ' + ^.pwd.password
+                show
+                show 'hashing the password' (white)
+                tell ^.pwd to hash
+                show ^.pwd.hash (red)
+                show
+                show 'checking with the correct password' (white)
+                tell ^.pwd to check
+                show 'Result of check: ' + it (green)
+                show
+                show 'checking with the wrong password' (white)
+                tell ^.pwd to generate(23)
+                tell ^.pwd to check
+                show 'Result of check: ' + it (red)
+                show
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

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

@@ -110,6 +110,45 @@ module Gloo
         set_result render.result_with_hash( param_hash )
       end
 
+      # ---------------------------------------------------------------------
+      #    Object Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the object's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Use the ERB templating system to generate ' \
+            'content. For example, you can use the ERB object for ' \
+            'string interpolation.',
+          :children => [
+            'template (text) — The template that will be used when the ERB object is run.',
+            'params (container) — The collection of children values used when the template is rendered.',
+            'result (text) — The result of the template rendering.'
+          ],
+          :messages => [
+            'run — Render the result based on the template and the parameter values.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            e [can] :
+              erb [erb] :
+                template [text] : BEGIN
+                  Hello <%= first %> <%= last %>!
+                  END
+                params [container] :
+                  first [string] : Eric
+                  last [string] : Crane
+                result [text] :
+              on_load [script] :
+                run e.erb
+                show e.erb.result
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

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

@@ -239,6 +239,62 @@ module Gloo
         return true
       end
 
+      # ---------------------------------------------------------------------
+      #    Object Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the object's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :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.',
+          :messages => [
+            'read ({into.obj}) — Read the file and put the data in the specified object. If {into.obj} is not specified, the data will be in it.',
+            'write ({from.obj}) — Write the data in {from.obj} into the file.',
+            'append ({data}) — Append the given data to the file as a new line. Adds a leading newline first if the file doesn\'t already end with one.',
+            'delete — Delete the file.',
+            'get_name — Get the name of the file without path or extension. Put the name into it.',
+            'get_ext — Get the file extension. Put the extension into it.',
+            'get_parent — Get the file or folder path parent. Put the parent into it.',
+            'get_sha256 — Get the SHA256 hash of the contents of the file. Put the hash value into it.',
+            '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.',
+            'exists? — Check to see if the file exists. It will be true or false.',
+            'is_file? — Check to see if the file specified is a regular file. It will be true or false.',
+            'is_dir? — Check to see if the file specified is a directory. It will be true or false.',
+            'find_match — Look for the existence of a file matching the file\'s pattern. It will be true or false.',
+            'mkdir — Create the file\'s path as a directory, if it doesn\'t already exist.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            #
+            # Get elements of a file name.
+            #
+            file_name [can] :
+
+              # The full file path, name and extension.
+              f [file] : /Users/me/dev/gloo/gloo.gemspec
+
+              on_load [script] :
+                show "Full file name:  " + ^.f
+
+                check ^.f for get_name
+                show "The file name alone: " and it
+
+                check ^.f for get_ext
+                show "The file extension: " and it
+
+                check ^.f for get_parent
+                show "The file path: " and it
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

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

@@ -125,6 +125,35 @@ module Gloo
         set_result result
       end
 
+      # ---------------------------------------------------------------------
+      #    Object Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the object's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Execute a system command.',
+          :children => [
+            "command (string) — Default: '#{DEFAULT_CMD}'. The command that will be sent to the system.",
+            'get_output (boolean) — Default: true. Should executing the command get the output and put it in the result object?',
+            'result (string) — The result of running the command. Only set if get_output is true.'
+          ],
+          :messages => [
+            'run — Run the system level command. Sets the result value to the output of the command if get_output is true.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            date [system] :
+              command [string] : date
+              get_output [bool] : true
+              result [string] :
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

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

@@ -148,6 +148,41 @@ module Gloo
         return "#{uri_value}#{p}"
       end
 
+      # ---------------------------------------------------------------------
+      #    Object Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the object's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Perform an HTTP Get.',
+          :children => [
+            "uri (string) — Example: '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.'
+          ],
+          :messages => [
+            'run — Run the HTTP Get and update the result.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            g [http_get] :
+              uri [string] : http://api.sunrise-sunset.org/json
+              params [container] :
+                lat [string] : 36.7201600
+                lng [string] : -4.4203400
+                date [string] : today
+              result [string] :
+
+            > run g
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

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

@@ -152,6 +152,39 @@ module Gloo
         return find_child_value( SKIP_SSL_VERIFY ) || false
       end
 
+      # ---------------------------------------------------------------------
+      #    Object Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the object's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Perform an HTTP Post.',
+          :children => [
+            "uri (string) — Example: 'https://web.site/'. The URI for the HTTP Post.",
+            'body (container) — Collection of parameters for the HTTP Post.',
+            'result (string) — The result of the request. Whatever was returned in the body of the HTTP POST.',
+            'skip_ssl_verify (boolean) — Optional. Skip the SSL verification as part of the request.'
+          ],
+          :messages => [
+            'run — Run the HTTP Post, sending the body data to the endpoint specified in the URI.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            post [post] :
+              txt [str] : Message from gloo!
+              uri [str] : https://my.service.com/my-long-token
+              body [can] :
+                text [alias] : post.txt
+                username [str] : me
+              on_load [script] : run post
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

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

@@ -202,6 +202,46 @@ module Gloo
         return data
       end
 
+      # ---------------------------------------------------------------------
+      #    Object Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the object's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'JSON data in a text string.',
+          :messages => [
+            'get ({path}) — Get a value from the JSON data. Example: tell myjson to get (\'title\'). The parameter is the path in JSON to the value we want. The value is put into it.',
+            'set ({obj.path}) — Convert an object to an approximate JSON value. Example: tell myjson to set (my.object). The parameter is the path to the object used as the source. Note this is an approximate conversion — a gloo object can have both a simple value and be a container for child objects, which JSON can\'t represent the same way.',
+            'parse ({dst.path}) — Parse the JSON data and put values in the object specified by the parameter. Example: tell myjson to parse (path.to.dst).',
+            'pretty — Make the JSON format pretty.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            #
+            # Get values from within a JSON object.
+            #
+
+            json_get [can] :
+              on_load [script] :
+                tell json_get.payload to get ('msg')
+                show it
+                tell json_get.payload to get ('sub.data')
+                show it
+                tell json_get.payload to get ('sub.child.msg')
+                show it
+              payload [json] : BEGIN
+                { "msg":"The message from inside a JSON block",
+                  "sub":{"data":"in sub-object",
+                    "child":{"msg":"third level"}} }
+                END
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

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

@@ -169,6 +169,46 @@ module Gloo
         end
       end
 
+      # ---------------------------------------------------------------------
+      #    Object Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the object's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'A URI or URL.',
+          :messages => [
+            'open — Open the URL in the default browser.',
+            'get_scheme — Get the URI scheme; example: http.',
+            'get_host — Get the URI host; example: google.com.',
+            'get_path — Get the URI resource path; example: /post.',
+            'get_query — Get the URI query parameters; example: id=121.',
+            'get_fragment — Get the URI fragment.',
+            'get_cert_expires — Get the web site\'s certificate expiration date.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            url [can] :
+              on_load [script] :
+                tell url.u to get_scheme
+                show "scheme: " + it
+
+                tell url.u to get_host
+                show "host: " + it
+
+                tell url.u to get_path
+                show "path: " + it
+
+                show "opening URL: " + url.u
+                tell url.u to open
+              u [uri] : https://my.url/path/1234
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/shell/command_node.rb

@@ -0,0 +1,39 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2026 Eric Crane.  All rights reserved.
+#
+# A node in a shell's command tree.
+# Ported from gloo-cli's CommandNode, namespace only.
+#
+
+module Gloo
+  module Shell
+    class CommandNode
+
+      attr_reader :name, :description, :method, :obj
+
+      #
+      # Initialize a command node.
+      # Children are supplied lazily via a block, evaluated
+      # with the shell's Context whenever they're needed.
+      #
+      def initialize( name, description: '', method: nil, obj: nil, &children_block )
+        @name = name
+        @description = description
+        @method = method
+        @obj = obj
+        @children_block = children_block
+      end
+
+      #
+      # Get this node's children, given the current shell context.
+      # Returns an empty array for leaf nodes.
+      #
+      def children( context )
+        return [] unless @children_block
+
+        @children_block.call( context )
+      end
+
+    end
+  end
+end

data/lib/gloo/shell/context.rb

@@ -0,0 +1,93 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2026 Eric Crane.  All rights reserved.
+#
+# A shell context.  Data associated with a running shell session.
+# Ported from gloo-cli's ShellContext, namespace only.
+#
+
+module Gloo
+  module Shell
+    class Context
+
+      attr_accessor :done
+
+      #
+      # Initialize the shell context.
+      #
+      def initialize
+        @done = false
+        @properties = {}
+      end
+
+      #
+      # Get a property value.
+      # Returns an empty array if the property doesn't exist.
+      #
+      def get( key )
+        key = key.to_sym
+        return @properties[ key ] if @properties.key?( key )
+
+        return []
+      end
+
+      #
+      # Set a property value.
+      #
+      def set( key, value )
+        @properties[ key.to_sym ] = value
+      end
+
+      #
+      # Add an item to a property list.
+      #
+      def add_to_list( key, item )
+        key = key.to_sym
+        list = get( key )
+        list = [] unless list.is_a?( Array )
+
+        list << item
+        set( key, list )
+
+        return list
+      end
+
+      #
+      # Check if a property exists.
+      #
+      def has?( key )
+        return @properties.key?( key.to_sym )
+      end
+
+      #
+      # Get all property keys.
+      #
+      def keys
+        return @properties.keys
+      end
+
+      #
+      # Dynamic method access to properties.
+      # e.g. context.verbs is the same as context.get(:verbs),
+      # context.verbs = [...] is the same as context.set(:verbs, [...]).
+      #
+      def method_missing( method_name, *args, &block )
+        if method_name.to_s.end_with?( '=' )
+          key = method_name.to_s.chomp( '=' ).to_sym
+          set( key, args.first )
+        else
+          key = method_name.to_sym
+          get( key )
+        end
+      end
+
+      #
+      # Respond to missing methods for property access.
+      #
+      def respond_to_missing?( method_name, include_private = false )
+        key = method_name.to_s.chomp( '=' ).to_sym
+        return has?( key ) || super
+      end
+
+    end
+  end
+end