activeinteractor 1.2.2 → 2.0.0.alpha.1.0.0

data/lib/active_interactor/context/status.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveInteractor
-  module Context
-    # Context status methods. Because {Status} is a module classes should include {Status} rather than inherit from it.
-    #
-    # @author Aaron Allen <hello@aaronmallen.me>
-    # @since 1.0.0
-    module Status
-      # Add an instance of {ActiveInteractor::Base interactor} to the list of {ActiveInteractor::Base interactors}
-      # called on the {Base context}. This list is used when {#rollback!} is called on a {Base context} instance.
-      #
-      # @since 0.1.0
-      #
-      # @param interactor [Class] an {ActiveInteractor::Base interactor} instance
-      # @return [Array<Class>] the list of called {ActiveInteractor::Base interactors}
-      def called!(interactor)
-        _called << interactor
-      end
-
-      # Fail the {Base context} instance. Failing an instance raises an error that may be rescued by the calling
-      # {ActiveInteractor::Base interactor}. The instance is also flagged as having failed.
-      #
-      # @since 0.1.0
-      #
-      # @example Fail an interactor context
-      #   class MyInteractor < ActiveInteractor::Base
-      #     def perform
-      #       context.fail!
-      #     end
-      #   end
-      #
-      #   MyInteractor.perform!
-      #   ActiveInteractor::Error::ContextFailure "<#MyInteractor::Context>"
-      #
-      # @param errors [ActiveModel::Errors, String] error messages for the failure
-      # @see https://api.rubyonrails.org/classes/ActiveModel/Errors.html ActiveModel::Errors
-      # @raise [Error::ContextFailure]
-      def fail!(errors = nil)
-        handle_errors(errors) if errors
-        @_failed = true
-        resolve
-        raise ActiveInteractor::Error::ContextFailure, self
-      end
-
-      # Whether the {Base context} instance has {#fail! failed}. By default, a new instance is successful and only
-      # changes when explicitly {#fail! failed}.
-      #
-      # @since 0.1.0
-      # @note The {#failure?} method is the inverse of the {#success?} method
-      #
-      # @example Check if a context has failed
-      #   result = MyInteractor.perform
-      #   result.failure?
-      #   #=> false
-      #
-      # @return [Boolean] `false` by default or `true` if {#fail! failed}.
-      def failure?
-        @_failed || false
-      end
-      alias fail? failure?
-
-      # Resolve an instance of {Base context}.  Called when an interactor
-      #  is finished with it's context.
-      #
-      # @since 1.0.3
-      # @return [self] the instance of {Base context}
-      def resolve
-        resolve_errors
-        self
-      end
-
-      # {#rollback! Rollback} an instance of {Base context}. Any {ActiveInteractor::Base interactors} the instance has
-      # been passed via the {#called!} method are asked to roll themselves back by invoking their
-      # {Interactor::Perform#rollback #rollback} methods. The instance is also flagged as rolled back.
-      #
-      # @since 0.1.0
-      #
-      # @return [Boolean] `true` if {#rollback! rolled back} successfully or `false` if already
-      #  {#rollback! rolled back}
-      def rollback!
-        return false if @_rolled_back
-
-        _called.reverse_each(&:rollback)
-        @_rolled_back = true
-      end
-
-      # Whether the {Base context} instance is successful. By default, a new instance is successful and only changes
-      # when explicitly {#fail! failed}.
-      #
-      # @since 0.1.0
-      # @note The {#success?} method is the inverse of the {#failure?} method
-      #
-      # @example Check if a context has failed
-      #   result = MyInteractor.perform
-      #   result.success?
-      #   #=> true
-      #
-      # @return [Boolean] `true` by default or `false` if {#fail! failed}
-      def success?
-        !failure?
-      end
-      alias successful? success?
-    end
-  end
-end

data/lib/active_interactor/error.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveInteractor
-  # ActiveInteractor errors
-  #
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 0.1.5
-  module Error
-    # Raised when an {Base interactor} {Context::Base context} {Context::Status#fail! fails}.
-    #
-    # @!attribute [r] context
-    #  An instance of {Context::Base context} used for debugging.
-    #
-    #  @return [Context::Base] an instance of {Context::Base}
-    class ContextFailure < StandardError
-      attr_reader :context
-
-      # Initialize a new instance of {ContextFailure}
-      #
-      # @param context [Class, nil] an instance of {Context::Base context}
-      # @return [ContextFailure] a new instance of {ContextFailure}
-      def initialize(context = nil)
-        @context = context
-        context_class_name = context&.class&.name || 'Context'
-        super("#{context_class_name} failed!")
-      end
-    end
-
-    # Raised when an invalid {Context::Base context} class is assigned to an {Base interactor}.
-    #
-    # @since 1.0.0
-    #
-    # @!attribute [r] class_name
-    #  The class name of the {Context::Base context} used for debugging.
-    #
-    #  @return [String|nil] the class name of the {Context::Base context}
-    class InvalidContextClass < StandardError
-      attr_reader :class_name
-
-      def initialize(class_name = nil)
-        @class_name = class_name
-        super("invalid context class #{class_name}")
-      end
-    end
-  end
-end

