gloo 7.0.4 → 7.1.1

data/lib/gloo/app/settings.rb

@@ -5,6 +5,7 @@
 #
 
 require 'yaml'
+require 'fileutils'
 
 module Gloo
   module App
@@ -137,9 +138,6 @@ module Gloo
         @ext_path = File.join( @user_root, 'extensions' )
         Dir.mkdir( @ext_path ) unless File.exist?( @ext_path )
 
-        @tmp_path = File.join( @user_root, 'tmp' )
-        Dir.mkdir( @tmp_path ) unless File.exist?( @tmp_path )
-
         @debug_path = File.join( @user_root, 'debug' )
         Dir.mkdir( @debug_path ) unless File.exist?( @debug_path )
       end
@@ -156,6 +154,8 @@ module Gloo
           @project_path = File.join( @user_root, 'projects' )
         end
 
+        init_tmp_path( settings[ 'gloo' ][ 'tmp_path' ] )
+
         @start_with = settings[ 'gloo' ][ 'start_with' ]
         @list_indent = settings[ 'gloo' ][ 'list_indent' ]
         @list_levels = settings[ 'gloo' ][ 'list_levels' ]
@@ -167,6 +167,16 @@ module Gloo
         @theme = DEFAULT_THEME unless THEMES.include?( @theme )
       end
 
+      #
+      # Set the tmp folder: the tmp_path setting if there is one (a
+      # leading ~ is expanded), or tmp under the user root. Created
+      # if it isn't there yet.
+      #
+      def init_tmp_path( path )
+        @tmp_path = path.blank? ? File.join( @user_root, 'tmp' ) : File.expand_path( path.to_s )
+        FileUtils.mkdir_p( @tmp_path ) unless File.exist?( @tmp_path )
+      end
+
       #
       # Get the app's required directories.
       #
@@ -188,6 +198,7 @@ module Gloo
       #
       def get_default_settings
         projects = File.join( @user_root, 'projects' )
+        tmp = File.join( @user_root, 'tmp' )
         str = <<~TEXT
           #
           # Gloo configuration
@@ -200,6 +211,12 @@ module Gloo
             #
             project_path: #{projects}
 
+            #
+            # Folder for temporary files, such as scratch files written by
+            # tests. Scripts get it with $.gloo_tmp.
+            #
+            tmp_path: #{tmp}
+
             #
             # Run this script when starting up gloo.
             # (Only if a script file is not specified.)

data/lib/gloo/core/gloo_system.rb

@@ -179,6 +179,11 @@ module Gloo
         return @engine.settings.project_path
       end
 
+      # Get the Gloo tmp directory
+      def msg_gloo_tmp
+        return @engine.settings.tmp_path
+      end
+
       # The running app directory.
       def msg_app
         return @engine.settings.project_path
@@ -314,6 +319,8 @@ module Gloo
             'gloo_config — Get the gloo configuration directory.',
             'gloo_projects — Get the gloo projects directory.',
             'gloo_log — Get the gloo logging directory.',
+            'gloo_tmp — Get the gloo tmp directory, for temporary files ' \
+              '(the tmp_path setting in gloo.yml).',
             'screen_lines — Get the number of lines on screen.',
             'screen_cols — Get the number of columns on screen.',
             'platform_cpu — Get the platform CPU.',

data/lib/gloo/core/invoker.rb

@@ -18,26 +18,39 @@ module Gloo
       #
       # Resolve, validate and invoke the function at the given
       # target path, with the given raw (unevaluated) arg tokens.
-      # Reports an error and returns nil for any failure - including
-      # a failure inside the function itself (see Function#invoke,
-      # which leaves `it` alone rather than setting it to an
-      # unreliable result when that happens).
+      # For any failure, reports an error, puts false in `it` and
+      # returns nil - before the call (see failed), or inside the
+      # function itself (see Function#invoke).
       #
       def self.invoke( engine, target, arg_tokens )
         if target.nil? || target.to_s.strip.empty?
           engine.syntax_err NO_TARGET_ERR
