gloo 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34119d3b6c3fc676b45d7172a6300e1bef50e7bfd480ecaaeab9ad39be040cc4
-  data.tar.gz: b812253883e7589dea4b6588b85661a1cf6e849a61e2c36a658be8279a0a6411
+  metadata.gz: b527dd8c4837506689358a05681e7e81ba5804aeb617815db80e014a6f0f381b
+  data.tar.gz: 9d0d089ff54f1c669ee3b1009411e8a0310ed01792b008946f3fee8feff89313
 SHA512:
-  metadata.gz: 33d90fe0f4135042d0d5d6cfa4323438183e43e034ce525542bff0aa34bd16baf703ed7819de51c5ad19b38dd51fec8423a4999179e08e41e0dbc89ad0f3d20c
-  data.tar.gz: 017e592805017fc75f776a9a1673eb50aba32ef227260c573f382e8dc83d067ac2429b1f18d722df22672b8f7c57cd941769180d517398db74cde98aeb56a64d
+  metadata.gz: f0632bc38a33051cbe970e0f29e01fac34d29ad9988df31773518c5cdc4d501a9462ff9a3c17fd54fa5db8b5c5326fa890eb8a1d395d7dedef057b5e41da16fc
+  data.tar.gz: 6370739e3e635f6659ed5f28c62fd7d858cd8cb7b02e2115c29119434b8459e5cdb78dc9d1f3a547424425e41242d000216b9f89899734aa7d1e9206b4282662

data/lib/VERSION

@@ -1 +1 @@
-3.4.0
+3.5.0

data/lib/VERSION_NOTES

@@ -1,3 +1,16 @@
+3.5.0 - 2024.10.18
+ - check obj for message alternate to tell
+ - new base object messages
+ - fixes issue with single row returned from query
+ - adds on_error event
+ - use aliases in pwd obj
+
+
+3.4.1 - 2024.09.23
+ - Removes old, unused sound objects
+ - Adds support for lib folder in gloo rather than in the project folder
+
+
 3.4.0 - 2024.09.22
  - Refactor for old TTY lib
  - Additional web server functionality

data/lib/gloo/app/args.rb

@@ -51,12 +51,12 @@ module Gloo
         return true unless app?
 
         if @app_path.nil?
-          @engine.log.error "App Path required to run in App mode."
+          @engine.err "App Path required to run in App mode."
           return false
         end
 
         unless File.directory? @app_path
-          @engine.log.error "'#{@app_path}' is not a valid directory."
+          @engine.err "'#{@app_path}' is not a valid directory."
           return false
         end
 

data/lib/gloo/app/engine.rb

@@ -201,7 +201,7 @@ module Gloo
         begin
           @parser.run @last_cmd
         rescue => e
-          err e.message
+          log_exception e
         end
       end
 
@@ -282,11 +282,30 @@ module Gloo
       # Report an error.
       # Write it to the log and set the heap error value.
       #
-      def err( msg )
+      def err( msg, backtrace=nil )
         @log.error msg
         @heap.error.set_to msg
+
+        @event_manager.on_error( msg, backtrace)
       end
 
+      # 
+      # Log an exception.
+      # This function does not log the full backtrace, but 
+      # does write part of it to the log.
+      # 
+      def log_exception ex
+        # Get the stack trace, and if needed truncate to fit.
+        msg_lines = ex.backtrace
+        if msg_lines.count > 27
+          msg_lines = msg_lines[0..13] + [ '... truncated ...' ] + msg_lines[-13..-1]
+        end
+        backtrace = msg_lines.join( "\n" )
+        @log.error backtrace
+
+        err( ex.message, backtrace)
+      end
+        
     end
   end
 end

data/lib/gloo/convert/converter.rb

@@ -30,8 +30,7 @@ module Gloo
           o = clazz.new
           return o.convert( value )
         rescue => e
