pg 1.0.0 → 1.5.9

data/lib/pg/exceptions.rb

@@ -1,11 +1,31 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'pg' unless defined?( PG )
 
 
 module PG
 
-	class Error < StandardError; end
+	class Error < StandardError
+		def initialize(msg=nil, connection: nil, result: nil)
+			@connection = connection
+			@result = result
+			super(msg)
+		end
+	end
+
+	class NotAllCopyDataRetrieved < PG::Error
+	end
+	class LostCopyState < PG::Error
+	end
+	class NotInBlockingMode < PG::Error
+	end
+
+	# PG::Connection#transaction uses this exception to distinguish a deliberate rollback from other exceptional situations.
+	# Normally, raising an exception will cause the .transaction method to rollback the database transaction and pass on the exception.
+	# But if you raise an PG::RollbackTransaction exception, then the database transaction will be rolled back, without passing on the exception.
+	class RollbackTransaction < StandardError
+	end
 
 end # module 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/date.rb

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'date'
+
+module PG
+	module TextDecoder
+		# This is a decoder class for conversion of PostgreSQL date type to Ruby Date values.
+		#
+		# As soon as this class is used, it requires the ruby standard library 'date'.
+		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,17 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'json'
+
+module PG
+	module TextDecoder
+		# This is a decoder class for conversion of PostgreSQL JSON/JSONB type to Ruby Hash, Array, String, Numeric, nil values.
+		#
+		# As soon as this class is used, it requires the ruby standard library 'json'.
+		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,13 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+module PG
+	module TextEncoder
+		# This is a encoder class for conversion of Ruby Date values to PostgreSQL date type.
+		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,31 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'ipaddr'
+
+module PG
+	module TextEncoder
+		# This is a encoder class for conversion of Ruby IPAddr values to PostgreSQL inet type.
+		#
+		# As soon as this class is used, it requires the ruby standard library 'ipaddr'.
+		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,17 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'json'
+
+module PG
+	module TextEncoder
+		# This is a encoder class for conversion of Ruby Hash, Array, String, Numeric, nil values to PostgreSQL JSON/JSONB type.
+		#
+		# As soon as this class is used, it requires the ruby standard library 'json'.
+		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/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/lib/pg/version.rb

@@ -0,0 +1,4 @@
+module PG
+	# Library version
+	VERSION = '1.5.9'
+end

data/lib/pg.rb

@@ -1,14 +1,28 @@
-#!/usr/bin/env ruby
 
-begin
-	require 'pg_ext'
-rescue LoadError
-	# If it's a Windows binary gem, try the <major>.<minor> subdirectory
-	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}"
+# -*- ruby -*-
+# frozen_string_literal: true
 
-		add_dll_path = proc do |path, &block|
+# The top-level PG namespace.
+module PG
+
+	# Is this file part of a fat binary gem with bundled libpq?
+	bundled_libpq_path = File.join(__dir__, RUBY_PLATFORM.gsub(/^i386-/, "x86-"))
+	if File.exist?(bundled_libpq_path)
+		POSTGRESQL_LIB_PATH = bundled_libpq_path
+	else
+		bundled_libpq_path = nil
+		# Try to load libpq path as found by extconf.rb
+		begin
+			require "pg/postgresql_lib_path"
+		rescue LoadError
+			# rake-compiler doesn't use regular "make install", but uses it's own install tasks.
+			# It therefore doesn't copy pg/postgresql_lib_path.rb in case of "rake compile".
+			POSTGRESQL_LIB_PATH = false
+		end
+	end
+
+	add_dll_path = proc do |path, &block|
+		if RUBY_PLATFORM =~/(mswin|mingw)/i && path && File.exist?(path)
 			begin
 				require 'ruby_installer/runtime'
 				RubyInstaller::Runtime.add_dll_directory(path, &block)
@@ -18,55 +32,108 @@ rescue LoadError
 				block.call
 				ENV['PATH'] = old_path
 			end
+		else
+			# No need to set a load path manually - it's set as library rpath.
+			block.call
 		end
+	end
 
-		# Temporary add this directory for DLL search, so that libpq.dll can be found.
-		add_dll_path.call(__dir__) do
+	# Add a load path to the one retrieved from pg_config
+	add_dll_path.call(POSTGRESQL_LIB_PATH) do
+		if bundled_libpq_path
+			# It's a Windows binary gem, try the <major>.<minor> subdirectory
+			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"
+		else
+			require 'pg_ext'
 		end
-	else
-		raise
 	end
 
-end
-
-
-# The top-level PG namespace.
-module PG
-
-	# Library version
-	VERSION = '1.0.0'
+	# Get the PG library version.
+	#
+	# +include_buildnum+ is no longer used and any value passed will be ignored.
+	def self.version_string( include_buildnum=nil )
+		"%s %s" % [ self.name, VERSION ]
+	end
 
-	# VCS revision
-	REVISION = %q$Revision: fef434914848 $
 
-	class NotAllCopyDataRetrieved < PG::Error
+	### Convenience alias for PG::Connection.new.
+	def self.connect( *args, &block )
+		Connection.new( *args, &block )
 	end
 
-	### Get the PG library version. If +include_buildnum+ is +true+, include the build ID.
-	def self::version_string( include_buildnum=false )
-		vstring = "%s %s" % [ self.name, VERSION ]
-		vstring << " (build %s)" % [ REVISION[/: ([[:xdigit:]]+)/, 1] || '0' ] if include_buildnum
-		return vstring
+	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
 
-
-	### Convenience alias for PG::Connection.new.
-	def self::connect( *args )
-		return PG::Connection.new( *args )
+	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/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'
+	autoload :VERSION, 'pg/version'
 
