gloo 6.7.2 → 7.0

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

@@ -10,6 +10,8 @@ module Gloo
   module Objs
     module StringMsgs
 
+      MISSING_PARAM_MSG = 'Missing parameter!'.freeze
+
       #
       # Get the list of message names this mixin implements, derived
       # from its own msg_* methods so String/Text don't have to
@@ -39,7 +41,8 @@ module Gloo
           'starts_with? ({str}) — Check if the string starts with the given string. A parameter is required: the string to look for at the beginning of this string. It will have a boolean.',
           'ends_with? ({str}) — Check if the string ends with the given string. A parameter is required: the string to look for at the end of this string. It will have a boolean.',
           'substring? ({str}) — Check if the string includes the given sub-string. A parameter is required: the string to look for in this string. It will have a boolean.',
-          'format_for_html — Format this string for HTML output. Tabs, spaces and returns are converted to HTML elements. The value of the string is changed.',
+          'index_of ({needle} {from}) — Find the 0-based position of the first occurrence of {needle} at or after position {from}. The {needle} parameter is required; {from} is optional and defaults to 0. Does not change the value of the string. It will have the position, or -1 if {needle} is not found; an out-of-range {from} (negative, or past the end of the string) is an error, and it will have false.',
+          'format_for_html — Format this string for HTML output. Tabs, spaces and returns are converted to HTML elements. The value of the string is changed. It will have the formatted string.',
           'encode64 — Base64 encode the string. This message changes the value of the string. It will have the encoded string.',
           'decode64 — Decode the string from Base64. This message changes the value of the string. It will have the decoded string.',
           'escape — Escape the string to make it URL safe. This message changes the value of the string. It will have the escaped string.',
@@ -65,7 +68,7 @@ module Gloo
       # Strip whitespace from the beginning and end of the string.
       #
       def msg_trim
-        return '' unless value
+        return @engine.heap.it.set_to( '' ) unless value
         
         result = value.strip
         @engine.heap.it.set_to result
@@ -86,7 +89,7 @@ module Gloo
           return result
         else
           # Error
-          @engine.log.error MISSING_PARAM_MSG
+          @engine.syntax_err MISSING_PARAM_MSG
           @engine.heap.it.set_to false
           return false
         end
@@ -105,7 +108,7 @@ module Gloo
           return result
         else
           # Error
-          @engine.log.error MISSING_PARAM_MSG
+          @engine.syntax_err MISSING_PARAM_MSG
           @engine.heap.it.set_to false
           return false
         end
@@ -115,7 +118,7 @@ module Gloo
       # Substitute the given string with another string.
       #
       def msg_sub
-        return '' unless value
+        return @engine.heap.it.set_to( '' ) unless value
         if @params&.token_count&.positive?
           expr = Gloo::Expr::Expression.new( @engine, [ @params.tokens.first ] )
           from = expr.evaluate
@@ -128,7 +131,7 @@ module Gloo
           return result
         else
           # Error
-          @engine.log.error MISSING_PARAM_MSG
+          @engine.syntax_err MISSING_PARAM_MSG
           @engine.heap.it.set_to false
           return false
         end
@@ -139,7 +142,7 @@ module Gloo
       # Find all occurrences and replace them.
       #
       def msg_gsub
-        return '' unless value
+        return @engine.heap.it.set_to( '' ) unless value
 
         if @params&.token_count&.positive?
           expr = Gloo::Expr::Expression.new( @engine, [ @params.tokens.first ] )
@@ -153,7 +156,7 @@ module Gloo
           return result
         else
           # Error
-          @engine.log.error MISSING_PARAM_MSG
+          @engine.syntax_err MISSING_PARAM_MSG
           @engine.heap.it.set_to false
           return false
         end
@@ -165,7 +168,7 @@ module Gloo
       # beginning or end of the string. Does not change the string's value.
       #
       def msg_split
-        return '' unless value
+        return @engine.heap.it.set_to( '' ) unless value
 
         if @params&.token_count&.positive?
           expr = Gloo::Expr::Expression.new( @engine, [ @params.tokens.first ] )
@@ -178,7 +181,7 @@ module Gloo
           return result
         else
           # Error
-          @engine.log.error MISSING_PARAM_MSG
+          @engine.syntax_err MISSING_PARAM_MSG
           @engine.heap.it.set_to false
           return false
         end
@@ -189,7 +192,7 @@ module Gloo
       # Same as split( 0, index ). Does not change the string's value.
       #
       def msg_splitl
-        return '' unless value
+        return @engine.heap.it.set_to( '' ) unless value
 
         if @params&.token_count&.positive?
           expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
