gloo 0.3.0 → 0.4.0

data/lib/gloo/utils/words.rb

@@ -9,11 +9,11 @@ require 'active_support/inflector'
 module Gloo
   module Utils
     class Words
-      
+
       def self.pluralize( word )
         return word.pluralize
       end
-      
+
     end
   end
 end

data/lib/gloo/verbs/alert.rb

@@ -7,36 +7,87 @@
 module Gloo
   module Verbs
     class Alert < Gloo::Core::Verb
-      
-      KEYWORD = 'alert'
-      KEYWORD_SHORT = '!'
 
-      # 
+      KEYWORD = 'alert'.freeze
+      KEYWORD_SHORT = '!'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
-        if @tokens.token_count > 1
-          expr = Gloo::Expr::Expression.new( @tokens.params )
-          result = expr.evaluate
-          $engine.heap.it.set_to result
-          system( '/usr/bin/osascript -e "display notification \"' + result.to_s + '\" with title \"OutlineScript\" "' ) 
-        end
+        return unless @tokens.token_count > 1
+
+        expr = Gloo::Expr::Expression.new( @tokens.params )
+        result = expr.evaluate
+        $engine.heap.it.set_to result
+        self.post_alert result
+      end
+
+      #
+      # Post the alert for the specific platform.
+      # Notice is not posted if we're in quiet mode.
+      #
+      def post_alert( msg )
+        return if $engine.args.quiet?
+
+        post_osx msg
+      end
+
+      #
+      # Post the alert on the Mac OSX.
+      #
+      def post_osx( msg )
+        cmd1 = '/usr/bin/osascript -e "display notification \"'
+        cmd2 = '\" with title \"Gloo\" "'
+        system( cmd1 + msg.to_s + cmd2 )
       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
+          ALERT VERB
+            NAME: alert
+            SHORTCUT: !
+
+          DESCRIPTION
+            Show a pop-up notification.
+            This has only been implemented for the Mac OSX as of yet.
+
+          SYNTAX
+            alert <messsage>
+
+          PARAMETERS
+            messsage - The message that will be displayed in the alert.
+
+          RESULT
+            On the Mac, a notification will popup on screen.
+            <it> will be set to the message.
+
+          ERRORS
+            None
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/verbs/beep.rb

@@ -0,0 +1,70 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Play a standard system beep sound.
+#
+
+module Gloo
+  module Verbs
+    class Beep < Gloo::Core::Verb
+
+      KEYWORD = 'beep'.freeze
+      KEYWORD_SHORT = 'b'.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
+        print 7.chr
+      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
+          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/context.rb

@@ -8,45 +8,85 @@
 module Gloo
   module Verbs
     class Context < Gloo::Core::Verb
-      
-      KEYWORD = 'context'
-      KEYWORD_SHORT = '@'
 
-      # 
+      KEYWORD = 'context'.freeze
+      KEYWORD_SHORT = '@'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
-        if @tokens.token_count == 1
-          show_context
-        else
-          path = @tokens.second
-          $engine.heap.context.set_to path
-          $engine.heap.it.set_to path
-          $log.debug "Context set to #{$engine.heap.context}"
-        end
+        set_context if @tokens.token_count > 1
+        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.
-      # 
+      #
       def show_context
         $log.show "Context:  #{$engine.heap.context}"
       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
+          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
+      end
+
     end
   end
 end

data/lib/gloo/verbs/create.rb

@@ -7,46 +7,77 @@
 module Gloo
   module Verbs
     class Create < Gloo::Core::Verb
-      
-      KEYWORD = 'create'
-      KEYWORD_SHORT = '`'
-      AS = 'as'
-      VAL = ':'
-      
-      # 
+
+      KEYWORD = 'create'.freeze
+      KEYWORD_SHORT = '`'.freeze
+      AS = 'as'.freeze
+      VAL = ':'.freeze
+
+      #
       # Run the verb.
-      # 
+      #
       def run
         name = @tokens.second
         type = @tokens.after_token( AS )
         value = @tokens.after_token( VAL )
-        
-        if Gloo::Expr::LString.is_string?( value )
+
+        if Gloo::Expr::LString.string?( value )
           value = Gloo::Expr::LString.strip_quotes( value )
         end
-        obj = $engine.factory.create( name, type, value )
-        
-        if obj && obj.add_children_on_create?
-          obj.add_default_children
-        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
       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
+          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.
+
+          ERRORS
+            None
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/verbs/help.rb

@@ -7,63 +7,213 @@
 module Gloo
   module Verbs
     class Help < Gloo::Core::Verb
-      
-      KEYWORD = 'help'
-      KEYWORD_SHORT = '?'
 
-      # 
+      KEYWORD = 'help'.freeze
+      KEYWORD_SHORT = '?'.freeze
+
+      DISPATCH = {
+        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
-      
-      # 
+
+      #
       # 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
+                    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