pg 0.21.0 → 1.2.3

data/lib/pg/binary_decoder.rb

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+module PG
+	module BinaryDecoder
+		# Convenience classes for timezone options
+		class TimestampUtc < Timestamp
+			def initialize(params={})
+				super(params.merge(flags: PG::Coder::TIMESTAMP_DB_UTC | PG::Coder::TIMESTAMP_APP_UTC))
+			end
+		end
+		class TimestampUtcToLocal < Timestamp
+			def initialize(params={})
+				super(params.merge(flags: PG::Coder::TIMESTAMP_DB_UTC | PG::Coder::TIMESTAMP_APP_LOCAL))
+			end
+		end
+		class TimestampLocal < Timestamp
+			def initialize(params={})
+				super(params.merge(flags: PG::Coder::TIMESTAMP_DB_LOCAL | PG::Coder::TIMESTAMP_APP_LOCAL))
+			end
+		end
+	end
+end # module PG

data/lib/pg/coder.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 module PG
 
@@ -28,6 +29,7 @@ module PG
 			{
 				oid: oid,
 				format: format,
+				flags: flags,
 				name: name,
 			}
 		end
@@ -52,6 +54,18 @@ module PG
 			str[-1,0] = "#{name_str} #{oid_str}#{format_str}"
 			str
 		end
+
+		def inspect_short
+			str = case format
+				when 0 then "T"
+				when 1 then "B"
+				else format.to_s
+			end
+			str += "E" if respond_to?(:encode)
+			str += "D" if respond_to?(:decode)
+
+			"#{name || self.class.name}:#{str}"
+		end
 	end
 
 	class CompositeCoder < Coder
@@ -79,5 +93,12 @@ module PG
 			})
 		end
 	end
-end # module PG
 
+	class RecordCoder < Coder
+		def to_h
+			super.merge!({
+				type_map: type_map,
+			})
+		end
+	end
+end # module PG

data/lib/pg/connection.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'pg' unless defined?( PG )
 require 'uri'
@@ -47,7 +48,7 @@ class PG::Connection
 
 		if args.length == 1
 			case args.first
-			when URI, URI.regexp
+			when URI, /\A#{URI::ABS_URI_REF}\z/
 				uri = URI(args.first)
 				options.merge!( Hash[URI.decode_www_form( uri.query )] ) if uri.query
 			when /=/
@@ -85,7 +86,7 @@ class PG::Connection
 
 
 	#  call-seq:
-	#     conn.copy_data( sql ) {|sql_result| ... } -> PG::Result
+	#     conn.copy_data( sql [, coder] ) {|sql_result| ... } -> PG::Result
 	#
 	# Execute a copy process for transfering data to or from the server.
 	#
@@ -109,6 +110,11 @@ class PG::Connection
 	# of blocking mode of operation, #copy_data is preferred to raw calls
 	# of #put_copy_data, #get_copy_data and #put_copy_end.
 	#
+	# _coder_ can be a PG::Coder derivation
+	# (typically PG::TextEncoder::CopyRow or PG::TextDecoder::CopyRow).
+	# This enables encoding of data fields given to #put_copy_data
+	# or decoding of fields received by #get_copy_data.
+	#
 	# Example with CSV input format:
 	#   conn.exec "create table my_table (a text,b text,c text,d text)"
 	#   conn.copy_data "COPY my_table FROM STDIN CSV" do
@@ -263,5 +269,23 @@ class PG::Connection
 		end
 	end
 
-end # class PG::Connection
+	REDIRECT_METHODS = {
+		:exec => [:async_exec, :sync_exec],
+		:query => [:async_exec, :sync_exec],
+		:exec_params => [:async_exec_params, :sync_exec_params],
+		:prepare => [:async_prepare, :sync_prepare],
+		:exec_prepared => [:async_exec_prepared, :sync_exec_prepared],
+		:describe_portal => [:async_describe_portal, :sync_describe_portal],
+		:describe_prepared => [:async_describe_prepared, :sync_describe_prepared],
+	}
+
+	def self.async_api=(enable)
+		REDIRECT_METHODS.each do |ali, (async, sync)|
+			remove_method(ali) if method_defined?(ali)
+			alias_method( ali, enable ? async : sync )
+		end
+	end
 
