pg_conn 0.33.1 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0819b55757ac186639c7615df4a1ec09fb449e85216a19cad30c7a6f8feb139f'
-  data.tar.gz: fdf28a9434d88abf0fb0f89b3459aeaf2602b1644524a931ab1b84832f9067a3
+  metadata.gz: a4c942ce055688931946e0d5a71ddc89a722b2dd98ea6d9d0edc150b39421dd9
+  data.tar.gz: 3fea9a99e361c86b3b413845d5f319562051347afe025a27006c80548f822ff4
 SHA512:
-  metadata.gz: a053216dde0bb4e3d060ff3dcd58527f2f36b1e560057020a8610c54fa32e00d0390c15841d44e3733039f10fa8a14cf98cb99660bd2d05daa1be9e2941dc139
-  data.tar.gz: 7c88b089bd4dbd3892ae20622a6edc0e2caf89f837833f78cf99fcb20bca91c92aad885029f5e381946970937414782513c3f7d4053d41512d391af0d6015eff
+  metadata.gz: aa391cc15005c51ca01503e33096dacecec5743fa3bf6f28c22d7fd2ad7e14d2e23f48dc2cc0e3e9cade6d77bc359d3b56ebb871015e2db9d08cffcedcf8988f
+  data.tar.gz: 6fd5537fe417a8dac42ad2ac3af16c75a329bcafc93118ae2a375a3ec3368d0dc088163f8dbd87d5b56a8cb357b3bc5c76c6f9ec49618d4d4c6099bee472b423

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.33.1"
+  VERSION = "0.35.0"
 end

data/lib/pg_conn.rb

@@ -147,13 +147,40 @@ module PgConn
     attr_reader :session
 
     # The transaction timestamp of the most recent SQL statement executed by
-    # #exec or #transaction block. The timestamp is without time zone
+    # #exec or #transaction block. The timestamp is without time zone and WRONG
+    # in most cases
     attr_reader :timestamp
 
     # The transaction timestamp of the most recent SQL statement executed by
     # #exec or #transaction block. The timestamp includes the current time zone
     attr_reader :timestamptz
 
+    # Controls error messages. It can be assigned true, false, nil. True causes
+    # the error message to be printed to standard error, false ignores it, and
+    # nil resets the state to the default given when the connection was
+    # initialized or false if absent. Note that #silent only controls the error
+    # message, the exception is not affected
+    def silent() @options[:silent] end
+    def silent=(value) set_option(:silent, value) end
+
+    # Controls notices. It can be assigned true, false, nil, or a Proc object
+    # that recieves the message. True causes the message to be printed to
+    # standard output, false ignores it, and nil resets the state to the
+    # default given when the connection was initialized or false if absent
+    def notice() @options[:notice] end
+    def notice=(value) set_option(:notice, value) end
+
+    # Controls warnings. It can be assigned true, false, nil, or a Proc object
+    # that recieves the message. True causes the message to be printed to
+    # standard error, false ignores it, and nil resets the state to the default
+    # given when the connection was initialized or false if absent
+    def warning() @options[:warning] end
+    def warning=(value) set_option(:warning, value) end
+
+    # TODO: Move error message handling into the same framework as notice and
+    # warning but we have a name collision just below that would need to be
+    # resolved somehow
+
     # PG::Error object of the first failed statement in the transaction;
     # otherwise nil. It is cleared at the beginning of a transaction so be sure
     # to save it before you run any cleanup code that may initiate new
@@ -163,7 +190,7 @@ module PgConn
     # True if the transaction is in a error state
     def error?() !@error.nil? end
 
-    # Tuple of error message, lineno, and charno of the error object where each
+    # Tuple of error message, lineno, and charno of the error object. Each
     # element defaults to nil if not found
     def err
       @err ||=
@@ -187,13 +214,17 @@ module PgConn
     # if absent in the Postgres error message
     def errchar = err[2]
 
+    DEFAULT_OPTIONS = { silent: false, notice: false, warning: false }
+
     # :call-seq:
-    #     initialize(dbname = nil, user = nil, field_name_class: Symbol)
-    #     initialize(connection_hash, field_name_class: Symbol)
-    #     initialize(connection_string, field_name_class: Symbol)
-    #     initialize(host, port, dbname, user, password, field_name_class: Symbol)
-    #     initialize(array, field_name_class: Symbol)
-    #     initialize(pg_connection_object)
+    #     initialize(dbname = nil, user = nil, **options)
+    #     initialize(connection_hash, **options)
+    #     initialize(connection_string, **options)
+    #     initialize(host, port, dbname, user, password, **options)
+    #     initialize(array, **options)
+    #     initialize(pg_connection_object, **options)
+    #
+    #     options can be :notice, :warning, :field_name_class, :timestamp, :timestamptz
     #
     # Initialize a connection object and connect to the database
     #
@@ -216,6 +247,9 @@ module PgConn
     # Symbol (the default) or String. The :timestamp option is used
     # internally to set the timestamp for transactions
     #
+    # The :notice and :warning options sets the default output handling this
+    # connection (FIXME fails on copied connections)
+    #
     # Note that the connection hash and the connection string may support more
     # parameters than documented here. Consult
     # https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING
@@ -223,13 +257,22 @@ module PgConn
     #
     # TODO: Change to 'initialize(*args, **opts)'
     def initialize(*args)
+      # Extract connection level options and leave other options (that should
+      # be the postgres authentication hash - postgres will emit an error if
+      # not)
       if args.last.is_a?(Hash)
-        @field_name_class = args.last.delete(:field_name_class) || Symbol
-        @timestamp = args.last.delete(:timestamp)
-        @timestamptz = args.last.delete(:timestamptz)
-        args.pop if args.last.empty?
+        opts = args.last
+        @field_name_class = opts.delete(:field_name_class) || Symbol
+        options = DEFAULT_OPTIONS.transform_values! { |k,v| opts.key?(k) ? opts.delete(k) : v }
+
+        # FIXME: Is this used?
+        @timestamp = opts.delete(:timestamp)
+        @timestamptz = opts.delete(:timestamptz)
+
+        args.pop if opts.empty?
       else
         @field_name_class = Symbol
+        options = DEFAULT_OPTIONS
       end
 
 #     else # We assume that the current user is a postgres superuser
@@ -265,12 +308,12 @@ module PgConn
           elsif args.size == 5
             make_connection args[0], args[1], nil, nil, args[2], args[3], args[4]
           else
-            raise Error, "Illegal number of parameters: #{args.size}"
+            raise Error, "Illegal number of arguments: #{args.size}"
           end
 
-      if @pg_connection && !using_existing_connection
-        # Set a dummy notice processor to avoid warnings on stderr
-        @pg_connection.set_notice_processor { |message| ; } # Intentionally a nop
+      if @pg_connection #&& !using_existing_connection
+        # Set a notice processor that separates notices and warnings
+        @pg_connection.set_notice_processor { |message| message_processor(message) }
 
         # Auto-convert to ruby types
         type_map = PG::BasicTypeMapForResults.new(@pg_connection)
@@ -279,23 +322,29 @@ module PgConn
         # type "uuid" with oid 2950..' warnings
         type_map.default_type_map = PG::TypeMapAllStrings.new
 
-        # Timestamp decoder
+        # Timestamp decoder. FIXME What is this? Why only Timestamp and not
+        # Timestamptz?
         type_map.add_coder PG::TextDecoder::Timestamp.new( # Timestamp without time zone
             oid: 1114,
             flags: PG::Coder::TIMESTAMP_DB_UTC | PG::Coder::TIMESTAMP_APP_UTC)
 
-        # Decode anonymous records but note that this is only useful to convert the
-        # outermost structure into an array, the elements are not decoded and are
-        # returned as strings. It is best to avoid anonymous records if possible
+        # Decode anonymous records but note that this is only useful to convert
+        # the outermost structure into an array, the elements are not decoded
+        # and are returned as strings. It is best to avoid anonymous records if
+        # possible
         type_map.add_coder PG::TextDecoder::Record.new(
             oid: 2249
         )
 
         @pg_connection.type_map_for_results = type_map
         @pg_connection.field_name_type = @field_name_class.to_s.downcase.to_sym # Use symbol field names
-        @pg_connection.exec "set client_min_messages to warning;" # Silence warnings
       end
 
+      # Set options even if there is no connection to avoid special casing
+      # absent options
+      @options, @default_options = {}, DEFAULT_OPTIONS.merge(options)
+      set_options(options) if @pg_connection
+
       @schema = SchemaMethods.new(self)
       @role = RoleMethods.new(self)
       @rdbms = RdbmsMethods.new(self)
@@ -307,6 +356,8 @@ module PgConn
     # per-session settings in #initialize? Are they cleared by #reset too?)
     def reset
       @pg_connection.reset
+      self.warning = false
+      self.notice = false
       @pg_connection.exec "set client_min_messages to warning;" # Silence warnings
     end
 
@@ -644,7 +695,7 @@ module PgConn
     # of the function.  If the :proc option is true the "function" is assumed
     # to be a procedure
     #
-    def call(name, *args, elem_type: nil, silent: false, proc: false) # :proc may interfere with hashes
+    def call(name, *args, elem_type: nil, silent: self.silent, proc: false) # :proc may interfere with hashes
       args_seq = quote_values(args, elem_type: elem_type)
       if proc
         pg_exec "call #{name}(#{args_seq})", silent: silent
@@ -668,7 +719,7 @@ module PgConn
     end
 
     # Like #call with :proc set to true
-    def proc(name, *args, silent: false)
+    def proc(name, *args, silent: self.silent)
       call(name, *args, silent: silent, proc: true)
     end
 
