gloo 0.3.0 → 0.4.0

data/lib/gloo/objs/ror/erb.rb

@@ -8,61 +8,61 @@ require 'erb'
 module Gloo
   module Objs
     class Erb < Gloo::Core::Obj
-      
-      KEYWORD = 'erb'
-      KEYWORD_SHORT = 'erb'
-      TEMPLATE = 'template'
-      PARAMS = 'params'
-      RESULT = 'result'
-
-      # 
+
+      KEYWORD = 'erb'.freeze
+      KEYWORD_SHORT = 'erb'.freeze
+      TEMPLATE = 'template'.freeze
+      PARAMS = 'params'.freeze
+      RESULT = 'result'.freeze
+
+      #
       # The name of the object type.
-      # 
+      #
       def self.typename
         return KEYWORD
       end
 
-      # 
+      #
       # The short name of the object type.
-      # 
+      #
       def self.short_typename
         return KEYWORD_SHORT
       end
-      
-      # 
+
+      #
       # Get the ERB template.
-      # 
-      def get_template
+      #
+      def template_value
         tmpl = find_child TEMPLATE
         return nil unless tmpl
+
         return tmpl.value
       end
-      
-      # 
+
+      #
       # Set the result of the system call.
-      # 
-      def set_result data
+      #
+      def set_result( data )
         r = find_child RESULT
         return nil unless r
+
         r.set_value data
       end
-      
-      # 
+
+      #
       # Get a hash with parameters for the ERB render.
-      # 
-      def get_param_hash
+      #
+      def param_hash
         h = {}
-        
+
         body = find_child PARAMS
         body.children.each do |child|
           h[ child.name ] = child.value
         end
-        
+
         return h
       end
 
-            
-
       # ---------------------------------------------------------------------
       #    Children
       # ---------------------------------------------------------------------
@@ -73,37 +73,77 @@ module Gloo
       def add_children_on_create?
         return true
       end
-      
+
       # Add children to this object.
-      # This is used by containers to add children needed 
+      # This is used by containers to add children needed
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create "template", "text", "", self
-        fac.create "params", "container", nil, self
-        fac.create "result", "text", nil, self
+        fac.create( { :name => 'template',
+                      :type => 'text',
+                      :value => '',
+                      :parent => self } )
+        fac.create( { :name => 'params',
+                      :type => 'container',
+                      :value => nil,
+                      :parent => self } )
+        fac.create( { :name => 'result',
+                      :type => 'text',
+                      :value => nil,
+                      :parent => self } )
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + [ 'run' ]
       end
-      
+
       # Run the system command.
       def msg_run
-        tmpl = get_template
+        tmpl = template_value
         return unless tmpl
-        render = ERB.new( tmpl )        
-        set_result render.result_with_hash( get_param_hash )
+
+        render = ERB.new( tmpl )
+        set_result render.result_with_hash( param_hash )
       end
-      
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          ERB OBJECT TYPE
+            NAME: erb
+            SHORTCUT: erb
+
+          DESCRIPTION
+            Use the ERB templating system to generate content.
+
+          CHILDREN
+            template - text
+              The template that will be used the the ERB object is run.
+            params - container
+              The collection of children values that will be used
+              when the template object is rendered.
+            result - text
+              The result of the template rendering.
+
+          MESSAGES
+            run - Render the result based on the template and the
+                  parameter values.
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/objs/ror/eval.rb

@@ -7,45 +7,46 @@
 module Gloo
   module Objs
     class Eval < Gloo::Core::Obj
-      
-      KEYWORD = 'eval'
-      KEYWORD_SHORT = 'ruby'
-      CMD = 'command'
-      RESULT = 'result'
 
-      # 
+      KEYWORD = 'eval'.freeze
+      KEYWORD_SHORT = 'ruby'.freeze
+      CMD = 'command'.freeze
+      RESULT = 'result'.freeze
+
+      #
       # The name of the object type.
-      # 
+      #
       def self.typename
         return KEYWORD
       end
 
-      # 
+      #
       # The short name of the object type.
-      # 
+      #
       def self.short_typename
         return KEYWORD_SHORT
       end
-      
-      # 
+
+      #
       # Get the URI from the child object.
       # Returns nil if there is none.
