gloo 6.7.1 → 7.0

data/lib/gloo/objs/dt/datetime.rb

@@ -69,14 +69,17 @@ module Gloo
       # Add the given modifier to the date.
       #
       def msg_add
-        modifier = "1 day"
+        data = nil
         if @params&.token_count&.positive?
           expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
           data = expr.evaluate
-          modifier = data
         end
+        modifier = DtTools.amount( @engine, data )
+        return false unless modifier
         
-        dt = Chronic.parse( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
         new_value = DtTools.add( dt, modifier )
         self.set_value( new_value )
         @engine.heap.it.set_to self.value
@@ -86,14 +89,17 @@ module Gloo
       # Subtract the given modifier from the date.
       #
       def msg_sub
-        modifier = "1 day"
+        data = nil
         if @params&.token_count&.positive?
           expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
           data = expr.evaluate
-          modifier = data
         end
+        modifier = DtTools.amount( @engine, data )
+        return false unless modifier
+
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
 
-        dt = Chronic.parse( self.value )
         self.set_value( DtTools.sub( dt, modifier ) )
         @engine.heap.it.set_to self.value
       end
@@ -102,7 +108,10 @@ module Gloo
       # Set the value to the beginning of the month.
       #
       def msg_begin_month
-        dt = self.value.to_time.beginning_of_month
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        dt = dt.to_time.beginning_of_month
         self.set_value dt
         @engine.heap.it.set_to dt
       end
@@ -111,7 +120,10 @@ module Gloo
       # Set the value to the end of the month.
       #
       def msg_end_month
-        dt = self.value.to_time.end_of_month
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        dt = dt.to_time.end_of_month
         self.set_value dt
         @engine.heap.it.set_to dt
       end
@@ -120,7 +132,10 @@ module Gloo
       # Set the value to the beginning of the year.
       #
       def msg_begin_year
-        dt = self.value.to_time.beginning_of_year
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        dt = dt.to_time.beginning_of_year
         self.set_value dt
         @engine.heap.it.set_to dt
       end
@@ -129,7 +144,10 @@ module Gloo
       # Set the value to the end of the year.
       #
       def msg_end_year
-        dt = self.value.to_time.end_of_year
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        dt = dt.to_time.end_of_year
         self.set_value dt
         @engine.heap.it.set_to dt
       end
@@ -138,7 +156,10 @@ module Gloo
       # Set the value to the beginning of the week.
       #
       def msg_begin_week
-        dt = self.value.to_time.beginning_of_week( start_day = :sunday )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        dt = dt.to_time.beginning_of_week( start_day = :sunday )
         self.set_value dt
         @engine.heap.it.set_to dt
       end
@@ -147,7 +168,10 @@ module Gloo
       # Set the value to the end of the week.
       #
       def msg_end_week
-        dt = self.value.to_time.end_of_week( start_day = :sunday )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        dt = dt.to_time.end_of_week( start_day = :sunday )
         self.set_value dt
         @engine.heap.it.set_to dt
       end
@@ -156,7 +180,10 @@ module Gloo
       # Set the value to the beginning of the day.
       #
       def msg_begin_day
-        dt = self.value.to_time.beginning_of_day
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        dt = dt.to_time.beginning_of_day
         self.set_value dt
         @engine.heap.it.set_to dt
       end
@@ -165,7 +192,10 @@ module Gloo
       # Set the value to the end of the day.
       # 
       def msg_end_day
-        dt = self.value.to_time.end_of_day
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        dt = dt.to_time.end_of_day
         self.set_value dt
         @engine.heap.it.set_to dt
       end
@@ -175,7 +205,10 @@ module Gloo
       # Tell the datetime to check if it is today.
       #
       def msg_is_today
-        today = DtTools.is_today?( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        today = DtTools.is_today?( dt )
         @engine.heap.it.set_to today
         return today
       end
@@ -184,7 +217,10 @@ module Gloo
       # Tell the datetime to check if it is in the future.
       #
       def msg_is_future
-        today = DtTools.is_future?( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        today = DtTools.is_future?( dt )
         @engine.heap.it.set_to today
         return today
       end
@@ -193,7 +229,10 @@ module Gloo
       # Tell the datetime to check if it is in the past.
       #
       def msg_is_past
-        today = DtTools.is_past?( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        today = DtTools.is_past?( dt )
         @engine.heap.it.set_to today
         return today
       end
@@ -202,7 +241,10 @@ module Gloo
       # Tell the datetime to check if it is yesterday.
       #
       def msg_is_yesterday
-        today = DtTools.is_yesterday?( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        today = DtTools.is_yesterday?( dt )
         @engine.heap.it.set_to today
         return today
       end
@@ -211,7 +253,10 @@ module Gloo
       # Tell the datetime to check if it is tomorrow.
       #
       def msg_is_tomorrow
-        today = DtTools.is_tomorrow?( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        today = DtTools.is_tomorrow?( dt )
         @engine.heap.it.set_to today
         return today
       end
@@ -220,7 +265,10 @@ module Gloo
       # Tell the datetime to check if it is this week.
       #
       def msg_is_this_week
-        today = DtTools.is_this_week?( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
+        today = DtTools.is_this_week?( dt )
         @engine.heap.it.set_to today
         return today
       end
@@ -245,7 +293,9 @@ module Gloo
           data = expr.evaluate
           format = data
         end
-        dt = Chronic.parse( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
         @engine.heap.it.set_to dt.strftime( format )
       end
 
@@ -284,6 +334,7 @@ module Gloo
             'end_year — Set the datetime to the end of the year.',
             'format ({fmt}) — Format the date and time using a strftime-style format string. Default if none given: %Y-%m-%d %H:%M:%S. It will have the formatted string.'
           ],
+          :notes => 'A value that isn\'t a date and time is left with no value, with a warning. A clock time out of range (eg. \'25:99\') is used as a best guess, with a warning that shows the value used.',
           :examples => <<~EXAMPLES.strip
             #
             # Show the current date and time.

data/lib/gloo/objs/dt/dt_tools.rb

@@ -22,6 +22,50 @@ class DtTools
   end
 
 
+  UNITS = %w[second minute hour day week fortnight month year].freeze
+
+  #
+  # Get a date/time object's value as a Time, for a message to work
+  # with. If it isn't a date or time (Chronic can't read it), report
+  # that, put false into it, and return nil.
+  #
+  def self.parse_value( engine, value, kind )
+    unless value.blank?
+      dt = is_dt_type?( value ) ? value : Chronic.parse( value.to_s )
+      return dt if dt
+    end
+
+    msg = value.blank? ? "There is no #{kind} to work with!" : "'#{value}' is not a #{kind}."
+    engine.err msg
+    engine.heap.it.set_to false
+    return nil
+  end
+
+  #
+  # Get the amount for add or sub, in the form "1 day" or "3 months".
+  # No amount is 1 of the default unit. A number with no unit is that
+  # many of the default unit (a best guess, with a warning). Anything
+  # else that isn't a number and a unit is reported; put false into it
+  # and return nil.
+  #
+  def self.amount( engine, data, default_unit = 'day' )
+    return "1 #{default_unit}" if data.nil?
+
+    text = data.to_s.strip
+    if text.match?( /\A-?\d+\z/ )
+      unit = text == '1' ? default_unit : "#{default_unit}s"
+      engine.warn "'#{text}' has no unit; using #{text} #{unit}."
+      return "#{text} #{default_unit}"
+    end
+
+    count, unit = text.split( ' ' )
+    return text if count&.match?( /\A-?\d+\z/ ) && UNITS.include?( unit.to_s.downcase.chomp( 's' ) )
+
+    engine.err "'#{text}' is not an amount like '1 day' or '3 months'."
+    engine.heap.it.set_to false
+    return nil
+  end
+
   # ---------------------------------------------------------------------
   #    Date Math
   # ---------------------------------------------------------------------
@@ -35,7 +79,7 @@ class DtTools
     amount, unit = modifier.split(' ')  
 
     # converts "1 day" to 1.day
-    duration = amount.to_i.send( unit )
+    duration = amount.to_i.send( unit.downcase )
     return date + duration
   end
 
@@ -48,7 +92,7 @@ class DtTools
     amount, unit = modifier.split(' ')  
 
     # converts "1 day" to 1.day
-    duration = amount.to_i.send( unit )  
+    duration = amount.to_i.send( unit.downcase )
     return dt - duration
   end
 

data/lib/gloo/objs/dt/time.rb

@@ -73,14 +73,17 @@ module Gloo
       # Add the given modifier to the time.
       #
       def msg_add
-        modifier = "1 hour"
+        data = nil
         if @params&.token_count&.positive?
           expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
           data = expr.evaluate
-          modifier = data
         end
+        modifier = DtTools.amount( @engine, data, 'hour' )
+        return false unless modifier
         
-        dt = Chronic.parse( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
         new_value = DtTools.add( dt, modifier )
         self.set_value( new_value )
         @engine.heap.it.set_to self.value
@@ -90,14 +93,17 @@ module Gloo
       # Subtract the given modifier from the time.
       #
       def msg_sub
-        modifier = "1 hour"
+        data = nil
         if @params&.token_count&.positive?
           expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
           data = expr.evaluate
-          modifier = data
         end
+        modifier = DtTools.amount( @engine, data, 'hour' )
+        return false unless modifier
+
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
 
-        dt = Chronic.parse( self.value )
         self.set_value( DtTools.sub( dt, modifier ) )
         @engine.heap.it.set_to self.value
       end
@@ -106,7 +112,9 @@ module Gloo
       # Get the hour.
       #
       def msg_hh
-        dt = Chronic.parse( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
         @engine.heap.it.set_to "#{dt.hour}".rjust(2, '0')
       end
 
@@ -114,7 +122,9 @@ module Gloo
       # Get the minute.
       #
       def msg_mm
-        dt = Chronic.parse( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
         @engine.heap.it.set_to "#{dt.min}".rjust(2, '0')
       end
 
@@ -122,7 +132,9 @@ module Gloo
       # Get the second.
       #
       def msg_ss
-        dt = Chronic.parse( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
         @engine.heap.it.set_to "#{dt.sec}".rjust(2, '0')
       end
 
@@ -130,7 +142,9 @@ module Gloo
       # Get the AM/PM.
       #
       def msg_am
-        dt = Chronic.parse( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
         @engine.heap.it.set_to dt.strftime( '%p' )
       end
 
@@ -146,7 +160,9 @@ module Gloo
           data = expr.evaluate
           format = data
         end
-        dt = Chronic.parse( self.value )
+        dt = DtTools.parse_value( @engine, self.value, self.class.typename )
+        return false unless dt
+
         @engine.heap.it.set_to dt.strftime( format )
       end
 
@@ -175,6 +191,7 @@ module Gloo
             'am — Get the am/pm portion of the time. Put "am" or "pm" into it.',
             'format ({fmt}) — Format the time using a strftime-style format string. Default if none given: %H:%M:%S. It will have the formatted string.'
           ],
+          :notes => 'A value that isn\'t a time is left with no value, with a warning. A clock time out of range (eg. \'25:99\') is used as a best guess, with a warning that shows the time used.',
           :examples => <<~EXAMPLES.strip
             #
             # Show the current time.

data/lib/gloo/objs/str_utils/cipher.rb

@@ -14,6 +14,10 @@ module Gloo
       KEYWORD_SHORT = 'crypt'.freeze
 
       CIPHER_TYPE = 'AES-256-CBC'.freeze
+
+      # A key or vector of the wrong size, or data encrypted with a
+      # different key.
+      CIPHER_ERRORS = [ ArgumentError, OpenSSL::Cipher::CipherError ].freeze
       KEY = 'key'.freeze
       INIT_VECTOR = 'init_vector'.freeze
       DATA = 'data'.freeze
@@ -81,6 +85,7 @@ module Gloo
       # Update the data value of the object.
       #
       def update_data( new_val )
+        @engine.heap.it.set_to new_val
         o = find_child_resolve_alias DATA
         return unless o
 
@@ -143,14 +148,22 @@ module Gloo
       # Decrypt the encrypted child object.
       #
       def msg_decrypt
-        update_data Cipher.decrypt( data, key, init_vector )
+        result = nil
+        return false unless attempt( "decrypt #{pn}", *CIPHER_ERRORS ) do
+          result = Cipher.decrypt( data, key, init_vector )
+        end
+        update_data result
       end
 
       #
       # Encrypt the decrypted child object.
       #
       def msg_encrypt
-        update_data Cipher.encrypt( data, key, init_vector )
+        result = nil
+        return false unless attempt( "encrypt #{pn}", *CIPHER_ERRORS ) do
+          result = Cipher.encrypt( data, key, init_vector )
+        end
+        update_data result
       end
 
       # ---------------------------------------------------------------------
@@ -204,8 +217,8 @@ module Gloo
           ],
           :messages => [
             'generate_keys — Generate an encryption key and initialization vector. The keys are base64 encoded.',
-            'encrypt — Encrypt the data.',
-            'decrypt — Decrypt the data.'
+            'encrypt — Encrypt the data. The data child is changed. It will have the encrypted data.',
+            'decrypt — Decrypt the data. The data child is changed. It will have the decrypted data.'
           ],
           :examples => <<~EXAMPLES.strip
             #

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

@@ -79,6 +79,7 @@ module Gloo
       # Update the hashed password value.
       #
       def update_hash( new_hash )
+        @engine.heap.it.set_to new_hash
         o = find_child_resolve_alias HASH
         return unless o
 
@@ -154,7 +155,10 @@ module Gloo
       # Uses the salt and the hash to check the password.
       #
       def msg_check
-        hashed_pwd = BCrypt::Password.new( hash )
+        hashed_pwd = nil
+        return false unless attempt( "check the password against the hash in #{pn}", BCrypt::Errors::InvalidHash ) do
+          hashed_pwd = BCrypt::Password.new( hash )
+        end
         result = ( hashed_pwd == salt_pwd )
         @engine.heap.it.set_to result
       end
@@ -178,7 +182,7 @@ module Gloo
           ],
           :messages => [
             'generate ({len}) — Generate a new password, put in the password child object. The {len} parameter is optional; the length is 7 if not specified.',
-            'hash — Hash the password in the child object. Put it in the hash child object.',
+            'hash — Hash the password in the child object. Put it in the hash child object. It will have the hash.',
             'check — Check the password in the child object. Is it the same as the hash?'
           ],
           :examples => <<~EXAMPLES.strip

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

@@ -42,6 +42,7 @@ module Gloo
       # Set the result of the ERB template conversion.
       #
       def set_result( data )
+        @engine.heap.it.set_to data
         r = find_child_resolve_alias RESULT
         return unless r
 
@@ -106,8 +107,13 @@ module Gloo
         tmpl = template_value
         return unless tmpl
 
-        render = ERB.new( tmpl )
-        set_result render.result_with_hash( param_hash )
+        # The template is Ruby code the script wrote, so anything it
+        # raises (including a syntax error) is the script's problem.
+        result = nil
+        return false unless attempt( "render the template in #{pn}", StandardError, ScriptError ) do
+          result = ERB.new( tmpl ).result_with_hash( param_hash )
+        end
+        set_result result
       end
 
       # ---------------------------------------------------------------------
@@ -130,7 +136,7 @@ module Gloo
             'result (text) — The result of the template rendering.'
           ],
           :messages => [
-            'run — Render the result based on the template and the parameter values.'
+            'run — Render the result based on the template and the parameter values. It will have the rendered result.'
           ],
           :examples => <<~EXAMPLES.strip
             e [can] :

data/lib/gloo/objs/system/file_handle.rb

@@ -12,7 +12,6 @@ module Gloo
       KEYWORD_SHORT = 'dir'.freeze
 
       FILE_NAME_ERR = 'file and path name expected'.freeze
-      FILE_MISSING_ERR = 'file not found'.freeze
 
 
       #
@@ -59,7 +58,7 @@ module Gloo
       # Show the contents of the file, paginated.
       #
       def msg_page
-        return unless value && File.file?( value )
+        return unless check_is_file?
 
         system "less #{value}"
       end
@@ -68,25 +67,32 @@ module Gloo
       # Show the contents of the file.
       #
       def msg_show
-        return unless value && File.file?( value )
+        return unless check_is_file?
 
-        puts File.read( value )
+        data = file_op( 'read' ) { File.read( value ) }
+        puts data if data
       end
 
       #
       # Read the contents of the file into the object.
       #
       def msg_read
-        return unless check_file_exists?
+        return @engine.heap.it.set_to( false ) unless check_file_exists?
+
+        data = file_op( 'read' ) { File.read( value ) }
+        return @engine.heap.it.set_to( false ) unless data
 
-        data = File.read( value )
         if @params&.token_count&.positive?
           pn = Gloo::Core::Pn.new( @engine, @params.first )
           o = pn.resolve
+          unless o
+            @engine.err Gloo::Core::NotFound.object( @params.first )
+            return @engine.heap.it.set_to( false )
+          end
+
           o.set_value data
-        else
-          @engine.heap.it.set_to data
         end
+        @engine.heap.it.set_to data
       end
 
       #
@@ -101,9 +107,11 @@ module Gloo
           expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
           data = expr.evaluate
         end
-        existing = File.exist?( value ) ? File.read( value ) : ''
-        prefix = existing.empty? || existing.end_with?( "\n" ) ? '' : "\n"
-        File.open( value, 'a' ) { |f| f.puts "#{prefix}#{data}" }
+        file_op( 'append to' ) do
+          existing = File.exist?( value ) ? File.read( value ) : ''
+          prefix = existing.empty? || existing.end_with?( "\n" ) ? '' : "\n"
+          File.open( value, 'a' ) { |f| f.puts "#{prefix}#{data}" }
+        end
       end
 
       #
@@ -117,7 +125,7 @@ module Gloo
           expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
           data = expr.evaluate
         end
-        File.write( value, data )
+        file_op( 'write' ) { File.write( value, data ) }
       end
 
       #
@@ -125,7 +133,8 @@ module Gloo
       #
       def msg_delete
         return unless value
-        File.delete( value )
+
+        file_op( 'delete' ) { File.delete( value ) }
       end
 
       #
@@ -156,7 +165,7 @@ module Gloo
       # Create a directory.
       #
       def msg_mkdir
-        FileUtils.mkdir_p(value) unless Dir.exist?(value)
+        file_op( 'make folder' ) { FileUtils.mkdir_p( value ) } unless Dir.exist?( value )
       end
 
       #
@@ -205,10 +214,10 @@ module Gloo
       # Get the SHA256 hash of the file contents.
       #
       def msg_get_sha256
-        return unless check_file_exists?
+        return @engine.heap.it.set_to( false ) unless check_file_exists?
 
-        file_hash = FileHandle.hash_for_file( value )
-        @engine.heap.it.set_to file_hash
+        file_hash = file_op( 'read' ) { FileHandle.hash_for_file( value ) }
+        @engine.heap.it.set_to( file_hash || false )
       end
 
       # 
@@ -221,18 +230,45 @@ module Gloo
         return file_hash
       end
 
+      #
+      # Run a file system operation. A failure the file system reports
+      # (no such file, a folder where a file was expected, no permission,
+      # ...) is a runtime error, and the result is nil.
+      #
+      def file_op( action )
+        return yield
+      rescue Errno::ENOENT
+        @engine.err Gloo::Core::NotFound.file( value )
+        return nil
+      rescue SystemCallError => e
+        @engine.err "Could not #{action} '#{value}': #{e.message}"
+        return nil
+      end
+
+      #
+      # Check that the file exists and is a file, not a folder.
+      # Report an error if not.
+      #
+      def check_is_file?
+        return false unless check_file_exists?
+        return true if File.file?( value )
+
+        @engine.err "'#{value}' is a folder, not a file."
+        return false
+      end
+
       #
       # Check to see if the file exists.
-      # Show error if not.
+      # Report an error if not.
       #
       def check_file_exists?
         if value.blank?
-          @engine.log.error FILE_NAME_ERR
+          @engine.err FILE_NAME_ERR
           return false
         end
 
         unless File.exist?( value )
-          @engine.log.error FILE_MISSING_ERR
+          @engine.err Gloo::Core::NotFound.file( value )
           return false
         end
 
@@ -254,7 +290,7 @@ module Gloo
             'on disk. The string value of the file object is the path ' \
             'and name of the file.',
           :messages => [
-            'read ({into.obj}) — Read the file and put the data in the specified object. If {into.obj} is not specified, the data will be in it.',
+            'read ({into.obj}) — Read the file and put the data in the specified object. If {into.obj} is not specified, the data will be in it. If {into.obj} does not exist, that is an error.',
             'write ({from.obj}) — Write the data in {from.obj} into the file.',
             'append ({data}) — Append the given data to the file as a new line. Adds a leading newline first if the file doesn\'t already end with one.',
             'delete — Delete the file.',