activeinteractor 1.0.0.beta.7 → 1.0.0

data/lib/active_interactor/interactor/context.rb

@@ -1,130 +1,322 @@
 # frozen_string_literal: true
 
-require 'active_model'
-require 'active_support/core_ext/string/inflections'
-
 module ActiveInteractor
   module Interactor
-    # Interactor context methods included by all {Base}
+    # Interactor context methods. Because {Context} is a module classes should include {Context} rather than inherit
+    # from it.
+    #
     # @author Aaron Allen <hello@aaronmallen.me>
-    # @since 0.0.1
-    # @!attribute [rw] context
-    #  @api private
-    #  @return [Context::Base] an instance of the interactor's context class
+    # @since 0.1.0
     module Context
-      # @!method context_fail!(errors = nil)
-      # Fail the interactor's context
-      # @since 1.0.0
-      # @see ActiveInteractor::Context::Base#fail!
-
-      # @!method context_rollback!
-      # Rollback the interactor's context
-      # @since 1.0.0
-      # @see ActiveInteractor::Context::Base#rollback!
-
-      # @!method context_valid?(context = nil)
-      # Whether or not the interactor's context is valid
-      # @since 1.0.0
-      # @see ActiveInteractor::Context::Base#valid?
-      def self.included(base)
-        base.class_eval do
-          extend ClassMethods
-          delegate :fail!, :rollback!, to: :context, prefix: true
-          delegate(*ActiveModel::Validations.instance_methods, to: :context, prefix: true)
-          delegate(*ActiveModel::Validations::HelperMethods.instance_methods, to: :context, prefix: true)
-
-          private
-
-          attr_accessor :context
-        end
-      end
-
-      # Interactor context class methods extended by all {Base}
+      # Interactor context class methods. Because {ClassMethods} is a module classes should extend {ClassMethods}
+      # rather than inherit from it.
+      #
+      # @author Aaron Allen <hello@aaronmallen.me>
+      # @since 0.1.0
       module ClassMethods
-        delegate(*ActiveModel::Validations::ClassMethods.instance_methods, to: :context_class, prefix: :context)
-        delegate(*ActiveModel::Validations::HelperMethods.instance_methods, to: :context_class, prefix: :context)
         # @!method context_attributes(*attributes)
-        # Set or get attributes defined on the interactor's context class
-        # @since 0.0.1
-        # @see ActiveInteractor::Context::Attributes#attributes
+        #  Call {ActiveInteractor::Context::Attributes#attributes .attributes} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        #  @example
+        #    class MyInteractor < ActiveInteractor::Base
+        #      context_attributes :first_name, :last_name
+        #    end
+        #
+        #    MyInteractor.context_class.attributes
+        #    #=> [:first_name, :last_name]
         delegate :attributes, to: :context_class, prefix: :context
 
