activeinteractor 1.0.0.beta.7 → 1.0.0

data/lib/active_interactor/interactor.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveInteractor
-  # Interactor methods. {Base} includes {Interactor} all interactors
-  #  should inherit from {Base}.
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 0.0.1
-  module Interactor
-    def self.included(base)
-      base.class_eval do
-        extend ClassMethods
-        include Callbacks
-        include Context
-        delegate :execute_perform, :execute_perform!, to: :worker
-      end
-    end
-
-    # Interactor class methods.
-    module ClassMethods
-      # Run an interactor context.  This it the primary API method for
-      # interacting with interactors.
-      # @example Run an interactor
-      #  MyInteractor.perform(name: 'Aaron')
-      #  #=> <#MyInteractor::Context name='Aaron'>
-      # @param context [Hash|Context::Base] attributes to assign to the interactor context
-      # @param options [Hash] execution options for the interactor perform step
-      #   see {PerformOptions}
-      # @return [Context::Base] an instance of context.
-      def perform(context = {}, options = {})
-        new(context).with_options(options).execute_perform
-      end
-
-      # Run an interactor context. The {.perform!} method behaves identically to
-      #  the {.perform} method with one notable exception. If the context is failed
-      #  during invocation of the interactor, the {Error::ContextFailure}
-      #  is raised.
-      # @example Run an interactor
-      #  MyInteractor.perform!(name: 'Aaron')
-      #  #=> <#MyInteractor::Context name='Aaron'>
-      # @param context [Hash|Context::Base] attributes to assign to the interactor context
-      # @param options [Hash] execution options for the interactor perform step
-      #   see {PerformOptions}
-      # @raise [Error::ContextFailure] if the context fails.
-      # @return [Context::Base] an instance of context.
-      def perform!(context = {}, options = {})
-        new(context).with_options(options).execute_perform!
-      end
-    end
-
-    # Options for invokation of {#perform}
-    # @since 1.0.0
-    # @return [PerformOptions] the options
-    def options
-      @options ||= PerformOptions.new
-    end
-
-    # Invoke an Interactor instance without any hooks, tracking, or rollback
-    # @abstract It is expected that the {#perform} method is overwritten
-    #  for each interactor class.
-    def perform; end
-
-    # Reverse prior invocation of an Interactor instance.
-    # @abstract Any interactor class that requires undoing upon downstream
-    #  failure is expected to overwrite the {#rollback} method.
-    def rollback; end
-
-    # Set options for invokation of {#perform}
-    # @since 1.0.0
-    # @param options [PerformOptions|Hash] the perform options
-    # @return [Base] the instance of {Base}
-    def with_options(options)
-      @options = options.is_a?(PerformOptions) ? options : PerformOptions.new(options)
-      self
-    end
-
-    private
-
-    def worker
-      Worker.new(self)
-    end
-  end
-end
-
-Dir[File.expand_path('interactor/*.rb', __dir__)].sort.each { |file| require file }

data/lib/active_interactor/interactor/perform_options.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveInteractor
-  module Interactor
-    # Options object for interactor perform
-    # @author Aaron Allen <hello@aaronmallen.me>
-    # @since 1.0.0
-    # @!attribute [rw] skip_each_perform_callbacks
-    #   @return [Boolean] whether or not to skip :each_perform callbacks for an {Organizer}
-    # @!attribute [rw] skip_perform_callbacks
-    #  @return [Boolean] whether or not to skip :perform callbacks
-    # @!attribute [rw] skip_rollback
-    #  @return [Boolean] whether or not to skip rollback when an interactor
-    #    fails its context
-    # @!attribute [rw] skip_rollback_callbacks
-    #  @return [Boolean] whether or not to skip :rollback callbacks
-    # @!attribute [rw] validate
-    #  @return [Boolean] whether or not to run validations on an interactor
-    # @!attribute [rw] validate_on_calling
-    #  @return [Boolean] whether or not to run validation on :calling
-    # @!attribute [rw] validate_on_called
-    #  @return [Boolean] whether or not to run validation on :called
-    class PerformOptions
-      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
-  end
-end