-          @engine.log.error e.message
-          @engine.heap.error.set_to e.message
+          @engine.log_exception e
         end
 
         return default

data/lib/gloo/core/dictionary.rb

@@ -190,7 +190,7 @@ module Gloo
       #
       def add_key( keyword )
         if @keywords.include?( keyword )
-          # @engine.log.error "duplicate keyword '#{keyword}'"
+          # @engine.err "duplicate keyword '#{keyword}'"
           return
         end
 

data/lib/gloo/core/event_manager.rb

@@ -72,6 +72,25 @@ module Gloo
         arr.each { |o| Gloo::Exec::Dispatch.message( @engine, 'run', o ) }
       end
 
+      # 
+      # Run the on_error scripts in any open objects.
+      # For each on_error script found, look for the error_data container
+      # and set the error message and backtrace.
+      # 
+      def on_error msg, backtrace
+        @engine.log.debug 'on_error event'
+        arr = Gloo::Core::ObjFinder.by_name( @engine, 'on_error' )
+        arr.each do |o|
+          data = o.parent.find_child 'error_data'
+          if data
+            data.find_child( 'message' ).set_value msg
+            data.find_child( 'backtrace' ).set_value backtrace
+          end
+
+          Gloo::Exec::Dispatch.message( @engine, 'run', o )
+        end
+      end
+
     end
   end
 end

data/lib/gloo/core/factory.rb

@@ -164,7 +164,7 @@ module Gloo
       #
       def create_new( name, value, type, parent )
         unless parent
-          @engine.log.error "Could not create object.  Bad path: #{name}"
+          @engine.err "Could not create object.  Bad path: #{name}"
           return nil
         end
 
@@ -202,7 +202,7 @@ module Gloo
         end
 
         unless t.can_create?
-          @engine.log.error "'#{type_name}' cannot be created."
+          @engine.err "'#{type_name}' cannot be created."
           return nil
         end
 

data/lib/gloo/core/gloo_system.rb

@@ -138,7 +138,7 @@ module Gloo
         o = "msg_#{msg}"
         return self.public_send( o ) if self.respond_to? o
 
-        @engine.log.error "Message #{msg} not implemented"
+        @engine.err "Message #{msg} not implemented"
         return false
       end
 

data/lib/gloo/core/obj.rb

@@ -216,6 +216,30 @@ module Gloo
         return nil
       end
 
+      # 
+      # Find a child, resolve any alias references.
+      # This returns the object, not the value.
+      # 
+      def find_child_resolve_alias( name )
+        o = find_child name
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o
+      end
+
+      # 
+      # Find a child, resolve any alias references,
+      # and return the object's value.
+      # 
+      def find_child_value( name )
+        o = find_child name
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o&.value
+      end
+
       #
       # Get the index of the child with the given name.
       # 
@@ -264,7 +288,7 @@ module Gloo
       # Get a list of message names that this object receives.
       #
       def self.messages
-        return %w[reload unload]
+        return %w[reload unload blank? contains?]
       end
 
       #
@@ -282,7 +306,7 @@ module Gloo
         @params = params
         return self.dispatch msg if self.can_receive_message? msg
 
-        @engine.log.error "Object #{self.name} cannot receive message #{msg}"
+        @engine.err "Object #{self.name} cannot receive message #{msg}"
         return false
       end
 
@@ -295,7 +319,7 @@ module Gloo
           self.public_send( o )
           return true
         else
-          @engine.log.error "Message #{msg} not implemented"
+          @engine.err "Message #{msg} not implemented"
           return false
         end
       end
@@ -305,7 +329,7 @@ module Gloo
       #
       def msg_unload
         if self.root?
-          @engine.log.error 'Cannot unload the root object.'
+          @engine.err 'Cannot unload the root object.'
           return
         end
 
@@ -318,13 +342,31 @@ module Gloo
       #
       def msg_reload
         if self.root?