-          return nil
+          return failed( engine )
         end
 
         func = resolve_function( engine, target )
-        return nil unless func
+        return failed( engine ) unless func
 
+        # An arg that couldn't be worked out was already reported, but
+        # the function's own error tracking would clear it if the call
+        # went ahead.
+        errors_before = engine.heap.error.error_count
         args = evaluate_arg_tokens( engine, arg_tokens )
-        return nil unless params_count_ok?( engine, func, args )
+        return failed( engine ) if engine.heap.error.error_count > errors_before
+        return failed( engine ) unless params_count_ok?( engine, func, args )
 
         return invoke_function( engine, func, args )
       end
 
+      #
+      # The function couldn't be called (the problem was already
+      # reported): put false in `it`, and return nil.
+      #
+      def self.failed( engine )
+        engine.heap.it.set_to false
+        return nil
+      end
+
       #
       # Resolve the function object at the target path. Reports an
       # error and returns nil if the path doesn't resolve to

data/lib/gloo/core/obj.rb

@@ -338,7 +338,7 @@ module Gloo
       # Get a list of message names that this object receives.
       #
       def self.messages
-        return %w[save reload unload blank? contains? responds_to? doc]
+        return %w[save reload unload blank? contains? responds_to? doc source_file source_dir]
       end
 
       #
@@ -492,6 +492,27 @@ module Gloo
         return self.doc
       end
 
+      #
+      # The path of the file this object was loaded from, into 'it';
+      # blank if it didn't come from a file.
+      #
+      def msg_source_file
+        path = @engine.persist_man.source_file_of( self ).to_s
+        @engine.heap.it.set_to path
+        return path
+      end
+
+      #
+      # The folder of the file this object was loaded from, with no
+      # trailing slash, into 'it'; blank if it didn't come from a file.
+      #
+      def msg_source_dir
+        path = @engine.persist_man.source_file_of( self )
+        dir = path ? File.dirname( path ) : ''
+        @engine.heap.it.set_to dir
+        return dir
+      end
+
 
       # ---------------------------------------------------------------------
       #    Render

data/lib/gloo/core/tokens.rb

@@ -176,6 +176,17 @@ module Gloo
         return nil
       end
 
+      #
+      # A copy of these tokens with one more token added at the end,
+      # taken as is (not split on spaces or quotes). The original is
+      # left alone.
+      #
+      def with_token( token )
+        copy = dup
+        copy.append_token token
+        return copy
+      end
+
       #
       # Get the item after a given token.
       #
@@ -186,6 +197,15 @@ module Gloo
         return nil
       end
 
+      protected
+
+      #
+      # Add a token at the end, in a new list (see with_token).
+      #
+      def append_token( token )
+        @tokens += [ token ]
+      end
+
       # ---------------------------------------------------------------------
       #    Private functions
       # ---------------------------------------------------------------------

data/lib/gloo/core/verb.rb

@@ -83,6 +83,37 @@ module Gloo
         return true
       end
 
+      #
+      # For a verb whose arguments are literal text (a file name, a
+      # path, a name): a trailing ( expr ) is worked out and its value
+      # added as the last argument, so the text can be computed, as in
+      # load ( $.gloo_tmp '/x.gloo' ). The parser has already split the
+      # parenthetical off into params. Returns false if the expression
+      # couldn't be worked out (already reported), true otherwise.
+      #
+      def take_evaluated_arg
+        return true unless @params
+
+        value, ok = evaluate_expr( @params.tokens )
+        return false unless ok
+
+        @tokens = @tokens.with_token( value.to_s )
+        @params = nil
+        return true
+      end
+
+      #
+      # Work out an expression from the given tokens. Returns the value
+      # and whether it worked: false if the expression reported a
+      # problem (already reported), in which case the value is whatever
+      # it had worked out so far.
+      #
+      def evaluate_expr( tokens )
+        errors_before = @engine.heap.error.error_count
+        value = Gloo::Expr::Expression.new( @engine, tokens ).evaluate
+        return value, @engine.heap.error.error_count == errors_before
+      end
+
       #
       # Run the verb.
       #

