gloo 0.5.2 → 0.7.0

data/lib/gloo/verbs/beep.rb

@@ -35,36 +35,6 @@ module Gloo
         return KEYWORD_SHORT
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this verb.
-      #
-      def self.help
-        return <<~TEXT
-          BEEP VERB
-            NAME: beep
-            SHORTCUT: b
-
-          DESCRIPTION
-            Play a standard system beep sound.
-
-          SYNTAX
-            beep
-
-          PARAMETERS
-            None
-
-          RESULT
-            None
-
-          ERRORS
-            None
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/verbs/cls.rb

@@ -32,36 +32,6 @@ module Gloo
         return KEYWORD_SHORT
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this verb.
-      #
-      def self.help
-        return <<~TEXT
-          CLS VERB
-            NAME: cls
-            SHORTCUT: cls
-
-          DESCRIPTION
-            Clear the console screen.
-
-          SYNTAX
-            cls
-
-          PARAMETERS
-            None
-
-          RESULT
-            The screen is cleared and cursor set to the top.
-
-          ERRORS
-            None
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/verbs/context.rb

@@ -20,16 +20,6 @@ module Gloo
         show_context
       end
 
-      #
-      # Set the context to the given path.
-      #
-      def set_context
-        path = @tokens.second
-        $engine.heap.context.set_to path
-        $engine.heap.it.set_to path
-        $log.debug "Context set to #{$engine.heap.context}"
-      end
-
       #
       # Show the current context.
       #
@@ -52,39 +42,19 @@ module Gloo
       end
 
       # ---------------------------------------------------------------------
-      #    Help
+      #    Private functions
       # ---------------------------------------------------------------------
 
+      private
+
       #
-      # Get help for this verb.
+      # Set the context to the given path.
       #
-      def self.help
-        return <<~TEXT
-          CONTEXT VERB
-            NAME: context
-            SHORTCUT: @
-
-          DESCRIPTION
-            Get or set the current context.
-            When no parameter is provided, the context will be shown.
-            Whe the optional path paramter is provided, the context will
-            be set to that path.
-            Use 'context root' to set the context back to the root level.
-
-          SYNTAX
-            context <path.to.new.context>
-
-          PARAMETERS
-            path.to.new.context - Optional.  The path to the new context.
-
-          RESULT
-            Context is optionally set.
-            <it> will be set to the new context path when we are changing context.
-            Context is show in either case.
-
-          ERRORS
-            None
-        TEXT
+      def set_context
+        path = @tokens.second
+        $engine.heap.context.set_to path
+        $engine.heap.it.set_to path
+        $log.debug "Context set to #{$engine.heap.context}"
       end
 
     end

data/lib/gloo/verbs/create.rb

@@ -12,6 +12,7 @@ module Gloo
       KEYWORD_SHORT = '`'.freeze
       AS = 'as'.freeze
       VAL = ':'.freeze
+      NO_NAME_ERR = 'Object name is missing!'.freeze
 
       #
       # Run the verb.
@@ -21,13 +22,11 @@ module Gloo
         type = @tokens.after_token( AS )
         value = @tokens.after_token( VAL )
 
-        if Gloo::Expr::LString.string?( value )
-          value = Gloo::Expr::LString.strip_quotes( value )
+        unless name
+          $engine.err NO_NAME_ERR
+          return
         end
-        obj = $engine.factory.create( { name: name, type: type, value: value } )
-
-        obj.add_default_children if obj&.add_children_on_create?
-        $engine.heap.it.set_to value
+        create name, type, value
       end
 
       #
@@ -45,37 +44,23 @@ module Gloo
       end
 
       # ---------------------------------------------------------------------
-      #    Help
+      #    Private functions
       # ---------------------------------------------------------------------
 
+      private
+
       #
-      # Get help for this verb.
+      # Create an object with given name of given type with
+      # the given initial value.
       #
