pg 0.12.0 → 0.16.0

data/Contributors.rdoc

@@ -36,4 +36,11 @@ list.
 * Mahlon E. Smith <mahlon@martini.nu>
 * Lars Kanis <kanis@comcard.de>
 * Jason Yanowitz <me-bitbucket@jasonyanowitz.com>
+* Charlie Savage <cfis@rubyforge.org>
+* Rafał Bigaj <rafal.bigaj@gmail.com>
+* Jason Yanowitz <me-bitbucket@jasonyanowitz.com>
+* Greg Hazel <ghazel@gmail.com>
+* Chris White <cwprogram@live.com>
+* Aaron Patterson <aaron.patterson@gmail.com>
+* Tim Felgentreff <timfelgentreff@gmail.com>
 

data/History.rdoc

@@ -1,3 +1,181 @@
+== v0.16.0 [2013-07-22] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Avoid warnings about uninitialized instance variables.
+- Use a more standard method of adding library and include directories.
+  This fixes build on AIX (Github #7) and Solaris (#164).
+- Cancel the running query, if a thread is about to be killed (e.g. by CTRL-C).
+- Fix GVL issue with wait_for_notify/notifies and notice callbacks.
+- Set proper encoding on the string returned by quote_ident, escape_literal
+  and escape_identifier (#163).
+- Use nil as PG::Error#result in case of a NULL-result from libpq (#166).
+- Recalculate the timeout of conn#wait_for_notify and conn#block in case
+  of socket events that require re-runs of select().
+
+Documentation fixes:
+
+- Fix non working example for PGresult#error_field.
+
+Enhancements:
+
+- Add unique exception classes for each PostgreSQL error type (#5).
+- Return result of the block in conn#transaction instead of nil (#158).
+- Allow 'rake compile' and 'rake gem' on non mercurial repos.
+- Add support for PG_DIAG_*_NAME error fields of PostgreSQL-9.3 (#161).
+
+
+== v0.15.1 [2013-04-08] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Shorten application_name to avoid warnings about truncated identifier.
+
+
+== v0.15.0 [2013-03-03] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+
+- Fix segfault in PG::Result#field_values when called with non String value.
+- Fix encoding of messages delivered by notice callbacks.
+- Fix text encoding for Connection#wait_for_notify and Connection#notifies.
+- Fix 'Bad file descriptor' problems under Windows: wrong behaviour of
+  #wait_for_notify() and timeout handling of #block on Ruby 1.9.
+
+Documentation fixes:
+
+- conn#socket() can not be used with IO.for_fd() on Windows.
+
+Enhancements:
+
+- Tested under Ruby 2.0.0p0.
+- Add single row mode of PostgreSQL 9.2.
+- Set fallback_application_name to programm name $0. Thanks to Will Leinweber
+  for the patch.
+- Release Ruby's GVL while calls to blocking libpq functions to allow better
+  concurrency in threaded applications.
+- Refactor different variants of waiting for the connection socket.
+- Make use of rb_thread_fd_select() on Ruby 1.9 and avoid deprecated
+  rb_thread_select().
+- Add an example of how to insert array data using a prepared statement (#145).
+- Add continous integration tests on travis-ci.org.
+- Add PG::Result#each_row for iterative over result sets by row. Thanks to
+  Aaron Patterson for the patch.
+- Add a PG::Connection#socket_io method for fetching a (non-autoclosing) IO
+  object for the connection's socket.
+
+Specs:
+
+- Fix various specs to run on older PostgreSQL and Ruby versions.
+- Avoid fork() in specs to allow usage on Windows and JRuby.
+
+
+== v0.14.1 [2012-09-02] Michael Granger <ged@FaerieMUD.org>
+
+Important bugfix:
+
+- Fix stack overflow bug in PG::Result#values and #column_values (#135). Thanks
+  to everyone who reported the bug, and Lars Kanis especially for figuring out
+  the problem.
+
+PostgreSQL 9.2 beta fixes:
+
+- Recognize PGRES_SINGLE_TUPLE as OK when checking PGresult (Jeremy Evans)
+
+Documentation fixes:
+
+- Add note about the usage scope of the result object received by the
+  #set_notice_receiver block. (Lars Kanis)
+- Add PGRES_COPY_BOTH to documentation of PG::Result#result_status. (Lars Kanis)
+- Add some documentation to PG::Result#fnumber (fix for #139)
+
+
+== v0.14.0 [2012-06-17] Michael Granger <ged@FaerieMUD.org>
+
+Bugfixes:
+  #47, #104
+
+
+New Methods for PostgreSQL 9 and async API support:
+PG
+- ::library_version
+
+PG::Connection
+- ::ping
+- #escape_literal
+- #escape_identifier
+- #set_default_encoding
+
+PG::Result
+- #check
+
+
+New Samples:
+
+This release also comes with a collection of contributed sample scripts for
+doing resource-utilization reports, graphing database statistics,
+monitoring for replication lag, shipping WAL files for replication,
+automated tablespace partitioning, etc. See the samples/ directory.
+
+
+== v0.13.2 [2012-02-22] Michael Granger <ged@FaerieMUD.org>
+
+- Make builds against PostgreSQL earlier than 8.3 fail with a descriptive
+  message instead of a compile failure.
+
+
+== v0.13.1 [2012-02-12] Michael Granger <ged@FaerieMUD.org>
+
+- Made use of a finished PG::Connection raise a PG::Error instead of
+  a fatal error (#110).
+- Added missing BSDL license file (#108)
+
+
+== v0.13.0 [2012-02-09] Michael Granger <ged@FaerieMUD.org>
+
+Reorganization of modules/classes to be better Ruby citizens (with backward-compatible aliases):
+- Created toplevel namespace 'PG' to correspond with the gem name.
+- Renamed PGconn to PG::Connection (with ::PGconn alias)
+- Renamed PGresult to PG::Result (with ::PGresult alias)
+- Renamed PGError to PG::Error (with ::PGError alias)
+- Declare all constants inside PG::Constants, then include them in
+  PG::Connection and PG::Result for backward-compatibility, and
+  in PG for convenience.
+- Split the extension source up by class/module.
+- Removed old compatibility code for PostgreSQL versions < 8.3
+
+Documentation:
+- Clarified licensing, updated to Ruby 1.9's license.
+- Merged authors list, added some missing people to the Contributor's
+  list.
+- Cleaned up the sample/ directory
+- Making contact info a bit clearer, link to the Google+ page and
+  the mailing list
+
+Enhancements:
+- Added a convenience method: PG.connect -> PG::Connection.new
+
+Bugfixes:
+- Fixed LATIN5-LATIN10 Postgres<->Ruby encoding conversions
+
+
+
+== v0.12.2 [2012-01-03] Michael Granger <ged@FaerieMUD.org>
+
+- Fix for the 1.8.7 breakage introduced by the st.h fix for alternative Ruby
+  implementations (#97 and #98). Thanks to Lars Kanis for the patch.
+- Encode error messages with the connection's encoding under 1.9 (#96)
+
+
+== v0.12.1 [2011-12-14] Michael Granger <ged@FaerieMUD.org>
+
+- Made rake-compiler a dev dependency, as Rubygems doesn't use the Rakefile
+  for compiling the extension. Thanks to eolamey@bitbucket and Jeremy Evans
+  for pointing this out.
+- Added an explicit include for ruby/st.h for implementations that need it
+  (fixes #95).
+
+
 == v0.12.0 [2011-12-07] Michael Granger <ged@FaerieMUD.org>
 
 - PGconn#wait_for_notify
@@ -5,11 +183,11 @@
   * accept a nil argument for no timeout (Sequel support)
   * Fixed API docs
   * Taint and encode event name and payload
-- Handle errors while rb_thread_select()ing in PGconn#block. 
+- Handle errors while rb_thread_select()ing in PGconn#block.
   (Brian Weaver).
 - Fixes for Win32 async queries (Rafał Bigaj)
 - Memory leak fixed: Closing opened WSA event. (rafal)
-- Fixes for #66 Win32 asynchronous queries hang on connection 
+- Fixes for #66 Win32 asynchronous queries hang on connection
   error. (rafal)
 - Fixed a typo in PGconn#error_message's documentation
 - fixing unused variable warnings for ruby 1.9.3 (Aaron Patterson)
@@ -22,7 +200,7 @@
 
 Enhancements:
 
-* Added a PGresult#values method to fetch all result rows as an Array of 
+* Added a PGresult#values method to fetch all result rows as an Array of
   Arrays. Thanks to Jason Yanowitz (JYanowitz at enovafinancial dot com) for
   the patch.
 

data/LICENSE

@@ -1,6 +1,6 @@
-Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
-You can redistribute it and/or modify it under either the terms of the GPL
-(see COPYING.txt file), or the conditions below:
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
 
   1. You may make and give away verbatim copies of the source form of the
      software without restriction, provided that you duplicate all of the
@@ -17,33 +17,32 @@ You can redistribute it and/or modify it under either the terms of the GPL
        b) use the modified software only within your corporation or
           organization.
 
-       c) rename any non-standard executables so the names do not conflict
-	  with standard executables, which must also be provided.
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
 
        d) make other distribution arrangements with the author.
 
-  3. You may distribute the software in object code or executable
-     form, provided that you do at least ONE of the following:
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
 
-       a) distribute the executables and library files of the software,
+       a) distribute the binaries and library files of the software,
 	  together with instructions (in the manual page or equivalent)
 	  on where to get the original distribution.
 
        b) accompany the distribution with the machine-readable source of
 	  the software.
 
-       c) give non-standard executables non-standard names, with
+       c) give non-standard binaries non-standard names, with
           instructions on where to get the original software distribution.
 
        d) make other distribution arrangements with the author.
 
   4. You may modify and include the part of the software into any other
      software (possibly commercial).  But some files in the distribution