data/lib/gloo/exec/exec_env.rb

@@ -35,13 +35,16 @@ module Gloo
       end
 
       #
-      # Where the line now running is, for error messages: the running
-      # script and its line, or the file and line being loaded.
+      # Where the line now running is, for error messages: the file and
+      # line being loaded, or the running script and its line. While a
+      # file is being read, a problem is in that file, even when a
+      # script started the load.
       #
       def current_location
+        return @load_location if @load_location
         return @running_script.location if @running_script
 
-        return @load_location
+        return nil
       end
 
       #

data/lib/gloo/exec/script.rb

@@ -65,6 +65,13 @@ module Gloo
         @break_out = true
       end
 
+      #
+      # Did a break end this script's run?
+      #
+      def broke_out?
+        return @break_out
+      end
+
     end
   end
 end

data/lib/gloo/objs/basic/script.rb

@@ -115,6 +115,15 @@ module Gloo
       def msg_run
         s = Gloo::Exec::Script.new( @engine, self )
         s.run
+        @broke_out = s.broke_out?
+      end
+
+      #
+      # Did a break end this script's last run? A loop uses this to
+      # stop when its do script breaks.
+      #
+      def broke_out?
+        return @broke_out == true
       end
 
       # ---------------------------------------------------------------------

data/lib/gloo/objs/basic/string_msgs.rb

@@ -57,7 +57,7 @@ module Gloo
           'split ({from} {to}) — Get the substring from index {from} up to (not including) index {to}. Indexes are 0-based; out-of-range indexes are clamped to the start or end of the string. Both parameters are required. Does not change the value of the string. It will have the substring.',
           'splitl ({index}) — Get the substring to the left of index {index} (same as split (0, {index})). A parameter is required. Does not change the value of the string. It will have the substring.',
           'splitr ({index}) — Get the substring from index {index} to the end of the string (same as split ({index}, size)). A parameter is required. Does not change the value of the string. It will have the substring.',
-          'split_list ({delim} {dst.path}) — Split the string by {delim} and put the parts into children of the container at {dst.path} (or an alias that points to one), one part per child, in order. Existing children are matched by position and have their values set; extra parts get new (untyped) children, numbered from 1; extra existing children are left alone. Both parameters are required. Does not change the value of the string. It will have the number of parts.',
+          'split_list ({delim} {dst.path}) — Split the string by {delim} and put the parts into children of the container at {dst.path} (or an alias that points to one), one part per child, in order. Existing children are matched by position and have their values set; extra parts get new (untyped) children, numbered from 1; extra existing children are left alone. Both parameters are required. Does not change the value of the string. It will be true (also when the string is empty), or false if a parameter or the target is bad.',
           'word_wrap ({width}) — Word-wrap the string to {width} columns, breaking on whitespace (never mid-word; an overlong word is left on its own line rather than broken). The {width} parameter is optional; it defaults to the terminal\'s current width. This message changes the value of the string. It will have the wrapped string.',
           'page — Show the value in a pager (less), for viewing long content a screen at a time.'
         ]
@@ -239,11 +239,12 @@ module Gloo
       # have their values set; if there are more parts than children,
       # new (untyped) children are created for the extras, numbered
       # from 1. Existing children beyond the part count are left alone.
-      # The string's own value is unchanged; the number of parts is put
-      # into 'it'.
+      # The string's own value is unchanged. 'it' is true once the parts
+      # are in place (also when there's nothing to split), or false if
+      # the parameters or the target are bad.
       #
       def msg_split_list