data/lib/active_interactor/organizer.rb

@@ -1,269 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/class/attribute'
-
-require 'active_interactor/organizer/interactor_interface_collection'
-
-module ActiveInteractor
-  # A base Organizer class.  All organizers should inherit from
-  #  {Organizer}.
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 0.0.1
-  # @!attribute [r] parallel
-  #  @since 1.0.0
-  #  @!scope class
-  #  @return [Boolean] whether or not to run the interactors
-  #    in parallel
-  # @example a basic organizer
-  #  class MyInteractor1 < ActiveInteractor::Base
-  #    def perform
-  #      context.interactor1 = true
-  #    end
-  #  end
-  #
-  #  class MyInteractor2 < ActiveInteractor::Base
-  #    def perform
-  #      context.interactor2 = true
-  #    end
-  #  end
-  #
-  #  class MyOrganizer < ActiveInteractor::Organizer
-  #    organize MyInteractor1, MyInteractor2
-  #  end
-  #
-  #  MyOrganizer.perform
-  #  #=> <MyOrganizer::Context interactor1=true interactor2=true>
-  class Organizer < Base
-    class_attribute :parallel, instance_writer: false, default: false
-    define_callbacks :each_perform
-
-    # Define a callback to call after each organized interactor's
-    #  {Base.perform} has been invoked
-    # @example
-    #  class MyInteractor1 < ActiveInteractor::Base
-    #    before_perform :print_name
-    #
-    #    def perform
-    #      puts 'MyInteractor1'
-    #    end
-    #  end
-    #
-    #  class MyInteractor2 < ActiveInteractor::Base
-    #    before_perform :print_name
-    #
-    #    def perform
-    #      puts 'MyInteractor2'
-    #    end
-    #  end
-    #
-    #  class MyOrganizer < ActiveInteractor::Organizer
-    #    after_each_perform :print_done
-    #
-    #    organized MyInteractor1, MyInteractor2
-    #
-    #    private
-    #
-    #    def print_done
-    #      puts "done"
-    #    end
-    #  end
-    #
-    #  MyOrganizer.perform(name: 'Aaron')
-    #  "MyInteractor1"
-    #  "Done"
-    #  "MyInteractor2"
-    #  "Done"
-    #  #=> <MyOrganizer::Context name='Aaron'>
-    def self.after_each_perform(*filters, &block)
-      set_callback(:each_perform, :after, *filters, &block)
-    end
-
-    # Define a callback to call around each organized interactor's
-    #  {Base.perform} has been invokation
-    # @example
-    #  class MyInteractor1 < ActiveInteractor::Base
-    #    before_perform :print_name
-    #
-    #    def perform
-    #      puts 'MyInteractor1'
-    #    end
-    #  end
-    #
-    #  class MyInteractor2 < ActiveInteractor::Base
-    #    before_perform :print_name
-    #
-    #    def perform
-    #      puts 'MyInteractor2'
-    #    end
-    #  end
-    #
-    #  class MyOrganizer < ActiveInteractor::Organizer
-    #    around_each_perform :print_time
-    #
-    #    organized MyInteractor1, MyInteractor2
-    #
-    #    private
-    #
-    #    def print_time
-    #      puts Time.now.utc
-    #      yield
-    #      puts Time.now.utc
-    #    end
-    #  end
-    #
-    #  MyOrganizer.perform(name: 'Aaron')
-    #  "2019-04-01 00:00:00 UTC"
-    #  "MyInteractor1"
-    #  "2019-04-01 00:00:01 UTC"
-    #  "2019-04-01 00:00:02 UTC"
-    #  "MyInteractor2"
-    #  "2019-04-01 00:00:03 UTC"
-    #  #=> <MyOrganizer::Context name='Aaron'>
-    def self.around_each_perform(*filters, &block)
-      set_callback(:each_perform, :around, *filters, &block)
-    end
-
-    # Define a callback to call before each organized interactor's
-    #  {Base.perform} has been invoked
-    # @example
-    #  class MyInteractor1 < ActiveInteractor::Base
-    #    before_perform :print_name
-    #
-    #    def perform
-    #      puts 'MyInteractor1'
-    #    end
-    #  end
-    #
-    #  class MyInteractor2 < ActiveInteractor::Base
-    #    before_perform :print_name
-    #
-    #    def perform
-    #      puts 'MyInteractor2'
-    #    end
-    #  end
-    #
-    #  class MyOrganizer < ActiveInteractor::Organizer
-    #    before_each_perform :print_start
-    #
-    #    organized MyInteractor1, MyInteractor2
-    #
-    #    private
-    #
-    #    def print_start
-    #      puts "Start"
-    #    end
-    #  end
-    #
-    #  MyOrganizer.perform(name: 'Aaron')
-    #  "Start"
-    #  "MyInteractor1"
-    #  "Start"
-    #  "MyInteractor2"
-    #  #=> <MyOrganizer::Context name='Aaron'>
-    def self.before_each_perform(*filters, &block)
-      set_callback(:each_perform, :before, *filters, &block)
-    end
-
-    # Declare Interactors to be invoked as part of the
-    #  organizer's invocation. These interactors are invoked in
-    #  the order in which they are declared
-    # @example Basic interactor organization
-    #   class MyOrganizer < ActiveInteractor::Organizer
-    #     organize :interactor_one, :interactor_two
-    #   end
-    # @example Conditional interactor organization with block
-    #   class MyOrganizer < ActiveInteractor::Organizer
-    #     organize do
-    #       add :interactor_one
-    #       add :interactor_two, if: -> { context.valid? }
-    #     end
-    #   end
-    # @example Conditional interactor organization with method
-    #   class MyOrganizer < ActiveInteractor::Organizer
-    #     organize do
-    #       add :interactor_one
-    #       add :interactor_two, unless: :invalid_context?
-    #     end
-    #
-    #     private
-    #
-    #     def invalid_context?
-    #       !context.valid?
-    #     end
-    #   end
-    # @example Interactor organization with perform options
-    #   class MyOrganizer < ActiveInteractor::Organizer
-    #     organize do
-    #       add :interactor_one, validate: false
-    #       add :interactor_two, skip_perform_callbacks: true
-    #     end
-    #   end
-    # @param interactors [Array<Base|Symbol|String>] the interactors to call
-    # @yield [.organized] if block given
-    # @return [InteractorInterfaceCollection] an instance of {InteractorInterfaceCollection}
-    def self.organize(*interactors, &block)
-      organized.concat(interactors) if interactors
-      organized.instance_eval(&block) if block
-      organized
-    end
-
-    # Organized interactors
-    # @return [InteractorInterfaceCollection] an instance of {InteractorInterfaceCollection}
-    def self.organized
-      @organized ||= InteractorInterfaceCollection.new
-    end
-
-    # Run organized interactors in parallel
-    # @since 1.0.0
-    def self.perform_in_parallel
-      self.parallel = true
-    end
-
-    # Invoke the organized interactors. An organizer is
-    #  expected not to define its own {Interactor#perform #perform} method
-    #  in favor of this default implementation.
-    def perform
-      if self.class.parallel
-        perform_in_parallel
-      else
-        perform_in_order
-      end
-    end
-
-    private
-
-    def execute_interactor(interface, fail_on_error = false, perform_options = {})
-      interface.perform(self, context, fail_on_error, perform_options)
-    end
-
-    def execute_interactor_with_callbacks(interface, fail_on_error = false, perform_options = {})
-      args = [interface, fail_on_error, perform_options]
-      return execute_interactor(*args) if options.skip_each_perform_callbacks
-
-      run_callbacks :each_perform do
-        execute_interactor(*args)
-      end
-    end
-
-    def merge_contexts(contexts)
-      contexts.each { |context| @context.merge!(context) }
-      context_fail! if contexts.any?(&:failure?)
-    end
-
-    def perform_in_order
-      self.class.organized.each do |interface|
-        result = execute_interactor_with_callbacks(interface, true)
-        context.merge!(result) if result
-      end
-    rescue Error::ContextFailure => e
-      context.merge!(e.context)
-    end
-
-    def perform_in_parallel
-      results = self.class.organized.map do |interface|
-        Thread.new { execute_interactor_with_callbacks(interface, false, skip_rollback: true) }
-      end
-      merge_contexts(results.map(&:value))
-    end
-  end
-end