@@ -776,6 +827,21 @@ module PgConn
       exec %(delete from #{table} where #{constraint})
     end
 
+    # Execute block with global options and resets afterwards. Currently only
+    # :silent, :notice and :warning is supported. Very useful in RSpec tests
+    #
+    # TODO: :error, :fail, :symbol, :schema, :search_path
+    #
+    def with(**options, &block)
+      begin
+        saved_options = @options.dup
+        set_options(options)
+        yield
+      ensure
+        set_options(saved_options)
+      end
+    end
+
     # Execute SQL statement(s) in a transaction and return the number of
     # affected records (if any). Also sets #timestamp unless a transaction is
     # already in progress. The +sql+ argument can be a command (String) or an
@@ -783,8 +849,8 @@ module PgConn
     # that span multiple lines. The empty array is a NOP but the empty string
     # is not.
     #
-    # #exec pass Postgres exceptions to the caller unless :fail is false in which case
-    # it returns nil.
+    # #exec pass Postgres exceptions to the caller unless :fail is false in
+    # which case it returns nil if an error occurred
     #
     # Note that postgres crashes the whole transaction stack if any error is
     # met so if you're inside a transaction, the transaction will be in an
@@ -792,14 +858,14 @@ module PgConn
     # transaction stack has collapsed
     #
     # TODO: Make sure the transaction stack is emptied on postgres errors
-    def exec(sql, commit: true, fail: true, silent: false)
+    def exec(sql, commit: true, fail: true, silent: self.silent)
       transaction(commit: commit) { execute(sql, fail: fail, silent: silent) }
     end
 
-    # Like #exec but returns true/false depending on if the command succeeded.
-    # There is not a corresponding #execute? method because any failure rolls
-    # back the whole transaction stack. TODO: Check which exceptions that
-    # should be captured
+    # Like #exec but returns true/false depending on if the command succeeded,
+    # error messages are suppressed by default.  There is no corresponding
+    # #execute? method because any failure rolls back the whole transaction
+    # stack. TODO: Check which exceptions that should be captured
     def exec?(sql, commit: true, silent: true)
       begin
         exec(sql, commit: commit, fail: true, silent: silent)
@@ -817,7 +883,7 @@ module PgConn
     # unless :fail is false in which case it returns nil
     #
     # TODO: Handle postgres exceptions wrt transaction state and stack
-    def execute(sql, fail: true, silent: false)
+    def execute(sql, fail: true, silent: self.silent)
       if @pg_connection
         begin
           pg_exec(sql, silent: silent)&.cmd_tuples
@@ -938,6 +1004,9 @@ module PgConn
     # PgConn::Rollback exception in which case #transaction returns nil. Note
     # that the transaction timestamp is set to the start of the first
     # transaction even if transactions are nested
+    #
+    # FIXME: There is some strange problem in rspec where an #insert handles
+    # an exception correctly while #exec, #execute, and #transaction does not
     def transaction(commit: true, &block)
       if block_given?
         result = nil
@@ -1102,6 +1171,68 @@ module PgConn
       "select #{field_list} from #{table} where #{where_clause}"
     end
 
+    STDOUT_PRODUCER = lambda { |msg| $stdout.puts msg }
+    STDERR_PRODUCER = lambda { |msg| $stderr.puts msg }
+
+    # FIXME Fails if connection is copied - requires a common options object
+    # that is shared between all connection copies
+    def set_option(option, value)
+      case option
+        when :silent
+          @options[:silent] =
+              case value
+                when true, false; value
+                when nil; @default_options[:silent]
+              else
+                raise ArgumentError, "Illegal value #{value.inspect}"
+              end
+        when :notice, :warning
+          @options[option] =
+              case value
+                when true; option == :notice ? STDOUT_PRODUCER : STDERR_PRODUCER
+                when false; nil
+                when nil; @default_options[option]
+                when Proc; value
+              else
+                raise ArgumentError, "Illegal value #{value.inspect}"
+              end
+          enabled = !@options[option].nil?
+          if option == :notice
+            if enabled
+              @pg_connection.exec "set client_min_messages to notice"
+            elsif warning
+              @pg_connection.exec "set client_min_messages to warning"
+            else
+              @pg_connection.exec "set client_min_messages to error"
+            end
+          elsif !notice
+            if enabled
+              @pg_connection.exec "set client_min_messages to notice"
+            else
+              @pg_connection.exec "set client_min_messages to error"
+            end
+          end
+      else
+        raise ArgumentError, "Illegal option: #{option.inspect}"
+      end
+    end
+
+    def set_options(opts)
+      opts.each { |k,v| set_option(k,v) if !@options.key?(k) || @options[k] != v }
+    end
+
+    def get_options() @options.dup end
+
+    # Called from postgres. Installed in #initialize
+    def message_processor(message)
+      case message
+        when /^NOTICE:\s*(.*)$/; @options[:notice]&.call($1)
+        when /^WARNING:\s*(.*)$/; @options[:warning]&.call($1)
+      else
+        raise "Oops"
+      end
+    end
+
     # :call-seq:
     #   pg_exec(string)
     #   pg_exec(array)
@@ -1121,7 +1252,7 @@ module PgConn
     # though
     #
     # TODO: Fix silent by not handling exceptions
-    def pg_exec(arg, silent: false)
+    def pg_exec(arg, silent: self.silent)
       if @pg_connection
         begin
           last_stmt = nil # To make the current SQL statement visible to the rescue clause. FIXME Not used?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_conn
 version: !ruby/object:Gem::Version
-  version: 0.33.1
+  version: 0.35.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg