gloo 6.7.2 → 7.0

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

@@ -41,6 +41,7 @@ module Gloo
       # Set the result of the system call.
       #
       def set_result( data )
+        @engine.heap.it.set_to data
         r = find_child_resolve_alias RESULT
         return unless r
 
@@ -110,7 +111,10 @@ module Gloo
         cmd = cmd_value
         return unless cmd
 
-        result = `#{cmd}`
+        result = nil
+        return false unless attempt( "run '#{cmd}'", SystemCallError ) do
+          result = `#{cmd}`
+        end
         set_result result
       end
 
@@ -143,7 +147,7 @@ module Gloo
             'result (string) — The result of running the command. Only set if get_output is true.'
           ],
           :messages => [
-            'run — Run the system level command. Sets the result value to the output of the command if get_output is true.'
+            'run — Run the system level command. Sets the result value to the output of the command if get_output is true, or to whether the command succeeded (true or false) if it is not. It will have the same value as result.'
           ],
           :examples => <<~EXAMPLES.strip
             date [system] :

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

@@ -14,6 +14,12 @@ module Gloo
 
       KEYWORD = 'http_get'.freeze
       KEYWORD_SHORT = 'get'.freeze
+
+      # What can go wrong reaching a URL: a bad URL, an unknown host,
+      # no connection, a timeout, an SSL problem, a bad response.
+      NETWORK_ERRORS = [ URI::InvalidURIError, SocketError, SystemCallError,
+                         IOError, Timeout::Error, OpenSSL::SSL::SSLError,
+                         Net::ProtocolError ].freeze
       URL = 'uri'.freeze
       DEFAULT_URL = 'https://web.site/'.freeze
       PARAMS = 'params'.freeze
@@ -76,7 +82,10 @@ module Gloo
       def msg_run
         url = full_url_value
         @engine.log.debug url
-        r = Gloo::Objs::HttpGet.invoke_request( url, skip_ssl_verify? )
+        r = nil
+        return false unless attempt( "get #{url}", *NETWORK_ERRORS ) do
+          r = Gloo::Objs::HttpGet.invoke_request( url, skip_ssl_verify? )
+        end
         update_result r
       end
 
@@ -125,6 +134,7 @@ module Gloo
       # Set the result of the API call.
       #
       def update_result( data )
+        @engine.heap.it.set_to data
         r = find_child_resolve_alias RESULT
         return unless r
 
@@ -167,7 +177,7 @@ module Gloo
             'skip_ssl_verify (boolean) — Optional. Skip the SSL verification as part of the request.'
           ],
           :messages => [
-            'run — Run the HTTP Get and update the result.'
+            'run — Run the HTTP Get and update the result. It will have the response body.'
           ],
           :examples => <<~EXAMPLES.strip
             g [http_get] :

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

@@ -60,6 +60,7 @@ module Gloo
       # Set the result of the API call.
       #
       def update_result( data )
+        @engine.heap.it.set_to data
         r = find_child_resolve_alias RESULT
         return unless r
 
@@ -111,7 +112,10 @@ module Gloo
         @engine.log.debug "posting to: #{uri}"
         body = self.body_as_json
         @engine.log.debug "posting body: #{body}"
-        result = Gloo::Objs::HttpPost.post_json( uri, body, skip_ssl_verify? )
+        result = nil
+        return false unless attempt( "post to #{uri}", *HttpGet::NETWORK_ERRORS ) do
+          result = Gloo::Objs::HttpPost.post_json( uri, body, skip_ssl_verify? )
+        end
         @engine.log.debug result.code
         @engine.log.debug result.message
 
@@ -171,7 +175,7 @@ module Gloo
             'skip_ssl_verify (boolean) — Optional. Skip the SSL verification as part of the request.'
           ],
           :messages => [
-            'run — Run the HTTP Post, sending the body data to the endpoint specified in the URI.'
+            'run — Run the HTTP Post, sending the body data to the endpoint specified in the URI. The result child (if there is one) gets the response body. It will have the response body.'
           ],
           :examples => <<~EXAMPLES.strip
             post [post] :

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

