pg 1.4.5 → 1.5.4

data/lib/pg/connection.rb

@@ -2,8 +2,7 @@
 # frozen_string_literal: true
 
 require 'pg' unless defined?( PG )
-require 'uri'
-require 'io/wait'
+require 'io/wait' unless ::IO.public_instance_methods(false).include?(:wait_readable)
 require 'socket'
 
 # The PostgreSQL connection class. The interface for this class is based on
@@ -31,8 +30,8 @@ require 'socket'
 class PG::Connection
 
 	# The order the options are passed to the ::connect method.
-	CONNECT_ARGUMENT_ORDER = %w[host port options tty dbname user password]
-
+	CONNECT_ARGUMENT_ORDER = %w[host port options tty dbname user password].freeze
+	private_constant :CONNECT_ARGUMENT_ORDER
 
 	### Quote a single +value+ for use in a connection-parameter string.
 	def self.quote_connstr( value )
@@ -46,6 +45,10 @@ class PG::Connection
 		hash.map { |k,v| "#{k}=#{quote_connstr(v)}" }.join( ' ' )
 	end
 
+	# Shareable program name for Ractor
+	PROGRAM_NAME = $PROGRAM_NAME.dup.freeze
+	private_constant :PROGRAM_NAME
+
 	# Parse the connection +args+ into a connection-parameter string.
 	# See PG::Connection.new for valid arguments.
 	#
@@ -63,8 +66,8 @@ class PG::Connection
 		iopts = {}
 
 		if args.length == 1
-			case args.first
-			when URI, /=/, /:\/\//
+			case args.first.to_s
+			when /=/, /:\/\//
 				# Option or URL string style
 				conn_string = args.first.to_s
 				iopts = PG::Connection.conninfo_parse(conn_string).each_with_object({}){|h, o| o[h[:keyword].to_sym] = h[:val] if h[:val] }
@@ -87,7 +90,7 @@ class PG::Connection
 		iopts.merge!( hash_arg )
 
 		if !iopts[:fallback_application_name]
-			iopts[:fallback_application_name] = $0.sub( /^(.{30}).{4,}(.{30})$/ ){ $1+"..."+$2 }
+			iopts[:fallback_application_name] = PROGRAM_NAME.sub( /^(.{30}).{4,}(.{30})$/ ){ $1+"..."+$2 }
 		end
 
 		return connect_hash_to_string(iopts)
@@ -114,6 +117,9 @@ class PG::Connection
 		return str
 	end
 
+	BinarySignature = "PGCOPY\n\377\r\n\0".b
+	private_constant :BinarySignature
+
 	#  call-seq:
 	#     conn.copy_data( sql [, coder] ) {|sql_result| ... } -> PG::Result
 	#
@@ -160,6 +166,14 @@ class PG::Connection
 	#     conn.put_copy_data ['more', 'data', 'to', 'copy']
 	#   end
 	#
+	# Also PG::BinaryEncoder::CopyRow can be used to send data in binary format to the server.
+	# In this case copy_data generates the header and trailer data automatically:
+	#   enco = PG::BinaryEncoder::CopyRow.new
+	#   conn.copy_data "COPY my_table FROM STDIN (FORMAT binary)", enco do
+	#     conn.put_copy_data ['some', 'data', 'to', 'copy']
+	#     conn.put_copy_data ['more', 'data', 'to', 'copy']
+	#   end
+	#
 	# Example with CSV output format:
 	#   conn.copy_data "COPY my_table TO STDOUT CSV" do
 	#     while row=conn.get_copy_data
@@ -181,6 +195,18 @@ class PG::Connection
 	# This receives all rows of +my_table+ as ruby array:
 	#   ["some", "data", "to", "copy"]
 	#   ["more", "data", "to", "copy"]
+	#
+	# Also PG::BinaryDecoder::CopyRow can be used to retrieve data in binary format from the server.
+	# In this case the header and trailer data is processed by the decoder and the remaining +nil+ from get_copy_data is processed by copy_data, so that binary data can be processed equally to text data:
+	#   deco = PG::BinaryDecoder::CopyRow.new
+	#   conn.copy_data "COPY my_table TO STDOUT (FORMAT binary)", deco do
+	#     while row=conn.get_copy_data
+	#       p row
+	#     end
+	#   end
+	# This receives all rows of +my_table+ as ruby array:
+	#   ["some", "data", "to", "copy"]
+	#   ["more", "data", "to", "copy"]
 
 	def copy_data( sql, coder=nil )
 		raise PG::NotInBlockingMode.new("copy_data can not be used in nonblocking mode", connection: self) if nonblocking?
