gloo 0.3.0 → 0.5.3

data/lib/gloo/verbs/help.rb

@@ -7,63 +7,222 @@
 module Gloo
   module Verbs
     class Help < Gloo::Core::Verb
-      
-      KEYWORD = 'help'
-      KEYWORD_SHORT = '?'
 
-      # 
+      KEYWORD = 'help'.freeze
+      KEYWORD_SHORT = '?'.freeze
+
+      DISPATCH = {
+        settings: 'show_settings',
+        verb: 'show_verbs',
+        verbs: 'show_verbs',
+        v: 'show_verbs',
+        obj: 'show_objs',
+        object: 'show_objs',
+        objects: 'show_objs',
+        o: 'show_objs'
+      }.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
         opts = @tokens.second if @tokens
-        
-        if opts && opts.strip.downcase == 'verbs'
-          show_verbs
-        elsif opts && opts.strip.downcase == 'objects'
-          show_objs
+        opts = opts.strip.downcase if opts
+
+        if opts
+          self.dispatch opts
+        else
+          show_default
+        end
+      end
+
+      #
+      # Dispatch the help to the right place.
+      #
+      def dispatch( opts )
+        cmd = DISPATCH[ opts.to_sym ]
+        if cmd
+          send cmd
         else
-          $engine.run_help( true )
+          entity_help opts
+        end
+      rescue
+        report_help_error opts
+      end
+
+      #
+      # Dispatch the help command to a verb or object
+      # if we can find one matching the request.
+      #
+      def entity_help( opts )
+        return if try_verb_help opts
+        return if try_object_help opts
+
+        report_help_error opts
+      end
+
+      #
+      # See if there is a verb we can show help
+      # information about.
+      #
+      def try_verb_help( opts )
+        if $engine.dictionary.verb?( opts )
+          t = $engine.dictionary.find_verb( opts )
+          out = t.send 'help'
+          self.show_output out
+          return true
+        end
+
+        return false
+      end
+
+      #
+      # See if there is a verb we can show help
+      # information about.
+      #
+      def try_object_help( opts )
+        if $engine.dictionary.obj?( opts )
+          t = $engine.dictionary.find_obj( opts )
+          out = t.send 'help'
+          self.show_output out
+          return true
         end
+
+        return false
+      end
+
+      #
+      # Lookup the opts in the dispatch table.
+      #
+      def lookup_opts( opts )
+        return DISPATCH[ opts.to_sym ]
       end
-      
-      # 
+
+      #
+      # Report an error with the inline help.
+      #
+      def report_help_error( opts )
+        msg = "Help command '#{opts}' could not be found"
+        $log.warn msg
+        $engine.heap.error.set_to msg
+      end
+
+      #
+      # If no parameter is given, show the default help page.
+      #
+      def show_default
+        $engine.run_help( true )
+      end
+
+      #
+      # Show application settings.
+      #
+      def show_settings
+        $settings.show
+      end
+
+      #
       # List the verbs
-      # 
+      #
       def show_verbs
-        return if $engine.args.quiet?
+        out = self.get_verb_list
+        self.show_output out
+      end
 
-        puts "Verbs:"
+      #
+      # Get the text for the list of verbs.
+      #
+      def get_verb_list
+        out = "Verbs:\n"
         $engine.dictionary.get_verbs.each do |v|
-          puts " \t #{v.keyword_shortcut} \t #{v.keyword}"
+          out << "  #{v.keyword_shortcut} -  #{v.keyword}\n"
         end
+        return out
       end
 
-      # 
+      #
       # List the object types
-      # 
+      #
       def show_objs
-        return if $engine.args.quiet?
+        out = self.get_obj_list
+        self.show_output out
+      end
 
-        puts "Object Types:"
+      #
+      # Get the text for the list of verbs.
+      #
+      def get_obj_list
+        out = "Object Types:\n"
         $engine.dictionary.get_obj_types.each do |v|
-          puts " \t #{v.short_typename} \t #{v.typename}"
+          out << "  #{v.short_typename} - #{v.typename}\n"
         end
+        return out
+      end
+
+      #
+      # Write output to it and show it unless we are in
+      # silent mode.
+      #
+      def show_output( out )
+        $engine.heap.it.set_to out
+        puts out unless $engine.args.quiet?
       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
+          HELP VERB
+            NAME: helps
+            SHORTCUT: ?
+
+          DESCRIPTION
+            Show information about the application.
+            The help command can also be used to show a list of objects,
+            verbs, or to show detail about a single object or a
+            single verb.
+
+          SYNTAX
+            help <about>
+
+          PARAMETERS
+            about - Optional parameter.
+                    If no parameter is given, shows the default help screen
+                    settings - Show application settings
+                    verbs - List available verbs
+                    objects - List available objects
+                    <verb> - Look up detail about a verb
+                    <object> - Look up detail about an object
+
+          RESULT
+            The help screen will be shown with relevant information.
+            <it> will also contain the help text.
+
+          ERRORS
+            Trying to access a help topic that does not exist will result
+            in an error.
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/verbs/if.rb

@@ -7,50 +7,84 @@
 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
+          evals_true = true if result.is_a?( Numeric ) && result != 0
         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