gloo 0.3.0 → 0.5.3

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/cls.rb

@@ -0,0 +1,67 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Clear the screen.
+#
+
+module Gloo
+  module Verbs
+    class Cls < Gloo::Core::Verb
+
+      KEYWORD = 'cls'.freeze
+      KEYWORD_SHORT = 'cls'.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        $engine&.clear_screen
+      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
+          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

@@ -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