-     are not written by the author, so that they are not under this terms.
+     are not written by the author, so that they are not under these terms.
 
-     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
-     files under the ./missing directory.  See each file for the copying
-     condition.
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
 
   5. The scripts and library files supplied as input to or produced as 
      output from the software do not automatically fall under the
@@ -55,4 +54,3 @@ You can redistribute it and/or modify it under either the terms of the GPL
      IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
      PURPOSE.
-

data/Manifest.txt

@@ -1,43 +1,57 @@
 .gemtest
-BSD
+BSDL
 ChangeLog
 Contributors.rdoc
-GPL
 History.rdoc
 LICENSE
 Manifest.txt
-README.OS_X.rdoc
+POSTGRES
+README-OS_X.rdoc
+README-Windows.rdoc
 README.ja.rdoc
 README.rdoc
-README.windows.rdoc
 Rakefile
 Rakefile.cross
-ext/compat.c
-ext/compat.h
+ext/errorcodes.def
+ext/errorcodes.rb
+ext/errorcodes.txt
 ext/extconf.rb
+ext/gvl_wrappers.c
+ext/gvl_wrappers.h
 ext/pg.c
 ext/pg.h
+ext/pg_connection.c
+ext/pg_errors.c
+ext/pg_result.c
 ext/vc/pg.sln
 ext/vc/pg_18/pg.vcproj
 ext/vc/pg_19/pg_19.vcproj
 lib/pg.rb
