granite 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a80b109dbceea5353225c682dac91eb5c3bc18ed
-  data.tar.gz: c995edf2a35d481bf68efa13c58abcd30afe876b
+  metadata.gz: 5d965fa31280c0c7068dec41cd034c2242444690
+  data.tar.gz: 22680daf024cf9d8956715e40c75ce2d3ad4cf93
 SHA512:
-  metadata.gz: ff37abbb9cd3326be35840912a9d4ec0fd3b107bccd95465a51925101897c17e2cc05a5378f2d262327e061f4b9d26924b0b1f79063d3b38da5e6e517328f82e
-  data.tar.gz: 81f809088a68c5769c901bdfbb4ed5d8e93ec1f3148b0e1886d8e82c70cf92efdb669a8f6c6cca85f9515b9ae66d71ba60b06b19b47cb09f6ec35cde8d3a8a86
+  metadata.gz: 3c92b2d9fb29164aa10c6b390686cdfca6830861eccaa8c85b6986996ee768fe0e34a7b6219ff4d6ae9a384d4d2cfd514a2896b248c9f01eff2af9bf0eef361b
+  data.tar.gz: 0f5fed5af5c2d707a41e3de1d4d18695e464605e0cd31fbbe0526e23c982fc5a02f1ea5961a82367baf06119994006af76f343ae271129575f9f0fced2666d1f

data/lib/granite/action/exceptions_handling.rb

@@ -0,0 +1,39 @@
+module Granite
+  class Action
+    module ExceptionsHandling
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :_exception_handlers, instance_writer: false
+        self._exception_handlers = {}
+
+        protected :_exception_handlers # rubocop:disable Style/AccessModifierDeclarations
+      end
+
+      module ClassMethods
+        # Register default handler for exceptions thrown inside execute_perform! and after_commit methods.
+        # @param klass Exception class, could be parent class too [Class]
+        # @param block [Block<Exception>] with default behavior for handling specified
+        #   type exceptions. First block argument is raised exception instance.
+        #
+        # @return [Hash<Class, Proc>] Registered handlers
+        def handle_exception(klass, &block)
+          self._exception_handlers = _exception_handlers.merge(klass => block)
+        end
+      end
+
+      private
+
+      def handled_exceptions
+        _exception_handlers.keys
+      end
+
+      def handle_exception(e)
+        klass = e.class.ancestors.detect do |ancestor|
+          ancestor <= Exception && _exception_handlers[ancestor]
+        end
+        instance_exec(e, &_exception_handlers[klass]) if klass
+      end
+    end
+  end
+end

data/lib/granite/action/performing.rb

@@ -1,3 +1,4 @@
+require 'granite/action/exceptions_handling'
 require 'granite/action/transaction'
 require 'granite/action/error'
 
@@ -17,28 +18,14 @@ module Granite
     module Performing
       extend ActiveSupport::Concern
 
+      include ExceptionsHandling
       include Transaction
 
       included do
-        class_attribute :_exception_handlers, instance_writer: false
-        self._exception_handlers = {}
-
-        protected :_exception_handlers
-
         define_callbacks :execute_perform
       end
 
       module ClassMethods
-        # Register default handler for exceptions thrown inside execute_perform! method.
-        # @param klass Exception class, could be parent class too [Class]
-        # @param block [Block<Exception>] with default behavior for handling specified
-        #   type exceptions. First block argument is raised exception instance.
-        #
-        # @return [Hash<Class, Proc>] Registered handlers
-        def handle_exception(klass, &block)
-          self._exception_handlers = _exception_handlers.merge(klass => block)
-        end
-
         def perform(*)
           fail 'Perform block declaration was removed! Please declare `private def execute_perform!(*)` method'
         end
@@ -54,7 +41,7 @@ module Granite
       #   using `:on`)
       # @return [Object] result of execute_perform! method execution or false in case of errors
       def perform(context: nil, **options)
-        transactional do
+        transaction do
           valid?(context) && perform_action(options)
         end
       end