-        # The context class of the interactor
-        # @note If a context class is not defined on the interactor
-        #  with {#contextualize_with} ActiveInteractor will attempt
-        #  to find a class with the naming conventions:
-        #    `MyInteractor::Context` or `MyInteractorContext`
-        #  if no matching context class is found a context class
-        #  will be created with the naming convention: `MyInteractor::Context`.
-        # @example With an existing class named `MyInteractor::Context`
-        #  class MyInteractor::Context < ActiveInteractor::Context::Base
-        #  end
-        #
-        #  class MyInteractor < ActiveInteractor::Base
-        #  end
-        #
-        #  MyInteractor.context_class
-        #  #=> MyInteractor::Context
-        # @example With an existing class named `MyInteractorContext`
-        #  class MyInteractorContext < ActiveInteractor::Context::Base
-        #  end
-        #
-        #  class MyInteractor < ActiveInteractor::Base
-        #  end
-        #
-        #  MyInteractor.context_class
-        #  #=> MyInteractorContext
-        # @example With no existing context class
-        #  class MyInteractor < ActiveInteractor::Base
-        #  end
-        #
-        #  MyInteractor.context_class
-        #  #=> MyInteractor::Context
-        # @return [Class] the interactor's context class
+        # @!method context_attribute_method?(attribute)
+        #  Call {ActiveInteractor::Context::Base.attribute_method? .attribute_method?} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_clear_validators!(attribute)
+        #  Call {ActiveInteractor::Context::Base.clear_validators! .clear_validators!} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validate(*args, &block)
+        #  Call {ActiveInteractor::Context::Base.validate .validate} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates(*attributes)
+        #  Call {ActiveInteractor::Context::Base.validates .validates} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates!(*attributes)
+        #  Call {ActiveInteractor::Context::Base.validates! .validates!} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_each(*attr_names, &block)
+        #  Call {ActiveInteractor::Context::Base.validates_each .validates_each} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_with(*args, &block)
+        #  Call {ActiveInteractor::Context::Base.validates_with .validates_with} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validators
+        #  Call {ActiveInteractor::Context::Base.validators .validators} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validators_on(*attributes)
+        #  Call {ActiveInteractor::Context::Base.validators_on .validators_on} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        delegate(*ActiveModel::Validations::ClassMethods.instance_methods, to: :context_class, prefix: :context)
+
+        # @!method context_validates_absence_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_absence_of .validates_absence_of} on the {Base interactor}
+        #  class' {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_acceptance_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_acceptance_of .validates_acceptance_of} on the
+        #  {Base interactor} class' {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_confirmation_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_confirmation_of .validates_confirmation_of} on the
+        #  {Base interactor} class' {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_exclusion_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_exclusion_of .validates_exclusion_of} on the
+        #  {Base interactor} class' {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_format_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_format_of .validates_format_of} on the {Base interactor}
+        #  class' {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_inclusion_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_inclusion_of .validates_inclusion_of} on the
+        #  {Base interactor} class' {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_length_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_length_of .validates_length_of} on the {Base interactor}
+        #  class' {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_numericality_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_numericality_of .validates_numericality_of} on the
+        #  {Base interactor} class' {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_presence_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_presence_of .validates_presence_of} on the {Base interactor}
+        #  class' {#context_class context class}
+        #
+        #  @since 0.1.0
+        #
+        # @!method context_validates_size_of(*attr_names)
+        #  Call {ActiveInteractor::Context::Base.validates_size_of .validates_size_of} on the {Base interactor} class'
+        #  {#context_class context class}
+        #
+        #  @since 0.1.0
+        delegate(*ActiveModel::Validations::HelperMethods.instance_methods, to: :context_class, prefix: :context)
+
+        # Get the {Base interactor} class' {ActiveInteractor::Context::Base context} class. If no class is found or no
+        # class is set via the {#contextualize_with} method a new class is created.
+        #
+        # @see ActiveInteractor::Context::Loader.find_or_create
+        #
+        # @return [Const] the {Base interactor} class' {ActiveInteractor::Context::Base context} class
         def context_class
           @context_class ||= ActiveInteractor::Context::Loader.find_or_create(self)
         end
 
-        # Manual define an interactor's context class
+        # Set the {Base interactor} class' {#context_class context class}
+        #
         # @since 1.0.0
+        #
         # @example
-        #   class AGenericContext < ActiveInteractor::Context::Base
+        #   class User < ActiveRecord::Base
         #   end
         #
         #   class MyInteractor < ActiveInteractor::Base
-        #     contextualize_with :a_generic_context
+        #     contextualize_with :user
         #   end
         #
         #   MyInteractor.context_class
-        #   #=> AGenericContext
-        # @param klass [String|Symbol|Class] the context class
-        # @raise [Error::InvalidContextClass] if no matching class can be found
-        # @return [Class] the context class
+        #   #=> User
+        #
+        # @param klass [Const, Symbol, String] the class to use as context
+        # @raise [Error::InvalidContextClass] if the class can not be found.
+        # @return [Const] the {Base interactor} class' {ActiveInteractor::Context::Base context} class
         def contextualize_with(klass)
           @context_class = begin
             context_class = klass.to_s.classify.safe_constantize
-            raise(Error::InvalidContextClass, klass) unless context_class
+            raise(ActiveInteractor::Error::InvalidContextClass, klass) unless context_class
 
             context_class
           end
         end
       end
 
