em-pg-client 0.2.0 → 0.2.1

data/HISTORY.rdoc

@@ -1,3 +1,8 @@
+0.2.1
+- support for pg >= 0.14 native PG::Result#check
+- support for pg >= 0.14 native PG::Connection#set_default_encoding
+- fix: connection option Hash argument was modified by Client.new and Client.async_connect
+
 0.2.0
 - disabled async_autoreconnect by default unless on_autoreconnect is set
 - async_connect sets #internal_encoding to Encoding.default_internal

data/README.rdoc

@@ -43,8 +43,8 @@ RDBMS. It is based on ruby-pg[https://bitbucket.org/ged/ruby-pg].
 
 == REQUIREMENTS
 
-* ruby >= 1.9 (tested: 1.9.3-p194, 1.9.2-p320, 1.9.2-p280, 1.9.1-p378)
-* https://bitbucket.org/ged/ruby-pg >= 0.13
+* ruby >= 1.9 (tested: 1.9.3-p194, 1.9.2-p320, 1.9.1-p378)
+* https://bitbucket.org/ged/ruby-pg >= 0.13.2 (>= 0.14 recommended)
 * PostgreSQL[http://www.postgresql.org/ftp/source/] RDBMS >= 8.3
 * http://rubyeventmachine.com >= 0.12.10
 * (optional) EM-Synchrony[https://github.com/igrigorik/em-synchrony]
@@ -56,9 +56,9 @@ RDBMS. It is based on ruby-pg[https://bitbucket.org/ged/ruby-pg].
 ==== Gemfile
 
   # eventmachine
-  gem "em-pg-client", "~> 0.2.0", :require => 'pg/em'
+  gem "em-pg-client", "~> 0.2.1", :require => 'pg/em'
   # em-synchrony
-  gem "em-pg-client", "~> 0.2.0", :require => ['pg/em', 'em-synchrony/pg']
+  gem "em-pg-client", "~> 0.2.1", :require => ['pg/em', 'em-synchrony/pg']
 
 ==== Github
 

data/Rakefile

@@ -8,8 +8,10 @@ desc "Run spec tests"
 task :test, [:which] do |t, args|
   args.with_defaults(:which => 'safe')
 
-  env_unix_socket = {'PGDATABASE' => 'test', 'PGHOST' => '/tmp'}
-  env_tcpip = {'PGDATABASE' => 'test', 'PGHOST' => 'localhost'}
+  env_common = {'PGDATABASE' => 'test'}
+  env_pg_013 = {'EM_PG_CLIENT_TEST_PG_VERSION' => '= 0.13.2'}
+  env_unix_socket = env_common.merge('PGHOST' => '/tmp')
+  env_tcpip = env_common.merge('PGHOST' => 'localhost')
 
   puts "WARNING: The test needs to be run with an available local PostgreSQL server"
 
@@ -21,10 +23,13 @@ task :test, [:which] do |t, args|
     ].each do |spec|
       sh env_unix_socket, "rspec #{spec}"
       sh env_tcpip, "rspec #{spec}"
+      sh env_pg_013.merge(env_unix_socket), "rspec #{spec}"
+      sh env_pg_013.merge(env_tcpip), "rspec #{spec}"
     end
   end
 
   if %w[all unsafe dangerous autoreconnect].include? args[:which]
+    raise "Set PGDATA environment variable before running the autoreconnect tests." unless ENV['PGDATA']
     %w[
       spec/em_client_autoreconnect.rb
       spec/em_synchrony_client_autoreconnect.rb

data/em-pg-client.gemspec

@@ -2,7 +2,7 @@ $:.unshift "lib"
 
 Gem::Specification.new do |s|
   s.name = "em-pg-client"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
   s.required_ruby_version = ">= 1.9.1"
   s.date = "#{Time.now.strftime("%Y-%m-%d")}"
   s.summary = "EventMachine PostgreSQL client"

data/lib/pg/em.rb

@@ -13,34 +13,6 @@ end
 
 module PG
 
-  class Result
-    class << self
-      unless method_defined? :check_result
-        # pg_check_result is internal ext function. I wish it was rubified.
-        # https://bitbucket.org/ged/ruby-pg/issue/123/rubify-pg_check_result
-        def check_result(connection, result)
-          if result.nil?
-            if (error_message = connection.error_message)
-              error = PG::Error.new(error_message)
-            end
-          else
-            case result.result_status
-              when PG::PGRES_BAD_RESPONSE,
-                   PG::PGRES_FATAL_ERROR,
-                   PG::PGRES_NONFATAL_ERROR
-                error = PG::Error.new(result.error_message)
-                error.instance_variable_set('@result', result)
-            end
-          end
-          if error
-            error.instance_variable_set('@connection', connection)
-            raise error 
-          end
-        end
-      end
-    end
-  end
-
   module EM
     class FeaturedDeferrable < ::EM::DefaultDeferrable
       def initialize(&blk)
@@ -215,8 +187,12 @@ module PG
           @client.consume_input
           until @client.is_busy
             if (single_result = @client.get_result).nil?
-              result = @last_result
-              Result.check_result(@client, result)
+              if (result = @last_result).nil?
+                error = PG::Error.new(@client.error_message)
+                error.instance_variable_set(:@connection, @client)
+                raise error
+              end
+              result.check
               detach
               @timer.cancel if @timer
               break
@@ -283,7 +259,7 @@ module PG
           when PG::PGRES_POLLING_OK, PG::PGRES_POLLING_FAILED
             @timer.cancel if @timer
             detach
-            success = @deferrable.protect_and_succeed do
+            @deferrable.protect_and_succeed do
               unless @client.status == PG::CONNECTION_OK
                 begin
                   raise PG::Error, @client.error_message
@@ -292,20 +268,14 @@ module PG
                 end
               end
               # mimic blocking connect behavior
-              unless Encoding.default_internal.nil? || reconnecting?
-                begin
-                  @client.internal_encoding = Encoding.default_internal
-                rescue EncodingError
-                  warn "warning: Failed to set the default_internal encoding to #{Encoding.default_internal}: '#{@client.error_message}'"
-                end
-              end
+              @client.set_default_encoding unless reconnecting?
               @client
             end
           end
         end
       end
 
-      def self.parse_async_args(*args)
+      def self.parse_async_args(args)
         async_args = {
           :@async_autoreconnect => nil,
           :@connect_timeout => 0,
@@ -314,7 +284,7 @@ module PG
           :@async_command_aborted => false,
         }
         if args.last.is_a? Hash
-          args.last.reject! do |key, value|
+          args[-1] = args.last.reject do |key, value|
             case key.to_s
             when 'async_autoreconnect'
               async_args[:@async_autoreconnect] = !!value
@@ -353,7 +323,7 @@ module PG
       # +client_encoding+ *will* be set for you according to Encoding.default_internal.
       def self.async_connect(*args, &blk)
         df = PG::EM::FeaturedDeferrable.new(&blk)
-        async_args = parse_async_args(*args)
+        async_args = parse_async_args(args)
         conn = df.protect { connect_start(*args) }
         if conn
           async_args.each {|k, v| conn.instance_variable_set(k, v) }
@@ -393,7 +363,7 @@ module PG
       # +em-synchrony+ version *will* do set +client_encoding+ for you according to
       # Encoding.default_internal.
       def initialize(*args)
-        Client.parse_async_args(*args).each {|k, v| self.instance_variable_set(k, v) }
+        Client.parse_async_args(args).each {|k, v| self.instance_variable_set(k, v) }
         super(*args)
       end
 
@@ -476,6 +446,48 @@ module PG
 
       alias_method :query, :exec
       alias_method :async_query, :async_exec
+
+      # support for pg < 0.14.0
+      unless method_defined? :set_default_encoding
+        def set_default_encoding
+          unless Encoding.default_internal.nil?
+            self.internal_encoding = Encoding.default_internal
+          end
+        rescue EncodingError
+          warn "warning: Failed to set the default_internal encoding to #{Encoding.default_internal}: '#{self.error_message}'"
+          Encoding.default_internal
+        end
+      end
+
+    end
+  end
+
+  # support for pg < 0.14.0
+  unless Result.method_defined? :check
+    class Result
+      def check
+        case result_status
+          when PG::PGRES_BAD_RESPONSE,
+               PG::PGRES_FATAL_ERROR,
+               PG::PGRES_NONFATAL_ERROR
+            error = PG::Error.new(error_message)
+            error.instance_variable_set(:@result, self)
+            error.instance_variable_set(:@connection, @connection)
+            raise error
+        end
+      end
+      alias_method :check_result, :check
+    end
+
+    module EM
+      class Client < PG::Connection
+        def get_result(&blk)
+          result = super(&blk)
+          result.instance_variable_set(:@connection, self) unless block_given?
+          result
+        end
+      end
     end
   end
+
 end

data/spec/em_client_autoreconnect.rb

@@ -19,6 +19,14 @@ end
 describe 'em-pg default autoreconnect' do
   include_context 'em-pg common'
 
+  it "should not have modified argument Hash" do
+    begin
+      @options.should eq(async_autoreconnect: true)
+    ensure
+      EM.stop
+    end
+  end
+
   it "should get database size using query" do
     @tested_proc.call
   end
@@ -50,7 +58,8 @@ describe 'em-pg default autoreconnect' do
         EM.stop
       end.should be_a_kind_of ::EM::DefaultDeferrable
     end
-    @client = PG::EM::Client.new(async_autoreconnect: true)
+    @options = {async_autoreconnect: true}
+    @client = PG::EM::Client.new(@options)
     @client.set_notice_processor {|msg| puts "warning from pgsql: #{msg.to_s.chomp.inspect}"}
   end
 end
@@ -58,6 +67,14 @@ end
 describe 'em-pg autoreconnect with on_autoreconnect' do
   include_context 'em-pg common'
 
+  it "should not have modified argument Hash" do
+    begin
+      @options.should eq(on_autoreconnect: @on_autoreconnect)
+    ensure
+      EM.stop
+    end
+  end
+
   it "should get database size using prepared statement"do
     @tested_proc.call
   end
@@ -76,12 +93,13 @@ describe 'em-pg autoreconnect with on_autoreconnect' do
         EM.stop
       end.should be_a_kind_of ::EM::DefaultDeferrable
     end
-    on_autoreconnect = proc do |client, ex|
+    @on_autoreconnect = proc do |client, ex|
       df = client.prepare('get_db_size', 'SELECT pg_database_size(current_database());')
       df.should be_a_kind_of ::EM::DefaultDeferrable
       df
     end
-    @client = PG::EM::Client.new(on_autoreconnect: on_autoreconnect)
+    @options = {on_autoreconnect: @on_autoreconnect}
+    @client = PG::EM::Client.new(@options)
     @client.set_notice_processor {|msg| puts "warning from pgsql: #{msg.to_s.chomp.inspect}"}
     @client.prepare('get_db_size', 'SELECT pg_database_size(current_database());')
   end

data/spec/em_client_common.rb

@@ -68,7 +68,7 @@ shared_context 'em-pg common before' do
     @client.close
   end
 
-  it "should be a client" do
+  it "should be a client #{PG::VERSION}" do
     ensure_em_stop do
       @client.should be_an_instance_of described_class
     end
@@ -90,21 +90,27 @@ shared_context 'em-pg common before' do
   it "should set async_autoreconnect according to on_autoreconnect" do
     ensure_em_stop do
       on_autoreconnect = proc {|c, e| false }
-      async_args = described_class.parse_async_args
+      async_args = described_class.parse_async_args([])
       async_args.should be_an_instance_of Hash
       async_args[:@on_autoreconnect].should be_nil
       async_args[:@async_autoreconnect].should be_false
-      async_args = described_class.parse_async_args(on_autoreconnect: on_autoreconnect)
+      args = [on_autoreconnect: on_autoreconnect]
+      async_args = described_class.parse_async_args(args)
+      args.should eq [{}]
       async_args.should be_an_instance_of Hash
       async_args[:@on_autoreconnect].should be on_autoreconnect
       async_args[:@async_autoreconnect].should be_true
-      async_args = described_class.parse_async_args(async_autoreconnect: false,
-        on_autoreconnect: on_autoreconnect)
+      args = [async_autoreconnect: false,
+        on_autoreconnect: on_autoreconnect]
+      async_args = described_class.parse_async_args(args)
+      args.should eq [{}]
       async_args.should be_an_instance_of Hash
       async_args[:@on_autoreconnect].should be on_autoreconnect
       async_args[:@async_autoreconnect].should be_false
-      async_args = described_class.parse_async_args(on_autoreconnect: on_autoreconnect,
-        async_autoreconnect: false)
+      args = [on_autoreconnect: on_autoreconnect,
+        async_autoreconnect: false]
+      async_args = described_class.parse_async_args(args)
+      args.should eq [{}]
       async_args.should be_an_instance_of Hash
       async_args[:@on_autoreconnect].should be on_autoreconnect
       async_args[:@async_autoreconnect].should be_false

data/spec/em_devel_client.rb

@@ -1,5 +1,6 @@
 $:.unshift "lib"
 gem 'eventmachine', '>= 1.0.0.beta.1'
+gem 'pg', ENV['EM_PG_CLIENT_TEST_PG_VERSION']
 require 'date'
 require 'eventmachine'
 require 'pg/em'

data/spec/em_release_client.rb

@@ -1,5 +1,6 @@
 $:.unshift "lib"
 gem 'eventmachine', '= 0.12.10'
+gem 'pg', ENV['EM_PG_CLIENT_TEST_PG_VERSION']
 require 'date'
 require 'eventmachine'
 require 'pg/em'

data/spec/em_synchrony_client.rb

@@ -1,11 +1,12 @@
 $:.unshift "lib"
+gem 'pg', ENV['EM_PG_CLIENT_TEST_PG_VERSION']
 require 'date'
 require 'em-synchrony'
 require 'em-synchrony/pg'
 
 describe PG::EM::Client do
 
-  it "should be client" do
+  it "should be client #{PG::VERSION}" do
     @client.should be_an_instance_of described_class
   end
 

data/spec/em_synchrony_client_autoreconnect.rb

@@ -22,6 +22,10 @@ end
 describe 'em-synchrony-pg default autoreconnect' do
   include_context 'em-synchrony-pg common'
 
+  it "should not have modified argument Hash" do
+    @options.should eq(async_autoreconnect: true)
+  end
+
   it "should get database size using query" do
     @tested_proc.call
   end
@@ -51,7 +55,8 @@ describe 'em-synchrony-pg default autoreconnect' do
         result[0]['pg_database_size'].to_i.should be > 0
       end
     end
-    @client = PG::EM::Client.new(async_autoreconnect: true)
+    @options = {async_autoreconnect: true}
+    @client = PG::EM::Client.new(@options)
     @client.set_notice_processor {|msg| puts "warning from pgsql: #{msg.to_s.chomp.inspect}"}
   end
 end
@@ -59,6 +64,10 @@ end
 describe 'em-synchrony-pg autoreconnect with on_autoreconnect' do
   include_context 'em-synchrony-pg common'
 
+  it "should not have modified argument Hash" do
+    @options.should eq(on_autoreconnect: @on_autoreconnect)
+  end
+
   it "should get database size using prepared statement" do
     @tested_proc.call
   end
@@ -76,12 +85,13 @@ describe 'em-synchrony-pg autoreconnect with on_autoreconnect' do
         result[0]['pg_database_size'].to_i.should be > 0
       end
     end
-    on_autoreconnect = proc do |client, ex|
+    @on_autoreconnect = proc do |client, ex|
       client.prepare('get_db_size', 'SELECT pg_database_size(current_database());')
     end
-    @client = PG::EM::Client.new(on_autoreconnect: on_autoreconnect)
+    @options = {on_autoreconnect: @on_autoreconnect}
+    @client = PG::EM::Client.new(@options)
     @client.set_notice_processor {|msg| puts "warning from pgsql: #{msg.to_s.chomp.inspect}"}
-    on_autoreconnect.call @client
+    @on_autoreconnect.call @client
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-pg-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-08 00:00:00.000000000 Z
+date: 2012-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &244130120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: 0.13.2
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.13.2
+  version_requirements: *244130120
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &244129580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: 0.12.10
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.12.10
+  version_requirements: *244129580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &244128480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -53,15 +43,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.8.0
+  version_requirements: *244128480
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &244127700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,15 +54,10 @@ dependencies:
         version: 1.0.0.beta.1
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0.beta.1
+  version_requirements: *244127700
 - !ruby/object:Gem::Dependency
   name: em-synchrony
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &244126900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -85,12 +65,7 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+  version_requirements: *244126900
 description: PostgreSQL asynchronous EventMachine client, based on pg interface (PG::Connection)
 email: rafal@yeondir.com
 executables: []
@@ -138,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - PostgreSQL server
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: EventMachine PostgreSQL client