@@ -189,18 +215,38 @@ class PG::Connection
 		case res.result_status
 		when PGRES_COPY_IN
 			begin
+				if coder && res.binary_tuples == 1
+					# Binary file header (11 byte signature, 32 bit flags and 32 bit extension length)
+					put_copy_data(BinarySignature + ("\x00" * 8))
+				end
+
 				if coder
 					old_coder = self.encoder_for_put_copy_data
 					self.encoder_for_put_copy_data = coder
 				end
+
 				yield res
 			rescue Exception => err
 				errmsg = "%s while copy data: %s" % [ err.class.name, err.message ]
-				put_copy_end( errmsg )
-				get_result
-				raise
+				begin
+					put_copy_end( errmsg )
+				rescue PG::Error
+					# Ignore error in cleanup to avoid losing original exception
+				end
+				discard_results
+				raise err
 			else
-				put_copy_end
+				begin
+					self.encoder_for_put_copy_data = old_coder if coder
+
+					if coder && res.binary_tuples == 1
+						put_copy_data("\xFF\xFF") # Binary file trailer 16 bit "-1"
+					end
+
+					put_copy_end
+				rescue PG::Error => err
+					raise PG::LostCopyState.new("#{err} (probably by executing another SQL query while running a COPY command)", connection: self)
+				end
 				get_last_result
 			ensure
 				self.encoder_for_put_copy_data = old_coder if coder
@@ -213,24 +259,25 @@ class PG::Connection
 					self.decoder_for_get_copy_data = coder
 				end
 				yield res
-			rescue Exception => err
+			rescue Exception
 				cancel
-				begin
-					while get_copy_data
+				discard_results
+				raise
+			else
+				if coder && res.binary_tuples == 1
+					# There are two end markers in binary mode: file trailer and the final nil.
+					# The file trailer is expected to be processed by BinaryDecoder::CopyRow and already returns nil, so that the remaining NULL from PQgetCopyData is retrieved here:
+					if get_copy_data
+						discard_results
+						raise PG::NotAllCopyDataRetrieved.new("Not all binary COPY data retrieved", connection: self)
 					end
-				rescue PG::Error
-					# Ignore error in cleanup to avoid losing original exception
-				end
-				while get_result
 				end
-				raise err
-			else
 				res = get_last_result
-				if !res || res.result_status != PGRES_COMMAND_OK
-					while get_copy_data
-					end
-					while get_result
-					end
+				if !res
+					discard_results
+					raise PG::LostCopyState.new("Lost COPY state (probably by executing another SQL query while running a COPY command)", connection: self)
+				elsif res.result_status != PGRES_COMMAND_OK
+					discard_results
 					raise PG::NotAllCopyDataRetrieved.new("Not all COPY data retrieved", connection: self)
 				end
 				res
@@ -319,6 +366,23 @@ class PG::Connection
 		end
 	end
 
+	# Read all pending socket input to internal memory and raise an exception in case of errors.
+	#
+	# This verifies that the connection socket is in a usable state and not aborted in any way.
+	# No communication is done with the server.
+	# Only pending data is read from the socket - the method doesn't wait for any outstanding server answers.
+	#
+	# Raises a kind of PG::Error if there was an error reading the data or if the socket is in a failure state.
+	#
+	# The method doesn't verify that the server is still responding.
+	# To verify that the communication to the server works, it is recommended to use something like <tt>conn.exec('')</tt> instead.
+	def check_socket
+		while socket_io.wait_readable(0)
+			consume_input
+		end
+		nil
+	end
+
 	# call-seq:
 	#    conn.get_result() -> PG::Result
 	#    conn.get_result() {|pg_result| block }
@@ -773,7 +837,10 @@ class PG::Connection
 		#    PG::Connection.ping(connection_string)     -> Integer
 		#    PG::Connection.ping(host, port, options, tty, dbname, login, password) ->  Integer
 		#
-		# Check server status.
+		# PQpingParams reports the status of the server.
+		#
+		# It accepts connection parameters identical to those of PQ::Connection.new .
+		# It is not necessary to supply correct user name, password, or database name values to obtain the server status; however, if incorrect values are provided, the server will log a failed connection attempt.
 		#
 		# See PG::Connection.new for a description of the parameters.
 		#