-        return @engine.heap.it.set_to( 0 ) unless value
+        return @engine.heap.it.set_to( true ) unless value
 
         if @params&.token_count.to_i < 2
           @engine.syntax_err MISSING_PARAM_MSG
@@ -265,9 +266,7 @@ module Gloo
           child.set_value part
         end
 
-        count = parts.count
-        @engine.heap.it.set_to count
-        return count
+        return @engine.heap.it.set_to( true )
       end
 
       #

data/lib/gloo/objs/basic/untyped.rb

@@ -50,7 +50,8 @@ module Gloo
           :description => 'An object with no type. A type declares ' \
             'which messages an object can receive; an untyped object ' \
             'receives only the base object messages (blank?, ' \
-            'contains?, responds_to?, reload, unload) but can hold a ' \
+            'contains?, responds_to?, doc, source_dir, source_file, ' \
+            'reload, unload) but can hold a ' \
             'value of any kind. If no type is specified when an object ' \
             'is created, it is untyped. Prefer untyped when you only ' \
             'need to hold, compare, or show a value and do not need ' \

data/lib/gloo/objs/ctrl/each.rb

@@ -43,13 +43,15 @@ module Gloo
       end
 
       #
-      # Run the do script once.
+      # Run the do script once. Returns true if a break in it ended the
+      # run, so the loop should stop.
       #
       def run_do
         o = find_child DO
-        return unless o
+        return false unless o
 
         Gloo::Exec::Dispatch.message( @engine, 'run', o )
+        return o.respond_to?( :broke_out? ) && o.broke_out?
       end
 
 

data/lib/gloo/objs/ctrl/each_child.rb

@@ -130,7 +130,7 @@ module Gloo
           end
 
           set_child child
-          @iterator_obj.run_do
+          break if @iterator_obj.run_do
         end
 
         if group_mode && !first_time

data/lib/gloo/objs/ctrl/each_dir.rb

@@ -58,7 +58,7 @@ module Gloo
           next unless File.directory?( f )
 
           set_dir f
-          @iterator_obj.run_do
+          break if @iterator_obj.run_do
         end
       end
 

data/lib/gloo/objs/ctrl/each_file.rb

@@ -60,7 +60,7 @@ module Gloo
           next unless include?( f )
 
           set_file f
-          @iterator_obj.run_do
+          break if @iterator_obj.run_do
         end
       end
 

data/lib/gloo/objs/ctrl/each_line.rb

@@ -48,7 +48,7 @@ module Gloo
 
         str.each_line do |line|
           set_line line
-          @iterator_obj.run_do
+          break if @iterator_obj.run_do
         end
       end
 

data/lib/gloo/objs/ctrl/each_word.rb

@@ -48,7 +48,7 @@ module Gloo
 
         str.split( ' ' ).each do |word|
           set_word word
-          @iterator_obj.run_do
+          break if @iterator_obj.run_do
         end
       end
 

data/lib/gloo/objs/ctrl/repeat.rb

@@ -37,13 +37,15 @@ module Gloo
       end
 
       #
-      # Run the do script once.
+      # Run the do script once. Returns true if a break in it ended the
+      # run, so the loop should stop.
       #
       def run_do
         o = find_child DO
-        return unless o
+        return false unless o
 
         Gloo::Exec::Dispatch.message( @engine, 'run', o )
+        return o.respond_to?( :broke_out? ) && o.broke_out?
       end
 
       #
@@ -98,7 +100,7 @@ module Gloo
       def msg_run
         times.times do |index|
           set_index index
-          run_do
+          break if run_do
         end
       end
 

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