+	# pg-1.1.0+ defaults to libpq's async API for query related blocking methods
+	self.async_api = true
+end # class PG::Connection

data/lib/pg/constants.rb

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

data/lib/pg/exceptions.rb

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

data/lib/pg/result.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- 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 @@
-#!/usr/bin/env ruby
+# -*- 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
@@ -17,35 +16,31 @@ module PG
 			end
 		end
 
-		class TimestampWithoutTimeZone < SimpleDecoder
-			ISO_DATETIME_WITHOUT_TIMEZONE = /\A(\d{4})-(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)(\.\d+)?\z/
-
+		class JSON < SimpleDecoder
 			def decode(string, tuple=nil, field=nil)
-				if string =~ ISO_DATETIME_WITHOUT_TIMEZONE
-					Time.new $1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, "#{$6}#{$7}".to_r
-				else
-					string
-				end
+				::JSON.parse(string, quirks_mode: true)
 			end
 		end
 
-		class TimestampWithTimeZone < SimpleDecoder
-			ISO_DATETIME_WITH_TIMEZONE = /\A(\d{4})-(\d\d)-(\d\d) (\d\d):(\d\d):(\d\d)(\.\d+)?([-\+]\d\d):?(\d\d)?:?(\d\d)?\z/
-
-			def decode(string, tuple=nil, field=nil)
-				if string =~ ISO_DATETIME_WITH_TIMEZONE
-					Time.new $1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, "#{$6}#{$7}".to_r, "#{$8}:#{$9 || '00'}:#{$10 || '00'}"
-				else
-					string
-				end
+		# Convenience classes for timezone options
+		class TimestampUtc < Timestamp
+			def initialize(params={})
+				super(params.merge(flags: PG::Coder::TIMESTAMP_DB_UTC | PG::Coder::TIMESTAMP_APP_UTC))
 			end
 		end
