gloo 6.0 → 6.1.0

data/lib/gloo/verbs/redirect.rb

@@ -122,16 +122,66 @@ module Gloo
         end
       end
 
-      # 
+      #
       # Redirect to another script.
       # This stops execution of the current script.
-      # 
+      #
       def redirect_to_script
         @engine.exec_env.running_script.break_out
 
         Gloo::Exec::Dispatch.message( @engine, RUN_MESSAGE, @target_obj )
       end
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Redirect from the current script (or page). ' \
+            'There are 3 ways to use this verb: redirect in a script; ' \
+            'redirect from one page to another, where the parameter is ' \
+            'a path to a page; or redirect (hard) to an external web ' \
+            'site, where the parameter is the URL.',
+          :syntax => [
+            'redirect {path.to.object}',
+            'redirect https://example.com/ (hard)'
+          ],
+          :parameters => [
+            '{path.to.object} — Reference to the script to run, or ' \
+              'reference to the page to redirect to. In the case of a ' \
+              'redirect (hard) this is the target website we will redirect to.'
+          ],
+          :result => 'No more commands are executed in the currently ' \
+            'running script. Execution transfers to the target script. ' \
+            'If the target is a page, the current page is replaced with ' \
+            'the target page.',
+          :errors => [
+            "#{MISSING_EXPR_ERR} — Redirect requires the target page or script to redirect to.",
+            "#{BAD_TARGET_ERR} — The target object does not exist or cannot receive the redirect.",
+            "#{APP_NOT_RUNING_ERR} — Page cannot redirect because the application is not running."
+          ],
+          :examples => <<~EXAMPLES.strip
+            # Redirect to a different script:
+            redirect [can] :
+              x [bool] : false
+              first_time [script] : show 'It is true (first time)'
+              second_time [script] : show 'It is true (second time)'
+              on_load [script] :
+                if ^.x then go ^.first_time
+                show 'skipping first time'
+                put true into ^.x
+                if ^.x then go ^.second_time
+                show 'skipping second time'
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/verbs/reload.rb

@@ -40,6 +40,33 @@ module Gloo
 
       private
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Re-load to original state. This will ' \
+            'essentially re-run gloo with the parameters given during ' \
+            'start-up. Use the files command to see the list of files ' \
+            'that will be re-loaded. Any changes made externally in the ' \
+            'stored files will take effect.',
+          :syntax => [ 'reload' ],
+          :result => 'Each open file will be first unloaded and then ' \
+            'loaded again. Note that re-load does not trigger the ' \
+            'on_load script to run. There is an on_reload message sent ' \
+            'to all open files.',
+          :examples => <<~EXAMPLES.strip
+            > reload
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/verbs/run.rb

@@ -70,6 +70,45 @@ module Gloo
         @engine.parser.run expr.evaluate
       end
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Run a script or other object. This is the ' \
+            'same as sending a run message to the object.',
+          :syntax => [
+            'run {path.to.object}',
+            'run ~> {expression}'
+          ],
+          :parameters => [
+            '{path.to.object} — Reference to the object which will be ' \
+              'run. The object must be a runnable object such as a script.',
+            '{expression} — Evaluate the expression and run it.'
+          ],
+          :result => 'The result depends on the object that is run.',
+          :errors => [
+            "#{MISSING_EXPR_ERR} — No expression is provided as parameter to the verb."
+          ],
+          :examples => <<~EXAMPLES.strip
+            > run my.script
+
+            > create s as script : "show 3 + 4"
+            > run s
+
+            # Run a script in an evaluated expression:
+            > create s as string : "show 3 + 4"
+            > run ~> s
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/verbs/save.rb

@@ -34,6 +34,32 @@ module Gloo
         return KEYWORD_SHORT
       end
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Save a previously loaded object to a .gloo ' \
+            'file. The path will be for the root level object that was ' \
+            'loaded earlier.',
+          :syntax => [ 'save {path.to.object}' ],
+          :parameters => [
+            '{path.to.object} — Name of the object file that is to be saved.'
+          ],
+          :result => 'The file is updated with the latest object state.',
+          :notes => 'The save verb is not currently fully functional.',
+          :examples => <<~EXAMPLES.strip
+            > save my_obj
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/verbs/show.rb