-misc/openssl-pg-segfault.rb
+lib/pg/connection.rb
+lib/pg/constants.rb
+lib/pg/exceptions.rb
+lib/pg/result.rb
+sample/array_insert.rb
 sample/async_api.rb
 sample/async_copyto.rb
+sample/async_mixed.rb
+sample/check_conn.rb
 sample/copyfrom.rb
 sample/copyto.rb
 sample/cursor.rb
+sample/disk_usage_report.rb
+sample/issue-119.rb
 sample/losample.rb
+sample/minimal-testcase.rb
 sample/notify_wait.rb
-sample/psql.rb
-sample/psqlHelp.rb
-sample/test1.rb
-sample/test2.rb
-sample/test4.rb
+sample/pg_statistics.rb
+sample/replication_monitor.rb
 sample/test_binary_values.rb
+sample/wal_shipper.rb
+sample/warehouse_partitions.rb
 spec/data/expected_trace.out
 spec/data/random_binary_data
 spec/lib/helpers.rb
-spec/m17n_spec.rb
-spec/pgconn_spec.rb
-spec/pgresult_spec.rb
+spec/pg/connection_spec.rb
+spec/pg/result_spec.rb
+spec/pg_spec.rb

data/README.ja.rdoc

@@ -1,7 +1,14 @@
 = pg
 