@@ -65,12 +65,15 @@ module Gloo
       def msg_pretty
         return unless self.value
 
-        json = JSON.parse( self.value )
-        if self.value.start_with?( '"{' )
-          json = JSON.parse( json )
+        json = nil
+        return false unless attempt( "parse the JSON in #{pn}", JSON::ParserError ) do
+          json = JSON.parse( self.value )
+          json = JSON.parse( json ) if self.value.start_with?( '"{' )
         end
         pretty = JSON.pretty_generate( json )
         set_value pretty
+        @engine.heap.it.set_to pretty
+        return pretty
       end
 
       #
@@ -78,13 +81,23 @@ module Gloo
       # The additional parameter is the path to the value.
       #
       def msg_get
-        if @params&.token_count&.positive?
-          expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
-          data = expr.evaluate
+        unless @params&.token_count&.positive?
+          @engine.syntax_err 'Missing path to the value!'
+          @engine.heap.it.set_to false
+          return false
+        end
+
+        expr = Gloo::Expr::Expression.new( @engine, @params.tokens )
+        data = expr.evaluate
+        if data.nil?
+          @engine.heap.it.set_to false
+          return false
         end
-        return unless data
 
-        field = Gloo::Objs::Json.get_value_in_json self.value, data
+        field = nil
+        return false unless attempt( "parse the JSON in #{pn}", JSON::ParserError ) do
+          field = Gloo::Objs::Json.get_value_in_json self.value, data
+        end
         @engine.heap.it.set_to field
         return field
       end
@@ -97,12 +110,12 @@ module Gloo
         if @params&.token_count&.positive?
           pn = Gloo::Core::Pn.new( @engine, @params.tokens.first )
           unless pn&.exists?
-            @engine.err 'Source path for objects does not exist'
-            return
+            @engine.err Gloo::Core::NotFound.object( @params.tokens.first )
+            return @engine.heap.it.set_to( false )
           end
         else
-          @engine.err 'Source path for objects is required'
-          return
+          @engine.syntax_err 'Source path for objects is required'
+          return @engine.heap.it.set_to( false )
         end
         parent = pn.resolve
 
@@ -124,16 +137,19 @@ module Gloo
         if @params&.token_count&.positive?
           pn = Gloo::Core::Pn.new( @engine, @params.tokens.first )
           unless pn&.exists?
-            @engine.err 'Destination path for parsed objects does not exist'
+            @engine.err Gloo::Core::NotFound.object( @params.tokens.first )
             return
           end
         else
-          @engine.err 'Destination path for parsed objects is required'
+          @engine.syntax_err 'Destination path for parsed objects is required'
           return
         end
         parent = pn.resolve
 
-        json = JSON.parse( self.value )
+        json = nil
+        return unless attempt( "parse the JSON in #{self.pn}", JSON::ParserError, set_it: false ) do
+          json = JSON.parse( self.value )
+        end
         self.handle_json_to_obj( json, parent )
       end
 
@@ -196,8 +212,12 @@ module Gloo
       # 
       def self.get_value_in_json( json, path_to_value )
         data = JSON.parse( json )
-        path_to_value.split( '.' ).each do |segment|
-          data = data[ segment ]
+        path_to_value.to_s.split( '.' ).each do |segment|
+          data = case data
+                 when Hash then data[ segment ]
+                 when Array then segment.match?( /\A\d+\z/ ) ? data[ segment.to_i ] : nil
+                 end
+          return nil if data.nil?
         end
         return data
       end
@@ -221,7 +241,7 @@ module Gloo
             '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).',
-            'pretty — Make the JSON format pretty.'
+            '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/objs/web/uri.rb

@@ -61,12 +61,17 @@ module Gloo
       # Get the expiration date for the certificate.
       #
       def msg_get_cert_expires