@@ -72,7 +59,7 @@ module Granite
       # @raise [Granite::Action::ValidationError] Action or associated objects are invalid
       # @raise [NotImplementedError] execute_perform! method was not defined yet
       def perform!(context: nil, **options)
-        transactional do
+        transaction do
           validate!(context)
           perform_action!(**options)
         end
@@ -88,7 +75,7 @@ module Granite
       # @raise [NotImplementedError] execute_perform! method was not defined yet
       def try_perform!(context: nil, **options)
         return unless satisfy_preconditions?
-        transactional do
+        transaction do
           validate!(context)
           perform_action!(**options)
         end
@@ -108,7 +95,7 @@ module Granite
         result = run_callbacks(:execute_perform) { execute_perform!(options) }
         @_action_performed = true
         result || true
-      rescue *_exception_handlers.keys => e
+      rescue *handled_exceptions => e
         handle_exception(e)
         raise_validation_error(e) if raise_errors
         raise Rollback
@@ -121,13 +108,6 @@ module Granite
       def execute_perform!(**_options)
         fail NotImplementedError, "BA perform body MUST be defined for #{self}"
       end
-
-      def handle_exception(e)
-        klass = e.class.ancestors.detect do |ancestor|
-          ancestor <= Exception && _exception_handlers[ancestor]
-        end
-        instance_exec(e, &_exception_handlers[klass]) if klass
-      end
     end
   end
 end

data/lib/granite/action/transaction.rb

@@ -1,39 +1,60 @@
+require 'granite/action/transaction_manager'
+
 module Granite
   class Action
-    class Rollback < defined?(ActiveRecord) ? ActiveRecord::Rollback : StandardError
-    end
-
     module Transaction
       extend ActiveSupport::Concern
 
-      private
+      included do
+        define_callbacks :commit
+      end
 
-      def transactional(&block)
-        if transactional?
-          yield
-        else
-          @_transactional = true
-          result = transaction(&block) || false
-          @_transactional = nil
-          result
+      module ClassMethods
+        delegate :transaction, to: :'Granite::Action::TransactionManager'
+
+        private
+
+        # Defines a callback which will be triggered right after transaction committed
+        # Uses the same arguments as `ActiveSupport::Callbacks.set_callback` except for the first two
+        #
+        def after_commit(*args, &block)
+          set_callback :commit, :after, *args, &block
         end
       end
 
-      def transactional?
-        # Fuck the police!
-        !(!@_transactional)
+      def run_callbacks(event)
+        if event.to_s == 'commit'
+          begin
+            super event
+          rescue *handled_exceptions => e
+            handle_exception(e)
+          end
+        else
+          super event
+        end
       end
 
+      private
+
+      attr_accessor :in_transaction
+
       def transaction(&block)
-        if defined?(ActiveRecord::Base)
-          ActiveRecord::Base.transaction(&block)
+        if in_transaction
+          yield
         else
-          begin
-            yield
-          rescue Granite::Action::Rollback
-            false
-          end
+          run_in_transaction(&block)
+        end
+      end
+
+      def run_in_transaction
+        self.in_transaction = true
+
+        TransactionManager.transaction do
+          TransactionManager.after_commit(self)
+          yield
         end
+      ensure
+        self.in_transaction = false
       end
     end
   end

data/lib/granite/action/transaction_manager.rb