-      def self.help
-        return <<~TEXT
-          CREATE VERB
-            NAME: create
-            SHORTCUT: `
-
-          DESCRIPTION
-            Create a new object of given type with given value.
-            Both type and value are optional when creating an object.
-
-          SYNTAX
-            create <new.object.path> as <type> : <value>
-
-          PARAMETERS
-            new.object.path - The path and name of the new object
-            type - The type of the new object
-            value - The initial value for the new object
-
-          RESULT
-            The new object will be created and added to the object heap.
-            <it> will be set to the new object's intitial value.
+      def create( name, type, value )
+        if Gloo::Expr::LString.string?( value )
+          value = Gloo::Expr::LString.strip_quotes( value )
+        end
+        obj = $engine.factory.create( { name: name, type: type, value: value } )
 
-          ERRORS
-            None
-        TEXT
+        obj.add_default_children if obj&.add_children_on_create?
+        $engine.heap.it.set_to value
       end
 
     end

data/lib/gloo/verbs/help.rb

@@ -10,16 +10,20 @@ module Gloo
 
       KEYWORD = 'help'.freeze
       KEYWORD_SHORT = '?'.freeze
+      DEFAULT_HELP = 'default_help'.freeze
+      HELP_NOT_FOUND_ERR = 'Help command could not be found:'.freeze
 
       DISPATCH = {
         settings: 'show_settings',
+        keywords: 'show_keywords',
         verb: 'show_verbs',
         verbs: 'show_verbs',
         v: 'show_verbs',
         obj: 'show_objs',
         object: 'show_objs',
         objects: 'show_objs',
-        o: 'show_objs'
+        o: 'show_objs',
+        topics: 'show_topics'
       }.freeze
 
       #
@@ -30,26 +34,161 @@ module Gloo
         opts = opts.strip.downcase if opts
 
         if opts
-          self.dispatch opts
+          dispatch opts
         else
-          show_default
+          $engine.help.page_topic DEFAULT_HELP
         end
       end
 
+      #
+      # Get the text for the list of verbs.
+      #
+      def get_verb_list
+        out = "Verbs:\n"
+        str = ''
+        verbs = $engine.dictionary.get_verbs.sort_by( &:keyword )
+        verbs.each_with_index do |v, i|
+          cut = v.keyword_shortcut.ljust( 5, ' ' )
+          str << " #{cut} #{v.keyword.ljust( 20, ' ' )}"
+          if ( ( i + 1 ) % 3 ).zero?
+            out << "#{str}\n"
+            str = ''
+          end
+        end
+
+        return out
+      end
+
+      #
+      # Lookup the opts in the dispatch table.
+      #
+      def lookup_opts( opts )
+        return DISPATCH[ opts.to_sym ]
+      end
+
+      #
+      # Get the text for the list of verbs.
+      #
+      def get_obj_list
+        out = "Object Types:\n"
+        str = ''
+        objs = $engine.dictionary.get_obj_types.sort_by( &:typename )
+        objs.each_with_index do |o, i|
+          name = o.typename
+          if o.short_typename != o.typename
+            name = "#{name} (#{o.short_typename})"
+          end
+          str << " #{name.ljust( 30, ' ' )}"
+          if ( ( i + 1 ) % 4 ).zero?
+            out << "#{str}\n"
+            str = ''
+          end
+        end
+
+        return out
+      end
+
+      #
+      # Get the list of help topics.
+      #
+      def get_topics
+        out = "Help Topics:\n"
+        str = ''
+        objs = $engine.help.topics.keys.sort
+        objs.each_with_index do |o, i|
+          str << " #{o.ljust( 30, ' ' )}"
+          if ( ( i + 1 ) % 4 ).zero?
+            out << "#{str}\n"
+            str = ''
+          end
+        end
+
+        return out
+      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
+
+      #
+      # Report an error with the inline help.
+      #
+      def report_help_error( opts )
+        $engine.err "#{HELP_NOT_FOUND_ERR} '#{opts}'"
+      end
+
       #
       # Dispatch the help to the right place.
       #
       def dispatch( opts )
+        return if dispatch_help_page( opts )
+
+        $log.debug 'looking for built in help topic'
         cmd = DISPATCH[ opts.to_sym ]
         if cmd
+          $log.debug 'found help index'
           send cmd
         else
+          $log.debug 'looking for entity help'
           entity_help opts
         end
       rescue
         report_help_error opts
       end
 
+      #
+      # Dispatch to a help page if we can find one.
+      #
+      def dispatch_help_page( opts )
+        if $engine.help.topic? opts
+          $log.debug 'found expanded help topic'
+          $engine.help.page_topic opts
+          return true
+        end
+
+        key = $engine.dictionary.lookup_keyword opts
+        if $engine.help.topic? key
+          $log.debug 'found expanded help topic'
+          $engine.help.page_topic key
+          return true
+        end
+
+        return false
+      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
+
+      #
+      # List all help topics (articles)
+      #
+      def show_topics
+        out = self.get_topics
+        show_output out
+      end
+
       #
       # Dispatch the help command to a verb or object
       # if we can find one matching the request.
@@ -69,7 +208,7 @@ module Gloo
         if $engine.dictionary.verb?( opts )
           t = $engine.dictionary.find_verb( opts )
           out = t.send 'help'
-          self.show_output out
+          show_output out
           return true
         end
 
@@ -84,36 +223,13 @@ module Gloo
         if $engine.dictionary.obj?( opts )
           t = $engine.dictionary.find_obj( opts )
           out = t.send 'help'
-          self.show_output out
+          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.
       #
@@ -122,22 +238,17 @@ module Gloo
       end
 
       #
-      # List the verbs
+      # Show all keywords: verbs and objects.
       #
-      def show_verbs
-        out = self.get_verb_list
-        self.show_output out
+      def show_keywords
+        $engine.dictionary.show_keywords
       end
 
       #
-      # Get the text for the list of verbs.
+      # List the verbs
       #
-      def get_verb_list
-        out = "Verbs:\n"
-        $engine.dictionary.get_verbs.each do |v|
-          out << "  #{v.keyword_shortcut} -  #{v.keyword}\n"
-        end
-        return out
+      def show_verbs
+        show_output get_verb_list
       end
 
       #
@@ -145,82 +256,7 @@ module Gloo
       #
       def show_objs
         out = self.get_obj_list
-        self.show_output out
-      end
-
-      #
-      # Get the text for the list of verbs.
-      #
-      def get_obj_list
-        out = "Object Types:\n"
-        $engine.dictionary.get_obj_types.each do |v|
-          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
+        show_output out
       end
 
     end