-        return unless value
+        if value.blank?
+          @engine.err 'There is no URL to get the certificate for!'
+          return @engine.heap.it.set_to( false )
+        end
 
-        uri = URI( value )
-        response = Net::HTTP.start( uri.host, uri.port, :use_ssl => true )
-        cert = response.peer_cert
-        o = cert.not_after
+        o = nil
+        return false unless attempt( "get the certificate for #{value}", *HttpGet::NETWORK_ERRORS ) do
+          uri = URI( value )
+          response = Net::HTTP.start( uri.host, uri.port, :use_ssl => true )
+          o = response.peer_cert.not_after
+        end
 
         @engine.heap.it.set_to o
         return o
@@ -77,9 +82,12 @@ module Gloo
       # in the URL.  Might be used to scroll down in the page.
       #
       def msg_get_fragment
-        return unless value
+        return @engine.heap.it.set_to( '' ) if value.blank?
 
-        o = URI( value ).fragment
+        o = nil
+        return false unless attempt( "read the URL '#{value}'", URI::InvalidURIError ) do
+          o = URI( value ).fragment
+        end
         @engine.heap.it.set_to o
         return o
       end
@@ -89,9 +97,12 @@ module Gloo
       # Example:  id=121
       #
       def msg_get_query
-        return unless value
+        return @engine.heap.it.set_to( '' ) if value.blank?
 
-        o = URI( value ).query
+        o = nil
+        return false unless attempt( "read the URL '#{value}'", URI::InvalidURIError ) do
+          o = URI( value ).query
+        end
         @engine.heap.it.set_to o
         return o
       end
@@ -101,9 +112,12 @@ module Gloo
       # Example:  /posts
       #
       def msg_get_path
-        return unless value
+        return @engine.heap.it.set_to( '' ) if value.blank?
 
-        o = URI( value ).path
+        o = nil
+        return false unless attempt( "read the URL '#{value}'", URI::InvalidURIError ) do
+          o = URI( value ).path
+        end
         @engine.heap.it.set_to o
         return o
       end
@@ -113,9 +127,12 @@ module Gloo
       # Example:  google.com
       #
       def msg_get_host
-        return unless value
+        return @engine.heap.it.set_to( '' ) if value.blank?
 
-        o = URI( value ).host
+        o = nil
+        return false unless attempt( "read the URL '#{value}'", URI::InvalidURIError ) do
+          o = URI( value ).host
+        end
         @engine.heap.it.set_to o
         return o
       end
@@ -125,9 +142,12 @@ module Gloo
       # Example:  http
       #
       def msg_get_scheme
-        return unless value
+        return @engine.heap.it.set_to( '' ) if value.blank?
 
-        o = URI( value ).scheme
+        o = nil
+        return false unless attempt( "read the URL '#{value}'", URI::InvalidURIError ) do
+          o = URI( value ).scheme
+        end
         @engine.heap.it.set_to o
         return o
       end
@@ -165,7 +185,7 @@ module Gloo
             `xdg-open "#{url}"`
           end
         else
-          engine.log.warn 'Opening URL not supported on this platform.' if engine
+          engine&.err 'Opening a URL is not supported on this platform.'
         end
       end
 

data/lib/gloo/persist/file_loader.rb

@@ -22,6 +22,13 @@ module Gloo
       BEGIN_BLOCK = 'BEGIN'.freeze
       END_BLOCK = 'END'.freeze
       SPACE_CNT = 2
+      UNNAMED = 'unnamed_'.freeze
+      NO_NAME_ERR = 'Object name is missing; using '.freeze
+      MISSING_BRACKET_ERR = "Missing ']' after type ".freeze
+      OVER_INDENTED_WARNING = 'Indented more than one level deeper than ' \
+        'the line above; nesting it under that line.'.freeze
+      MISALIGNED_WARNING = "Indentation doesn't line up with any line " \
+        'above; nesting it under the closest one.'.freeze
 
       # A 'load lib {name}' (or 'load ext {name}') statement at the top
       # of a file, before the first object declaration. It makes a core