@@ -786,6 +853,8 @@ class PG::Connection
 		#   could not establish connection
 		# [+PQPING_NO_ATTEMPT+]
 		#   connection not attempted (bad params)
+		#
+		# See also check_socket for a way to check the connection without doing any server communication.
 		def ping(*args)
 			if Fiber.respond_to?(:scheduler) && Fiber.scheduler
 				# Run PQping in a second thread to avoid blocking of the scheduler.
@@ -797,23 +866,25 @@ class PG::Connection
 		end
 		alias async_ping ping
 
-		REDIRECT_CLASS_METHODS = {
+		REDIRECT_CLASS_METHODS = PG.make_shareable({
 			:new => [:async_connect, :sync_connect],
 			:connect => [:async_connect, :sync_connect],
 			:open => [:async_connect, :sync_connect],
 			:setdb => [:async_connect, :sync_connect],
 			:setdblogin => [:async_connect, :sync_connect],
 			:ping => [:async_ping, :sync_ping],
-		}
+		})
+		private_constant :REDIRECT_CLASS_METHODS
 
 		# These methods are affected by PQsetnonblocking
-		REDIRECT_SEND_METHODS = {
+		REDIRECT_SEND_METHODS = PG.make_shareable({
 			:isnonblocking => [:async_isnonblocking, :sync_isnonblocking],
 			:nonblocking? => [:async_isnonblocking, :sync_isnonblocking],
 			:put_copy_data => [:async_put_copy_data, :sync_put_copy_data],
 			:put_copy_end => [:async_put_copy_end, :sync_put_copy_end],
 			:flush => [:async_flush, :sync_flush],
-		}
+		})
+		private_constant :REDIRECT_SEND_METHODS
 		REDIRECT_METHODS = {
 			:exec => [:async_exec, :sync_exec],
 			:query => [:async_exec, :sync_exec],
@@ -831,12 +902,14 @@ class PG::Connection
 			:client_encoding= => [:async_set_client_encoding, :sync_set_client_encoding],
 			:cancel => [:async_cancel, :sync_cancel],
 		}
+		private_constant :REDIRECT_METHODS
 
 		if PG::Connection.instance_methods.include? :async_encrypt_password
 			REDIRECT_METHODS.merge!({
 				:encrypt_password => [:async_encrypt_password, :sync_encrypt_password],
 			})
 		end
+		PG.make_shareable(REDIRECT_METHODS)
 
 		def async_send_api=(enable)
 			REDIRECT_SEND_METHODS.each do |ali, (async, sync)|

data/lib/pg/exceptions.rb

@@ -14,5 +14,12 @@ module PG
 		end
 	end
 
+	class NotAllCopyDataRetrieved < PG::Error
+	end
+	class LostCopyState < PG::Error
+	end
+	class NotInBlockingMode < PG::Error
+	end
+
 end # module PG
 

data/lib/pg/text_decoder/date.rb

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'date'
+
+module PG
+	module TextDecoder
+		class Date < SimpleDecoder
+			def decode(string, tuple=nil, field=nil)
+				if string =~ /\A(\d{4})-(\d\d)-(\d\d)\z/
+					::Date.new $1.to_i, $2.to_i, $3.to_i
+				else
+					string
+				end
+			end
+		end
+	end
+end # module PG

data/lib/pg/text_decoder/inet.rb

@@ -0,0 +1,9 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+module PG
+	module TextDecoder
+		# Init C part of the decoder
+		init_inet
+	end
+end # module PG

data/lib/pg/text_decoder/json.rb

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'json'
+
+module PG
+	module TextDecoder
+		class JSON < SimpleDecoder
+			def decode(string, tuple=nil, field=nil)
+				::JSON.parse(string, quirks_mode: true)
+			end
+		end
+	end
+end # module PG

data/lib/pg/text_decoder/numeric.rb

@@ -0,0 +1,9 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+module PG
+	module TextDecoder
+		# Init C part of the decoder
+		init_numeric
+	end
+end # module PG

data/lib/pg/text_decoder/timestamp.rb