-
-		class JSON < SimpleDecoder
-			def decode(string, tuple=nil, field=nil)
-				::JSON.parse(string, quirks_mode: true)
+		class TimestampUtcToLocal < Timestamp
+			def initialize(params={})
+				super(params.merge(flags: PG::Coder::TIMESTAMP_DB_UTC | PG::Coder::TIMESTAMP_APP_LOCAL))
+			end
+		end
+		class TimestampLocal < Timestamp
+			def initialize(params={})
+				super(params.merge(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.rb

@@ -1,27 +1,32 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'json'
+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
+			def encode(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
+				value.respond_to?(:strftime) ? value.strftime("%Y-%m-%d %H:%M:%S.%N %:z") : value
 			end
 		end
 
@@ -30,6 +35,25 @@ module PG
 				::JSON.generate(value, quirks_mode: true)
 			end
 		end
+
+		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/tuple.rb

@@ -0,0 +1,30 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'pg' unless defined?( PG )
+
+
+class PG::Tuple
+
+	### Return a String representation of the object suitable for debugging.
+	def inspect
+		"#<#{self.class} #{self.map{|k,v| "#{k}: #{v.inspect}" }.join(", ") }>"
+	end
+
+	def has_key?(key)
+		field_map.has_key?(key)
+	end
+	alias key? has_key?
+
+	def keys
+		field_names || field_map.keys.freeze
+	end
+
+	def each_key(&block)
+		if fn=field_names
+			fn.each(&block)
+		else
+			field_map.each_key(&block)
+		end
+	end
+end

data/lib/pg/type_map_by_column.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- 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

@@ -1,11 +1,13 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 require 'pathname'
 require 'rspec'
 require 'shellwords'
 require 'pg'
 
-TEST_DIRECTORY = Pathname.getwd + "tmp_test_specs"
+DEFAULT_TEST_DIR_STR = File.join(Dir.pwd, "tmp_test_specs")
+TEST_DIR_STR = ENV['RUBY_PG_TEST_DIR'] || DEFAULT_TEST_DIR_STR
+TEST_DIRECTORY = Pathname.new(TEST_DIR_STR)
 
 module PG::TestingHelpers
 
@@ -20,12 +22,11 @@ module PG::TestingHelpers
 
 			mod.around( :each ) do |example|
 				begin
+					@conn.set_default_encoding
 					@conn.exec( 'BEGIN' ) unless example.metadata[:without_transaction]
-					if PG.respond_to?( :library_version )
-						desc = example.source_location.join(':')
-						@conn.exec_params %Q{SET application_name TO '%s'} %
-							[@conn.escape_string(desc.slice(-60))]
-					end
+					desc = example.source_location.join(':')
+					@conn.exec %Q{SET application_name TO '%s'} %
+						[@conn.escape_string(desc.slice(-60))]
 					example.run
 				ensure
 					@conn.exec( 'ROLLBACK' ) unless example.metadata[:without_transaction]
@@ -171,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
@@ -193,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"
 
@@ -208,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
 
@@ -217,14 +218,14 @@ 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'
 
 		rescue => err
 			$stderr.puts "%p during test setup: %s" % [ err.class, err.message ]
 			$stderr.puts "See #{@logfile} for details."
-			$stderr.puts *err.backtrace if $DEBUG
+			$stderr.puts err.backtrace if $DEBUG
 			fail
 		end
 
@@ -238,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 )
@@ -251,7 +252,7 @@ module PG::TestingHelpers
 
 	def check_for_lingering_connections( conn )
 		conn.exec( "SELECT * FROM pg_stat_activity" ) do |res|
-			conns = res.find_all {|row| row['pid'].to_i != conn.backend_pid }
+			conns = res.find_all {|row| row['pid'].to_i != conn.backend_pid && ["client backend", nil].include?(row["backend_type"]) }
 			unless conns.empty?
 				puts "Lingering connections remain:"
 				conns.each do |row|
@@ -264,7 +265,7 @@ module PG::TestingHelpers
 
 	# Retrieve the names of the column types of a given result set.
 	def result_typenames(res)
-		@conn.exec( "SELECT " + res.nfields.times.map{|i| "format_type($#{i*2+1},$#{i*2+2})"}.join(","),
+		@conn.exec_params( "SELECT " + res.nfields.times.map{|i| "format_type($#{i*2+1},$#{i*2+2})"}.join(","),
 				res.nfields.times.map{|i| [res.ftype(i), res.fmod(i)] }.flatten ).
 				values[0]
 	end
@@ -318,6 +319,39 @@ module PG::TestingHelpers
 		return ConnStillUsableMatcher.new
 	end
 
+	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( [conn.socket_io], [], [], 5.0 ) or
+					raise "Asynchronous connection timed out!"
+
+			elsif status == PG::PGRES_POLLING_WRITING
+				select( [], [conn.socket_io], [], 5.0 ) or
+					raise "Asynchronous connection timed out!"
+			end
+			status = conn.send(meth)
+		end
+	end
+
+	def wait_for_query_result(conn)
+		result = nil
+		loop do
+			# Buffer any incoming data on the socket until a full result is ready.
+			conn.consume_input
+			while conn.is_busy
+				select( [conn.socket_io], nil, nil, 5.0 ) or
+					raise "Timeout waiting for query response."
+				conn.consume_input
+			end
+
+			# Fetch the next result. If there isn't one, the query is finished
+			result = conn.get_result || break
+		end
+		result
+	end
+
 end
 
 
@@ -336,17 +370,11 @@ RSpec.configure do |config|
 	else
 		config.filter_run_excluding :windows
 	end
-	config.filter_run_excluding :socket_io unless
-		PG::Connection.instance_methods.map( &:to_sym ).include?( :socket_io )
-
-	if PG.library_version < 90200
-		config.filter_run_excluding( :postgresql_92, :postgresql_93, :postgresql_94, :postgresql_95 )
-	elsif PG.library_version < 90300
-		config.filter_run_excluding( :postgresql_93, :postgresql_94, :postgresql_95 )
-	elsif PG.library_version < 90400
-		config.filter_run_excluding( :postgresql_94, :postgresql_95 )
-	elsif PG.library_version < 90500
-		config.filter_run_excluding( :postgresql_95 )
-	end
-end
 
+	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