data/lib/active_interactor/rails/config.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_interactor/configurable'
-
-module ActiveInteractor
-  module Rails
-    # The ActiveInteractor rails configuration object
-    # @author Aaron Allen <hello@aaronmallen.me>
-    # @since 1.0.0
-    # @!attribute [rw] directory
-    #  @return [String] the directory interactors are stored in
-    # @!attribute [rw] generate_context_classes
-    #  @return [Boolean] whether or not to generate a seperate
-    #    context class for an interactor.
-    class Config
-      include ActiveInteractor::Configurable
-      defaults directory: 'interactors', generate_context_classes: true
-
-      # @!method initialize(options = {})
-      # @param options [Hash] the options for the configuration
-      # @option options [String] :directory (defaults to: 'interactors') the configuration directory property
-      # @option options [Boolean] :generate_context_classes (defaults to: `true`) the configuration
-      #   generate_context_class property.
-      # @return [Config] a new instance of {Config}
-    end
-
-    # The {ActiveInteractor::Rails} configuration
-    # @since 1.0.0
-    # @return [ActiveInteractor::Config] the configuration instance
-    def self.config
-      @config ||= Config.new
-    end
-
-    # Configures {ActiveInteractor::Rails}
-    # @since 1.0.0
-    # @example Configure ActiveInteractor
-    #  ActiveInteractor.configure do |config|
-    #    config.logger = Rails.logger
-    #  end
-    # @yield [ActiveInteractor::Rails#config]
-    def self.configure
-      yield config
-    end
-  end
-end

