gloo 0.3.0 → 0.4.0

data/lib/gloo/verbs/if.rb

@@ -7,50 +7,83 @@
 module Gloo
   module Verbs
     class If < Gloo::Core::Verb
-      
-      KEYWORD = 'if'
-      KEYWORD_SHORT = 'if'
-      THEN = 'then'
-      
-      # 
+
+      KEYWORD = 'if'.freeze
+      KEYWORD_SHORT = 'if'.freeze
+      THEN = 'then'.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_true = false
-        if value.count > 0
+        if value.count.positive?
           expr = Gloo::Expr::Expression.new( value )
           result = expr.evaluate
           evals_true = true if result == true
         end
-        
-        if evals_true
-          cmd = @tokens.expr_after( THEN )
-          i = $engine.parser.parse_immediate cmd
-          return unless i
-          i.run
-        end
+        return unless evals_true
+
+        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
+          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
+      end
+
     end
   end
 end

data/lib/gloo/verbs/list.rb

@@ -7,13 +7,13 @@
 module Gloo
   module Verbs
     class List < Gloo::Core::Verb
-      
-      KEYWORD = 'list'
-      KEYWORD_SHORT = '.'
 
-      # 
+      KEYWORD = 'list'.freeze
+      KEYWORD_SHORT = '.'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
         levels = determine_levels
         target = self.determine_target
@@ -30,33 +30,31 @@ module Gloo
         # 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
-        if @tokens.token_count == 1
-          return $engine.heap.context
-        else
-          return Gloo::Core::Pn.new( @tokens.second )
-        end
+        return $engine.heap.context if @tokens.token_count == 1
+
+        return Gloo::Core::Pn.new( @tokens.second )
       end
 
       # Show the target object.
-      def show_target( obj, levels, indent="" )
+      def show_target( obj, levels, indent = '' )
         show_obj( obj, indent )
-        
-        return if levels == 0
-        obj.children.each do |o| 
+        return if levels.zero?
+
+        obj.children.each do |o|
           show_target( o, levels - 1, "#{indent}  " )
         end
       end
-      
+
       # Show object in standard format.
-      def show_obj obj, indent="  "
-        if obj.has_multiline_value? && obj.value_is_array?
+      def show_obj( obj, indent = '  ' )
+        if obj.multiline_value? && obj.value_is_array?
           $log.show "#{indent}#{obj.name} [#{obj.type_display}] :"
           obj.value.each do |line|
             $log.show "#{indent}  #{line}"
@@ -65,21 +63,54 @@ module Gloo
           $log.show "#{indent}#{obj.name} [#{obj.type_display}] : #{obj.value}"
         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
+          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.
+
+          ERRORS
+            None
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/verbs/load.rb

@@ -7,33 +7,67 @@
 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.
+            The file's path should be provided from the gloo project folder
+            as the root directory.
+
+          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/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