-          @engine.log.error 'Cannot reload the root object.'
+          @engine.err 'Cannot reload the root object.'
           return
         end
 
         @engine.persist_man.reload self
       end
 
+      # 
+      # Check to see if the value is blank.
+      # 
+      def msg_blank?
+        val_blank = value.blank?
+        @engine.heap.it.set_to val_blank
+        return val_blank
+      end
+
+      # 
+      # Check to see if there are children.
+      # 
+      def msg_contains?
+        has_children = child_count.positive?
+        @engine.heap.it.set_to has_children
+        return has_children
+      end
+
 
       # ---------------------------------------------------------------------
       #    Render

data/lib/gloo/core/parser.rb

@@ -31,7 +31,7 @@ module Gloo
         verb = dic.find_verb( tokens.verb )
         return verb.new( @engine, tokens, params ) if verb
 
-        @engine.log.error "Verb '#{tokens.verb}' was not found."
+        @engine.err "Verb '#{tokens.verb}' was not found."
         return nil
       end
 

data/lib/gloo/core/pn.rb

@@ -150,7 +150,7 @@ module Gloo
           @elements[ 0..-2 ].each do |e|
             o = o.find_child( e )
             if o.nil?
-              @engine.log.error "Object '#{e}' was not found."
+              @engine.err "Object '#{e}' was not found."
               return nil
             end
           end

data/lib/gloo/exec/dispatch.rb

@@ -12,6 +12,23 @@ module Gloo
   module Exec
     class Dispatch
 
+      OBJ_NOT_FOUND_ERR = 'Object was not found: '.freeze
+
+      # 
+      # Send a message to an object of a given name (and path).
+      # Once the object is found, the message is dispatched.
+      # 
+      def self.send_message( engine, msg, to_obj_pn, params = nil )
+        pn = Gloo::Core::Pn.new( engine, to_obj_pn )
+        target_obj = pn.resolve
+
+        unless target_obj
+          engine.err "#{OBJ_NOT_FOUND_ERR} #{to_obj_pn}"
+          return
+        end
+        Gloo::Exec::Dispatch.message( engine, msg, target_obj, params )
+      end
+
       #
       # Dispatch the given message to the given object.
       #

data/lib/gloo/exec/runner.rb

@@ -36,7 +36,7 @@ module Gloo
         if o
           o.send_message 'run'
         else
-          engine.log.error "Could not send message to object.  Bad path: #{path_name}"
+          engine.err "Could not send message to object.  Bad path: #{path_name}"
         end
       end
 

data/lib/gloo/objs/data/mysql.rb

@@ -160,7 +160,7 @@ module Gloo
 
           heads = rs.fields if rs
         rescue => e
-          @engine.err e.message
+          @engine.log_exception e
         end
 
         return [ heads, data ]
@@ -242,7 +242,7 @@ module Gloo
           }
           Mysql2::Client.new( h )
         rescue => e
-          @engine.err e.message
+          @engine.log_exception e
           @engine.heap.it.set_to false
           return false
         end

data/lib/gloo/objs/data/pg.rb

@@ -189,7 +189,7 @@ module Gloo
         begin
           result = pg_conn.exec( "SELECT NOW()" )
         rescue => e
-          @engine.err e.message
+          @engine.log_exception e
           @engine.heap.it.set_to false
           return false
         end

data/lib/gloo/objs/data/query.rb

@@ -81,7 +81,7 @@ module Gloo
           result = db.query( sql_value, param_array )
           process_result( result, db )
         rescue => e
-          @engine.err e.message
+          @engine.log_exception e
           return
         end
       end
@@ -105,7 +105,7 @@ module Gloo
           app.add_db_time elapsed if app
           return result
         rescue => e
-          @engine.err e.message
+          @engine.log_exception e
           return
         end
       end

data/lib/gloo/objs/data/query_result.rb

@@ -33,8 +33,13 @@ module Gloo
 
       # 
       # Does the data contain a single row?