data/lib/active_interactor/interactor/callbacks.rb

@@ -1,293 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveInteractor
-  module Interactor
-    # Interactor callback methods. Because {Callbacks} is a module classes should include {Callbacks} rather than
-    # inherit from it.
-    #
-    # @author Aaron Allen <hello@aaronmallen.me>
-    # @since 0.1.0
-    # @see https://github.com/aaronmallen/activeinteractor/wiki/Callbacks Callbacks
-    # @see https://api.rubyonrails.org/classes/ActiveSupport/Callbacks.html ActiveSupport::Callbacks
-    module Callbacks
-      # Interactor callback class methods. Because {ClassMethods} is a module classes should extend {ClassMethods}
-      # rather than inherit from it.
-      #
-      # @author Aaron Allen
-      # @since 0.1.0
-      module ClassMethods
-        # Define a callback to call after validation has been run on an {Base interactor} instance's
-        # {ActiveInteractor::Context::Base context} instance.
-        #
-        # @example
-        #   class MyInteractor < ActiveInteractor::Base
-        #     after_context_validation :ensure_name_is_aaron
-        #     context_validates :name, presence: true
-        #
-        #     private
-        #
-        #     def ensure_name_is_aaron
-        #       context.name = 'Aaron'
-        #     end
-        #   end
-        #
-        #   result = MyInteractor.perform(name: 'Bob')
-        #   result.name
-        #   #=> 'Aaron'
-        #
-        #   result = MyInteractor.perform({ name: 'Bob' }, { validate: false })
-        #   result.name
-        #   #=> 'Bob'
-        def after_context_validation(*args, &block)
-          options = normalize_options(args.extract_options!.dup.merge(prepend: true))
-          set_callback(:validation, :after, *args, options, &block)
-        end
-
-        # Define a callback to call after {Interactor::Perform#perform #perform} has been called on an
-        # {Base interactor} instance.
-        #
-        # @example
-        #   class MyInteractor < ActiveInteractor::Base
-        #     after_perform :print_done
-        #
-        #     def perform
-        #       puts 'Performing'
-        #     end
-        #
-        #     private
-        #
-        #     def print_done
-        #       puts 'Done'
-        #     end
-        #   end
-        #
-        #   MyInteractor.perform
-        #   "Performing"
-        #   "Done"
-        #   #=> <#MyInteractor::Context>
-        def after_perform(*filters, &block)
-          set_callback(:perform, :after, *filters, &block)
-        end
-
-        # Define a callback to call after {Interactor::Perform#rollback #rollback} has been called on an
-        # {Base interactor} instance.
-        #
-        # @example
-        #   class MyInteractor < ActiveInteractor::Base
-        #     after_rollback :print_done
-        #
-        #     def perform
-        #       context.fail!
-        #     end
-        #
-        #     def rollback
-        #       puts 'Rolling Back'
-        #     end
-        #
-        #     private
-        #
-        #     def print_done
-        #       puts 'Done'
-        #     end
-        #   end
-        #
-        #   MyInteractor.perform
-        #   "Rolling Back"
-        #   "Done"
-        #   #=> <MyInteractor::Context>
-        def after_rollback(*filters, &block)
-          set_callback(:rollback, :after, *filters, &block)
-        end
-
-        # Define a callback to call around {Interactor::Perform#perform #perform} invokation on an {Base interactor}
-        # instance.
-        #
-        # @example
-        #   class MyInteractor < ActiveInteractor::Base
-        #     around_perform :track_time
-        #
-        #     def perform
-        #       sleep(1)
-        #     end
-        #
-        #     private
-        #
-        #     def track_time
-        #       context.start_time = Time.now.utc
-        #       yield
-        #       context.end_time = Time.now.utc
-        #     end
-        #   end
-        #
-        #   result = MyInteractor.perform
-        #   result.start_time
-        #   #=> 2019-01-01 00:00:00 UTC
-        #
-        #   result.end_time
-        #   #=> 2019-01-01 00:00:01 UTC
-        def around_perform(*filters, &block)
-          set_callback(:perform, :around, *filters, &block)
-        end
-
-        # Define a callback to call around {Interactor::Perform#rollback #rollback} invokation on an {Base interactor}
-        # instance.
-        #
-        # @example
-        #   class MyInteractor < ActiveInteractor::Base
-        #     around_rollback :track_time
-        #
-        #     def perform
-        #       context.fail!
-        #     end
-        #
-        #     def rollback
-        #       sleep(1)
-        #     end
-        #
-        #     private
-        #
-        #     def track_time
-        #       context.start_time = Time.now.utc
-        #       yield
-        #       context.end_time = Time.now.utc
-        #     end
-        #   end
-        #
-        #   result = MyInteractor.perform
-        #   result.start_time
-        #   #=> 2019-01-01 00:00:00 UTC
-        #
-        #   result.end_time
-        #   #=> 2019-01-01 00:00:01 UTC
-        def around_rollback(*filters, &block)
-          set_callback(:rollback, :around, *filters, &block)
-        end
-
-        # Define a callback to call before validation has been run on an {Base interactor} instance's
-        # {ActiveInteractor::Context::Base context} instance.
-        #
-        # @example
-        #   class MyInteractor < ActiveInteractor::Base
-        #     before_context_validation :ensure_name_is_aaron
-        #     context_validates :name, inclusion: { in: %w[Aaron] }
-        #
-        #     private
-        #
-        #     def ensure_name_is_aaron
-        #       context.name = 'Aaron'
-        #     end
-        #   end
-        #
-        #   result = MyInteractor.perform(name: 'Bob')
-        #   result.successful?
-        #   #=> true
-        #
-        #   result.name
-        #   #=> 'Aaron'
-        #
-        #   result = MyInteractor.perform({ name: 'Bob' }, { validate: false })
-        #   result.name
-        #   #=> 'Bob'
-        def before_context_validation(*args, &block)
-          options = normalize_options(args.extract_options!.dup)
-          set_callback(:validation, :before, *args, options, &block)
-        end
-
-        # Define a callback to call before {Interactor::Perform#perform #perform} has been called on an
-        # {Base interactor} instance
-        #
-        # @example
-        #   class MyInteractor < ActiveInteractor::Base
-        #     before_perform :print_starting
-        #
-        #     def perform
-        #       puts 'Performing'
-        #     end
-        #
-        #     private
-        #
-        #     def print_starting
-        #       puts 'Starting'
-        #     end
-        #   end
-        #
-        #   MyInteractor.perform
-        #   "Starting"
-        #   "Performing"
-        #   #=> <#MyInteractor::Context>
-        def before_perform(*filters, &block)
-          set_callback(:perform, :before, *filters, &block)
-        end
-
-        # Define a callback to call before {Interactor::Perform#rollback #rollback} has been called on an
-        # {Base interactor} instance.
-        #
-        # @example
-        #   class MyInteractor < ActiveInteractor::Base
-        #     before_rollback :print_starting
-        #
-        #     def perform
-        #       context.fail!
-        #     end
-        #
-        #     def rollback
-        #       puts 'Rolling Back'
-        #     end
-        #
-        #     private
-        #
-        #     def print_starting
-        #       puts 'Starting'
-        #     end
-        #   end
-        #
-        #   MyInteractor.perform
-        #   "Starting"
-        #   "Rolling Back"
-        #   #=> <#MyInteractor::Context>
-        def before_rollback(*filters, &block)
-          set_callback(:rollback, :before, *filters, &block)
-        end
-
-        # Set {.after_callbacks_deferred_when_organized} to `true`
-        #
-        # @since v1.2.0
-        #
-        # @example a basic {Base organizer} set to defer 'after' callbacks when organized
-        #   class MyOrganizer < ActiveInteractor::Organizer::Base
-        #     defer_after_callbacks_when_organized
-        #   end
-        def defer_after_callbacks_when_organized
-          self.after_callbacks_deferred_when_organized = true
-        end
-
-        def self.extended(base)
-          base.class_eval do
-            class_attribute :after_callbacks_deferred_when_organized, instance_writer: false, default: false
-          end
-        end
-
-        private
-
-        def normalize_options(options)
-          if options.key?(:on)
-            options[:on] = Array(options[:on])
-            options[:if] = Array(options[:if])
-            options[:if].unshift { |o| !(options[:on] & Array(o.validation_context)).empty? }
-          end
-
-          options
-        end
-      end
-
-      def self.included(base)
-        base.class_eval do
-          define_callbacks :validation,
-                           skip_after_callbacks_if_terminated: true,
-                           scope: %i[kind name]
-          define_callbacks :perform, :rollback
-        end
-      end
-    end
-  end
-end