-      # 
-      def get_cmd
+      #
+      def cmd_value
         cmd = find_child CMD
         return nil unless cmd
+
         return cmd.value
       end
-      
-      # 
+
+      #
       # Set the result of the system call.
-      # 
-      def set_result data
+      #
+      def set_result( data )
         r = find_child RESULT
         return nil unless r
+
         r.set_value data
       end
-            
 
       # ---------------------------------------------------------------------
       #    Children
@@ -57,36 +58,77 @@ module Gloo
       def add_children_on_create?
         return true
       end
-      
+
       # Add children to this object.
-      # This is used by containers to add children needed 
+      # This is used by containers to add children needed
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create "command", "string", "date", self
-        fac.create "result", "string", nil, self
+        fac.create( { :name => 'command',
+                      :type => 'string',
+                      :value => '1+2',
+                      :parent => self } )
+        fac.create( { :name => 'result',
+                      :type => 'string',
+                      :value => nil,
+                      :parent => self } )
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + [ 'run' ]
       end
-      
+
       # Run the system command.
       def msg_run
-        cmd = get_cmd
+        cmd = cmd_value
         return unless cmd
-        result = eval cmd
-        set_result result
+
+        begin
+          # rubocop:disable Security/Eval
+          result = eval cmd
+          # rubocop:enable Security/Eval
+          set_result result
+          $engine.heap.it.set_to result
+        rescue => e
+          $log.error e.message
+          $engine.heap.error.set_to e.message
+        end
       end
-      
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          EVAL OBJECT TYPE
+            NAME: eval
+            SHORTCUT: ruby
+
+          DESCRIPTION
+            Execute a ruby expression.
+
+          CHILDREN
+            command - string
+              The ruby expression or command that will be run.
+            result - string
+              The result of the command or expression after it is run.
+
+          MESSAGES
+            run - Execute the ruby command and update the result.
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/objs/snd/play.rb

@@ -0,0 +1,71 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Play an audio file (MP3).
+#
+
+module Gloo
+  module Objs
+    class Play < Gloo::Core::Obj
+
+      KEYWORD = 'play'.freeze
+      KEYWORD_SHORT = 'play'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'run' ]
+      end
+
+      # Play the audio file.
+      def msg_run
+        system "afplay #{value}"
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          PLAY OBJECT TYPE
+            NAME: play
+            SHORTCUT: play
+
+          DESCRIPTION
+            Play an audio file, an MP3 for example.
+            The value of the play object is the path to the audio file.
+
+          CHILDREN
+            None.
+
+          MESSAGES
+            run - Play the audio file.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/snd/say.rb

@@ -0,0 +1,120 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Wrapper for the 'say something' function on the Mac.
+#
+require 'erb'
+
+module Gloo
+  module Objs
+    class Say < Gloo::Core::Obj
+
+      KEYWORD = 'say'.freeze
+      KEYWORD_SHORT = 'say'.freeze
+      VOICE = 'voice'.freeze
+      MSG = 'message'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      #
+      # Get the voice to use.
+      #
+      def voice_value
+        v = find_child VOICE
+        return nil unless v
+
+        return v.value
+      end
+
+      #
+      # Get the message to speak.
+      #
+      def msg_value
+        o = find_child MSG
+        return nil unless o
+
+        return o.value
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      def add_children_on_create?
+        return true
+      end
+
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      def add_default_children
+        fac = $engine.factory
+        fac.create_string VOICE, '', self
+        fac.create_string MSG, 'talk to me', self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'run' ]
+      end
+
+      # Run the system command.
+      def msg_run
+        v = voice_value.empty? ? '' : "-v '#{voice_value}'"
+        cmd = "say #{v} '#{msg_value}'"
+        system cmd
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          SAY OBJECT TYPE
+            NAME: say
+            SHORTCUT: say
+
+          DESCRIPTION
+            Use the Mac text to speach function to say the .
+            From the Mac CLI, run this to get a list of voices:
+              say -v '?'
+
+          CHILDREN
+            voice - string
+              The Voice to use.  If left blank, the default voice will be used.
+            message - string - 'talk to me'
+              The message to speak.
+
+          MESSAGES
+            run - Speak the message, optionally in the voice specified.
+        TEXT
+      end
+
+    end
+  end
+end