em-pg-client-helper 0.1.1 → 0.2.0

data/lib/em-pg-client-helper.rb

@@ -48,16 +48,17 @@ module PG::EM::Client::Helper
 	#
 	# Calling this method opens up a transaction (by executing `BEGIN`), and
 	# then runs the supplied block, passing in a transaction object which you
-	# can use to execute SQL commands.  When the block completes, a `COMMIT`
-	# will automatically be executed, unless you have manually called
-	# `txn.commit` or `txn.rollback`.  Since `db_transaction` returns a
-	# deferrable, you should use `#callback` to specify what to run after the
-	# transaction completes.
+	# can use to execute SQL commands.  You *must* call `txn.commit` or
+	# `txn.callback` yourself as your inner-most callback, otherwise you will
+	# leave the connection in a weird limbo state.
+	#
+	# Since `db_transaction` returns a deferrable, you should use `#callback`
+	# to specify what to run after the transaction completes.
 	#
 	# If an SQL error occurs during the transaction, the block's execution
 	# will be aborted, a `ROLLBACK` will be executed, and the `#errback`
-	# block (if defined) on the deferrable will be executed (rather than the
-	# `#callback` block).
+	# block (if defined) on the deferrable that `db_transaction` returns will
+	# be executed (rather than the `#callback` block).
 	#
 	# Arguments:
 	#
@@ -71,7 +72,10 @@ module PG::EM::Client::Helper
 	#    of the transaction.  This block will be passed a
 	#    `PG::EM::Client::Helper::Transaction` instance, which has methods to
 	#    allow you to commit or rollback the transaction, and execute SQL
-	#    statements within the context of the transaction.
+	#    statements within the context of the transaction.  This block *must*
+	#    return a deferrable.  When that returned deferrable completes, a
+	#    COMMIT will be triggered automatically.  If that deferrable fails,
+	#    a ROLLBACK will be sent, instead.
 	#
 	# Returns a deferrable object, on which you can call `#callback` and
 	# `#errback` to define what to do when the transaction succeeds or fails,
@@ -79,7 +83,7 @@ module PG::EM::Client::Helper
 	#
 	def db_transaction(db, opts = {}, &blk)
 		if db.is_a? PG::EM::ConnectionPool
-			db.__send__(:hold_deferrable) do |conn|
+			db.__send__(:hold_deferred) do |conn|
 				::PG::EM::Client::Helper::Transaction.new(conn, opts, &blk)
 			end
 		else
@@ -108,7 +112,6 @@ module PG::EM::Client::Helper
 			
 			conn.exec_defer("BEGIN").callback do
 				blk.call(self)
-				commit if @active
 			end.errback { |ex| rollback(ex) }
 		end
 
@@ -131,9 +134,11 @@ module PG::EM::Client::Helper
 		# event of a database error or other exception.
 		#
 		def rollback(ex)
-			@conn.exec_defer("ROLLBACK") do
-				@active = false
-				self.fail(ex)
+			if @active
+				@conn.exec_defer("ROLLBACK") do
+					@active = false
+					self.fail(ex)
+				end
 			end
 		end
 
@@ -158,9 +163,9 @@ module PG::EM::Client::Helper
 				      "Cannot execute a query in a transaction that has been closed"
 			end
 
-			df = @conn.exec_defer(sql, values).
-			       errback { |ex| rollback(ex) }
-			df.callback(&blk) if blk
+			@conn.exec_defer(sql, values).
+			        errback { |ex| rollback(ex) }.
+			        tap { |df| df.callback(&blk) if blk }
 		end
 	end
 end

data/spec/db_transaction_spec.rb

@@ -31,19 +31,19 @@ describe "PG::EM::Client::Helper#db_transaction" do
 
 	it "runs a BEGIN/COMMIT cycle by default" do
 		mock_query_chain([["BEGIN"], ["COMMIT"]]) do
-			# Nothing
+			EM::DefaultDeferrable.new.tap { |df| df.succeed }
 		end
 	end
 	
 	it "rolls back if BEGIN fails" do
 		mock_query_chain([["BEGIN"], ["ROLLBACK"]], 0) do
-			# Nothing
+			EM::DefaultDeferrable.new.tap { |df| df.succeed }
 		end
 	end
 	
 	it "rolls back if COMMIT fails" do
 		mock_query_chain([["BEGIN"], ["COMMIT"], ["ROLLBACK"]], 1) do
-			# Nothing
+			EM::DefaultDeferrable.new.tap { |df| df.succeed }
 		end
 	end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-pg-client-helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git-version-bump
@@ -236,7 +236,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2023776752281468626
+      hash: 3974973386782984490
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -245,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2023776752281468626
+      hash: 3974973386782984490
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23