@@ -0,0 +1,84 @@
+require 'granite/action/transaction_manager/transactions_stack'
+
+module Granite
+  class Action
+    class Rollback < defined?(ActiveRecord) ? ActiveRecord::Rollback : StandardError
+    end
+
+    module TransactionManager
+      class << self
+        # Runs a block in a transaction
+        # It will open a new transaction or append a block to the current one if it exists
+        # @return [Object] result of a block
+        def transaction(&block)
+          run_in_transaction(&block) || false
+        ensure
+          finish_root_transaction if transactions_stack.depth.zero?
+        end
+
+        # Adds a block or listener object to be executed after finishing the current transaction.
+        # Callbacks are reset after each transaction.
+        # @param [Object] listener an object which will receive `run_callbacks(:commit)` after transaction committed
+        # @param [Proc] block a block which will be called after transaction committed
+        def after_commit(listener = nil, &block)
+          callback = listener || block
+
+          fail 'Block or object is required to register after_commit hook!' unless callback
+
+          transactions_stack.add_callback callback
+        end
+
+        private
+
+        TRANSACTIONS_STACK_KEY = :granite_transaction_manager_transactions_stack
+
+        def transactions_stack
+          Thread.current[TRANSACTIONS_STACK_KEY] ||= TransactionsStack.new
+        end
+
+        def transactions_stack=(value)
+          Thread.current[TRANSACTIONS_STACK_KEY] = value
+        end
+
+        def run_in_transaction(&block)
+          if defined?(ActiveRecord::Base)
+            ActiveRecord::Base.transaction(requires_new: true) do
+              transactions_stack.transaction(&block)
+            end
+          else
+            transactions_stack.transaction(&block)
+          end
+        end
+
+        def finish_root_transaction
+          trigger_after_commit_callbacks
+        ensure
+          self.transactions_stack = nil
+        end
+
+        def trigger_after_commit_callbacks
+          collected_errors = []
+
+          transactions_stack.callbacks.reverse_each do |callback|
+            begin
+              callback.respond_to?(:run_callbacks) ? callback.run_callbacks(:commit) : callback.call
+            rescue StandardError => e
+              collected_errors << e
+            end
+          end
+
+          return unless collected_errors.any?
+
+          log_errors(collected_errors[1..-1])
+          fail collected_errors.first
+        end
+
+        def log_errors(errors)
+          errors.each do |error|
+            ActiveData.config.logger.error "Unhandled error in callback: #{error.inspect}\n#{error.backtrace.join("\n")}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/granite/action/transaction_manager/transactions_stack.rb

@@ -0,0 +1,65 @@
+module Granite
+  class Action
+    module TransactionManager
+      # A class to manage transaction callbacks stack.
+      class TransactionsStack
+        attr_reader :depth
+
+        def initialize
+          @callbacks = []
+          @depth = 0
+        end
+
+        def transaction
+          start_new!
+          result = yield
+          finish_current!
+          result
+        rescue StandardError, ScriptError
+          rollback_current!
+          raise
+        end
+
+        def add_callback(callback)
+          fail 'Start a transaction before you add callbacks on it' if depth.zero?
+
+          @callbacks.last << callback
+        end
+
+        def callbacks
+          @callbacks.flatten
+        end
+
+        private
+
+        def start_new!
+          @depth += 1
+          @callbacks << []
+        end
+
+        def finish_current!
+          finish_current(true)
+        end
+
+        def rollback_current!
+          finish_current(false)
+        end
+
+        def finish_current(result)
+          fail ArgumentError, 'No current transaction' if @depth.zero?
+
+          @depth -= 1
+
+          if result
+            current = @callbacks.pop
+            previous = @callbacks.pop
+            @callbacks << [previous, current].flatten.compact
+          else
+            @callbacks.pop
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/granite/version.rb

@@ -1,3 +1,3 @@
 module Granite
-  VERSION = '0.8.3'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granite
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Arkadiy Zabazhanov & friends
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -280,6 +280,7 @@ files:
 - lib/granite.rb
 - lib/granite/action.rb
 - lib/granite/action/error.rb
+- lib/granite/action/exceptions_handling.rb
 - lib/granite/action/performer.rb
 - lib/granite/action/performing.rb
 - lib/granite/action/policies.rb
@@ -292,6 +293,8 @@ files:
 - lib/granite/action/projectors.rb
 - lib/granite/action/subject.rb
 - lib/granite/action/transaction.rb
+- lib/granite/action/transaction_manager.rb
+- lib/granite/action/transaction_manager/transactions_stack.rb
 - lib/granite/action/types.rb
 - lib/granite/action/types/collection.rb
 - lib/granite/base.rb