@@ -200,7 +203,7 @@ module Gloo
           return result
         else
           # Error
-          @engine.log.error MISSING_PARAM_MSG
+          @engine.syntax_err MISSING_PARAM_MSG
           @engine.heap.it.set_to false
           return false
         end
@@ -211,7 +214,7 @@ module Gloo
       # Same as split( index, size ). Does not change the string's value.
       #
       def msg_splitr
-        return '' unless value
+        return @engine.heap.it.set_to( '' ) unless value
 
         if @params&.token_count&.positive?
           expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
@@ -222,7 +225,7 @@ module Gloo
           return result
         else
           # Error
-          @engine.log.error MISSING_PARAM_MSG
+          @engine.syntax_err MISSING_PARAM_MSG
           @engine.heap.it.set_to false
           return false
         end
@@ -240,10 +243,10 @@ module Gloo
       # into 'it'.
       #
       def msg_split_list
-        return unless value
+        return @engine.heap.it.set_to( 0 ) unless value
 
         if @params&.token_count.to_i < 2
-          @engine.log.error MISSING_PARAM_MSG
+          @engine.syntax_err MISSING_PARAM_MSG
           @engine.heap.it.set_to false
           return false
         end
@@ -282,9 +285,45 @@ module Gloo
           @engine.heap.it.set_to result
           return result
         else
+          @engine.syntax_err MISSING_PARAM_MSG
+          @engine.heap.it.set_to false
+          return false
+        end
+      end
+
+      #
+      # Get the 0-based position of the first occurrence of {needle}
+      # at or after the optional {from} position (default 0).
+      # Puts -1 into 'it' if not found. An out-of-range {from} (negative,
+      # or past the end of the string) logs an error and puts false
+      # into 'it'. Does not change the string's value.
+      #
+      def msg_index_of
+        unless @params&.token_count&.positive?
+          @engine.syntax_err MISSING_PARAM_MSG
+          @engine.heap.it.set_to false
+          return false
+        end
+
+        expr = Gloo::Expr::Expression.new( @engine, [ @params.tokens.first ] )
+        needle = expr.evaluate.to_s
+
+        from = 0
+        if @params.token_count > 1
+          expr = Gloo::Expr::Expression.new( @engine, [ @params.tokens.last ] )
+          from = expr.evaluate.to_i
+        end
+
+        str = value.to_s
+        if from.negative? || from > str.length
+          @engine.err "Start position #{from} is out of range!"
           @engine.heap.it.set_to false
           return false
         end
+
+        result = str.index( needle, from ) || -1
+        @engine.heap.it.set_to result
+        return result
       end
 
       #
@@ -328,26 +367,23 @@ module Gloo
       # 
       def msg_format_for_html
         text = self.value
-        out = ""
-        return out unless text
+        return @engine.heap.it.set_to( '' ) unless text
 
-        # indentation
+        # Indentation: each leading space is one &nbsp;, each leading
+        # tab four, in whatever order they come.
+        out = ""
         text.each_line do |line|
           i = 0
-          while line[i] == ' '
+          while [ ' ', "\t" ].include?( line[ i ] )
+            out << ( line[ i ] == ' ' ? '&nbsp;' : '&nbsp;&nbsp;&nbsp;&nbsp;' )
             i += 1
-            out << "&nbsp;"
           end
-    
-          i = 0
-          while line[i] == "\t"
-            i += 1
-            out << "&nbsp;&nbsp;&nbsp;&nbsp;"
-          end
-          out << line
+          out << line[ i..]
         end
-    
+
         self.value = out.gsub( "\n", "<br/>" )
+        @engine.heap.it.set_to self.value
+        return self.value
       end
 
       # 
@@ -515,13 +551,13 @@ module Gloo
       #
       # Resolve the target container path for split_list. The path may
       # point directly at a container, or at an alias that points to
-      # one. Returns nil (and logs an error, setting 'it' to false)
+      # one. Returns nil (and reports an error, setting 'it' to false)
       # if the path doesn't exist or doesn't resolve to a container.
       #
       def split_list_target( token )
         pn = Gloo::Core::Pn.new( @engine, token )
         unless pn&.exists?
-          @engine.log.error 'Target container path does not exist!'
+          @engine.err Gloo::Core::NotFound.object( token )
           @engine.heap.it.set_to false
           return nil
         end
@@ -529,7 +565,7 @@ module Gloo
         target = pn.resolve
         target = Gloo::Objs::Alias.resolve_alias( @engine, target )
         unless target&.is_container?
-          @engine.log.error 'Target for split_list must be a container!'
+          @engine.err 'Target for split_list must be a container!'
           @engine.heap.it.set_to false
           return nil
         end

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