data/lib/active_interactor/rails/models.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveInteractor
-  module Rails
-    # Model helper methods
-    # @author Aaron Allen <hello@aaronmallen.me>
-    # @since 1.0.0
-    module Models
-      # Model class helper methods
-      # @author Aaron Allen <hello@aaronmallen.me>
-      # @since 1.0.0
-      module ClassMethods
-        # Include {Context::Status} methods
-        def acts_as_context
-          class_eval do
-            include InstanceMethods
-            include ActiveInteractor::Context::Status
-            delegate :each_pair, to: :attributes
-          end
-        end
-      end
-
-      # Model instance helper methods
-      # @author Aaron Allen <hello@aaronmallen.me>
-      # @since 1.0.0
-      module InstanceMethods
-        # Override initialize method to ensure
-        #  context flags are copied to the new instance
-        # @param attributes [Hash|nil] attributes to assign to the class
-        def initialize(attributes = nil)
-          copy_flags!(attributes) if attributes
-          copy_called!(attributes) if attributes
-          attributes_as_hash = attributes_as_hash(attributes)
-          super(attributes_as_hash)
-        end
-
-        # Merge an instance and ensure
-        #  context flags are copied to the new instance
-        # @param context [*] the instance to be merged
-        # @return [*] the merged instance
-        def merge!(context)
-          copy_flags!(context)
-          context.each_pair do |key, value|
-            self[key] = value
-          end
-          self
-        end
-
-        private
-
-        def attributes_as_hash(attributes)
-          return attributes.to_h if attributes&.respond_to?(:to_h)
-          return attributes.attributes.to_h if attributes.respond_to?(:attributes)
-        end
-      end
-    end
-  end
-end