+      # OR, if the result is empty, return false.
       # 
       def single_row_result?
+        if @result_can && ( @result_can.child_count == 0 )
+          return false
+        end
+
         return @data.count == 1
       end
 
@@ -108,7 +113,7 @@ module Gloo
       def update_single_row
         row = @data[0]
         @heads.each_with_index do |h, i|
-          child = @result_can.find_child h          
+          child = @result_can.find_child h
           child.set_value row[i] if child
         end
       end

data/lib/gloo/objs/data/sqlite.rb

@@ -162,7 +162,7 @@ module Gloo
           sql = "SELECT COUNT(name) FROM sqlite_master WHERE type='table'"
           db.get_first_value sql
         rescue => e
-          @engine.err e.message
+          @engine.log_exception e
           @engine.heap.it.set_to false
           return false
         end

data/lib/gloo/objs/data/table.rb

@@ -67,7 +67,7 @@ module Gloo
             result = o.run_query
             return result
           rescue => e
-            @engine.err e.message
+            @engine.log_exception e
             return nil
           end
         else
@@ -196,7 +196,7 @@ module Gloo
           helper = Gloo::WebSvr::TableRenderer.new( @engine )
           return helper.data_to_table params
         rescue => e
-          @engine.err e.message
+          @engine.log_exception e
           return nil
         end
       end

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

@@ -98,7 +98,7 @@ module Gloo
           set_result result
           @engine.heap.it.set_to result
         rescue => e
-          @engine.err e.message
+          @engine.log_exception e
         end
       end
 

data/lib/gloo/objs/security/password.rb

@@ -39,8 +39,7 @@ module Gloo
       # Returns nil if there is none.
       #
       def salt
-        o = find_child SALT
-        return o&.value
+        return find_child_value SALT
       end
 
       #
@@ -48,15 +47,14 @@ module Gloo
       # Returns nil if there is none.
       #
       def password
-        o = find_child PASSWORD
-        return o&.value
+        return find_child_value PASSWORD
       end
 
       #
       # Update the password value.
       #
       def update_password( new_pwd )
-        o = find_child PASSWORD
+        o = find_child_resolve_alias PASSWORD
         return unless o
 
         o.set_value new_pwd
@@ -74,15 +72,14 @@ module Gloo
       # Returns nil if there is none.
       #
       def hash
-        o = find_child HASH
-        return o&.value
+        return find_child_value HASH
       end
 
       #
       # Update the hashed password value.
       #
       def update_hash( new_hash )
-        o = find_child HASH
+        o = find_child_resolve_alias HASH
         return unless o
 
         o.set_value new_hash

data/lib/gloo/objs/web_svr/element.rb

@@ -242,7 +242,7 @@ module Gloo
         begin
           return e.render( render_ƒ )
         rescue => e
-          engine.err e.message
+          engine.log_exception e
           return ''
         end
       end

data/lib/gloo/objs/web_svr/page.rb

@@ -354,7 +354,7 @@ module Gloo
         elsif is_text?
           contents = render_text params
         else
-          @engine.log.error "Unknown content type: #{content_type}"
+          @engine.err "Unknown content type: #{content_type}"
           return nil
         end
 

data/lib/gloo/objs/web_svr/svr.rb

@@ -50,6 +50,7 @@ module Gloo
       CODE = 'code'.freeze
       ELAPSED = 'elapsed'.freeze
       DB = 'db'.freeze
+      PAGE = 'page'.freeze
 
       # Container with pages in the web app.
       PAGES = 'pages'.freeze
@@ -426,7 +427,7 @@ module Gloo
           @engine.stop_running_app
           # The running app will call the stop function (below)
         else
-          @engine.log.error SERVER_NOT_RUNNING
+          @engine.err SERVER_NOT_RUNNING
         end
       end
 
@@ -437,7 +438,7 @@ module Gloo
         if @router
           @router.show_routes
         else
