activerecord-wrapped_transaction 0.5.1 → 0.9.0

data/gemfiles/rails_6_sqlite3.gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: ..
+  specs:
+    activerecord-wrapped_transaction (0.9.0)
+      activerecord (>= 5, < 7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    database_cleaner (1.8.5)
+    database_cleaner-active_record (1.8.0)
+      activerecord
+      database_cleaner (~> 1.8.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6, < 7)
+  activerecord-wrapped_transaction!
+  appraisal (~> 2.3.0)
+  database_cleaner-active_record (~> 1.8.0)
+  pry
+  rake (>= 12.3.3)
+  rspec (~> 3.5)
+  simplecov (~> 0.18.5)
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/lib/activerecord/wrapped_transaction.rb

@@ -1,25 +1,44 @@
 require "active_record"
 require "activerecord/wrapped_transaction/version"
+require "activerecord/wrapped_transaction/context"
 require "activerecord/wrapped_transaction/result"
 
 module ActiveRecord
   module WrappedTransaction
     extend ActiveSupport::Concern
 
+    class InvalidTransactor < ArgumentError; end
+
+    TRANSACTOR = ->(object) do
+      object.tap do |o|
+        raise InvalidTransactor, "#{object.inspect} must respond to #transaction" unless o.respond_to?(:transaction)
+      end
+    end
+
     included do
       delegate :wrapped_transaction, to: :class
     end
 
     class_methods do
+      # @param [{ Symbol => Object }] options
+      # @option options [Boolean] :requires_new
+      # @option options [String] :isolation
+      # @option options [Boolean] :joinable
       # @return [ActiveRecord::WrappedTransaction::Result]
-      def wrapped_transaction(options = {}, &block)
-        ActiveRecord::WrappedTransaction::Result.new(transactor: connection, transaction_options: options, &block)
+      def wrapped_transaction(**options, &block)
+        ActiveRecord::WrappedTransaction::Result.new(transactor: connection, **options, &block)
       end
     end
 
     class << self
+      # @param [#transaction] transactor
+      # @param [{ Symbol => Object }] options
+      # @option options [Boolean] :requires_new
+      # @option options [String] :isolation
+      # @option options [Boolean] :joinable
+      # @return [ActiveRecord::WrappedTransaction::Result]
       def call(transactor: ActiveRecord::Base, **options)
-        ActiveRecord::WrappedTransaction::Result.new(transactor: transactor, transaction_options: options) { yield }
+        ActiveRecord::WrappedTransaction::Result.new(transactor: transactor, **options) { yield }
       end
     end
   end

data/lib/activerecord/wrapped_transaction/context.rb

@@ -0,0 +1,95 @@
+module ActiveRecord
+  module WrappedTransaction
+    class Context
+      # @!attribute [r] transactor
+      # @return [#transaction, ActiveRecord::ConnectionAdapters::AbstractAdapter]
+      attr_reader :transactor
+
+      attr_reader :isolation
+      attr_reader :requires_new
+      attr_reader :joinable
+
+      # @!attribute [r] parent
+      # @return [ActiveRecord::WrappedTransaction::Context]
+      attr_reader :parent
+
+      def initialize(transactor:, requires_new: nil, isolation: nil, joinable: true, parent: nil)
+        @transactor = TRANSACTOR[transactor]
+        @requires_new = requires_new
+        @isolation = isolation
+        @joinable = joinable
+        @parent = parent
+
+        @transaction_options = {
+          requires_new: @requires_new,
+          isolation: @isolation,
+          joinable: @joinable
+        }.freeze
+      end
+
+      # @!attribute [r] depth
+      # The depth of the wrapped transaction
+      # @return [Integer]
+      def depth
+        @depth ||= calculate_depth
+      end
+
+      # @return [ActiveRecord::WrappedContext::Result]
+      def maybe(**new_options, &block)
+        new_options[:joinable] = false
+        new_options[:requires_new] = true
+
+        build_result(**new_options, &block)
+      end
+
+      # @return [ActiveRecord::WrappedContext::Result]
+      def wrap(**new_options, &block)
+        build_result(**new_options, &block)
+      end
+
+      # Cancel the current transaction with an arbitrary `reason`.
+      #
+      # @param [String] reason
+      # @return [void]
+      def cancel!(reason = nil)
+        throw :cancel_transaction, reason
+      end
+
+      # @api private
+      def wrap_transaction
+        transactor.transaction **@transaction_options do
+          yield
+        end
+      end
+
+      private
+
+      def build_result(**new_options, &block)
+        options = build_result_options(**new_options)
+
+        Result.new(**options, &block)
+      end
+
+      def build_result_options(requires_new: @requires_new, isolation: @isolation, joinable: @joinable, **unused_options)
+        # :nocov:
+        unused_options.each do |key, value|
+          warn "received unused option: #{key.inspect} => #{value.inspect}"
+        end
+        # :nocov:
+
+        {
+          transactor: @transactor,
+          requires_new: requires_new,
+          isolation: isolation,
+          joinable: joinable,
+          parent_context: self
+        }
+      end
+
+      # @return [Integer]
+      def calculate_depth
+        parent.nil? ? 0 : parent.depth + 1
+      end
+    end
+  end
+end

data/lib/activerecord/wrapped_transaction/result.rb

@@ -15,32 +15,23 @@ module ActiveRecord
       # @return [Exception, nil]
       attr_reader :error
 
-      # @!attribute [r] result
-      # @return [Object, nil]
-      attr_reader :result
-
-      # @!attribute [r] transactor
-      # @return [#transaction, ActiveRecord::ConnectionAdapters::AbstractAdapter]
-      attr_reader :transactor
-
       # @param [#transaction, ActiveRecord::ConnectionAdapters::AbstractAdapter] transactor
+      # @param [ActiveRecord::WrappedTransaction::Context] parent_context
+      # @param [{ Symbol => Object }] options
+      # @option options [Boolean] :requires_new
+      # @option options [String] :isolation
+      # @option options [Boolean] :joinable
       # @yield A block that goes in the transaction.
       # @yieldreturn [Object]
-      def initialize(transactor: ActiveRecord::Base, transaction_options: {})
-        unless block_given?
-          raise ArgumentError, "Must call with a block to run in the transaction"
-        end
+      def initialize(transactor: ActiveRecord::Base, parent_context: nil, **options)
+        raise ArgumentError, "Must call with a block to run in the transaction" unless block_given?
 
-        unless transactor.respond_to?(:transaction)
-          raise ArgumentError, "transactor `#{transactor.inspect} must respond to :transaction"
-        else
-          @transactor = transactor
-        end
+        @context = Context.new transactor: transactor, parent: parent_context, **options
 
-        wrap_transaction transaction_options do
+        wrap_transaction do
           execute_transaction do
             watch_for_cancellation do
-              @result = yield
+              @result = unwrap yield @context
             end
           end
         end
@@ -52,21 +43,28 @@ module ActiveRecord
         @cancelled
       end
 
-      def success?
-        @success
+      # @!attribute [r] result
+      # @return [Object, nil]
+      def result
+        @result if success?
       end
 
       def rolled_back?
         !success?
       end
 
+      def success?
+        @success
+      end
+
       private
-      def wrap_transaction(transaction_options = {})
-        caught = transactor.transaction(transaction_options) do
+
+      def wrap_transaction
+        caught = @context.wrap_transaction do
           yield
         end
       ensure
-        @success = caught.eql?(TXN_COMPLETE)
+        @success = caught.eql? TXN_COMPLETE
       end
 
       def execute_transaction
@@ -82,11 +80,18 @@ module ActiveRecord
       def watch_for_cancellation
         cancellation_reason = catch(:cancel_transaction) { yield; NOT_CANCELLED }
 
-        unless cancellation_reason.eql?(NOT_CANCELLED)
-          @cancelled = true
-          @cancellation_reason = cancellation_reason
-          raise ActiveRecord::Rollback, "Cancelled transaction"
-        end
+        return if cancellation_reason.eql? NOT_CANCELLED
+
+        @cancelled = true
+        @cancellation_reason = cancellation_reason
+
+        raise ActiveRecord::Rollback, "Cancelled transaction"
+      end
+
+      def unwrap(value)
+        return value unless value.kind_of?(self.class) && value.success?
+
+        value.result
       end
     end
   end

data/lib/activerecord/wrapped_transaction/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module WrappedTransaction
-    VERSION = "0.5.1"
+    VERSION = "0.9.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-wrapped_transaction
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Alexa Grey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,120 +16,92 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: bundler
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -149,22 +121,39 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- Appraisals
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - activerecord-wrapped_transaction.gemspec
+- bin/appraisal
 - bin/console
+- bin/rake
+- bin/rspec
 - bin/setup
 - db/connection.rb
 - db/models.rb
 - db/schema.rb
+- gemfiles/rails_5_mysql2.gemfile
+- gemfiles/rails_5_mysql2.gemfile.lock
+- gemfiles/rails_5_pg.gemfile
+- gemfiles/rails_5_pg.gemfile.lock
+- gemfiles/rails_5_sqlite3.gemfile
+- gemfiles/rails_5_sqlite3.gemfile.lock
+- gemfiles/rails_6_mysql2.gemfile
+- gemfiles/rails_6_mysql2.gemfile.lock
+- gemfiles/rails_6_pg.gemfile
+- gemfiles/rails_6_pg.gemfile.lock
+- gemfiles/rails_6_sqlite3.gemfile
+- gemfiles/rails_6_sqlite3.gemfile.lock
 - lib/activerecord-wrapped_transaction.rb
 - lib/activerecord/wrapped_transaction.rb
+- lib/activerecord/wrapped_transaction/context.rb
 - lib/activerecord/wrapped_transaction/result.rb
 - lib/activerecord/wrapped_transaction/version.rb
 homepage: https://github.com/scryptmouse/activerecord-wrapped_transaction
@@ -186,8 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Wrap transactions in a manner that detects if the transaction completed