pg 1.1.3 → 1.2.0

data/lib/pg/constants.rb

@@ -1,4 +1,5 @@
 # -*- ruby -*-
+# frozen_string_literal: true
 
 require 'pg' unless defined?( PG )
 

data/lib/pg/exceptions.rb

@@ -1,4 +1,5 @@
 # -*- ruby -*-
+# frozen_string_literal: true
 
 require 'pg' unless defined?( PG )
 

data/lib/pg/result.rb

@@ -1,4 +1,5 @@
 # -*- ruby -*-
+# frozen_string_literal: true
 
 require 'pg' unless defined?( PG )
 
@@ -9,12 +10,23 @@ class PG::Result
 	#
 	# +type_map+: a PG::TypeMap instance.
 	#
-	# See PG::BasicTypeMapForResults
+	# This method is equal to #type_map= , but returns self, so that calls can be chained.
+	#
+	# See also PG::BasicTypeMapForResults
 	def map_types!(type_map)
 		self.type_map = type_map
 		return self
 	end
 
+	# Set the data type for all field name returning methods.
+	#
+	# +type+: a Symbol defining the field name type.
+	#
+	# This method is equal to #field_name_type= , but returns self, so that calls can be chained.
+	def field_names_as(type)
+		self.field_name_type = type
+		return self
+	end
 
 	### Return a String representation of the object suitable for debugging.
 	def inspect

data/lib/pg/text_decoder.rb

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

data/lib/pg/text_encoder.rb

@@ -1,4 +1,5 @@
 # -*- ruby -*-
+# frozen_string_literal: true
 
 require 'json'
 require 'ipaddr'
@@ -6,36 +7,26 @@ require 'ipaddr'
 module PG
 	module TextEncoder
 		class Date < SimpleEncoder
-			STRFTIME_ISO_DATE = "%Y-%m-%d".freeze
 			def encode(value)
-				value.respond_to?(:strftime) ? value.strftime(STRFTIME_ISO_DATE) : value
+				value.respond_to?(:strftime) ? value.strftime("%Y-%m-%d") : value
 			end
 		end
 
 		class TimestampWithoutTimeZone < SimpleEncoder
-			STRFTIME_ISO_DATETIME_WITHOUT_TIMEZONE = "%Y-%m-%d %H:%M:%S.%N".freeze
 			def encode(value)
-				value.respond_to?(:strftime) ? value.strftime(STRFTIME_ISO_DATETIME_WITHOUT_TIMEZONE) : value
+				value.respond_to?(:strftime) ? value.strftime("%Y-%m-%d %H:%M:%S.%N") : value
 			end
 		end
 
 		class TimestampUtc < SimpleEncoder
-			STRFTIME_ISO_DATETIME_WITHOUT_TIMEZONE_UTC = "%Y-%m-%d %H:%M:%S.%N".freeze
 			def encode(value)
-				value.respond_to?(:utc) ? value.utc.strftime(STRFTIME_ISO_DATETIME_WITHOUT_TIMEZONE_UTC) : value
+				value.respond_to?(:utc) ? value.utc.strftime("%Y-%m-%d %H:%M:%S.%N") : value
 			end
 		end
 
 		class TimestampWithTimeZone < SimpleEncoder
-			STRFTIME_ISO_DATETIME_WITH_TIMEZONE = "%Y-%m-%d %H:%M:%S.%N %:z".freeze
 			def encode(value)
-				value.respond_to?(:strftime) ? value.strftime(STRFTIME_ISO_DATETIME_WITH_TIMEZONE) : value
-			end
-		end
-
-		class Numeric < SimpleEncoder
-			def encode(value)
-				value.is_a?(BigDecimal) ? value.to_s('F') : value
+				value.respond_to?(:strftime) ? value.strftime("%Y-%m-%d %H:%M:%S.%N %:z") : value
 			end
 		end
 
@@ -51,12 +42,12 @@ module PG
 				when IPAddr
 					default_prefix = (value.family == Socket::AF_INET ? 32 : 128)
 					s = value.to_s
-                                        if value.respond_to?(:prefix)
+					if value.respond_to?(:prefix)
 						prefix = value.prefix
-                                        else
+					else
 						range = value.to_range
 						prefix  = default_prefix - Math.log(((range.end.to_i - range.begin.to_i) + 1), 2).to_i
-                                        end
+					end
 					s << "/" << prefix.to_s if prefix != default_prefix
 					s
 				else
