gloo 0.3.0 → 0.4.0

data/lib/gloo/verbs/quit.rb

@@ -7,34 +7,65 @@
 module Gloo
   module Verbs
     class Quit < Gloo::Core::Verb
-      
-      KEYWORD = 'quit'
-      KEYWORD_SHORT = 'q'
 
-      # 
+      KEYWORD = 'quit'.freeze
+      KEYWORD_SHORT = 'q'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       # We'll mark the application as not running and let the
       # engine stop gracefully next time through the loop.
-      # 
+      #
       def run
         $engine.stop_running
       end
-      
-      # 
+
+      #
       # Get the Verb's keyword.
-      # 
+      #
       def self.keyword
         return KEYWORD
       end
-      
-      # 
+
+      #
       # Get the Verb's keyword shortcut.
-      # 
+      #
       def self.keyword_shortcut
         return KEYWORD_SHORT
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this verb.
+      #
+      def self.help
+        return <<~TEXT
+          QUIT VERB
+            NAME: quit
+            SHORTCUT: q
+
+          DESCRIPTION
+            Stop running the gloo application.
+            Cleanup and shutdown.
+
+          SYNTAX
+            quit
+
+          PARAMETERS
+            None
+
+          RESULT
+            None
+
+          ERRORS
+            None
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/verbs/run.rb

@@ -8,13 +8,13 @@
 module Gloo
   module Verbs
     class Run < Gloo::Core::Verb
-      
-      KEYWORD = 'run'
-      KEYWORD_SHORT = 'r'
-      
-      # 
+
+      KEYWORD = 'run'.freeze
+      KEYWORD_SHORT = 'r'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
         name = @tokens.second
         pn = Gloo::Core::Pn.new name
@@ -26,21 +26,52 @@ module Gloo
           $log.error "Could not send message to object.  Bad path: #{name}"
         end
       end
-      
-      # 
+
+      #
       # Get the Verb's keyword.
-      # 
+      #
       def self.keyword
         return KEYWORD
       end
 
-      # 
+      #
       # Get the Verb's keyword shortcut.
-      # 
+      #
       def self.keyword_shortcut
         return KEYWORD_SHORT
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this verb.
+      #
+      def self.help
+        return <<~TEXT
+          RUN VERB
+            NAME: run
+            SHORTCUT: r
+
+          DESCRIPTION
+            Run a script or other object.
+            This is the same as sending a 'run' message to the object.
+
+          SYNTAX
+            run <path.to.object>
+
+          PARAMETERS
+            path.to.object - Reference to the object which will be run.
+
+          RESULT
+            The result depends on the object that is run.
+
+          ERRORS
+            The errors depend on the object that is run.
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/verbs/save.rb

@@ -7,31 +7,66 @@
 module Gloo
   module Verbs
     class Save < Gloo::Core::Verb
-      
-      KEYWORD = 'save'
-      KEYWORD_SHORT = '>'
 
-      # 
+      KEYWORD = 'save'.freeze
+      KEYWORD_SHORT = '>'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
+        # TODO:  Not currently using folders or keeping
+        # track of where the object was loaded from.
         $engine.persist_man.save @tokens.second
       end
-                
-      # 
+
+      #
       # Get the Verb's keyword.
-      # 
+      #
       def self.keyword
         return KEYWORD
       end
 
-      # 
+      #
       # Get the Verb's keyword shortcut.
-      # 
+      #
       def self.keyword_shortcut
         return KEYWORD_SHORT
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this verb.
+      #
+      def self.help
+        return <<~TEXT
+          SAVE VERB
+            NAME: save
+            SHORTCUT: >
+
+          DESCRIPTION
+            Stop running the gloo application.
+            Cleanup and shutdown.
+
+          SYNTAX
+            save <path.to.object>
+            Save a previously loaded object.  The path will be for the
+            root level object that was loaded earlier.
+
+          PARAMETERS
+            path.to.object - Name of the object file that is to be saved.
+
+          RESULT
+            The file is updated with the latest object state.
+
+          ERRORS
+            None
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/verbs/show.rb

@@ -8,47 +8,81 @@ require 'colorized_string'
 module Gloo
   module Verbs
     class Show < Gloo::Core::Verb
-      
-      KEYWORD = 'show'
-      KEYWORD_SHORT = '='
 
-      # 
+      KEYWORD = 'show'.freeze
+      KEYWORD_SHORT = '='.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
         if @tokens.token_count > 1
           expr = Gloo::Expr::Expression.new( @tokens.params )
-					result = expr.evaluate
+          result = expr.evaluate
           $log.show get_formatted_string( result )
           $engine.heap.it.set_to result
         else
-          $log.show ""
+          $log.show ''
         end
       end
-                
-      # 
+
+      #
       # Get the Verb's keyword.
-      # 
+      #
       def self.keyword
         return KEYWORD
       end
 
-      # 
+      #
       # Get the Verb's keyword shortcut.
-      # 
+      #
       def self.keyword_shortcut
         return KEYWORD_SHORT
       end
-			
-			def get_formatted_string str
-				if @params && @params.token_count > 0
-					expr = Gloo::Expr::Expression.new( @params.tokens )
-					val = expr.evaluate
-					color = val.to_sym
-					return ColorizedString[ "#{str}" ].colorize( color )
-				end
-				return str
-			end
+
+      #
+      # Get the formatted string.
+      #
+      def get_formatted_string( str )
+        if @params&.token_count&.positive?
+          expr = Gloo::Expr::Expression.new( @params.tokens )
+          val = expr.evaluate
+          color = val.to_sym
+          return ColorizedString[ str.to_s ].colorize( color )
+        end
+        return str
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this verb.
+      #
+      def self.help
+        return <<~TEXT
+          SHOW VERB
+            NAME: show
+            SHORTCUT: =
+
+          DESCRIPTION
+            Show an object's value.
+
+          SYNTAX
+            show <path.to.object>
+
+          PARAMETERS
+            path.to.object - The object that we want to see.
+
+          RESULT
+            The object's value is shown.
+            <it> will contain the object's value.
+
+          ERRORS
+            None
+        TEXT
+      end
 
     end
   end

data/lib/gloo/verbs/tell.rb

@@ -7,14 +7,14 @@
 module Gloo
   module Verbs
     class Tell < Gloo::Core::Verb
-      
-      KEYWORD = 'tell'
-      KEYWORD_SHORT = '->'
-      TO = 'to'
-      
-      # 
+
+      KEYWORD = 'tell'.freeze
+      KEYWORD_SHORT = '->'.freeze
+      TO = 'to'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
         name = @tokens.second
         msg = @tokens.after_token( TO )
@@ -27,21 +27,53 @@ module Gloo
           $log.error "Could not send message to object.  Bad path: #{name}"
         end
       end
-      
-      # 
+
+      #
       # Get the Verb's keyword.
-      # 
+      #
       def self.keyword
         return KEYWORD
       end
 
-      # 
+      #
       # Get the Verb's keyword shortcut.
-      # 
+      #
       def self.keyword_shortcut
         return KEYWORD_SHORT
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this verb.
+      #
+      def self.help
+        return <<~TEXT
+          TELL VERB
+            NAME: tell
+            SHORTCUT: ->
+
+          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 see.
+            message - The message to send.
+
+          RESULT
+            The result depends on the message that is sent.
+
+          ERRORS
+            Errors depend on the message that is sent.
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/verbs/unless.rb

@@ -7,50 +7,84 @@
 module Gloo
   module Verbs
     class Unless < Gloo::Core::Verb
-      
-      KEYWORD = 'unless'
-      KEYWORD_SHORT = 'if!'
-      THEN = 'do'
-      
-      # 
+
+      KEYWORD = 'unless'.freeze
+      KEYWORD_SHORT = 'if!'.freeze
+      THEN = 'do'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
         value = @tokens.before_token( THEN )
         if value.count > 1
           # The first token is the verb, so we drop it.
-          value = value[1..-1]
+          value = value[ 1..-1 ]
         end
 
         evals_false = false
-        if value.count > 0
+        if value.count.positive?
           expr = Gloo::Expr::Expression.new( value )
           result = expr.evaluate
           evals_false = true if result == false
         end
-        
-        if evals_false
-          cmd = @tokens.expr_after( THEN )
-          i = $engine.parser.parse_immediate cmd
-          return unless i
-          i.run
-        end
+        return unless evals_false
+
+        cmd = @tokens.expr_after( THEN )
+        i = $engine.parser.parse_immediate cmd
+        return unless i
+
+        i.run
       end
-      
-      # 
+
+      #
       # Get the Verb's keyword.
-      # 
+      #
       def self.keyword
         return KEYWORD
       end
 
-      # 
+      #
       # Get the Verb's keyword shortcut.
-      # 
+      #
       def self.keyword_shortcut
         return KEYWORD_SHORT
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this verb.
+      #
+      def self.help
+        return <<~TEXT
+          UNLESS VERB
+            NAME: unless
+            SHORTCUT: if!
+
+          DESCRIPTION
+            Unless an expression is true, do something.
+            This is the opposite of the if verb.
+
+          SYNTAX
+            unless <true> do <do>
+
+          PARAMETERS
+            true - Does the expression evaluate to true?
+            do - Execute command if the expression is not 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
+            The errors depend on the object that is run.
+        TEXT
+      end
+
     end
   end
 end