@@ -64,7 +71,7 @@ module Gloo
       #
       def load
         unless @mech.exist?( @pn )
-          @engine.err "File '#{@pn}' does not exist."
+          @engine.err Gloo::Core::NotFound.file( @pn )
           return
         end
 
@@ -72,9 +79,17 @@ module Gloo
         @indent_stack = IndentStack.new( @engine.heap.root, @source_doc )
         f = @mech.read( @pn )
 
-        f = join_continuations( f )
-        f.each_line { |line| dispatch_line( line ) }
-        finish
+        exec_env = @engine.exec_env
+        outer_location = exec_env.load_location
+        begin
+          each_joined_line( f ) do |line, number|
+            exec_env.load_location = "#{@pn}:#{number}"
+            dispatch_line( line )
+          end
+          finish
+        ensure
+          exec_env.load_location = outer_location
+        end
       end
 
       #
@@ -89,10 +104,27 @@ module Gloo
       end
 
       #
-      # Join continuation lines.
-      #
-      def join_continuations( data )
-        return data.gsub( "\\\n", '' )
+      # Yield each line of the file with its line number (counting from
+      # 1). A line ending in a backslash continues on the next line:
+      # the two are joined, dropping the backslash and the line break,
+      # and the joined line has the number of the line it starts on.
+      #
+      def each_joined_line( data )
+        pending = nil
+        start = 0
+        data.each_line.with_index( 1 ) do |line, number|
+          if pending
+            pending << line
+          else
+            pending = line.dup
+            start = number
+          end
+          next if pending.delete_suffix!( "\\\n" )
+
+          yield pending, start
+          pending = nil
+        end
+        yield pending, start if pending
       end
 
       # ---------------------------------------------------------------------
@@ -207,16 +239,44 @@ module Gloo
       #
       def finalize_declaration( line )
         line_tabs = tab_count( line )
-        @indent_stack.place( line_tabs, @last, @last_node )
+        placed = @indent_stack.place( line_tabs, @last, @last_node )
+        warn_indent( placed ) if placed
         create_declared_obj( line, line_tabs )
       end
 
+      #
+      # A declaration with no name is a syntax error. The best guess is
+      # a placeholder name that isn't taken under the parent, so the
+      # object (its type, value and children) still loads.
+      #
+      def placeholder_name( parent )
+        n = 1
+        n += 1 while parent&.contains_child?( "#{UNNAMED}#{n}" )
+        name = "#{UNNAMED}#{n}"
+        @engine.syntax_err "#{NO_NAME_ERR}'#{name}'."
+        return name
+      end
+
+      #
+      # Warn about indentation that was understood, but probably isn't
+      # what was meant.
+      #
+      def warn_indent( placed )
+        msg = if placed == IndentStack::OVER_INDENTED
+                OVER_INDENTED_WARNING
+              else
+                MISALIGNED_WARNING
+              end
+        @engine.warn msg
+      end
+
       #
       # Create the heap object and its source node for one declaration
       # line, and start body collection if its type calls for one.
       #
       def create_declared_obj( line, line_tabs )
         name, type, value, style = split_declaration( line )
+        name ||= placeholder_name( @indent_stack.parent )
         leaf, parent, roots, created = @shorthand.expand( name, @indent_stack.parent )
         roots.each { |r| @ledger.root( r ) }
         created.each { |c| @ledger.created( c ) }
@@ -234,8 +294,8 @@ module Gloo
         # name re-declared across files -- @last is the same object
         # across re-declarations (the factory returns the existing
         # one), so a later, comment-less re-declaration doesn't blank