-end # module PG
 
+	# 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
+
+	# Ruby-3.4+ prints a warning, if bigdecimal is required but not in the Gemfile.
+	# But it's a false positive, since we enable bigdecimal depending features only if it's available.
+	# And most people don't need these features.
+	def self.require_bigdecimal_without_warning
+		oldverb, $VERBOSE = $VERBOSE, nil
+		require "bigdecimal"
+	ensure
+		$VERBOSE = oldverb
+	end
 
+end # module PG

data/misc/openssl-pg-segfault.rb

@@ -0,0 +1,31 @@
+# -*- ruby -*-
+
+PGHOST   = 'localhost'
+PGDB     = 'test'
+#SOCKHOST = 'github.com'
+SOCKHOST = 'it-trac.laika.com'
+
+# Load pg first, so the libssl.so that libpq is linked against is loaded.
+require 'pg'
+$stderr.puts "connecting to postgres://#{PGHOST}/#{PGDB}"
+conn = PG.connect( PGHOST, :dbname => PGDB )
+
+# Now load OpenSSL, which might be linked against a different libssl.
+require 'socket'
+require 'openssl'
+$stderr.puts "Connecting to #{SOCKHOST}"
+sock = TCPSocket.open( SOCKHOST, 443 )
+ctx = OpenSSL::SSL::SSLContext.new
+sock = OpenSSL::SSL::SSLSocket.new( sock, ctx )
+sock.sync_close = true
+
+# The moment of truth...
+$stderr.puts "Attempting to connect..."
+begin
+	sock.connect
+rescue Errno
+	$stderr.puts "Got an error connecting, but no segfault."
+else
+	$stderr.puts "Nope, no segfault!"
+end
+

data/misc/postgres/History.txt

@@ -0,0 +1,9 @@
+== v0.8.0 [2012-02-09] Michael Granger <ged@FaerieMUD.org>
+
+This placeholder version.
+
+
+== v0.7.9.2008.01.28 [2008-01-28] Jeff Davis <<ruby-pg@j-davis.com>>
+
+The last actual version.
+

data/misc/postgres/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/postgres.rb

data/misc/postgres/README.txt

@@ -0,0 +1,21 @@
+= postgres
+
+* https://github.com/ged/ruby-pg
+
+== Description
+
+This is an old, deprecated version of the Ruby PostgreSQL driver that hasn't
+been maintained or supported since early 2008.
+
+You should install/require 'pg' instead.
+
+If you need the 'postgres' gem for legacy code that can't be converted, you can
+still install it using an explicit version, like so:
+
+  gem install postgres -v '0.7.9.2008.01.28'
+  gem uninstall postgres -v '>0.7.9.2008.01.28'
+
+If you have any questions, the nice folks in the Google group can help:
+
+  http://goo.gl/OjOPP / ruby-pg@googlegroups.com
+

data/misc/postgres/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'date'
+require 'rubygems'
+require 'hoe'
+require 'pp'
+
+Hoe.spec 'postgres' do
+	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
+	self.dependency 'pg', '~> 0'
+	self.spec_extras[:date] = Date.parse( '2008/01/30' )
+
+	line = '-' * 75
+	msg = paragraphs_of( 'README.txt', 3..-1 )
+	msg.unshift( line )
+	msg.push( line )
+
+	self.spec_extras[:post_install_message] = msg.join( "\n\n" ) + "\n"
+end
+
+# vim: syntax=ruby

data/misc/postgres/lib/postgres.rb

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require 'pathname'
+
+module Postgres
+
+	VERSION = '0.8.1'
+
+	gemdir = Pathname( __FILE__ ).dirname.parent
+	readme = gemdir + 'README.txt'
+
+	header, message = readme.read.split( /^== Description/m )
+	abort( message.strip )
+
+end
+

data/misc/ruby-pg/History.txt

@@ -0,0 +1,9 @@
+== v0.8.0 [2012-02-09] Michael Granger <ged@FaerieMUD.org>
+
+This placeholder version.
+
+
+== v0.7.9.2008.01.28 [2008-01-28] Jeff Davis <<ruby-pg@j-davis.com>>
+
+The last actual version.
+

data/misc/ruby-pg/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ruby/pg.rb

data/misc/ruby-pg/README.txt

@@ -0,0 +1,21 @@
+= ruby-pg
+
+* https://github.com/ged/ruby-pg
+
+== Description
+
+This is an old, deprecated version of the 'pg' gem that hasn't been
+maintained or supported since early 2008.
+
+You should install/require 'pg' instead.
+
+If you need ruby-pg for legacy code that can't be converted, you can still
+install it using an explicit version, like so:
+
+  gem install ruby-pg -v '0.7.9.2008.01.28'
+  gem uninstall ruby-pg -v '>0.7.9.2008.01.28'
+
+If you have any questions, the nice folks in the Google group can help:
+
+  http://goo.gl/OjOPP / ruby-pg@googlegroups.com
+

data/misc/ruby-pg/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'date'
+require 'rubygems'
+require 'hoe'
+require 'pp'
+
+Hoe.spec 'ruby-pg' do
+	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
+	self.dependency 'pg', '~> 0'
+	self.spec_extras[:date] = Date.parse( '2008/01/30' )
+
+	line = '-' * 75
+	msg = paragraphs_of( 'README.txt', 3..-1 )
+	msg.unshift( line )
+	msg.push( line )
+
+	self.spec_extras[:post_install_message] = msg.join( "\n\n" ) + "\n"
+end
+
+# vim: syntax=ruby