pg 0.17.1 → 1.2.3

data/lib/pg/text_decoder.rb

@@ -0,0 +1,46 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'date'
+require 'json'
+
+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
+
+		class JSON < SimpleDecoder
+			def decode(string, tuple=nil, field=nil)
+				::JSON.parse(string, quirks_mode: true)
+			end
+		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 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

@@ -0,0 +1,59 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'json'
+require 'ipaddr'
+
+module PG
+	module TextEncoder
+		class Date < SimpleEncoder
+			def encode(value)
+				value.respond_to?(:strftime) ? value.strftime("%Y-%m-%d") : value
+			end
+		end
+
+		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
+
+		class JSON < SimpleEncoder
+			def encode(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
+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

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'pg' unless defined?( PG )
+
+class PG::TypeMapByColumn
+	# Returns the type oids of the assigned coders.
+	def oids
+		coders.map{|c| c.oid if c }
+	end
+
+	def inspect
+		type_strings = coders.map{|c| c ? c.inspect_short : 'nil' }
+		"#<#{self.class} #{type_strings.join(' ')}>"
+	end
+end

data/lib/pg.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 begin
 	require 'pg_ext'
@@ -7,7 +8,24 @@ rescue LoadError
 	if RUBY_PLATFORM =~/(mswin|mingw)/i
 		major_minor = RUBY_VERSION[ /^(\d+\.\d+)/ ] or
 			raise "Oops, can't extract the major/minor version from #{RUBY_VERSION.dump}"
-		require "#{major_minor}/pg_ext"
+
+		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.
+		# mingw32-platform strings differ (RUBY_PLATFORM=i386-mingw32 vs. x86-mingw32 for rubygems)
+		add_dll_path.call(File.join(__dir__, RUBY_PLATFORM.gsub(/^i386-/, "x86-"))) do
+			require "#{major_minor}/pg_ext"
+		end
 	else
 		raise
 	end
@@ -19,10 +37,10 @@ end
 module PG
 
 	# Library version
-	VERSION = '0.17.1'
+	VERSION = '1.2.3'
 
 	# VCS revision
-	REVISION = %q$Revision: 22d57e3a2b37 $
+	REVISION = %q$Revision: 6f611e78845a $
 
 	class NotAllCopyDataRetrieved < PG::Error
 	end
@@ -43,12 +61,14 @@ 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/{lib/helpers.rb → helpers.rb}

@@ -1,14 +1,47 @@
-#!/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
 
+	### Automatically set up the database when it's used, and wrap a transaction around
+	### examples that don't disable it.
+	def self::included( mod )
+		super
+
+		if mod.respond_to?( :around )
+
+			mod.before( :all ) { @conn = setup_testing_db(described_class ? described_class.name : mod.description) }
+
+			mod.around( :each ) do |example|
+				begin
+					@conn.set_default_encoding
+					@conn.exec( 'BEGIN' ) unless example.metadata[:without_transaction]
+					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]
+				end
+			end
+
+			mod.after( :all ) { teardown_testing_db(@conn) }
+		end
+
+	end
+
+
+	#
+	# Examples
+	#
 
 	# Set some ANSI escape code constants (Shamelessly stolen from Perl's
 	# Term::ANSIColor by Russ Allbery <rra@stanford.edu> and Zenin <zenin@best.com>
@@ -121,28 +154,9 @@ module PG::TestingHelpers
 		end
 
 		# Eliminate the noise of creating/tearing down the database by
-		# redirecting STDERR/STDOUT to a logfile if the Ruby interpreter
-		# supports fork()
+		# redirecting STDERR/STDOUT to a logfile
 		logfh = File.open( logpath, File::WRONLY|File::CREAT|File::APPEND )
-		begin
-			pid = fork
-		rescue NotImplementedError
-			logfh.close
-			system( *cmd )
-		else
-			if pid
-				logfh.close
-			else
-				$stdout.reopen( logfh )
-				$stderr.reopen( $stdout )
-				$stderr.puts( ">>> " + cmd.shelljoin )
-				exec( *cmd )
-				$stderr.puts "After the exec()?!??!"
-				exit!
-			end
-
-			Process.wait( pid )
-		end
+		system( *cmd, [STDOUT, STDERR] => logfh )
 
 		raise "Command failed: [%s]" % [cmd.join(' ')] unless $?.success?
 	end
