pg 0.18.3 → 1.4.3

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,11 +1,18 @@
-#!/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
 
 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,18 +10,34 @@ 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
-		self
+		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
 		str = self.to_s
-		str[-1,0] = " status=#{res_status(result_status)} ntuples=#{ntuples} nfields=#{nfields} cmd_tuples=#{cmd_tuples}"
-		str
+		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
 
-# Backward-compatible alias
-PGresult = PG::Result

data/lib/pg/text_decoder.rb

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'date'
+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
@@ -16,29 +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 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,59 @@
-#!/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
+
+		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

@@ -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.4.3'
+end

data/lib/pg.rb

@@ -1,64 +1,89 @@
-#!/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
 
-		# Set the PATH environment variable, so that libpq.dll can be found.
-		old_path = ENV['PATH']
-		ENV['PATH'] = "#{File.expand_path("../#{RUBY_PLATFORM}", __FILE__)};#{old_path}"
-		require "#{major_minor}/pg_ext"
-		ENV['PATH'] = old_path
+# 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
-		raise
+		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
 
-end
-
-
-# The top-level PG namespace.
-module PG
+	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)
+			rescue LoadError
+				old_path = ENV['PATH']
+				ENV['PATH'] = "#{path};#{old_path}"
+				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
 
-	# Library version
-	VERSION = '0.18.3'
+	# 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
+	end
 
-	# VCS revision
-	REVISION = %q$Revision: 3b49541c9f12 $
 
 	class NotAllCopyDataRetrieved < PG::Error
 	end
+	class NotInBlockingMode < PG::Error
+	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
+	# 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
 
 
 	### Convenience alias for PG::Connection.new.
-	def self::connect( *args )
-		return PG::Connection.new( *args )
+	def self.connect( *args, &block )
+		Connection.new( *args, &block )
 	end
 
 
 	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/basic_type_registry'
+	require 'pg/basic_type_map_based_on_result'
+	require 'pg/basic_type_map_for_queries'
+	require 'pg/basic_type_map_for_results'
 	require 'pg/type_map_by_column'
 	require 'pg/connection'
 	require 'pg/result'
+	require 'pg/tuple'
+	require 'pg/version'
 
 end # module PG
-
-
-# Backward-compatible aliase
-PGError = PG::Error
-

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

data/misc/ruby-pg/lib/ruby/pg.rb

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

data/pg.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# -*- encoding: utf-8 -*-
+
+require_relative 'lib/pg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg"
+  spec.version       = PG::VERSION
+  spec.authors       = ["Michael Granger", "Lars Kanis"]
+  spec.email         = ["ged@FaerieMUD.org", "lars@greiz-reinsdorf.de"]
+
+  spec.summary       = "Pg is the Ruby interface to the PostgreSQL RDBMS"
+  spec.description   = "Pg is the Ruby interface to the PostgreSQL RDBMS. It works with PostgreSQL 9.3 and later."
+  spec.homepage      = "https://github.com/ged/ruby-pg"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ged/ruby-pg"
+  spec.metadata["changelog_uri"] = "https://github.com/ged/ruby-pg/blob/master/History.rdoc"
+  spec.metadata["documentation_uri"] = "http://deveiate.org/code/pg"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.extensions    = ["ext/extconf.rb"]
+  spec.require_paths = ["lib"]
+  spec.cert_chain    = ["certs/ged.pem"]
+  spec.rdoc_options  = ["--main", "README.rdoc"]
+end

data/rakelib/task_extension.rb

@@ -0,0 +1,46 @@
+# This source code is borrowed from:
+# https://github.com/oneclick/rubyinstaller2/blob/b3dcbf69f131e44c78ea3a1c5e0041c223f266ce/lib/ruby_installer/build/utils.rb#L104-L144
+
+module TaskExtension
+  # Extend rake's file task to be defined only once and to check the expected file is indeed generated
+  #
+  # The same as #task, but for #file.
+  # In addition this file task raises an error, if the file that is expected to be generated is not present after the block was executed.
+  def file(name, *args, &block)
+    task_once(name, block) do
+      super(name, *args) do |ta|
+        block.call(ta).tap do
+          raise "file #{ta.name} is missing after task executed" unless File.exist?(ta.name)
+        end
+      end
+    end
+  end
+
+  # Extend rake's task definition to be defined only once, even if called several times
+  #
+  # This allows to define common tasks next to specific tasks.
+  # It is expected that any variation of the task's block is reflected in the task name or namespace.
+  # If the task name is identical, the task block is executed only once, even if the file task definition is executed twice.
+  def task(name, *args, &block)
+    task_once(name, block) do
+      super
+    end
+  end
+
+  private def task_once(name, block)
+    name = name.keys.first if name.is_a?(Hash)
+    if block &&
+        Rake::Task.task_defined?(name) &&
+        Rake::Task[name].instance_variable_get('@task_block_location') == block.source_location
+      # task is already defined for this target and the same block
+      # So skip double definition of the same action
+      Rake::Task[name]
+    elsif block
+      yield.tap do
+        Rake::Task[name].instance_variable_set('@task_block_location', block.source_location)
+      end
+    else
+      yield
+    end
+  end
+end

data/sample/array_insert.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 
 require 'pg'