@@ -0,0 +1,30 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+module PG
+	module TextDecoder
+		# Convenience classes for timezone options
+		class TimestampUtc < Timestamp
+			def initialize(hash={}, **kwargs)
+				warn("PG::Coder.new(hash) is deprecated. Please use keyword arguments instead! Called from #{caller.first}", category: :deprecated) unless hash.empty?
+				super(**hash, **kwargs, flags: PG::Coder::TIMESTAMP_DB_UTC | PG::Coder::TIMESTAMP_APP_UTC)
+			end
+		end
+		class TimestampUtcToLocal < Timestamp
+			def initialize(hash={}, **kwargs)
+				warn("PG::Coder.new(hash) is deprecated. Please use keyword arguments instead! Called from #{caller.first}", category: :deprecated) unless hash.empty?
+				super(**hash, **kwargs, flags: PG::Coder::TIMESTAMP_DB_UTC | PG::Coder::TIMESTAMP_APP_LOCAL)
+			end
+		end
+		class TimestampLocal < Timestamp
+			def initialize(hash={}, **kwargs)
+				warn("PG::Coder.new(hash) is deprecated. Please use keyword arguments instead! Called from #{caller.first}", category: :deprecated) unless hash.empty?
+				super(**hash, **kwargs, flags: PG::Coder::TIMESTAMP_DB_LOCAL | PG::Coder::TIMESTAMP_APP_LOCAL)
+			end
+		end
+
+		# For backward compatibility:
+		TimestampWithoutTimeZone = TimestampLocal
+		TimestampWithTimeZone = Timestamp
+	end
+end # module PG

data/lib/pg/text_encoder/date.rb

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+module PG
+	module TextEncoder
+		class Date < SimpleEncoder
+			def encode(value)
+				value.respond_to?(:strftime) ? value.strftime("%Y-%m-%d") : value
+			end
+		end
+	end
+end # module PG

data/lib/pg/text_encoder/inet.rb

@@ -0,0 +1,28 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'ipaddr'
+
+module PG
+	module TextEncoder
+		class Inet < SimpleEncoder
+			def encode(value)
+				case value
+				when IPAddr
+					default_prefix = (value.family == Socket::AF_INET ? 32 : 128)
+					s = value.to_s
+					if value.respond_to?(:prefix)
+						prefix = value.prefix
+					else
+						range = value.to_range
+						prefix  = default_prefix - Math.log(((range.end.to_i - range.begin.to_i) + 1), 2).to_i
+					end
+					s << "/" << prefix.to_s if prefix != default_prefix
+					s
+				else
+					value
+				end
+			end
+		end
+	end
+end # module PG

data/lib/pg/text_encoder/json.rb

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'json'
+
+module PG
+	module TextEncoder
+		class JSON < SimpleEncoder
+			def encode(value)
+				::JSON.generate(value, quirks_mode: true)
+			end
+		end
+	end
+end # module PG

data/lib/pg/text_encoder/numeric.rb

@@ -0,0 +1,9 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+module PG
+	module TextEncoder
+		# Init C part of the decoder
+		init_numeric
+	end
+end # module PG

data/lib/pg/text_encoder/timestamp.rb

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+module PG
+	module TextEncoder
+		class TimestampWithoutTimeZone < SimpleEncoder
+			def encode(value)
+				value.respond_to?(:strftime) ? value.strftime("%Y-%m-%d %H:%M:%S.%N") : value
+			end
+		end
+
+		class TimestampUtc < SimpleEncoder
+			def encode(value)
+				value.respond_to?(:utc) ? value.utc.strftime("%Y-%m-%d %H:%M:%S.%N") : value
+			end
+		end
+
+		class TimestampWithTimeZone < SimpleEncoder
+			def encode(value)
+				value.respond_to?(:strftime) ? value.strftime("%Y-%m-%d %H:%M:%S.%N %:z") : value
+			end
+		end
+	end
+end # module PG

data/lib/pg/version.rb

@@ -1,4 +1,4 @@
 module PG
 	# Library version
-	VERSION = '1.4.5'
+	VERSION = '1.5.4'
 end

data/lib/pg.rb

@@ -50,12 +50,6 @@ module PG
 		end
 	end
 
-
-	class NotAllCopyDataRetrieved < PG::Error
-	end
-	class NotInBlockingMode < PG::Error
-	end
-
 	# Get the PG library version.
 	#
 	# +include_buildnum+ is no longer used and any value passed will be ignored.
@@ -69,21 +63,67 @@ module PG
 		Connection.new( *args, &block )
 	end
 