@@ -66,4 +57,3 @@ module PG
 		end
 	end
 end # module PG
-

data/lib/pg/type_map_by_column.rb

@@ -1,4 +1,5 @@
 # -*- ruby -*-
+# frozen_string_literal: true
 
 require 'pg' unless defined?( PG )
 
@@ -9,7 +10,7 @@ class PG::TypeMapByColumn
 	end
 
 	def inspect
-		type_strings = coders.map{|c| c ? "#{c.name}:#{c.format}" : 'nil' }
+		type_strings = coders.map{|c| c ? c.inspect_short : 'nil' }
 		"#<#{self.class} #{type_strings.join(' ')}>"
 	end
 end

data/spec/helpers.rb

@@ -172,18 +172,18 @@ module PG::TestingHelpers
 			datadir = testdir + 'data'
 			pidfile = datadir + 'postmaster.pid'
 			if pidfile.exist? && pid = pidfile.read.chomp.to_i
-				$stderr.puts "pidfile (%p) exists: %d" % [ pidfile, pid ]
+				trace "pidfile (%p) exists: %d" % [ pidfile, pid ]
 				begin
 					Process.kill( 0, pid )
 				rescue Errno::ESRCH
-					$stderr.puts "No postmaster running for %s" % [ datadir ]
+					trace "No postmaster running for %s" % [ datadir ]
 					# Process isn't alive, so don't try to stop it
 				else
-					$stderr.puts "Stopping lingering database at PID %d" % [ pid ]
+					trace "Stopping lingering database at PID %d" % [ pid ]
 					run 'pg_ctl', '-D', datadir.to_s, '-m', 'fast', 'stop'
 				end
 			else
-				$stderr.puts "No pidfile (%p)" % [ pidfile ]
+				trace "No pidfile (%p)" % [ pidfile ]
 			end
 		end
 	end
@@ -194,12 +194,12 @@ module PG::TestingHelpers
 		require 'pg'
 		stop_existing_postmasters()
 
-		puts "Setting up test database for #{description}"
+		trace "Setting up test database for #{description}"
 		@test_pgdata = TEST_DIRECTORY + 'data'
 		@test_pgdata.mkpath
 
-		@port = 54321
-		ENV['PGPORT'] = @port.to_s
+		ENV['PGPORT'] ||= "54321"
+		@port = ENV['PGPORT'].to_i
 		ENV['PGHOST'] = 'localhost'
 		@conninfo = "host=localhost port=#{@port} dbname=test"
 
@@ -209,7 +209,7 @@ module PG::TestingHelpers
 		begin
 			unless (@test_pgdata+"postgresql.conf").exist?
 				FileUtils.rm_rf( @test_pgdata, :verbose => $DEBUG )
-				$stderr.puts "Running initdb"
+				trace "Running initdb"
 				log_and_run @logfile, 'initdb', '-E', 'UTF8', '--no-locale', '-D', @test_pgdata.to_s
 			end
 
@@ -218,7 +218,7 @@ module PG::TestingHelpers
 				'-D', @test_pgdata.to_s, 'start'
 			sleep 2
 
-			$stderr.puts "Creating the test DB"
+			trace "Creating the test DB"
 			log_and_run @logfile, 'psql', '-e', '-c', 'DROP DATABASE IF EXISTS test', 'postgres'
 			log_and_run @logfile, 'createdb', '-e', 'test'
 
@@ -239,7 +239,7 @@ module PG::TestingHelpers
 
 
 	def teardown_testing_db( conn )
-		puts "Tearing down test database"
+		trace "Tearing down test database"
 
 		if conn
 			check_for_lingering_connections( conn )
@@ -319,20 +319,19 @@ module PG::TestingHelpers
 		return ConnStillUsableMatcher.new
 	end
 
-	def wait_for_polling_ok(conn)
-		socket = conn.socket_io
-		status = conn.connect_poll
+	def wait_for_polling_ok(conn, meth = :connect_poll)
+		status = conn.send(meth)
 
 		while status != PG::PGRES_POLLING_OK
 			if status == PG::PGRES_POLLING_READING
-				select( [socket], [], [], 5.0 ) or
+				select( [conn.socket_io], [], [], 5.0 ) or
 					raise "Asynchronous connection timed out!"
 
 			elsif status == PG::PGRES_POLLING_WRITING
-				select( [], [socket], [], 5.0 ) or
+				select( [], [conn.socket_io], [], 5.0 ) or
 					raise "Asynchronous connection timed out!"
 			end
