pg_conn 0.33.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d008acfbbae8f338d5f83bcdacc35b40b67b986b04068dc82b9ae7fd8053e8d4
-  data.tar.gz: 617b133d7c15c9e358b23331883b3ec7228227d3d70db59b5e7a74b01f111bf5
+  metadata.gz: 6d18d4244a00a767589287122f298966ccdd9e8d53a6467f84097df698be34a6
+  data.tar.gz: 6ad5c4c5cf19459996d744e25627cd852d03fa1fa25688572c40de71a5a61100
 SHA512:
-  metadata.gz: 9c742a5c22f61d1add1b77b0c50047c596d901416b32d202e16eddc38f6718fe5357550e029fe863406c0243d157632dbe61bea85dc9428d9b862f8ec512fe8f
-  data.tar.gz: adae387af6cf778c870bdae60beb94d12634c079048748d146bab24b6035ce4295968f72467a3283be5afe79360306e22279ce94d1e36d5c893e90918cd5f952
+  metadata.gz: 9a476b27de6f211d02957c543cf2ee0742011e3d06a468a006fee143827c3cceb8ad32610ca5dee5692cf0230a4c188dd6a4a57335e1eb51d48bc23a9a52e7d3
+  data.tar.gz: 89dcdcec1bdd52d6b2a6ce56ee688e77661f7d438187e289d26e9344d9d030450caea180e260348050c9abcfd34261465fa1d82cefbded641e16ffde708250b5

data/lib/pg_conn/version.rb

@@ -1,3 +1,3 @@
 module PgConn
-  VERSION = "0.33.0"
+  VERSION = "0.34.0"
 end

data/lib/pg_conn.rb

@@ -147,13 +147,32 @@ 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 notices. Valid values are 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
+    def notice=(value) set_option(:notice, value) end
+    def notice() @options[:notice] end
+
+    # Controls warnings. Valid values are 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
+    def warning=(value) set_option(:warning, value) end
+    def warning() @options[:warning] 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 +182,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 +206,17 @@ module PgConn
     # if absent in the Postgres error message
     def errchar = err[2]
 
+    DEFAULT_OPTIONS = { 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 +239,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 +249,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 +300,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,21 +314,25 @@ module PgConn
         # type "uuid" with oid 2950..' warnings
         type_map.default_type_map = PG::TypeMapAllStrings.new
 
-        # Timestamp decoder
+        # Timestamp decoder. FIXME What is this?
         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
+
+        @options, @default_options = {}, DEFAULT_OPTIONS
+        set_options(options) # require @default_options
+        @default_options = @options.dup
       end
 
       @schema = SchemaMethods.new(self)
@@ -307,6 +346,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
 
@@ -776,6 +817,21 @@ module PgConn
       exec %(delete from #{table} where #{constraint})
     end
 
+    # Execute block with global options and resets afterwards. Currently only
+    # :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 +839,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
@@ -889,7 +945,7 @@ module PgConn
         # and log as a side-effect)
         if @pg_connection
             @timestamp, @timestamptz = @pg_connection.exec(
-                'select current_timestamp, current_timestamp::timestamp without time zone'
+                'select current_timestamp::timestamp without time zone, current_timestamp'
             ).tuple_values(0)
         end
       end
@@ -1102,6 +1158,60 @@ 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 :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)

metadata

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