gloo 0.5.3 → 0.7.1

data/lib/gloo/verbs/if.rb

@@ -11,31 +11,18 @@ module Gloo
       KEYWORD = 'if'.freeze
       KEYWORD_SHORT = 'if'.freeze
       THEN = 'then'.freeze
+      MISSING_EXPR_ERR = 'Missing Expression!'.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 ]
-        end
+        value = value_tokens
+        return if value.nil?
 
-        evals_true = false
-        if value.count.positive?
-          expr = Gloo::Expr::Expression.new( value )
-          result = expr.evaluate
-          evals_true = true if result == true
-          evals_true = true if result.is_a?( Numeric ) && result != 0
-        end
-        return unless evals_true
+        return unless evals_true( value )
 
-        cmd = @tokens.expr_after( THEN )
-        i = $engine.parser.parse_immediate cmd
-        return unless i
-
-        i.run
+        run_then
       end
 
       #
@@ -53,36 +40,51 @@ module Gloo
       end
 
       # ---------------------------------------------------------------------
-      #    Help
+      #    Private functions
       # ---------------------------------------------------------------------
 
+      private
+
       #
-      # Get help for this verb.
+      # Get the list of tokens that represent the parameters
+      # of the if command.
       #
-      def self.help
-        return <<~TEXT
-          IF VERB
-            NAME: if
-            SHORTCUT: if
-
-          DESCRIPTION
-            If an expression is true then do something.
-
-          SYNTAX
-            if <true> then <do>
-
-          PARAMETERS
-            true - Does the expression evaluate to true?
-            do - Execute command if the expression is true.
-
-          RESULT
-            Unchanged if the expression is not true.
-            If true, then the result will be based on the command
-            specified after the 'then' keyword.
-
-          ERRORS
-            The errors depend on the object that is run.
-        TEXT
+      def value_tokens
+        value = @tokens.before_token( THEN )
+        if value && value.count > 1
+          # The first token is the verb, so we drop it.
+          value = value[ 1..-1 ]
+        else
+          $engine.err MISSING_EXPR_ERR
+        end
+
+        return value
+      end
+
+      #
+      # Does the given value evalute to true?
+      #
+      def evals_true( value )
+        eval_result = false
+        if value.count.positive?
+          expr = Gloo::Expr::Expression.new( value )
+          result = expr.evaluate
+          eval_result = true if result == true
+          eval_result = true if result.is_a?( Numeric ) && result != 0
+        end
+
+        return eval_result
+      end
+
+      #
+      # Run the 'then' command.
+      #
+      def run_then
+        cmd = @tokens.expr_after( THEN )
+        i = $engine.parser.parse_immediate cmd
+        return unless i
+
+        i.run
       end
 
     end

data/lib/gloo/verbs/list.rb

@@ -10,6 +10,7 @@ module Gloo
 
       KEYWORD = 'list'.freeze
       KEYWORD_SHORT = '.'.freeze
+      TARGET_MISSING_ERR = 'Object does not exist: '.freeze
 
       #
       # Run the verb.
@@ -19,30 +20,44 @@ module Gloo
         target = self.determine_target
         obj = target.resolve
         if obj
-          self.show_target( obj, levels )
+          show_target( obj, levels )
         else
-          $log.warn "Object #{target} does not exist"
+          $engine.err "#{TARGET_MISSING_ERR} #{target}"
         end
       end
 
-      # Determine how many levels to show.
-      def determine_levels
-        # Check settings for the default value.
-        levels = $settings.list_indent
-        return levels if levels
-
-        # Last chance: use the default
-        return 1
-      end
-
+      #
       # Determine the target object for the show command.
