torquebox-transactions 2.1.0 → 2.1.1

data/lib/torquebox/transactions.rb

@@ -30,11 +30,10 @@ module TorqueBox
     # The default module mixed into the Manager. Adapters for various
     # resources are expected to override these methods as appropriate
     # for their library. See ActiveRecordAdapters::Transaction, for
-    # example.  These are the methods invoked by Manager#with_tx()
+    # example.
     module Transaction
 
       def prepare
-        @transactions.push( @tm.suspend ) if active?
         @tm.begin
       end
 
@@ -46,15 +45,6 @@ module TorqueBox
         @tm.rollback
       end
 
-      def cleanup
-        @tm.suspend
-        if @transactions.last
-          @tm.resume( @transactions.pop )
-        else
-          Thread.current[:torquebox_transaction] = nil
-        end
-      end
-
       def error( exception )
         puts "Transaction rollback: #{exception}"
         rollback
@@ -88,37 +78,122 @@ module TorqueBox
         end
       end
 
-      # Where we either begin a new transaction (with_tx) or simply
-      # yield as part of the current transaction.
-      def run(*args, &block)
-        return yield unless @tm
-        opts = args.last.is_a?(Hash) ? args.pop : {}
-        if active? && !opts[:requires_new]
-          enlist(*args)
-          yield
-        else
-          with_tx do
-            enlist(*args)
-            block.call
-          end
-        end
-      end
-
       # Is there an active transaction?
       def active?
         @tm.transaction != nil
       end
 
-      # The heart of the matter
-      def with_tx
+      # Begin a transaction, yield, commit or rollback on error.
+      def start
         prepare
         result = yield
         commit
         result
       rescue Exception => e
         error(e)
+      end
+
+      # Suspend current transaction, yield, and resume
+      def suspend
+        @transactions.push( @tm.suspend )
+        yield
+      ensure
+        @tm.resume( @transactions.pop )
+      end
+
+      # JEE Required
+      def required &block
+        if active?
+          yield
+        else
+          start &block
+        end
+      end
+
+      # JEE RequiresNew
+      def requires_new &block
+        if active?
+          suspend do
+            start &block
+          end
+        else
+          start &block
+        end
+      end
+
+      # JEE NotSupported
+      def not_supported &block
+        if active?
+          suspend &block
+        else
+          yield
+        end
+      end
+
+      # JEE Supports
+      def supports
+        yield
+      end
+
+      # JEE Mandatory
+      def mandatory
+        if active?
+          yield
+        else
+          raise "No active transaction"
+        end
+      end
+
+      # JEE Never
+      def never
+        if active?
+          raise "Active transaction detected"
+        else
+          yield
+        end
+      end
+
+      # Returns a 2-element tuple [resources, method] where method is
+      # a symbol corresponding to one of the JEE tx attribute methods
+      # above. All but the last argument should be XA resources to be
+      # enlisted in the transaction. The last argument passed is
+      # expected to be either a symbol referring to one of the JEE
+      # methods or a Hash in which the method symbol is associated
+      # with the :scope key. If omitted, defaults to :required.
+      #
+      # For backwards compatibility the hash may also contain a
+      # :requires_new key which, if true, will result in the
+      # :requires_new method symbol being returned.
+      #
+      # :none may be used as an alias for :not_supported
+      #
+      # Whew!
+      def parse_args(*args)
+        resources, method = case args.last
+                            when Symbol
+                              last = args.pop
+                              [args, last]
+                            when Hash
+                              hash = args.pop
+                              last = hash[:scope] || (hash[:requires_new] ? :requires_new : :required)
+                              [args, last]
+                            else
+                              [args, :required]
+                            end
+        method = :not_supported if method == :none
+        [resources, method]
+      end
+      
+      def run(*args, &block)
+        return yield unless @tm
+        resources, method = parse_args(*args)
+        fn = lambda do
+          enlist(*resources)
+          block.call
+        end
+        send(method, &fn)
       ensure
-        cleanup
+        Thread.current[:torquebox_transaction] = nil if @transactions.empty?
       end
 
     end

data/spec/transactions_spec.rb

@@ -0,0 +1,60 @@
+require 'torquebox/transactions'
+
+describe TorqueBox::Transactions do
+
+  describe "argument parsing" do
+
+    before(:each) do
+      @mgr = TorqueBox::Transactions::Manager.new
+    end
+
+    it "should parse resources followed by a symbol" do
+      resources, method = @mgr.parse_args(1, 2, 3, :requires_new)
+      resources.should == [1, 2, 3]
+      method.should == :requires_new
+    end
+
+    it "should parse only a symbol" do
+      resources, method = @mgr.parse_args(:requires_new)
+      resources.should == []
+      method.should == :requires_new
+    end
+
+    it "should parse no args, returning :required, by default" do
+      resources, method = @mgr.parse_args
+      resources.should == []
+      method.should == :required
+    end
+
+    it "should parse :none to :not_supported" do
+      resources, method = @mgr.parse_args(:none)
+      resources.should == []
+      method.should == :not_supported
+    end
+
+    it "should parse resources followed by a hash" do
+      resources, method = @mgr.parse_args(1, 2, 3, :requires_new => true)
+      resources.should == [1, 2, 3]
+      method.should == :requires_new
+    end
+
+    it "should parse only a hash" do
+      resources, method = @mgr.parse_args(:requires_new => true)
+      resources.should == []
+      method.should == :requires_new
+    end
+
+    it "should parse only a hash containing :scope key" do
+      resources, method = @mgr.parse_args(:scope => :mandatory)
+      resources.should == []
+      method.should == :mandatory
+    end
+
+    it "should parse only a hash, preferring :scope to :requires_new" do
+      resources, method = @mgr.parse_args(:scope => :required, :requires_new => true)
+      resources.should == []
+      method.should == :required
+    end
+
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: torquebox-transactions
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors: 
   - The TorqueBox Team
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-26 00:00:00 Z
+date: 2012-08-27 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: torquebox-core
@@ -20,7 +20,7 @@ dependencies:
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
-            version: 2.1.0
+            version: 2.1.1
     type: :runtime
     version_requirements: *id001
   - !ruby/object:Gem::Dependency 
@@ -48,6 +48,7 @@ files:
   - lib/torquebox/active_record_adapters.rb
   - lib/torquebox/transactions.rb
   - lib/torquebox/transactions/ext/active_record/base.rb
+  - spec/transactions_spec.rb
 homepage: http://torquebox.org/
 licenses: 
   - lgpl
@@ -75,5 +76,5 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: TorqueBox Transactions Gem
-test_files: []
-
+test_files: 
+  - spec/transactions_spec.rb