-			status = conn.connect_poll
+			status = conn.send(meth)
 		end
 	end
 
@@ -377,5 +376,7 @@ RSpec.configure do |config|
 	config.filter_run_excluding( :postgresql_93 ) if PG.library_version <  90300
 	config.filter_run_excluding( :postgresql_94 ) if PG.library_version <  90400
 	config.filter_run_excluding( :postgresql_95 ) if PG.library_version <  90500
+	config.filter_run_excluding( :postgresql_96 ) if PG.library_version <  90600
 	config.filter_run_excluding( :postgresql_10 ) if PG.library_version < 100000
+	config.filter_run_excluding( :postgresql_12 ) if PG.library_version < 120000
 end

data/spec/pg/basic_type_mapping_spec.rb

@@ -21,6 +21,14 @@ ensure
 	end
 end
 
+def expect_to_typecase_result_value_warning
+	warning = 'Warning: no type cast defined for type "name" with oid 19. '\
+		"Please cast this type explicitly to TEXT to be safe for future changes.\n"\
+		'Warning: no type cast defined for type "regproc" with oid 24. '\
+		"Please cast this type explicitly to TEXT to be safe for future changes.\n"
+	expect { yield }.to output(warning).to_stderr
+end
+
 describe 'Basic type mapping' do
 
 	describe PG::BasicTypeMapForQueries do
@@ -32,8 +40,8 @@ describe 'Basic type mapping' do
 		# Encoding Examples
 		#
 