-* https://bitbucket.org/ged/ruby-pg
+home :: https://bitbucket.org/ged/ruby-pg
+mirror :: https://github.com/ged/ruby-pg
+docs :: http://deveiate.org/code/pg
 
-This file needs translation. Anyone who is willing to volunteer, please 
-mail <ged@FaerieMUD.org>.
+
+== Description
+
+This file needs a translation of the English README. Pull requests, patches, or
+volunteers gladly accepted.
+
+Until such time, please accept my sincere apologies for not knowing Japanese.
 

data/README.rdoc

@@ -1,25 +1,44 @@
 = pg
 
-* https://bitbucket.org/ged/ruby-pg
+home :: https://bitbucket.org/ged/ruby-pg
+mirror :: https://github.com/ged/ruby-pg
+docs :: http://deveiate.org/code/pg
+
 
 == Description
 
 Pg is the Ruby interface to the {PostgreSQL RDBMS}[http://www.postgresql.org/].
 
-It works with PostgreSQL 8.2 and later.
+It works with {PostgreSQL 8.4 and later}[http://www.postgresql.org/support/versioning/].
+
+A small example usage:
+
+  #!/usr/bin/env ruby
+
+  require 'pg'
 
-This will be the last minor version to support 8.2 -- 0.13 will support 8.3 
-and later, following the 
-{PostgreSQL Release Support Policy}[http://bit.ly/6AfPhm].
+  # Output a table of current connections to the DB
+  conn = PG.connect( dbname: 'sales' )
+  conn.exec( "SELECT * FROM pg_stat_activity" ) do |result|
+    puts "     PID | User             | Query"
+  result.each do |row|
+      puts " %7d | %-16s | %s " %
+        row.values_at('procpid', 'usename', 'current_query')
+    end
+  end
 
+== Build Status
+
+{<img src="https://travis-ci.org/ged/ruby-pg.png?branch=master" alt="Build Status" />}[https://travis-ci.org/ged/ruby-pg]
 
 
 == Requirements
 
-* Ruby 1.8.7-p249 or later.
-* PostgreSQL 8.2.x or later installed.
+* Ruby 1.9.3-p392, or 2.0.0-p0.
+* PostgreSQL 8.4.x or later (with headers, -dev packages, etc).
 
-It may work with earlier versions as well, but those are not regularly tested.
+It may work with earlier versions of Ruby/PostgreSQL as well, but those are
+not regularly tested.
 
 
 == How To Install
@@ -33,8 +52,16 @@ Postgres:
 
     gem install pg -- --with-pg-config=<path to pg_config>
 
-See README.OS_X.rdoc for more information about installing under MacOS X, and
-README.windows.rdoc for Windows build/installation instructions.
+If you're installing via Bundler, you can provide compile hints like so:
+
+    bundle config build.pg --with-pg-config=<path to pg_config>
+
+See README-OS_X.rdoc for more information about installing under MacOS X, and
+README-Windows.rdoc for Windows build/installation instructions.
+
+There's also {a Google+ group}[http://goo.gl/TFy1U] and a
+{mailing list}[http://groups.google.com/group/ruby-pg] if you get stuck, or just
+want to chat about something.
 
 
 == Contributing
@@ -50,39 +77,38 @@ After checking out the source, run:
 This task will install any missing dependencies, run the tests/specs, and
 generate the API documentation.
 
+The current maintainers are Michael Granger <ged@FaerieMUD.org> and
+Lars Kanis <lars@greiz-reinsdorf.de>.
 
-== Copying
 
-This library is copyrighted by the authors.
+== Copying
 
-Authors:
+Copyright (c) 1997-2013 by the authors.
 
-* Yukihiro Matsumoto <matz@ruby-lang.org> - Author of Ruby.
-* Eiji Matsumoto <usagi@ruby.club.or.jp> - One of users who loves Ruby.
 * Jeff Davis <ruby-pg@j-davis.com>
-
-Thanks to:
-
-* Noboru Saitou <noborus@netlab.jp> - Past maintainer.
-* Dave Lee - Past maintainer.
-* Guy Decoux (ts) <decoux@moulon.inra.fr> 
-  
-Maintainers:
-
+* Guy Decoux (ts) <decoux@moulon.inra.fr>
 * Michael Granger <ged@FaerieMUD.org>
+* Lars Kanis <lars@greiz-reinsdorf.de>
+* Dave Lee
+* Eiji Matsumoto <usagi@ruby.club.or.jp>
+* Yukihiro Matsumoto <matz@ruby-lang.org>
+* Noboru Saitou <noborus@netlab.jp>
 
-You may redistribute this software under the terms of the Ruby license,
-included in the file "LICENSE". The Ruby license also allows distribution
-under the terms of the GPL, included in the file "GPL".
+You may redistribute this software under the same terms as Ruby itself; see
+http://www.ruby-lang.org/en/LICENSE.txt or the LICENSE file in the source
+for details.
 
 Portions of the code are from the PostgreSQL project, and are distributed
-under the terms of the BSD license, included in the file "BSD".
+under the terms of the PostgreSQL license, included in the file POSTGRES.
 
 Portions copyright LAIKA, Inc.
 
 
 == Acknowledgments
 
+See Contributors.rdoc for the many additional fine people that have contributed
+to this library over the years.
+
 We are thankful to the people at the ruby-list and ruby-dev mailing lists.
 And to the people who developed PostgreSQL.
 

data/Rakefile

@@ -26,7 +26,7 @@ EXTDIR  = BASEDIR + 'ext'
 PKGDIR  = BASEDIR + 'pkg'
 TMPDIR  = BASEDIR + 'tmp'
 
-DLEXT   = Config::CONFIG['DLEXT']
+DLEXT   = RbConfig::CONFIG['DLEXT']
 EXT     = LIBDIR + "pg_ext.#{DLEXT}"
 
 TEST_DIRECTORY = BASEDIR + "tmp_test_specs"
@@ -37,6 +37,7 @@ CLEAN.include( PKGDIR.to_s, TMPDIR.to_s )
 # Set up Hoe plugins
 Hoe.plugin :mercurial
 Hoe.plugin :signing
+Hoe.plugin :deveiate
 
 Hoe.plugins.delete :rubyforge
 Hoe.plugins.delete :compiler
@@ -49,14 +50,13 @@ $hoespec = Hoe.spec 'pg' do
 	self.readme_file = 'README.rdoc'
 	self.history_file = 'History.rdoc'
 	self.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
-	self.extra_rdoc_files.include( 'BSD', 'GPL', 'LICENSE' )
+	self.extra_rdoc_files.include( 'POSTGRES', 'LICENSE' )
 	self.extra_rdoc_files.include( 'ext/*.c' )
 
-	self.developer 'Jeff Davis', 'ruby-pg@j-davis.com'
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
-	self.dependency 'rake-compiler', '~> 0.7'
-	self.dependency	'rspec', '~> 2.6', :developer
+	self.dependency 'rake-compiler', '~> 0.8', :developer
+	self.dependency	'hoe-deveiate', '~> 0.2', :developer
 
 	self.spec_extras[:licenses] = ['BSD', 'Ruby', 'GPL']
 	self.spec_extras[:extensions] = [ 'ext/extconf.rb' ]
@@ -65,6 +65,11 @@ $hoespec = Hoe.spec 'pg' do
 
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
 	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
+	self.spec_extras[:rdoc_options] = [
+		'-f', 'fivefish',
+		'-t', 'pg: The Ruby Interface to PostgreSQL',
+		'-m', 'README.rdoc',
+	]
 
 	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
 end
@@ -97,7 +102,7 @@ task :maint do
 	ENV['MAINTAINER_MODE'] = 'yes'
 end
 
-ENV['RUBY_CC_VERSION'] = '1.8.7:1.9.2'
+ENV['RUBY_CC_VERSION'] ||= '1.8.7:1.9.2:2.0.0'
 
 # Rake-compiler task
 Rake::ExtensionTask.new do |ext|
@@ -107,32 +112,38 @@ Rake::ExtensionTask.new do |ext|
 	ext.lib_dir        = 'lib'
 	ext.source_pattern = "*.{c,h}"
 	ext.cross_compile  = true
-	ext.cross_platform = %w[i386-mingw32]
-
-  # configure options only for cross compile
-  ext.cross_config_options += [
-    "--with-pg-include=#{STATIC_POSTGRESQL_LIBDIR}",
-    "--with-opt-include=#{STATIC_POSTGRESQL_INCDIR}",
-    "--with-pg-lib=#{STATIC_POSTGRESQL_LIBDIR}",
-    "--with-opt-lib=#{STATIC_OPENSSL_BUILDDIR}",
-    "--enable-static-build",
-  ]
+	ext.cross_platform = CrossLibraries.map &:for_platform
+
+  ext.cross_config_options += CrossLibraries.map do |lib|
+    {
+      lib.for_platform => [
+        "--with-pg-include=#{lib.static_postgresql_libdir}",
+        "--with-opt-include=#{lib.static_postgresql_incdir}",
+        "--with-pg-lib=#{lib.static_postgresql_libdir}",
+        "--with-opt-lib=#{lib.static_openssl_builddir}",
+      ]
+    }
+  end
 end
 
 
 # Make the ChangeLog update if the repo has changed since it was last built
 file '.hg/branch' do
-	abort "You need the Mercurial repo to make packages"
+	warn "WARNING: You need the Mercurial repo to update the ChangeLog"
 end
-file 'ChangeLog' => '.hg/branch' do |task|
-	$stderr.puts "Updating the changelog..."
-	begin
-		content = make_changelog()
-	rescue NameError
-		abort "Packaging tasks require the hoe-mercurial plugin (gem install hoe-mercurial)"
-	end
-	File.open( task.name, 'w', 0644 ) do |fh|
-		fh.print( content )
+file 'ChangeLog' do |task|
+	if File.exist?('.hg/branch')
+		$stderr.puts "Updating the changelog..."
+		begin
+			content = make_changelog()
+		rescue NameError
+			abort "Packaging tasks require the hoe-mercurial plugin (gem install hoe-mercurial)"
+		end
+		File.open( task.name, 'w', 0644 ) do |fh|
+			fh.print( content )
+		end
+	else
+		touch 'ChangeLog'
 	end
 end
 
@@ -147,3 +158,19 @@ task :cleanup_testing_dbs do
     Rake::Task[:clean].invoke
 end
 
+desc "Update list of server error codes"
+task :update_error_codes do
+	URL_ERRORCODES_TXT = "http://git.postgresql.org/gitweb/?p=postgresql.git;a=blob_plain;f=src/backend/utils/errcodes.txt;hb=HEAD"
+
+	ERRORCODES_TXT = "ext/errorcodes.txt"
+	sh "wget #{URL_ERRORCODES_TXT.inspect} -O #{ERRORCODES_TXT.inspect} || curl #{URL_ERRORCODES_TXT.inspect} -o #{ERRORCODES_TXT.inspect}"
+end
+
+file 'ext/errorcodes.def' => ['ext/errorcodes.rb', 'ext/errorcodes.txt'] do
+	ruby 'ext/errorcodes.rb', 'ext/errorcodes.txt', 'ext/errorcodes.def'
+end
+
+file 'ext/pg_errors.c' => ['ext/errorcodes.def'] do
+	# trigger compilation of changed errorcodes.def
+	touch 'ext/pg_errors.c'
+end