-      # @api private
-      # @param context [Context::Base|Hash] attributes to assign to the context
-      # @return [Base] a new instane of {Base}
+      # @!method context_fail!(errors = nil)
+      #  Call {ActiveInteractor::Context::Status#fail! #fail!} on the {Base interactor} instance's
+      #  {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 1.0.0
+      #
+      # @!method context_rollback!
+      #  Call {ActiveInteractor::Context::Status#rollback! #rollback!} on the {Base interactor} instance's
+      #  {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 1.0.0
+      delegate :fail!, :rollback!, to: :context, prefix: true
+
+      # @!method context_errors
+      #  Call {ActiveInteractor::Context::Base#errors #errors} on the {Base interactor} instance's
+      #  {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_invalid?(context = nil)
+      #  Call {ActiveInteractor::Context::Base#invalid? #invalid?} on the {Base interactor} instance's
+      #  {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_valid?(context = nil)
+      #  Call {ActiveInteractor::Context::Base#valid? #valid?} on the {Base interactor} instance's
+      #  {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validate(context = nil)
+      #  Call {ActiveInteractor::Context::Base#validate #validate} on the {Base interactor} instance's
+      #  {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validate!(context = nil)
+      #  Call {ActiveInteractor::Context::Base#validate! #validate!} on the {Base interactor} instance's
+      #  {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_with(*args, &block)
+      #  Call {ActiveInteractor::Context::Base#validates_with #validates_with} on the {Base interactor} instance's
+      #  {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      delegate(*ActiveModel::Validations.instance_methods, to: :context, prefix: true)
+
+      # @!method context_validates_absence_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_absence_of #validates_absence_of} on the {Base interactor}
+      #  instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_acceptance_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_acceptance_of #validates_acceptance_of} on the
+      #  {Base interactor} instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_confirmation_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_confirmation_of #validates_confirmation_of} on the
+      #  {Base interactor} instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_exclusion_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_exclusion_of #validates_exclusion_of} on the {Base interactor}
+      #  instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_format_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_format_of #validates_format_of} on the {Base interactor}
+      #  instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_inclusion_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_inclusion_of #validates_inclusion_of}  on the
+      #  {Base interactor} instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_length_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_length_of #validates_length_of} on the {Base interactor}
+      #  instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_numericality_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_numericality_of #validates_numericality_of} on the
+      #  {Base interactor} instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_presence_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_presence_of #validates_presence_of} on the {Base interactor}
+      #  instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      #
+      # @!method context_validates_size_of(*attr_names)
+      #  Call {ActiveInteractor::Context::Base#validates_size_of #validates_size_of} on the {Base interactor}
+      #  instance's {ActiveInteractor::Context::Base context} instance
+      #
+      #  @since 0.1.0
+      delegate(*ActiveModel::Validations::HelperMethods.instance_methods, to: :context, prefix: true)
+
+      # Initialize a new instance of {Base}
+      #
+      # @param context [Hash, Class] attributes to assign to the {Base interactor} instance's
+      #  {ActiveInteractor::Context::Base context} instance
+      # @return [Base] a new instance of {Base}
       def initialize(context = {})
         @context = self.class.context_class.new(context)
       end
 
-      # @api private
-      # Mark the interactor's context as called and return the context
+      # Mark the {Base interactor} instance as called on the instance's {ActiveInteractor::Context::Base context}
+      # instance and return the {ActiveInteractor::Context::Base context} instance.
+      #
       # @since 1.0.0
-      # @return [Context::Base] an instance of the interactor's context class
+      #
+      # @return [Class] the {ActiveInteractor::Context::Base context} instance
       def finalize_context!
         context.called!(self)
         context
       end
+
+      private
+
+      attr_accessor :context
     end
   end
 end

data/lib/active_interactor/interactor/perform.rb

