pg 0.19.0 → 1.1.0

data/lib/pg/basic_type_mapping.rb

@@ -1,7 +1,27 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 require 'pg' unless defined?( PG )
 
+# This module defines the mapping between OID and encoder/decoder classes for PG::BasicTypeMapForResults, PG::BasicTypeMapForQueries and PG::BasicTypeMapBasedOnResult.
+#
+# Additional types can be added like so:
+#
+#   require 'pg'
+#   require 'ipaddr'
+#
+#   class InetDecoder < PG::SimpleDecoder
+#     def decode(string, tuple=nil, field=nil)
+#       IPAddr.new(string)
+#     end
+#   end
+#   class InetEncoder < PG::SimpleEncoder
+#     def encode(ip_addr)
+#       ip_addr.to_s
+#     end
+#   end
+#
+#   # 0 if for text format, can also be 1 for binary
+#   PG::BasicTypeRegistry.register_type(0, 'inet', InetEncoder, InetDecoder)
 module PG::BasicTypeRegistry
 	# An instance of this class stores the coders that should be used for a given wire format (text or binary)
 	# and type cast direction (encoder or decoder).
@@ -137,6 +157,7 @@ module PG::BasicTypeRegistry
 	# Register an OID type named +name+ with a typecasting encoder and decoder object in
 	# +type+.  +name+ should correspond to the `typname` column in
 	# the `pg_type` table.
+	# +format+ can be 0 for text format and 1 for binary.
 	def self.register_type(format, name, encoder_class, decoder_class)
 		CODERS_BY_NAME[format] ||= { encoder: {}, decoder: {} }
 		CODERS_BY_NAME[format][:encoder][name] = encoder_class.new(name: name, format: format) if encoder_class
@@ -145,8 +166,14 @@ module PG::BasicTypeRegistry
 
 	# Alias the +old+ type to the +new+ type.
 	def self.alias_type(format, new, old)
-		CODERS_BY_NAME[format][:encoder][new] = CODERS_BY_NAME[format][:encoder][old]
-		CODERS_BY_NAME[format][:decoder][new] = CODERS_BY_NAME[format][:decoder][old]
+		[:encoder, :decoder].each do |ende|
+			enc = CODERS_BY_NAME[format][ende][old]
+			if enc
+				CODERS_BY_NAME[format][ende][new] = enc
+			else
+				CODERS_BY_NAME[format][ende].delete(new)
+			end
+		end
 	end
 
 	register_type 0, 'int2', PG::TextEncoder::Integer, PG::TextDecoder::Integer
@@ -154,7 +181,7 @@ module PG::BasicTypeRegistry
 	alias_type    0, 'int8', 'int2'
 	alias_type    0, 'oid',  'int2'
 
-	# register_type 0, 'numeric', OID::Decimal.new
+	register_type 0, 'numeric', PG::TextEncoder::Numeric, PG::TextDecoder::Numeric
 	register_type 0, 'text', PG::TextEncoder::String, PG::TextDecoder::String
 	alias_type 0, 'varchar', 'text'
 	alias_type 0, 'char', 'text'
@@ -193,8 +220,8 @@ module PG::BasicTypeRegistry
 	# register_type 'citext', OID::Text.new
 	# register_type 'ltree', OID::Text.new
 	#
-	# register_type 'cidr', OID::Cidr.new
-	# alias_type 'inet', 'cidr'
+	register_type 0, 'inet', PG::TextEncoder::Inet, PG::TextDecoder::Inet
+	alias_type 0, 'cidr', 'inet'
 
 
 
@@ -213,6 +240,8 @@ module PG::BasicTypeRegistry
 	register_type 1, 'bool', PG::BinaryEncoder::Boolean, PG::BinaryDecoder::Boolean
 	register_type 1, 'float4', nil, PG::BinaryDecoder::Float
 	register_type 1, 'float8', nil, PG::BinaryDecoder::Float
+	register_type 1, 'timestamp', nil, PG::BinaryDecoder::TimestampUtc
+	register_type 1, 'timestamptz', nil, PG::BinaryDecoder::TimestampUtcToLocal
 end
 
 # Simple set of rules for type casting common PostgreSQL types to Ruby.
@@ -258,7 +287,7 @@ end
 # This prints the rows with type casted columns:
 #   ["a", 123, [5, 4, 3]]
 #
-# See also PG::BasicTypeMapBasedOnResult for the encoder direction.
+# See also PG::BasicTypeMapBasedOnResult for the encoder direction and PG::BasicTypeRegistry for the definition of additional types.
 class PG::BasicTypeMapForResults < PG::TypeMapByOid
 	include PG::BasicTypeRegistry
 
@@ -412,6 +441,10 @@ class PG::BasicTypeMapForQueries < PG::TypeMapByClass
 		# to unnecessary type conversions on server side.
 		Integer => [0, 'int8'],
 		Float => [0, 'float8'],
+		BigDecimal => [0, 'numeric'],
+		# We use text format and no type OID for IPAddr, because setting the OID can lead
+		# to unnecessary inet/cidr conversions on the server side.
+		IPAddr => [0, 'inet'],
 		Array => :get_array_type,
 	}
 

data/lib/pg/binary_decoder.rb

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

data/lib/pg/connection.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 require 'pg' unless defined?( PG )
 require 'uri'