@@ -133,8 +133,8 @@ module Gloo
             'child (alias) — iterate a container\'s children.',
             'word (string) — iterate the words in a string.',
             'line (string) — iterate the lines in a block of text.',
-            'file (file) — iterate the files in a folder; an optional ext (string) child limits to files of that extension.',
-            'dir (file) — iterate the directories in a folder.'
+            'file (file) — iterate the files in a folder. Optional children: ext (string) limits to files of that extension, ignoring case; recursive (bool) walks the subfolders too; include_dirs (bool) lists folders as well as files.',
+            'dir (file) — iterate the directories in a folder. Optional child: recursive (bool) walks the subfolders too.'
           ],
           :messages => [
             'run — Run the loop for each item in the collection.'
@@ -144,7 +144,16 @@ module Gloo
             '(string) child naming a property of each child, plus ' \
             'on_group_start / on_group_end (script) children — those ' \
             'scripts run whenever the group_by value changes, letting ' \
-            'you aggregate results in groups.',
+            'you aggregate results in groups. ' \
+            'When iterating files or directories, the in folder may be ' \
+            'given with or without a trailing slash, may start with ~ ' \
+            'for the home folder, and may include ' \
+            'wildcards: in: /notes/**/ walks every subfolder, and ' \
+            'in: /projects/*/docs/ looks in each project\'s docs folder. ' \
+            'Wildcards combine with ext, recursive and include_dirs. ' \
+            'Paths are full paths, sorted, with each folder before ' \
+            'what is in it. Hidden files and folders are skipped, and ' \
+            'a recursive walk does not go into symlinked folders.',
           :examples => <<~EXAMPLES.strip
             #
             # Show each child in a container.
@@ -167,6 +176,16 @@ module Gloo
               on_load [script] :
                 show 'showing children in container' (white)
                 tell each_child.for to run
+
+            #
+            # Show every markdown file in a folder tree.
+            #
+            notes [each] :
+              file [file] :
+              in [file] : /my/notes/
+              ext [string] : md
+              recursive [bool] : true
+              do [script] : show ^.file
           EXAMPLES
         }
       end

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

@@ -9,6 +9,7 @@ module Gloo
     class EachDir
 
       DIR = 'dir'.freeze
+      RECURSIVE = 'recursive'.freeze
       
       # ---------------------------------------------------------------------
       #    Create Iterator
@@ -42,21 +43,33 @@ module Gloo
       # Run for each directory.
       #
       def run
-        folder = @iterator_obj.in_value
+        folder = EachFile.expand_home( @iterator_obj.in_value )
         return unless folder
 
         unless Dir.exist?( folder )
-          @engine.err "Folder does not exist: #{folder}"
+          # A path with a wildcard is a pattern, not a folder.
+          unless EachFile.wildcard?( folder )
+            @engine.err Gloo::Core::NotFound.folder( folder )
+            return
+          end
         end
 
-        Dir.glob( "#{folder}*" ).each do |f|
-          if Dir.exist?( f )
-            set_dir f
-            @iterator_obj.run_do
-          end
+        Dir.glob( EachFile.pattern( folder, recursive? ) ).each do |f|
+          next unless File.directory?( f )
+
+          set_dir f
+          @iterator_obj.run_do
         end
       end
 
+      #
+      # Walk the subfolders too?
+      #
+      def recursive?
+        value = @iterator_obj.find_child_value RECURSIVE
+        return Gloo::Objs::Boolean.coerse_to_bool( value )
+      end
+
       #
       # Set the value of the dir.
       #

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

@@ -10,7 +10,10 @@ module Gloo
 
       FILE = 'file'.freeze
       EXT = 'ext'.freeze
+      RECURSIVE = 'recursive'.freeze
+      INCLUDE_DIRS = 'include_dirs'.freeze
       WILD = '*'.freeze
+      RECURSE = '**'.freeze
 
       
       # ---------------------------------------------------------------------
@@ -45,7 +48,7 @@ module Gloo
       # Run for each file.
       #
       def run
-        folder = @iterator_obj.in_value
+        folder = EachFile.expand_home( @iterator_obj.in_value )
         return unless folder
 
         unless Dir.exist?( folder )
@@ -53,20 +56,86 @@ module Gloo
           @engine.log.info "Folder does not exist: #{folder}"
         end
 
-        Dir.glob( "#{folder}#{wildcard}" ).each do |f|
+        Dir.glob( EachFile.pattern( folder, recursive? ) ).each do |f|
+          next unless include?( f )
+
           set_file f
           @iterator_obj.run_do
         end
       end
 