+	if defined?(Ractor.make_shareable)
+		def self.make_shareable(obj)
+			Ractor.make_shareable(obj)
+		end
+	else
+		def self.make_shareable(obj)
+			obj.freeze
+		end
+	end
+
+	module BinaryDecoder
+		%i[ TimestampUtc TimestampUtcToLocal TimestampLocal ].each do |klass|
+			autoload klass, 'pg/binary_decoder/timestamp'
+		end
+		autoload :Date, 'pg/binary_decoder/date'
+	end
+	module BinaryEncoder
+		%i[ TimestampUtc TimestampLocal ].each do |klass|
+			autoload klass, 'pg/binary_encoder/timestamp'
+		end
+	end
+	module TextDecoder
+		%i[ TimestampUtc TimestampUtcToLocal TimestampLocal TimestampWithoutTimeZone TimestampWithTimeZone ].each do |klass|
+			autoload klass, 'pg/text_decoder/timestamp'
+		end
+		autoload :Date, 'pg/text_decoder/date'
+		autoload :Inet, 'pg/text_decoder/inet'
+		autoload :JSON, 'pg/text_decoder/json'
+		autoload :Numeric, 'pg/text_decoder/numeric'
+	end
+	module TextEncoder
+		%i[ TimestampUtc TimestampWithoutTimeZone TimestampWithTimeZone ].each do |klass|
+			autoload klass, 'pg/text_encoder/timestamp'
+		end
+		autoload :Date, 'pg/text_encoder/date'
+		autoload :Inet, 'pg/text_encoder/inet'
+		autoload :JSON, 'pg/text_encoder/json'
+		autoload :Numeric, 'pg/text_encoder/numeric'
+	end
 
+	autoload :BasicTypeMapBasedOnResult, 'pg/basic_type_map_based_on_result'
+	autoload :BasicTypeMapForQueries, 'pg/basic_type_map_for_queries'
+	autoload :BasicTypeMapForResults, 'pg/basic_type_map_for_results'
+	autoload :BasicTypeRegistry, 'pg/basic_type_registry'
 	require 'pg/exceptions'
-	require 'pg/constants'
 	require 'pg/coder'
-	require 'pg/binary_decoder'
-	require 'pg/text_encoder'
-	require 'pg/text_decoder'
-	require 'pg/basic_type_registry'
-	require 'pg/basic_type_map_based_on_result'
-	require 'pg/basic_type_map_for_queries'
-	require 'pg/basic_type_map_for_results'
 	require 'pg/type_map_by_column'
 	require 'pg/connection'
 	require 'pg/result'
 	require 'pg/tuple'
-	require 'pg/version'
+	autoload :VERSION, 'pg/version'
+
+
+	# Avoid "uninitialized constant Truffle::WarningOperations" on Truffleruby up to 22.3.1
+	if RUBY_ENGINE=="truffleruby" && !defined?(Truffle::WarningOperations)
+		module TruffleFixWarn
+			def warn(str, category=nil)
+				super(str)
+			end
+		end
+		Warning.extend(TruffleFixWarn)
+	end
 
 end # module PG

data/pg.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ged/ruby-pg"
-  spec.metadata["changelog_uri"] = "https://github.com/ged/ruby-pg/blob/master/History.rdoc"
+  spec.metadata["changelog_uri"] = "https://github.com/ged/ruby-pg/blob/master/History.md"
   spec.metadata["documentation_uri"] = "http://deveiate.org/code/pg"
 
   # Specify which files should be added to the gem when it is released.
@@ -28,5 +28,7 @@ Gem::Specification.new do |spec|
   spec.extensions    = ["ext/extconf.rb"]
   spec.require_paths = ["lib"]
   spec.cert_chain    = ["certs/ged.pem"]
-  spec.rdoc_options  = ["--main", "README.rdoc"]
+  spec.rdoc_options  = ["--main", "README.md",
+                        "--title", "PG: The Ruby PostgreSQL Driver"]
+  spec.extra_rdoc_files = `git ls-files -z *.rdoc *.md lib/*.rb lib/*/*.rb lib/*/*/*.rb ext/*.c ext/*.h`.split("\x0")
 end

data/rakelib/task_extension.rb

@@ -9,7 +9,7 @@ module TaskExtension
   def file(name, *args, &block)
     task_once(name, block) do
       super(name, *args) do |ta|
-        block.call(ta).tap do
+        block&.call(ta).tap do
           raise "file #{ta.name} is missing after task executed" unless File.exist?(ta.name)
         end
       end

data/translation/.po4a-version

@@ -0,0 +1,7 @@
+po4a version 0.68.
+Written by Martin Quinson and Denis Barbier.
+
+Copyright © 2002-2022 Software in the Public Interest, Inc.
+This is free software; see source code for copying
+conditions. There is NO warranty; not even for
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.