gloo 0.3.0 → 0.5.3

data/lib/gloo/verbs/load.rb

@@ -7,33 +7,68 @@
 module Gloo
   module Verbs
     class Load < Gloo::Core::Verb
-      
-      KEYWORD = 'load'
-      KEYWORD_SHORT = '<'
 
-      # 
+      KEYWORD = 'load'.freeze
+      KEYWORD_SHORT = '<'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
-				fn = @tokens.second
-				$log.debug "Getting ready to load file: #{fn}"
+        fn = @tokens.second
+        $log.debug "Getting ready to load file: #{fn}"
         $engine.persist_man.load fn
       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
+          LOAD VERB
+            NAME: load
+            SHORTCUT: <
+
+          DESCRIPTION
+            Load an object file.
+            There are two ways to specify the file.  Give either the full path and file name or use a relative path from the gloo project folder.  For the latter, the extension is not needed.  For the former, the
+            file extension is necessary.
+            Using * instead of a file name will load all gloo files in the folder.
+
+          SYNTAX
+            load <file_name>
+
+          PARAMETERS
+            file_name - Name of the object file that is to be loaded.
+
+          RESULT
+            Objects are loaded into the heap.
+            on_load scripts are run within the loaded objects.
+
+          ERRORS
+            If the file specified can't be found or can't be loaded,
+            an error condition will result.
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/verbs/move.rb

@@ -0,0 +1,128 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Move an object to a new parent.
+#
+
+module Gloo
+  module Verbs
+    class Move < Gloo::Core::Verb
+
+      KEYWORD = 'move'.freeze
+      KEYWORD_SHORT = 'mv'.freeze
+      TO = 'to'.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        dst = lookup_dst
+        return if dst.nil?
+
+        o = lookup_obj
+        return unless o
+
+        o.parent.remove_child o
+        dst.add_child o
+      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
+
+      # ---------------------------------------------------------------------
+      #    Helper functions
+      # ---------------------------------------------------------------------
+
+      #
+      # Lookup the object that we're moving.
+      #
+      def lookup_obj
+        arr = @tokens.before_token( TO )
+        if arr.count == 1
+          msg = 'object to move was not specified'
+          $log.error msg, nil, $engine
+        end
+
+        name = arr[ 1 ]
+        pn = Gloo::Core::Pn.new name
+        o = pn.resolve
+
+        unless o
+          msg = "could not find object to move: #{name}"
+          $log.error msg, nil, $engine
+        end
+
+        return o
+      end
+
+      #
+      # Lookup destination, the new parent object.
+      #
+      def lookup_dst
+        dst = @tokens.after_token( TO )
+        unless dst
+          msg = "'move' must include 'to' parent object"
+          $log.error msg, nil, $engine
+          return nil
+        end
+
+        pn = Gloo::Core::Pn.new dst
+        o = pn.resolve
+        unless o
+          msg = "could not resolve '#{dst}'"
+          $log.error msg, nil, $engine
+          return nil
+        end
+
+        return o
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this verb.
+      #
+      def self.help
+        return <<~TEXT
+          MOVE VERB
+            NAME: move
+            SHORTCUT: mv
+
+          DESCRIPTION
+            Move an object to a new parent.
+
+          SYNTAX
+            move <path.to.object> to <new.parent>
+
+          PARAMETERS
+            path.to.object - The object that we want to move.
+            new.parent - The new location for the object.
+
+          RESULT
+            The object will now be in the new location.
+
+          ERRORS
+            The <path.to.object> is not specified.
+            The <path.to.object> cannot be resolved.
+            The <new.parent> is not specified.
+            The <new.parent> cannot be resolved.
+            The 'to' keyword is missing.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/verbs/put.rb

@@ -7,56 +7,112 @@
 module Gloo
   module Verbs
     class Put < Gloo::Core::Verb
-      
-      KEYWORD = 'put'
-      KEYWORD_SHORT = 'p'
-      INTO = 'into'
-      
-      # 
+
+      KEYWORD = 'put'.freeze
+      KEYWORD_SHORT = 'p'.freeze
+      INTO = 'into'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
-        value = @tokens.before_token( INTO )
-				if value.nil?
-					$log.error "'put' must include 'into'"
-				end
-        if value.count > 1
-          # The first token is the verb, so we drop it.
-          value = value[1..-1]
-        end
+        value = fetch_value_tokens
+        return if value.nil?
+
+        target = lookup_target
+        return if target.nil?
 
-        target = @tokens.after_token( INTO )
-				if target.nil?
-					$log.error "'put' must include 'into' target"
-				end
         pn = Gloo::Core::Pn.new target
         o = pn.resolve
-				if o.nil?
-					$log.error "could not find target of put: #{target}"
-				else
-	        if value.count > 0
-	          expr = Gloo::Expr::Expression.new( value )
-	          result = expr.evaluate
-	          o.set_value result
-	          $engine.heap.it.set_to result
-	        end
-				end
+        if o.nil?
+          msg = "could not find target of put: #{target}"
+          $log.error msg, nil, $engine
+        elsif value.count.positive?
+          expr = Gloo::Expr::Expression.new( value )
+          result = expr.evaluate
+          o.set_value result
+          $engine.heap.it.set_to result
+        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
 
+      # ---------------------------------------------------------------------
+      #    Helper functions
+      # ---------------------------------------------------------------------
+
+      # Get the value that is being put.
+      def fetch_value_tokens
+        value = @tokens.before_token( INTO )
+        if value.nil?
+          msg = "'put' must include 'into'"
+          $log.error msg, nil, $engine
+          return nil
+        end
+
+        if value.count > 1
+          # The first token is the verb, so we drop it.
+          value = value[ 1..-1 ]
+        end
+        return value
+      end
+
+      # Lookup the target of the put command.
+      def lookup_target
+        target = @tokens.after_token( INTO )
+        return target if target
+
+        msg = "'put' must include 'into' target"
+        $log.error msg, nil, $engine
+        return nil
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this verb.
+      #
+      def self.help
+        return <<~TEXT
+          PUT VERB
+            NAME: put
+            SHORTCUT: p
+
+          DESCRIPTION
+            Put a value into an object.
+            The value is the result of an expression.
+
+          SYNTAX
+            put <expression> into <dst.path>
+
+          PARAMETERS
+            expression - The expression that is evaluated.
+            dst.path - The path to the destination object.
+
+          RESULT
+            <it> will contain the result of the evaluation.
+
+          ERRORS
+            The destination is not specified.
+            The destination cannot be resolved.
+            The 'into' keyword is missing.
+        TEXT
+      end
+
     end
   end
 end

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,39 +8,84 @@
 module Gloo
   module Verbs
     class Run < Gloo::Core::Verb
-      
-      KEYWORD = 'run'
-      KEYWORD_SHORT = 'r'
-      
-      # 
+
+      KEYWORD = 'run'.freeze
+      KEYWORD_SHORT = 'r'.freeze
+      EVALUATE_RUN = '~>'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
-        name = @tokens.second
-        pn = Gloo::Core::Pn.new name
-        o = pn.resolve
-
-        if o
-          o.send_message 'run'
+        if @tokens.second == EVALUATE_RUN
+          run_expression
         else
-          $log.error "Could not send message to object.  Bad path: #{name}"
+          run_script
         end
       end
-      
-      # 
+
+      #
+      # Run a script specified by pathname
+      #
+      def run_script
+        Gloo::Exec::Runner.run @tokens.second
+      end
+
+      #
+      # Evaluate an expression and run that.
+      #
+      def run_expression
+        return unless @tokens.token_count > 2
+
+        expr = Gloo::Expr::Expression.new( @tokens.params[ 1..-1 ] )
+        $engine.parser.run expr.evaluate
+      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