-		it "should do basic param encoding", :ruby_19 do
-			res = @conn.exec_params( "SELECT $1::int8,$2::float,$3,$4::TEXT",
+		it "should do basic param encoding" do
+			res = @conn.exec_params( "SELECT $1::int8, $2::float, $3, $4::TEXT",
 				[1, 2.1, true, "b"], nil, basic_type_mapping )
 
 			expect( res.values ).to eq( [
@@ -43,26 +51,132 @@ describe 'Basic type mapping' do
 			expect( result_typenames(res) ).to eq( ['bigint', 'double precision', 'boolean', 'text'] )
 		end
 
-		it "should do array param encoding" do
-			res = @conn.exec_params( "SELECT $1,$2,$3,$4", [
-					[1, 2, 3], [[1, 2], [3, nil]],
-					[1.11, 2.21],
-					['/,"'.gsub("/", "\\"), nil, 'abcäöü'],
+		it "should do basic Time encoding" do
+			res = @conn.exec_params( "SELECT $1 AT TIME ZONE '-02'",
+				[Time.new(2019, 12, 8, 20, 38, 12.123, "-01:00")], nil, basic_type_mapping )
+
+			expect( res.values ).to eq( [[ "2019-12-08 23:38:12.123" ]] )
+		end
+
+		it "should do basic param encoding of various float values" do
+			res = @conn.exec_params( "SELECT $1::float, $2::float, $3::float, $4::float, $5::float, $6::float, $7::float, $8::float, $9::float, $10::float, $11::float, $12::float",
+				[0, 7, 9, 0.1, 0.9, -0.11, 10.11,
+			   9876543210987654321e-400,
+			   9876543210987654321e400,
+			   -1.234567890123456789e-280,
+			   -1.234567890123456789e280,
+			   9876543210987654321e280
+			  ], nil, basic_type_mapping )
+
+			expect( res.values[0][0, 9] ).to eq(
+					[ "0", "7", "9", "0.1", "0.9", "-0.11", "10.11", "0", "Infinity" ]
+			)
+
+			expect( res.values[0][9]  ).to match( /^-1\.2345678901234\d*e\-280$/ )
+			expect( res.values[0][10] ).to match( /^-1\.2345678901234\d*e\+280$/ )
+			expect( res.values[0][11] ).to match(  /^9\.8765432109876\d*e\+298$/ )
+
+			expect( result_typenames(res) ).to eq( ['double precision'] * 12 )
+		end
+
+		it "should do default array-as-array param encoding" do
+			expect( basic_type_mapping.encode_array_as).to eq(:array)
+			res = @conn.exec_params( "SELECT $1,$2,$3,$4,$5,$6", [
+					[1, 2, 3], # Integer -> bigint[]
+					[[1, 2], [3, nil]], # Integer two dimensions -> bigint[]
+					[1.11, 2.21], # Float -> double precision[]
+					['/,"'.gsub("/", "\\"), nil, 'abcäöü'], # String -> text[]
+					[BigDecimal("123.45")], # BigDecimal -> numeric[]
+					[IPAddr.new('1234::5678')], # IPAddr -> inet[]
 				], nil, basic_type_mapping )
 
 			expect( res.values ).to eq( [[
-					'{1,2,3}', '{{1,2},{3,NULL}}',
+					'{1,2,3}',
+					'{{1,2},{3,NULL}}',
 					'{1.11,2.21}',
 					'{"//,/"",NULL,abcäöü}'.gsub("/", "\\"),
+					'{123.45}',
+					'{1234::5678}',
 			]] )
 
-			expect( result_typenames(res) ).to eq( ['bigint[]', 'bigint[]', 'double precision[]', 'text[]'] )
+			expect( result_typenames(res) ).to eq( ['bigint[]', 'bigint[]', 'double precision[]', 'text[]', 'numeric[]', 'inet[]'] )
+		end
+
+		it "should do default array-as-array param encoding with Time objects" do
+			res = @conn.exec_params( "SELECT $1", [
+					[Time.new(2019, 12, 8, 20, 38, 12.123, "-01:00")], # Time -> timestamptz[]
+				], nil, basic_type_mapping )
+
+			expect( res.values[0][0] ).to match( /\{\"2019-12-08 \d\d:38:12.123[+-]\d\d\"\}/ )
+			expect( result_typenames(res) ).to eq( ['timestamp with time zone[]'] )
+		end
+
+		it "should do array-as-json encoding" do
+			basic_type_mapping.encode_array_as = :json
+			expect( basic_type_mapping.encode_array_as).to eq(:json)
+
+			res = @conn.exec_params( "SELECT $1::JSON, $2::JSON", [
+					[1, {a: 5}, true, ["a", 2], [3.4, nil]],
+					['/,"'.gsub("/", "\\"), nil, 'abcäöü'],
+				], nil, basic_type_mapping )
+
+			expect( res.values ).to eq( [[
+					'[1,{"a":5},true,["a",2],[3.4,null]]',
+					'["//,/"",null,"abcäöü"]'.gsub("/", "\\"),
+			]] )
+
+			expect( result_typenames(res) ).to eq( ['json', 'json'] )
+		end
+
+		it "should do hash-as-json encoding" do
+			res = @conn.exec_params( "SELECT $1::JSON, $2::JSON", [
+					{a: 5, b: ["a", 2], c: nil},
+					{qu: '/,"'.gsub("/", "\\"), ni: nil, uml: 'abcäöü'},
+				], nil, basic_type_mapping )
+
+			expect( res.values ).to eq( [[
+					'{"a":5,"b":["a",2],"c":null}',
+					'{"qu":"//,/"","ni":null,"uml":"abcäöü"}'.gsub("/", "\\"),
+			]] )
+
+			expect( result_typenames(res) ).to eq( ['json', 'json'] )
+		end
+
+		describe "Record encoding" do
+			before :all do
+				@conn.exec("CREATE TYPE test_record1 AS (i int, d float, t text)")
+				@conn.exec("CREATE TYPE test_record2 AS (i int, r test_record1)")
+			end
+
+			after :all do
+				@conn.exec("DROP TYPE IF EXISTS test_record2 CASCADE")
+				@conn.exec("DROP TYPE IF EXISTS test_record1 CASCADE")
+			end
+
+			it "should do array-as-record encoding" do
+				basic_type_mapping.encode_array_as = :record
+				expect( basic_type_mapping.encode_array_as).to eq(:record)
+
+				res = @conn.exec_params( "SELECT $1::test_record1, $2::test_record2, $3::text", [
+						[5, 3.4, "txt"],
+				    [1, [2, 4.5, "bcd"]],
+				    [4, 5, 6],
+					], nil, basic_type_mapping )
+
+				expect( res.values ).to eq( [[
+						'(5,3.4,txt)',
+				    '(1,"(2,4.5,bcd)")',
+						'("4","5","6")',
+				]] )
+
+				expect( result_typenames(res) ).to eq( ['test_record1', 'test_record2', 'text'] )
+			end
 		end
 
 		it "should do bigdecimal param encoding" do
 			large = ('123456790'*10) << '.' << ('012345679')
 			res = @conn.exec_params( "SELECT $1::numeric,$2::numeric",
-				[BigDecimal.new('1'), BigDecimal.new(large)], nil, basic_type_mapping )
+				[BigDecimal('1'), BigDecimal(large)], nil, basic_type_mapping )
 
 			expect( res.values ).to eq( [
 					[ "1.0", large ],
@@ -82,6 +196,23 @@ describe 'Basic type mapping' do
 			expect( result_typenames(res) ).to eq( ['inet', 'inet', 'cidr', 'cidr'] )
 		end
 
+		it "should do array of string encoding on unknown classes" do
+			iv = Class.new do
+				def to_s
+					"abc"
+				end
+			end.new
+			res = @conn.exec_params( "SELECT $1", [
+					[iv, iv], # Unknown -> text[]
+				], nil, basic_type_mapping )
+
+			expect( res.values ).to eq( [[
+					'{abc,abc}',
+			]] )
+
+			expect( result_typenames(res) ).to eq( ['text[]'] )
+		end
+
 	end
 
 
@@ -95,7 +226,7 @@ describe 'Basic type mapping' do
 		# Decoding Examples
 		#
 
-		it "should do OID based type conversions", :ruby_19 do
+		it "should do OID based type conversions" do
 			res = @conn.exec( "SELECT 1, 'a', 2.0::FLOAT, TRUE, '2013-06-30'::DATE, generate_series(4,5)" )
 			expect( res.map_types!(basic_type_mapping).values ).to eq( [
 					[ 1, 'a', 2.0, true, Date.new(2013,6,30), 4 ],
@@ -187,7 +318,9 @@ describe 'Basic type mapping' do
 				it "should convert format #{format} timestamps per TimestampUtc" do
 					restore_type("timestamp") do
 						PG::BasicTypeRegistry.register_type 0, 'timestamp', nil, PG::TextDecoder::TimestampUtc
-						@conn.type_map_for_results = PG::BasicTypeMapForResults.new(@conn)
+						expect_to_typecase_result_value_warning do
+							@conn.type_map_for_results = PG::BasicTypeMapForResults.new(@conn)
+						end
 						res = @conn.exec_params( "SELECT CAST('2013-07-31 23:58:59+02' AS TIMESTAMP WITHOUT TIME ZONE),
 																			CAST('1913-12-31 23:58:59.1231-03' AS TIMESTAMP WITHOUT TIME ZONE),
 																			CAST('4714-11-24 23:58:59.1231-03 BC' AS TIMESTAMP WITHOUT TIME ZONE),
@@ -209,7 +342,9 @@ describe 'Basic type mapping' do
 					restore_type("timestamp") do
 						PG::BasicTypeRegistry.register_type 0, 'timestamp', nil, PG::TextDecoder::TimestampUtcToLocal
 						PG::BasicTypeRegistry.register_type 1, 'timestamp', nil, PG::BinaryDecoder::TimestampUtcToLocal
-						@conn.type_map_for_results = PG::BasicTypeMapForResults.new(@conn)
+						expect_to_typecase_result_value_warning do
+							@conn.type_map_for_results = PG::BasicTypeMapForResults.new(@conn)
+						end
 						res = @conn.exec_params( "SELECT CAST('2013-07-31 23:58:59+02' AS TIMESTAMP WITHOUT TIME ZONE),
 																			CAST('1913-12-31 23:58:59.1231-03' AS TIMESTAMP WITHOUT TIME ZONE),
 																			CAST('4714-11-24 23:58:59.1231-03 BC' AS TIMESTAMP WITHOUT TIME ZONE),
@@ -231,7 +366,9 @@ describe 'Basic type mapping' do
 					restore_type("timestamp") do
 						PG::BasicTypeRegistry.register_type 0, 'timestamp', nil, PG::TextDecoder::TimestampLocal
 						PG::BasicTypeRegistry.register_type 1, 'timestamp', nil, PG::BinaryDecoder::TimestampLocal
-						@conn.type_map_for_results = PG::BasicTypeMapForResults.new(@conn)
+						expect_to_typecase_result_value_warning do
+							@conn.type_map_for_results = PG::BasicTypeMapForResults.new(@conn)
+						end
 						res = @conn.exec_params( "SELECT CAST('2013-07-31 23:58:59' AS TIMESTAMP WITHOUT TIME ZONE),
 																			CAST('1913-12-31 23:58:59.1231' AS TIMESTAMP WITHOUT TIME ZONE),
 																			CAST('4714-11-24 23:58:59.1231-03 BC' AS TIMESTAMP WITHOUT TIME ZONE),