@@ -0,0 +1,256 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  module Interactor
+    # Interactor perform methods. Because {Perform} is a module classes should include {Perform} rather than inherit
+    # from it.
+    #
+    # @author Aaron Allen <hello@aaronmallen.me>
+    # @since 1.0.0
+    module Perform
+      # Interactor perform class methods. Because {ClassMethods} is a module classes should extend {ClassMethods}
+      # rather than inherit from it.
+      #
+      # @author Aaron Allen <hello@aaronmallen.me>
+      # @since 1.0.0
+      module ClassMethods
+        # Initialize a new {Base interactor} instance and call its {Interactor::Perform#perform #perform} method. This
+        # is the default api to interact with all {Base interactors}.
+        #
+        # @since 0.1.0
+        #
+        # @example
+        #   class MyInteractor < ActiveInteractor::Base
+        #     def perform
+        #       puts "I performed"
+        #     end
+        #   end
+        #
+        #   MyInteractor.perform
+        #   "I performed"
+        #   #=> <#MyInteractor::Context>
+        #
+        # @param context [Hash, Class] attributes to assign to the {Base interactor} instance's
+        #  {ActiveInteractor::Context::Base context} instance
+        # @param options [Hash, Perform::Options] options to use for the {.perform}. See {Perform::Options}
+        # @return [Class] an instance of the {Base interactor} class' {ActiveInteractor::Context::Base context}
+        #  instance
+        def perform(context = {}, options = {})
+          new(context).with_options(options).execute_perform
+        end
+
+        # Initialize a new {Base interactor} instance and call its {Interactor::Perform#perform #perform} method without
+        # rescuing {ActiveInteractor::Error::ContextFailure}.
+        #
+        # @since 0.1.0
+        #
+        # @example Calling {Perform::ClassMethods#perform! .perform!} without failure
+        #   class MyInteractor < ActiveInteractor::Base
+        #     def perform
+        #       puts "I performed"
+        #     end
+        #   end
+        #
+        #   MyInteractor.perform!
+        #   "I performed"
+        #   #=> <#MyInteractor::Context>
+        #
+        # @example Calling {Perform::ClassMethods#perform! .perform!} with failure
+        #   class MyInteractor < ActiveInteractor::Base
+        #     def perform
+        #       context.fail!
+        #     end
+        #   end
+        #
+        #   MyInteractor.perform!
+        #   ActiveInteractor::Error::ContextFailure "<#MyInteractor::Context>"
+        #
+        # @param context [Hash, Class] attributes to assign to the {Base interactor} instance's
+        #  {ActiveInteractor::Context::Base context} instance
+        # @param options [Hash, Perform::Options] options to use for the {.perform}. See {Perform::Options}
+        # @raise [Error::ContextFailure] if the {ActiveInteractor::Context::Base context} instance
+        #  fails.
+        # @return [Class] an instance of the {Base interactor} class' {ActiveInteractor::Context::Base context}
+        #  instance
+        def perform!(context = {}, options = {})
+          new(context).with_options(options).execute_perform!
+        end
+      end
+
+      # Interactor {Interactor::Perform#perform #perform} options
+      #
+      # @author Aaron Allen <hello@aaronmallen.me>
+      # @since 1.0.0
+      #
+      # @!attribute [rw] skip_each_perform_callbacks
+      #  if `true` an {Organizer::Base organizer} will be instructed to skip
+      #  {Organizer::Callbacks::ClassMethods each_perform} callbacks.
+      #
+      #  @since 1.0.0
+      #
+      #  @return [Boolean] whether or not to skip {Organizer::Callbacks::ClassMethods each_perform} callbacks
+      #
+      # @!attribute [rw] skip_perform_callbacks
+      #  if `true` an {Base interactor} will be instructed to skip {Interactor::Callbacks::ClassMethods perform}
+      #  callbacks.
+      #
+      #  @since 1.0.0
+      #
+      #  @return [Boolean] whether or not to skip {Interactor::Callbacks::ClassMethods perform} callbacks.
+      #
+      # @!attribute [rw] skip_rollback
+      #  if `true` an {Base interactor} will be instructed to skip {Interactor::Perform#rollback #rollback} on
+      #  {Context::Base context} {ActiveInteractor::Context::Status#fail! failure}.
+      #
+      #  @since 1.0.0
+      #
+      #  @return [Boolean] whether or not to skip {Interactor::Perform#rollback #rollback}
+      #
+      # @!attribute [rw] skip_rollback_callbacks
+      #  if `true` an {Base interactor} will be instructed to skip {Interactor::Callbacks::ClassMethods rollback}
+      #  callbacks on {Context::Base context} {ActiveInteractor::Context::Status#fail! failure}.
+      #
+      #  @since 1.0.0
+      #
+      #  @return [Boolean] whether or not to skip {Interactor::Callbacks::ClassMethods rollback} callbacks.
+      #
+      # @!attribute [rw] validate
+      #  if `false` an {Base interactor} will not run validations.
+      #
+      #  @since 1.0.0
+      #
+      #  @return [Boolean] whether or to run validations.
+      #
+      # @!attribute [rw] validate_on_calling
+      #  if `false` an {Base interactor} will not run validations with the validation context `:calling`.
+      #
+      #  @since 1.0.0
+      #
+      #  @return [Boolean] whether or to run validations with the validation context `:calling`
+      #
+      # @!attribute [rw] validate_on_called
+      #  if `false` an {Base interactor} will not run validations with the validation context `:called`.
+      #
+      #  @since 1.0.0
+      #
+      #  @return [Boolean] whether or to run validation with the validation context `:called`.
+      #
+      # @!method initialize(options = {})
+      #  Initialize a new instance of {Options}
+      #
+      #  @since 1.0.0
+      #
+      #  @param options [Hash{Symbol=>*}] the attributes to assign to {Options}
+      #  @option options [Boolean] :skip_each_perform_callbacks (false) the {Options#skip_each_perform_callbacks}
+      #   attribute
+      #  @option options [Boolean] :skip_perform_callbacks (false) the {Options#skip_perform_callbacks} attribute
+      #  @option options [Boolean] :skip_rollback (false) the {Options#skip_rollback} attribute
+      #  @option options [Boolean] :skip_rollback_callbacks (false) the {Options#skip_rollback_callbacks} attribute
+      #  @option options [Boolean] :validate (true) the {Options#validate} attribute
+      #  @option options [Boolean] :validate_on_calling (true) the {Options#validate_on_calling} attribute
+      #  @option options [Boolean] :validate_on_called (true) the {Options#validate_on_called} attribute
+      #  @return [Options] a new instance of {Options}
+      class Options
+        include ActiveInteractor::Configurable
+        defaults skip_each_perform_callbacks: false, skip_perform_callbacks: false, skip_rollback: false,
+                 skip_rollback_callbacks: false, validate: true, validate_on_calling: true, validate_on_called: true
+      end
+
+      # @!method execute_perform
+      #  Run the {Base interactor} instance's {#perform} with callbacks and validation.
+      #
+      #  @api private
+      #  @since 0.1.0
+      #
+      # @!method execute_perform!
+      #  Run the {Base interactor} instance's {#perform} with callbacks and validation without rescuing
+      #  {Error::ContextFailure}.
+      #
+      #  @api private
+      #  @since 0.1.0
+      delegate :execute_perform, :execute_perform!, to: :worker
+
+      # Duplicate an {Base interactor} instance as well as it's {#options} and {ActiveInteractor::Context::Base context}
+      # instances.
+      #
+      # @return [Base] a duplicated {Base interactor} instance
+      def deep_dup
+        self.class.new(context.dup).with_options(options.dup)
+      end
+
+      # Options for the {Base interactor} {#perform}
+      #
+      # @return [Options] an instance of {Options}
+      def options
+        @options ||= ActiveInteractor::Interactor::Perform::Options.new
+      end
+
+      # The steps to run when an {Base interactor} is called. An {Base interactor's} {#perform} method should never be
+      # called directly on an {Base interactor} instance and should instead be invoked by the {Base interactor's} class
+      # method {Perform::ClassMethods#perform .perform}.
+      #
+      # @since 0.1.0
+      #
+      # @abstract {Base interactors} should override {#perform} with the appropriate steps and
+      #  {ActiveInteractor::Context::Base context} mutations required for the {Base interactor} to do its work.
+      #
+      # @example
+      #   class MyInteractor < ActiveInteractor::Base
+      #     def perform
+      #       context.first_name = 'Aaron'
+      #     end
+      #   end
+      #
+      #   MyInteractor.perform
+      #   #=> <#MyInteractor::Context first_name='Aaron'>
+      def perform; end
+
+      # The steps to run when an {Base interactor} {ActiveInteractor::Context::Status#fail! fails}. An
+      # {Base interactor's} {#rollback} method should never be called directly and is instead called by the
+      # {Base interactor's} {ActiveInteractor::Context::Base context} when
+      # {ActiveInteractor::Context::Status#fail! #fail} is called.
+      #
+      # @since 0.1.0
+      #
+      # @abstract {Base interactors} should override {#rollback} with the appropriate steps and
+      #  {ActiveInteractor::Context::Base context} mutations required for the {Base interactor} to roll back its work.
+      #
+      # @example
+      #   class MyInteractor < ActiveInteractor::Base
+      #     def perform
+      #       context.first_name = 'Aaron'
+      #       context.fail!
+      #     end
+      #
+      #     def rollback
+      #       context.first_name = 'Bob'
+      #     end
+      #   end
+      #
+      #   MyInteractor.perform
+      #   #=> <#MyInteractor::Context first_name='Bob'>
+      def rollback; end
+
+      # Set {Options options} for an {Base interactor's} {#perform}
+      #
+      # @api private
+      #
+      # @param options [Hash, Perform::Options] options to use for the perform call. See {Perform::Options}
+      # @return [self] the {Base interactor} instance
+      def with_options(options)
+        @options = if options.is_a?(ActiveInteractor::Interactor::Perform::Options)
+                     options
+                   else
+                     ActiveInteractor::Interactor::Perform::Options.new(options)
+                   end
+        self
+      end
+
+      private
+
+      def worker
+        ActiveInteractor::Interactor::Worker.new(self)
+      end
+    end
+  end
+end