@@ -47,7 +47,7 @@ class PG::Connection
 
 		if args.length == 1
 			case args.first
-			when URI, URI.regexp
+			when URI, /\A#{URI.regexp}\z/
 				uri = URI(args.first)
 				options.merge!( Hash[URI.decode_www_form( uri.query )] ) if uri.query
 			when /=/
@@ -85,7 +85,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 +109,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,9 +268,24 @@ 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
 
-# :stopdoc:
-# Backward-compatible alias
-PGconn = PG::Connection
+	# 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,4 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 require 'pg' unless defined?( PG )
 

data/lib/pg/exceptions.rb

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

data/lib/pg/result.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 require 'pg' unless defined?( PG )
 
@@ -19,12 +19,13 @@ class PG::Result
 	### Return a String representation of the object suitable for debugging.
 	def inspect
 		str = self.to_s
-		str[-1,0] = " status=#{res_status(result_status)} ntuples=#{ntuples} nfields=#{nfields} cmd_tuples=#{cmd_tuples}"
+		str[-1,0] = if cleared?
+			" cleared"
+		else
+			" status=#{res_status(result_status)} ntuples=#{ntuples} nfields=#{nfields} cmd_tuples=#{cmd_tuples}"
+		end
 		return str
 	end
 
 end # class PG::Result
 
-# :stopdoc:
-# Backward-compatible alias
-PGresult = PG::Result

data/lib/pg/text_decoder.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 require 'date'
 require 'json'
@@ -17,35 +17,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.load(string)
+		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,6 +1,7 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 require 'json'
+require 'ipaddr'
 
 module PG
 	module TextEncoder
@@ -18,6 +19,13 @@ module PG
 			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
+			end
+		end
+
 		class TimestampWithTimeZone < SimpleEncoder
 			STRFTIME_ISO_DATETIME_WITH_TIMEZONE = "%Y-%m-%d %H:%M:%S.%N %:z".freeze
 			def encode(value)
@@ -25,9 +33,35 @@ module PG
 			end
 		end
 
+		class Numeric < SimpleEncoder
+			def encode(value)
+				value.is_a?(BigDecimal) ? value.to_s('F') : value
+			end
+		end
+
 		class JSON < SimpleEncoder
 			def encode(value)
-				::JSON.dump(value)
+				::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

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,4 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 require 'pg' unless defined?( PG )
 

data/lib/pg.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 begin
 	require 'pg_ext'
@@ -8,11 +8,22 @@ rescue LoadError
 		major_minor = RUBY_VERSION[ /^(\d+\.\d+)/ ] or
 			raise "Oops, can't extract the major/minor version from #{RUBY_VERSION.dump}"
 
-		# Set the PATH environment variable, so that libpq.dll can be found.
-		old_path = ENV['PATH']
-		ENV['PATH'] = "#{File.expand_path("..", __FILE__)};#{old_path}"
-		require "#{major_minor}/pg_ext"
-		ENV['PATH'] = old_path
+		add_dll_path = proc do |path, &block|
+			begin
+				require 'ruby_installer/runtime'
+				RubyInstaller::Runtime.add_dll_directory(path, &block)
+			rescue LoadError
+				old_path = ENV['PATH']
+				ENV['PATH'] = "#{path};#{old_path}"
+				block.call
+				ENV['PATH'] = old_path
+			end
+		end
+
+		# Temporary add this directory for DLL search, so that libpq.dll can be found.
+		add_dll_path.call(__dir__) do
+			require "#{major_minor}/pg_ext"
+		end
 	else
 		raise
 	end
@@ -24,10 +35,10 @@ end
 module PG
 
 	# Library version
-	VERSION = '0.19.0'
+	VERSION = '1.1.0'
 
 	# VCS revision
-	REVISION = %q$Revision: 8beaa5d72670 $
+	REVISION = %q$Revision: ca83074366ac $
 
 	class NotAllCopyDataRetrieved < PG::Error
 	end
@@ -49,16 +60,15 @@ module PG
 	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_mapping'
 	require 'pg/type_map_by_column'
 	require 'pg/connection'
 	require 'pg/result'
+	require 'pg/tuple'
 
 end # module PG
 
 
-# Backward-compatible aliase
-PGError = PG::Error
-

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
 
@@ -21,11 +23,9 @@ module PG::TestingHelpers
 			mod.around( :each ) do |example|
 				begin
 					@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]
@@ -251,7 +251,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 +264,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 +318,40 @@ module PG::TestingHelpers
 		return ConnStillUsableMatcher.new
 	end
 
+	def wait_for_polling_ok(conn)
+		socket = conn.socket_io
+		status = conn.connect_poll
+
+		while status != PG::PGRES_POLLING_OK
+			if status == PG::PGRES_POLLING_READING
+				select( [socket], [], [], 5.0 ) or
+					raise "Asynchronous connection timed out!"
+
+			elsif status == PG::PGRES_POLLING_WRITING
+				select( [], [socket], [], 5.0 ) or
+					raise "Asynchronous connection timed out!"
+			end
+			status = conn.connect_poll
+		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
 
 
@@ -339,14 +373,8 @@ RSpec.configure do |config|
 	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
+	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_10 ) if PG.library_version < 100000
 end
-