+      #
       def determine_target
         return $engine.heap.context if @tokens.token_count == 1
 
         return Gloo::Core::Pn.new( @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
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
       # Show the target object.
+      #
       def show_target( obj, levels, indent = '' )
         show_obj( obj, indent )
         return if levels.zero?
@@ -52,7 +67,9 @@ module Gloo
         end
       end
 
+      #
       # Show object in standard format.
+      #
       def show_obj( obj, indent = '  ' )
         if obj.multiline_value? && obj.value_is_array?
           $log.show "#{indent}#{obj.name} [#{obj.type_display}] :"
@@ -65,50 +82,15 @@ module Gloo
       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.
+      # Determine how many levels to show.
       #
-      def self.help
-        return <<~TEXT
-          LIST VERB
-            NAME: list
-            SHORTCUT: .
-
-          DESCRIPTION
-            List out objects (and children) at the current context.
-            When a path is provided, it will be listed instead of the
-            current context.
-
-          SYNTAX
-            list <path.to.object>
-
-          PARAMETERS
-            path.to.object - Optional path to object that will be listed.
-                             When no path is provided, the current context is used.
-
-          RESULT
-            Object and children are listed out in the CLI.
+      def determine_levels
+        # Check settings for the default value.
+        levels = $settings.list_indent
+        return levels if levels
 
-          ERRORS
-            None
-        TEXT
+        # Last chance: use the default
+        return 1
       end
 
     end

data/lib/gloo/verbs/load.rb

@@ -10,14 +10,20 @@ module Gloo
 
       KEYWORD = 'load'.freeze
       KEYWORD_SHORT = '<'.freeze
+      MISSING_EXPR_ERR = 'Missing Expression!'.freeze
 
       #
       # Run the verb.
       #
       def run
         fn = @tokens.second
-        $log.debug "Getting ready to load file: #{fn}"
-        $engine.persist_man.load fn
+
+        if fn
+          $log.debug "Getting ready to load file: #{fn}"
+          $engine.persist_man.load fn
+        else
+          $engine.err MISSING_EXPR_ERR
+        end
       end
 
       #
@@ -34,41 +40,6 @@ module Gloo
         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

@@ -11,6 +11,10 @@ module Gloo
       KEYWORD = 'move'.freeze
       KEYWORD_SHORT = 'mv'.freeze
       TO = 'to'.freeze
+      MISSING_SRC_ERR = 'Object to move was not specified!'.freeze
+      MISSING_SRC_OBJ_ERR = 'Could not find object to move: '.freeze
+      MISSING_DST_ERR = "Move' must include 'to' parent object!".freeze
+      MISSING_DST_OBJ_ERR = 'Could not resolve target: '.freeze
 
       #
       # Run the verb.
@@ -41,28 +45,26 @@ module Gloo
       end
 
       # ---------------------------------------------------------------------
-      #    Helper functions
+      #    Private functions
       # ---------------------------------------------------------------------
 
+      private
+
       #
       # 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
+          $engine.err MISSING_SRC_ERR
+          return
         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
-
+        $engine.err( "#{MISSING_SRC_OBJ_ERR} #{name}" ) unless o
         return o
       end
 
@@ -72,57 +74,16 @@ module Gloo
       def lookup_dst
         dst = @tokens.after_token( TO )
         unless dst
-          msg = "'move' must include 'to' parent object"
-          $log.error msg, nil, $engine
+          $engine.err MISSING_DST_ERR
           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
-
+        $engine.err( "#{MISSING_DST_OBJ_ERR} '#{dst}'" ) unless o
         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

@@ -11,6 +11,9 @@ module Gloo
       KEYWORD = 'put'.freeze
       KEYWORD_SHORT = 'p'.freeze
       INTO = 'into'.freeze
+      MISSING_EXPR_ERR = 'Missing Expression!'.freeze
+      INTO_MISSING_ERR = 'Target (into) missing!'.freeze
+      TARGET_ERR = 'Target could not be resolved: '.freeze
 
       #
       # Run the verb.
@@ -22,17 +25,7 @@ module Gloo
         target = lookup_target
         return if target.nil?
 
-        pn = Gloo::Core::Pn.new target
-        o = pn.resolve
-        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
+        update_target target, value
       end
 
       #
@@ -50,67 +43,50 @@ module Gloo
       end
 
       # ---------------------------------------------------------------------
-      #    Helper functions
+      #    Private functions
       # ---------------------------------------------------------------------
 
+      private
+
+      #
       # 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
+        if value.nil? || ( value.count <= 1 )
+          $engine.err MISSING_EXPR_ERR
           return nil
         end
 
-        if value.count > 1
-          # The first token is the verb, so we drop it.
-          value = value[ 1..-1 ]
-        end
-        return value
+        # The first token is the verb, so we drop it.
+        return value[ 1..-1 ]
       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
+        $engine.err INTO_MISSING_ERR
         return nil
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
       #
-      # Get help for this verb.
+      # Update the target with the new value.
       #
-      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
+      def update_target( target, value )
+        pn = Gloo::Core::Pn.new target
+        o = pn.resolve
+        if o.nil?
+          $engine.err "#{TARGET_ERR} #{target}"
+        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
 
     end