@@ -158,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
@@ -180,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"
 
@@ -195,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
 
@@ -204,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
 
@@ -225,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 )
@@ -238,56 +252,129 @@ 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|
-					puts "  [%d] {%s} %s -- %s" % row.values_at( 'pid', 'state', 'application_name', 'query' )
+					puts "  [%s] {%s} %s -- %s" % row.values_at( 'pid', 'state', 'application_name', 'query' )
 				end
 			end
 		end
 	end
 
-	def connection_string_should_contain_application_name(conn_args, app_name)
-		conn_name = conn_args.match(/application_name='(.*)'/)[1]
-		conn_name.should include(app_name[0..10])
-		conn_name.should include(app_name[-10..-1])
-		conn_name.length.should <= 64
+
+	# Retrieve the names of the column types of a given result set.
+	def result_typenames(res)
+		@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
+
+
+	# A matcher for checking the status of a PG::Connection to ensure it's still
+	# usable.
+	class ConnStillUsableMatcher
+
+		def initialize
+			@conn = nil
+			@problem = nil
+		end
+
+		def matches?( conn )
+			@conn = conn
+			@problem = self.check_for_problems
+			return @problem.nil?
+		end
+
+		def check_for_problems
+			return "is finished" if @conn.finished?
+			return "has bad status" unless @conn.status == PG::CONNECTION_OK
+			return "has bad transaction status (%d)" % [ @conn.transaction_status ] unless
+				@conn.transaction_status.between?( PG::PQTRANS_IDLE, PG::PQTRANS_INTRANS )
+			return "is not usable." unless self.can_exec_query?
+			return nil
+		end
+
+		def can_exec_query?
+			@conn.send_query( "VALUES (1)" )
+			@conn.get_last_result.values == [["1"]]
+		end
+
+		def failure_message
+			return "expected %p to be usable, but it %s" % [ @conn, @problem ]
+		end
+
+		def failure_message_when_negated
+			"expected %p not to be usable, but it still is" % [ @conn ]
+		end
+
+	end
+
+
+	### Return a ConnStillUsableMatcher to be used like:
+	###
+	###    expect( pg_conn ).to still_be_usable
+	###
+	def still_be_usable
+		return ConnStillUsableMatcher.new
 	end
 
-	# Ensure the connection is in a clean execution status.
-	def verify_clean_exec_status
-		@conn.send_query( "VALUES (1)" )
-		@conn.get_last_result.values.should == [["1"]]
+	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
 
 
 RSpec.configure do |config|
-	ruby_version_vec = RUBY_VERSION.split('.').map {|c| c.to_i }.pack( "N*" )
-
 	config.include( PG::TestingHelpers )
-	config.treat_symbols_as_metadata_keys_with_true_values = true
 
-	config.mock_with :rspec
-	config.filter_run_excluding :ruby_19 if ruby_version_vec <= [1,9,1].pack( "N*" )
+	config.run_all_when_everything_filtered = true
+	config.filter_run :focus
+	config.order = 'random'
+	config.mock_with( :rspec ) do |mock|
+		mock.syntax = :expect
+	end
+
 	if RUBY_PLATFORM =~ /mingw|mswin/
 		config.filter_run_excluding :unix
 	else
 		config.filter_run_excluding :windows
 	end
-	config.filter_run_excluding :socket_io unless
-		PG::Connection.instance_methods.map( &:to_sym ).include?( :socket_io )
-
-	config.filter_run_excluding :postgresql_90 unless
-		PG::Connection.instance_methods.map( &:to_sym ).include?( :escape_literal )
-
-	if !PG.respond_to?( :library_version )
-		config.filter_run_excluding( :postgresql_91, :postgresql_92, :postgresql_93 )
-	elsif PG.library_version < 90200
-		config.filter_run_excluding( :postgresql_92, :postgresql_93 )
-	elsif PG.library_version < 90300
-		config.filter_run_excluding( :postgresql_93 )
-	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