-          @engine.log.error SERVER_NOT_RUNNING
+          @engine.err SERVER_NOT_RUNNING
         end
       end
 
@@ -558,7 +559,7 @@ module Gloo
       # This is done after the page is rendered and before
       # the on_response event is fired.
       # 
-      def set_response_data( request, response )
+      def set_response_data( request, response, page_obj=nil )
         data = find_child RESPONSE_DATA
         return unless data
         data = Gloo::Objs::Alias.resolve_alias( @engine, data )
@@ -567,6 +568,10 @@ module Gloo
         data.find_child( DB )&.set_value( request.db )
         data.find_child( TYPE )&.set_value( response.type )
         data.find_child( CODE )&.set_value( response.code )
+
+        if page_obj
+          data.find_child( PAGE )&.set_value( page_obj.pn ) 
+        end
       end
 
 

data/lib/gloo/persist/disc_mech.rb

@@ -17,6 +17,7 @@ module Gloo
       #
       def initialize( engine )
         @engine = engine
+        @log = @engine.log
       end
 
       #
@@ -32,6 +33,13 @@ module Gloo
       def get_all_files_in( folder )
         pns = []
         dir = File.join( @engine.settings.project_path, folder )
+
+        unless Dir.exist?( dir )
+          @log.debug "Folder does not exist in project: #{folder}"
+          dir = File.join( @engine.settings.user_root, folder )
+          @log.debug "Looking in gloo home? found == #{Dir.exist?( dir )}"
+        end
+
         Dir.glob( "#{dir}*.gloo" ).each do |f|
           pns << f
         end

data/lib/gloo/persist/file_loader.rb

@@ -35,7 +35,7 @@ module Gloo
       #
       def load
         unless @mech.exist?( @pn )
-          @engine.log.error "File '#{@pn}' does not exist."
+          @engine.err "File '#{@pn}' does not exist."
           return
         end
 

data/lib/gloo/persist/file_storage.rb

@@ -37,7 +37,7 @@ module Gloo
         if @obj
           @engine.log.debug "Loaded object: #{@obj.name}"
         else
-          @engine.log.error "Error loading file at #{@pn}"
+          @engine.err "Error loading file at #{@pn}"
         end
       end
 

data/lib/gloo/verbs/check.rb

@@ -0,0 +1,54 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# Alternate version of the Tell verb.
+# Reads better to check object conditions.
+#
+
+module Gloo
+  module Verbs
+    class Check < Gloo::Core::Verb
+
+      KEYWORD = 'check'.freeze
+      KEYWORD_SHORT = '<-'.freeze
+      FOR = 'for'.freeze
+      UNKNOWN_MSG_ERR = 'Missing message!'.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        msg = @tokens.after_token( FOR )
+
+        unless msg
+          @engine.err( UNKNOWN_MSG_ERR ) 
+          return
+        end
+
+        Gloo::Exec::Dispatch.send_message(
+          @engine, msg, @tokens.second, @params )
+      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
+
+    end
+  end
+end

data/lib/gloo/verbs/redirect.rb

@@ -83,6 +83,7 @@ module Gloo
       # 
       def redirect_to_page
         if @engine.app_running?
+          @engine.exec_env.running_script.break_out
           @engine.running_app.obj.redirect = @target_obj
         else
           @engine.err APP_NOT_RUNING_ERR

data/lib/gloo/verbs/tell.rb

@@ -1,7 +1,9 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
 # Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
 #
-# Create an object, optionally of a type.
+# Send a message to an object.
+# Tell the object to do some known action.
+# Also see the Check verb.
 #
 
 module Gloo
@@ -11,18 +13,21 @@ module Gloo
       KEYWORD = 'tell'.freeze
       KEYWORD_SHORT = '->'.freeze
       TO = 'to'.freeze