@@ -58,6 +58,60 @@ module Gloo
         return str
       end
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => "Show an object's value, a literal or the " \
+            'result of an evaluation.',
+          :syntax => [
+            'show {target}',
+            'show {target} ({color})'
+          ],
+          :parameters => [
+            '{target} — The object that we want to see. The target ' \
+              'might be the path to an object, a literal or an ' \
+              'expression to be evaluated before being shown.',
+            '{color} — Optional color for the text.'
+          ],
+          :result => "The object's value is shown, or the literal, or " \
+            'the result of the evaluated expression is shown. It will ' \
+            "contain the object's value.",
+          :examples => <<~EXAMPLES.strip,
+            > show "me"
+            > show "hello " "world"
+            > show 132 * 23
+
+            > create x : "boo"
+            > show x
+          EXAMPLES
+          :notes => <<~NOTES.strip
+            Example with Color:
+
+            #
+            # Show multiple messages in color
+            #
+
+            colors [can] :
+              var [string] : red
+              on_load [script] :
+                show "red" (colors.var)
+                show "blue" (blue)
+                show "green" (green)
+                show "white" (white)
+                show "black" (black)
+                show "yellow" (yellow)
+          NOTES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/verbs/tell.rb

@@ -50,6 +50,38 @@ module Gloo
 
       private
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Send a message to an object. Ask the object ' \
+            'to perform an action.',
+          :syntax => [ 'tell {path.to.object} to {message}' ],
+          :parameters => [
+            '{path.to.object} — The object that we want to send a message to.',
+            '{message} — The message to send.'
+          ],
+          :result => 'The result depends on the message that is sent.',
+          :errors => [
+            "#{UNKNOWN_MSG_ERR} — No message was specified, or the `to` keyword is missing.",
+            'Object was not found — The target of the message was not found.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            > tell an.obj to unload
+            > tell the.script to run
+            > tell my.str to up
+            > tell the.container to count
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/verbs/throw.rb

@@ -50,6 +50,35 @@ module Gloo
         return expr.evaluate
       end
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Deliberately raise a Ruby exception, to ' \
+            'exercise the on_exception handling pipeline (e.g. for ' \
+            'testing). Execution continues normally after the throw — ' \
+            'it is not a fatal halt.',
+          :syntax => [ 'throw {optional message}' ],
+          :parameters => [
+            "{message} — Optional. An expression evaluated and used as the thrown message. If not provided, a default message (\"#{DEFAULT_MSG}\") is used."
+          ],
+          :result => "Fires the app's on_exception handler, if one is " \
+            'defined, with exception_data.message set to the thrown ' \
+            'message. Does not fire on_error.',
+          :examples => <<~EXAMPLES.strip
+            > throw
+            > throw "custom message"
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/verbs/unless.rb

@@ -101,6 +101,56 @@ module Gloo
 
         i.run
       end
+
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => "Unless an expression is true, do something. " \
+            "This is the opposite of the if verb.",
+          :syntax => [
+            'unless {true} do {command}',
+            'unless {true} do {command} else {else command}'
+          ],
+          :parameters => [
+            '{true} — Does the expression evaluate to true?',
+            '{command} — Execute command if the expression is false.',
+            '{else command} — The else command is optional. Execute else command if the expression is true.'
+          ],
+          :result => 'Unchanged if the expression is true. If not true, ' \
+            'then the result will be based on the command specified ' \
+            'after the do keyword.',
+          :errors => [
+            "#{MISSING_EXPR_ERR} — No expression is provided as parameter to the verb.",
+            'Other errors depend on the command that is run.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            #
+            # Unless statement example
+            #
+
+            unless [container] :
+
+              x [bool] : true
+              false_msg [string] : It is NOT true!
+
+              on_load [script] :
+                unless unless.x do show "first time: " + unless.false_msg
+                unless ^.x do show 'F' else show 'T'
+
+                put false into unless.x
+                unless unless.x do show "second time: " +  unless.false_msg
+                unless ^.x do show 'F' else show 'T'
+          EXAMPLES
+        }
+      end
     end
   end
 end

data/lib/gloo/verbs/unload.rb

@@ -41,6 +41,29 @@ module Gloo
 
       private
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Un-load all open files. Use the files ' \
+            'command to see the list of files that will be un-loaded. ' \
+            'The heap will be empty after this is run, so be sure to ' \
+            'save state prior to executing.',
+          :syntax => [ 'unload' ],
+          :result => 'All objects will be unloaded from the heap.',
+          :examples => <<~EXAMPLES.strip
+            > unload
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/verbs/version.rb

@@ -58,11 +58,11 @@ module Gloo
         @engine.platform.show notes
       end
 
-      # 
+      #
       # Is the request to show version notes?
-      # 
+      #
       def vers_notes?
-        if ( @tokens.token_count > 1 ) && ( 
+        if ( @tokens.token_count > 1 ) && (
           ( @tokens.last == NOTES ) || ( @tokens.last == NOTES_SHORT ) )
           return true
         end
@@ -70,6 +70,40 @@ module Gloo
         return false
       end
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Show the application version information. ' \
+            'This is the same as showing the version by running gloo ' \
+            'with the --version command line parameter.',
+          :syntax => [
+            'version',
+            'version notes'
+          ],
+          :parameters => [
+            'notes ({n}) — Optional. Show the version notes (release notes) instead of just the version number.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            > version
+            > v
+            This is the same as running this from the command line:
+
+            > gloo --version
+
+            > version notes
+            > v n
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

data/lib/gloo/verbs/wait.rb

@@ -37,6 +37,32 @@ module Gloo
         return KEYWORD_SHORT
       end
 
+      # ---------------------------------------------------------------------
+      #    Verb Documentation
+      # ---------------------------------------------------------------------
+
+      #
+      # Get the verb's documentation data.
+      #
+      def self.doc_data
+        {
+          :name => KEYWORD,
+          :shortcut => KEYWORD_SHORT,
+          :description => 'Wait for the given number of seconds.',
+          :syntax => [ 'wait {seconds}' ],
+          :parameters => [
+            '{seconds} — The number of seconds to wait. Optional. If no value is given, we will wait for 1 second.'
+          ],
+          :examples => <<~EXAMPLES.strip
+            > wait
+            > wait 3
+
+            > create x as int : 10
+            > wait x
+          EXAMPLES
+        }
+      end
+
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gloo
 version: !ruby/object:Gem::Version
-  version: '6.0'
+  version: 6.1.0
 platform: ruby
 authors:
 - Eric Crane
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,36 +67,30 @@ dependencies:
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 1.3.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 1.3.7
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: 7.2.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: 7.2.3.1
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -272,6 +265,16 @@ files:
 - bin/console
 - bin/run
 - bin/setup
+- docs/application.md
+- docs/getting_started.md
+- docs/iterators.md
+- docs/language_objects.md
+- docs/language_scripting.md
+- docs/language_syntax.md
+- docs/objects.md
+- docs/operators.md
+- docs/plugins.md
+- docs/verbs.md
 - exe/gloo
 - exe/o
 - gloo.gemspec
@@ -320,6 +323,9 @@ files:
 - lib/gloo/core/pn.rb
 - lib/gloo/core/tokens.rb
 - lib/gloo/core/verb.rb
+- lib/gloo/docs/doc_data.rb
+- lib/gloo/docs/help_shell.rb
+- lib/gloo/docs/markdown_renderer.rb
 - lib/gloo/exec/action.rb
 - lib/gloo/exec/dispatch.rb
 - lib/gloo/exec/exec_env.rb
@@ -385,6 +391,9 @@ files:
 - lib/gloo/plugin/callback.rb
 - lib/gloo/plugin/ext_manager.rb
 - lib/gloo/plugin/lib_manager.rb
+- lib/gloo/shell/command_node.rb
+- lib/gloo/shell/context.rb
+- lib/gloo/shell/runner.rb
 - lib/gloo/verbs/break.rb
 - lib/gloo/verbs/check.rb
 - lib/gloo/verbs/cls.rb
@@ -454,11 +463,11 @@ files:
 - test.gloo/verbs/run.test.gloo
 - test.gloo/verbs/tell.test.gloo
 - test.gloo/verbs/unless.test.gloo
-homepage: http://github.com/ecrane/gloo
+homepage: https://github.com/ecrane/gloo
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  documentation_uri: https://github.com/ecrane/gloo
 rdoc_options: []
 require_paths:
 - lib
@@ -473,8 +482,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Gloo scripting language.  A scripting language built on ruby.
 test_files: []