-        # out an earlier file's doc. @last can be nil for an unknown
-        # type (factory.create logs a warning and returns nil).
+        # out an earlier file's doc. @last can be nil for a type that
+        # can't be created (an unknown type is created untyped).
         @last.doc = node.doc if @last && @last.doc.to_s.strip.empty?
         @indent_stack.node.children << node
         @last_node = node
@@ -258,6 +318,7 @@ module Gloo
       def split_declaration( line )
         splitter = LineSplitter.new( line, @indent_stack&.tabs || 0 )
         name, type, value = splitter.split
+        @engine.syntax_err "#{MISSING_BRACKET_ERR}'#{type}'." if splitter.missing_bracket
         style = { :raw_tail => splitter.raw_tail, :block_style => :inline }
         return name, type, value, style if @block_value == ''
 

data/lib/gloo/persist/file_saver.rb

@@ -263,7 +263,8 @@ module Gloo
         return body_value_unchanged?( node ) if node.block_style == :body
 
         trial = node.obj.class.new( @engine )
-        trial.set_value( node.raw_value )
+        # Only a comparison: any bad-value warning was given on load.
+        @engine.without_warnings { trial.set_value( node.raw_value ) }
         return trial.value == node.obj.value
       rescue
         return false

data/lib/gloo/persist/indent_stack.rb

@@ -11,17 +11,27 @@ module Gloo
   module Persist
     class IndentStack
 
-      attr_reader :tabs
+      # What place reports about a line's indentation, when it's
+      # probably not what was meant (the loader warns about it).
+      OVER_INDENTED = :over_indented
+      MISALIGNED = :misaligned
 
       #
       # Set up a stack rooted at the given heap object and source node.
       #
       def initialize( root_obj, root_node )
-        @tabs = 0
+        @levels = [ 0 ]
         @parent_stack = [ root_obj ]
         @node_stack = [ root_node ]
       end
 
+      #
+      # The indentation (in tabs) of the current nesting level.
+      #
+      def tabs
+        return @levels.last
+      end
+
       #
       # The heap object new children should be created under.
       #
@@ -43,46 +53,52 @@ module Gloo
       # new parent. last_obj/last_node are whatever was created for the
       # previous declaration line.
       #
+      # Each open nesting level remembers its own indentation, so a line
+      # nests under the line above whenever it's deeper (by any amount),
+      # and an outdent goes back to exactly the level it lines up with.
+      #
+      # Returns nil, or OVER_INDENTED if the line is more than one level
+      # deeper than the line above, or MISALIGNED if an outdent doesn't
+      # line up with any open level (it's nested under the closest one).
+      #
       def place( line_tabs, last_obj, last_node )
-        indent = indent_delta( line_tabs )
-        if indent.positive?
-          # last_obj is nil when the previous line failed to make an
-          # object (eg. an unknown type in a malformed file) -- keep
-          # the current parent rather than pushing nil.
-          @parent_stack.push( last_obj || @parent_stack.last )
-          @node_stack.push( last_node || @node_stack.last )
-        elsif indent.negative?
-          indent.abs.times do
-            # never pop the root -- a file with erratic (mixed
-            # tab/space) indentation can outdent further than it ever
-            # indented; clamp instead of emptying the stack.
-            break if @parent_stack.length <= 1
+        return indent( line_tabs, last_obj, last_node ) if line_tabs > tabs
 
-            @parent_stack.pop
-            @node_stack.pop
-          end
+        popped = nil
+        while tabs > line_tabs
+          @levels.pop
+          popped = [ @parent_stack.pop, @node_stack.pop ]
         end
+        return nil if tabs == line_tabs
+
+        # Between two open levels: best guess, keep it under the
+        # closest (deepest) one it's still inside of.
+        push_level( line_tabs, *popped )
+        return MISALIGNED
       end
 
       private
 
       #