-      OBJ_NOT_FOUND_ERR = 'Object was not found: '.freeze
       UNKNOWN_MSG_ERR = 'Missing message!'.freeze
 
       #
       # Run the verb.
       #
       def run
-        setup_msg
-        return unless @msg
+        msg = @tokens.after_token( TO )
 
-        setup_target
-        dispatch_msg
+        unless msg
+          @engine.err( UNKNOWN_MSG_ERR ) 
+          return
+        end
+
+        Gloo::Exec::Dispatch.send_message(
+          @engine, msg, @tokens.second, @params )
       end
 
       #
@@ -45,36 +50,6 @@ module Gloo
 
       private
 
-      #
-      # Lookup the message to send.
-      #
-      def setup_msg
-        @msg = @tokens.after_token( TO )
-
-        @engine.err( UNKNOWN_MSG_ERR ) unless @msg
-      end
-
-      #
-      # Setup the target of the message.
-      #
-      def setup_target
-        @obj_name = @tokens.second
-        pn = Gloo::Core::Pn.new( @engine, @obj_name )
-        @target_obj = pn.resolve
-      end
-
-      #
-      # Dispatch the message to the target object.
-      #
-      def dispatch_msg
-        if @target_obj
-          Gloo::Exec::Dispatch.message(
-            @engine, @msg, @target_obj, @params )
-        else
-          @engine.err "#{OBJ_NOT_FOUND_ERR} #{@obj_name}"
-        end
-      end
-
     end
   end
 end

data/lib/gloo/web_svr/handler.rb

@@ -35,6 +35,7 @@ module Gloo
       # 
       def handle request
         @request = request
+        page_obj = nil
 
         page, id = @server_obj.router.page_for_route( @request.path, @request.method )
         @engine.log.debug "Found Page: #{page&.name}" if page
@@ -44,12 +45,13 @@ module Gloo
             result = handle_file page
           else
             result = handle_page page
+            page_obj = page
           end
         else
           result = server_error_result
         end
 
-        return result
+        return result, page_obj
       end
 
       # 

data/lib/gloo/web_svr/request.rb

@@ -60,11 +60,11 @@ module Gloo
         @handler.server_obj.set_request_data self
         @handler.server_obj.run_on_request
         
-        result = @handler.handle self
+        result, page_obj = @handler.handle self
         finish_timer
 
         # Run the on_response script if there is one.
-        @handler.server_obj.set_response_data self, result
+        @handler.server_obj.set_response_data( self, result, page_obj )
         @handler.server_obj.run_on_response
 
         return result

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gloo
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Eric Crane
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-22 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -458,8 +458,6 @@ files:
 - lib/gloo/objs/ror/eval.rb
 - lib/gloo/objs/security/cipher.rb
 - lib/gloo/objs/security/password.rb
-- lib/gloo/objs/snd/play.rb
-- lib/gloo/objs/snd/say.rb
 - lib/gloo/objs/system/file_handle.rb
 - lib/gloo/objs/system/ssh_exec.rb
 - lib/gloo/objs/system/system.rb
@@ -485,6 +483,7 @@ files:
 - lib/gloo/verbs/alert.rb
 - lib/gloo/verbs/beep.rb
 - lib/gloo/verbs/break.rb
+- lib/gloo/verbs/check.rb
 - lib/gloo/verbs/cls.rb
 - lib/gloo/verbs/context.rb
 - lib/gloo/verbs/create.rb

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

@@ -1,48 +0,0 @@
-# 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
-
-    end
-  end
-end

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

@@ -1,98 +0,0 @@
-# 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
-      DEFAULT_MSG = 'talk to me'.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, DEFAULT_MSG, self
-      end
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + [ 'run' ]
-      end
-
-      #
-      # Have the computer 'speak' the message.
-      #
-      def msg_run
-        v = voice_value.empty? ? '' : "-v '#{voice_value}'"
-        cmd = "say #{v} '#{msg_value}'"
-        system cmd
-      end
-
-    end
-  end
-end