@@ -209,7 +209,8 @@ module Gloo
         {
           :name => KEYWORD,
           :shortcut => KEYWORD_SHORT,
-          :description => 'Tool to encrypt and decrypt data.',
+          :description => 'Tool to encrypt and decrypt data, with ' \
+            'AES-256-CBC.',
           :children => [
             'key (string) — The encryption key. Base64 encoded.',
             'init_vector (string) — The initialization vector. Base64 encoded.',
@@ -218,8 +219,15 @@ module Gloo
           :messages => [
             'generate_keys — Generate an encryption key and initialization vector. The keys are base64 encoded.',
             '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.'
+            'decrypt — Decrypt the data. The data child is changed. It will have the decrypted data. With the wrong key or init_vector, decrypt usually reports an error and it is false; but not always (see notes).'
           ],
+          :notes => 'AES-CBC can\'t always tell that a key is wrong. A ' \
+            'wrong key usually leaves the decrypted data with padding ' \
+            'that doesn\'t check out, which is reported as an error. But ' \
+            'about 1 time in 256 the padding happens to look right: then ' \
+            'decrypt reports nothing, and the data is garbage rather than ' \
+            'the original. To be sure the key is right, keep a value you ' \
+            'can check, such as encrypting a known word alongside the data.',
           :examples => <<~EXAMPLES.strip
             #
             # Encrypt and Decrypt a string.

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

@@ -74,7 +74,9 @@ module Gloo
       end
 
       #
-      # Read the contents of the file into the object.
+      # Read the contents of the file. With a destination, the contents
+      # go into it and 'it' is true; with none, the contents go in 'it'.
+      # 'it' is false if the file can't be read.
       #
       def msg_read
         return @engine.heap.it.set_to( false ) unless check_file_exists?
@@ -91,6 +93,7 @@ module Gloo
           end
 
           o.set_value data
+          return @engine.heap.it.set_to( true )
         end
         @engine.heap.it.set_to data
       end
@@ -290,7 +293,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. If {into.obj} does not exist, that is an error.',
+            'read ({into.obj}) — Read the file and put the data in the specified object; it will be true. If {into.obj} is not specified, the data will be in it. If {into.obj} does not exist, or the file can\'t be read, that is an error and it will be false.',
             '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.',

data/lib/gloo/objs/web/json.rb

@@ -131,26 +131,28 @@ module Gloo
       #
       # Parse the JSON data and put it in objects.
       # The additional parameter is the path to the destination
-      # for the parsed objects.
+      # for the parsed objects. 'it' is true once they're built, or
+      # false if the destination or the JSON is bad.
       #
       def msg_parse
         if @params&.token_count&.positive?
           pn = Gloo::Core::Pn.new( @engine, @params.tokens.first )
           unless pn&.exists?
             @engine.err Gloo::Core::NotFound.object( @params.tokens.first )
-            return
+            return @engine.heap.it.set_to( false )
           end
         else
           @engine.syntax_err 'Destination path for parsed objects is required'
-          return
+          return @engine.heap.it.set_to( false )
         end
         parent = pn.resolve
 
         json = nil
-        return unless attempt( "parse the JSON in #{self.pn}", JSON::ParserError, set_it: false ) do
+        return false unless attempt( "parse the JSON in #{self.pn}", JSON::ParserError ) do
           json = JSON.parse( self.value )
         end
         self.handle_json_to_obj( json, parent )
+        return @engine.heap.it.set_to( true )
       end
 
       # ---------------------------------------------------------------------
@@ -240,7 +242,7 @@ module Gloo
           :messages => [
             'get ({path}) — Get a value from the JSON data. Example: tell myjson to get (\'title\'). The parameter is the path in JSON to the value we want. The value is put into it.',
             'set ({obj.path}) — Convert an object to an approximate JSON value. Example: tell myjson to set (my.object). The parameter is the path to the object used as the source. Note this is an approximate conversion — a gloo object can have both a simple value and be a container for child objects, which JSON can\'t represent the same way.',
-            'parse ({dst.path}) — Parse the JSON data and put values in the object specified by the parameter. Example: tell myjson to parse (path.to.dst).',
+            'parse ({dst.path}) — Parse the JSON data and put values in the object specified by the parameter; it will be true. If the destination is missing or the JSON is bad, that is an error and it will be false. Example: tell myjson to parse (path.to.dst).',
             'pretty — Make the JSON format pretty. The value of the json is changed. It will have the pretty JSON.'
           ],
           :examples => <<~EXAMPLES.strip

data/lib/gloo/persist/declaration_ledger.rb

@@ -14,11 +14,10 @@ module Gloo
       attr_reader :roots
 
       #
-      # Set up a ledger for the file at pn.
+      # Set up a ledger for one file's load.
       #
-      def initialize( engine, pn )
+      def initialize( engine )
         @engine = engine
-        @pn = pn
         @roots = []
         @mine = {}.compare_by_identity
       end
@@ -43,15 +42,16 @@ module Gloo
       # `value`. If another file created it and the values differ, the
       # new value is being ignored -- warn so it isn't a surprise. A
       # duplicate name inside one file is left alone (a documented
-      # "first one wins").
+      # "first one wins"). The warning's location (this file and line)
+      # comes from the load.
       #
       def clash( prior, name, value )
         return if @mine.key?( prior )
         return if value.nil? || value.to_s.strip.empty?
         return if prior.value.to_s == value.to_s
 
-        @engine.log.warn(
-          "#{@pn}: '#{name}' is already declared in another loaded file with a " \
+        @engine.warn(
+          "'#{name}' is already declared in another loaded file with a " \
           "different value (#{prior.value.inspect} kept, #{value.inspect} ignored)."
         )
       end

data/lib/gloo/persist/file_loader.rb

@@ -48,11 +48,12 @@ module Gloo
         @mech = @engine.platform.get_file_mech( @engine )
         @pn = pn
         @obj = nil
+        @found = false
         @source_doc = Gloo::Persist::Source::SourceDoc.new
         @trivia = Gloo::Persist::TriviaBuffer.new
         @body = Gloo::Persist::ScriptBodyCollector.new
         @shorthand = Gloo::Persist::ShorthandExpander.new( engine )
-        @ledger = Gloo::Persist::DeclarationLedger.new( engine, pn )
+        @ledger = Gloo::Persist::DeclarationLedger.new( engine )
         @in_block = false
         @block_value = ''
         @body_started = false
@@ -66,6 +67,14 @@ module Gloo
         return @ledger.roots
       end
 
+      #
+      # Was the file there to read? False before load, or when the
+      # file couldn't be found (already reported as an error).
+      #
+      def found?
+        return @found
+      end
+
       #
       # Load the objects from the file.
       #
@@ -74,6 +83,7 @@ module Gloo
           @engine.err Gloo::Core::NotFound.file( @pn )
           return
         end
+        @found = true
 
         @engine.log.debug "Loading file '#{@pn}'"
         @indent_stack = IndentStack.new( @engine.heap.root, @source_doc )

data/lib/gloo/persist/file_storage.rb

@@ -8,6 +8,8 @@ module Gloo
   module Persist
     class FileStorage
 
+      NO_OBJECTS_WARNING = 'No objects in file; nothing loaded from '.freeze
+
       attr_reader :obj, :pn, :roots, :source_doc
 
       #
@@ -50,6 +52,10 @@ module Gloo
 
       #
       # Load the object from the file.
+      # A file that has no objects (empty, comments only, or only
+      # 'load lib' lines) isn't an error, so it's reported as a
+      # warning. A file that couldn't be found was already reported
+      # by the loader.
       #
       def load
         fl = FileLoader.new( @engine, @pn )
@@ -59,8 +65,8 @@ module Gloo
         @source_doc = fl.source_doc
         if @obj
           @engine.log.debug "Loaded object: #{@obj.name}"
-        else
-          @engine.err "Error loading file at #{@pn}"
+        elsif fl.found?
+          @engine.warn "#{NO_OBJECTS_WARNING}#{@pn}"
         end
       end