-      # Update @tabs for the new line and return the signed change in
-      # nesting depth: positive if it's more indented than the last
-      # line placed, negative if less, zero if the same.
-      #
-      def indent_delta( line_tabs )
-        if line_tabs > @tabs
-          # TODO:  What if indent is more than one more level?
-          @tabs = line_tabs
-          return 1
-        elsif line_tabs < @tabs
-          diff = @tabs - line_tabs
-          @tabs -= diff
-          return -diff
-        end
+      # A deeper line: the previous line's object/node becomes the
+      # new parent.
+      #
+      def indent( line_tabs, last_obj, last_node )
+        over = line_tabs > tabs + 1
+        # last_obj is nil when the previous line failed to make an
+        # object (eg. a type that can't be created) -- keep the
+        # current parent rather than pushing nil.
+        push_level( line_tabs, last_obj || parent, last_node || node )
+        return over ? OVER_INDENTED : nil
+      end
 
-        return 0
+      #
+      # Open a nesting level at the given indentation.
+      #
+      def push_level( line_tabs, obj, node )
+        @levels.push line_tabs
+        @parent_stack.push obj
+        @node_stack.push node
       end
 
     end

data/lib/gloo/persist/line_splitter.rb

@@ -12,7 +12,7 @@ module Gloo
       BEGIN_BLOCK = 'BEGIN'.freeze
       END_BLOCK = 'END'.freeze
 
-      attr_reader :obj, :raw_tail
+      attr_reader :obj, :raw_tail, :missing_bracket
 
       #
       # Set up a line splitter
@@ -21,6 +21,7 @@ module Gloo
         @line = line
         @tabs = tabs
         @raw_tail = ''
+        @missing_bracket = false
       end
 
       #
@@ -43,8 +44,19 @@ module Gloo
       # a string value, which can matter when the value is used to
       # build HTML.
       #
+      # A line that starts with the type ('[') or the value (':') has no
+      # name: the name is nil, and the whole line is left for the type
+      # and value.
+      #
       def detect_name
         @line = @line.lstrip.chomp
+        if @line.start_with?( '[', ':' )
+          @name = nil
+          @line = " #{@line}"
+          @idx = 0
+          return
+        end
+
         @idx = @line.index( ' ' )
         @idx = 0 unless @idx
         @name = @line[ 0..@idx - 1 ]
@@ -58,6 +70,12 @@ module Gloo
       # reproduce a declaration's original spacing when its value
       # hasn't changed.
       #
+      # A type that opens with '[' but has no ']' (eg. 'a [int : 3') is
+      # read up to the next space, as if it were closed there; the tail
+      # is everything after it, and missing_bracket is set so the loader
+      # can report it. A ']' later on the line (in the value) doesn't
+      # count.
+      #
       def detect_type
         @line = @line[ @idx + 1..-1 ]
         @idx = @line.index( ' ' )
@@ -68,13 +86,32 @@ module Gloo
           return
         end
 
-        @type = @line[ 0..( @idx ? @idx - 1 : -1 ) ]
-        @type = @type[ 1..-1 ] if @type[ 0 ] == '['
+        word = @line[ 0..( @idx ? @idx - 1 : -1 ) ]
+        return detect_bracketed_type( word ) if word[ 0 ] == '['
+
+        @type = word
         @type = @type[ 0..-2 ] if @type[ -1 ] == ']'
         close = @line.index( ']' )
         @raw_tail = close ? @line[ close + 1..-1 ] : ''
       end
 
+      #
+      # The type word starts with '['. The type ends at the ']' in that
+      # word (which may be followed directly by the ':', as in
+      # 'a [int]: 3'); with no ']' in it, the whole word is the type.
+      #
+      def detect_bracketed_type( word )
+        close = word.index( ']' )
+        if close
+          @type = word[ 1...close ]
+          @raw_tail = @line[ close + 1..-1 ]
+        else
+          @missing_bracket = true
+          @type = word[ 1..-1 ]
+          @raw_tail = @idx ? @line[ @idx..-1 ] : ''
+        end
+      end
+
       #
       # Detect the object value.
       # Use nil if there is no value specified.