-      # 
-      # Get the wildcard for the glob.
-      # 
-      def wildcard
-        o = @iterator_obj.find_child EXT
-        return WILD unless o
+      #
+      # Expand a leading ~ to the home folder.
+      # Other paths are left as they are, so relative paths stay relative.
+      #
+      def self.expand_home( folder )
+        return folder unless folder.is_a?( ::String ) && folder.start_with?( '~' )
+
+        return File.expand_path( folder )
+      end
+
+      #
+      # Get the glob pattern for everything in the folder, and
+      # optionally everything in its subfolders.
+      # The folder may itself include wildcards.
+      #
+      def self.pattern( folder, recursive )
+        return File.join( folder, RECURSE, WILD ) if recursive
+
+        return File.join( folder, WILD )
+      end
+
+      #
+      # Does the folder path include glob wildcards?
+      #
+      def self.wildcard?( folder )
+        return folder.to_s.match?( /[*?\[{]/ )
+      end
+
+      #
+      # Should the loop run for this path?
+      # Folders only when include_dirs is set; files only when they
+      # match the extension, if there is one.
+      #
+      def include?( f )
+        return include_dirs? if File.directory?( f )
+        return false unless File.file?( f )
+
+        return ext_match?( f )
+      end
+
+      #
+      # Does the file have the extension we're looking for?
+      # The match ignores case, so md matches .MD on every platform.
+      #
+      def ext_match?( f )
+        ext = @iterator_obj.find_child_value EXT
+        return true if ext.nil? || ext.to_s.strip.empty?
 
-        return "#{WILD}.#{o.value}"
+        ext = ext.to_s.strip.delete_prefix( '.' )
+        return File.extname( f ).casecmp?( ".#{ext}" )
+      end
+
+      #
+      # Walk the subfolders too?
+      #
+      def recursive?
+        return child_true?( RECURSIVE )
+      end
+
+      #
+      # List folders as well as files?
+      #
+      def include_dirs?
+        return child_true?( INCLUDE_DIRS )
+      end
+
+      #
+      # Is the named child present and true?
+      #
+      def child_true?( name )
+        value = @iterator_obj.find_child_value name
+        return Gloo::Objs::Boolean.coerse_to_bool( value )
       end
 
       #

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

@@ -164,10 +164,10 @@ module Gloo
       #
       # Invoke the function, run the script and return the result.
       #
-      # If on_invoke itself hits an error, it is left alone rather
-      # than being clobbered with an unreliable result - callers can
-      # tell this happened because the engine is left in an error
-      # state (@engine.heap.error), same as any other failed verb.
+      # If on_invoke itself hits an error, there is no reliable
+      # result, so it is set to false (like any other command that
+      # would set it and fails), and the engine is left in an error
+      # state (@engine.heap.error).
       #
       def invoke args
         @engine.log.debug "Invoking function: #{name}"
@@ -179,6 +179,7 @@ module Gloo
         failed = @engine.heap.error.error_count.positive?
 
         if failed
+          @engine.heap.it.set_to false
           run_after_invoke
           return nil
         end
@@ -230,7 +231,7 @@ module Gloo
             'result (string) — The result of the function to return to the caller.'
           ],
           :messages => [
-            'invoke — Invoke the function, set it and return the result. The function result is put into it as well as being returned to the caller.'
+            'invoke — Invoke the function, set it and return the result. The function result is put into it as well as being returned to the caller. If on_invoke hits an error, there is no result: it is false, and after_invoke still runs.'
           ],
           :examples => <<~EXAMPLES.strip
             #

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

@@ -73,14 +73,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
@@ -90,14 +93,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
@@ -106,7 +112,9 @@ module Gloo
       # Get the month.
       #
       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.month}".rjust(2, '0')
       end
 
@@ -114,7 +122,9 @@ module Gloo
       # Get the day.
       #
       def msg_dd
-        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.day}".rjust(2, '0')
       end
 
@@ -122,7 +132,9 @@ module Gloo
       # Get the year.
       #
       def msg_yyyy
-        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.year.to_s
       end
 
@@ -130,7 +142,9 @@ module Gloo
       # Get the year (2 digit).
       #
       def msg_yy
-        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.year.to_s[-2..-1]
       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
             'yyyy — Get the 4 digit year portion of the date. Put the 4 digit year into it.',
             'format ({fmt}) — Format the date using a strftime-style format string. Default if none given: %Y-%m-%d. It will have the formatted string.'
           ],
+          :notes => 'A value that isn\'t a date (eg. \'2026-02-31\') is left with no value, with a warning: "\'2026-02-31\' is not a date; using no value."',
           :examples => <<~EXAMPLES.strip
             #
             # Show the current date.