activeinteractor 1.0.0.beta.7 → 1.0.0

data/lib/active_interactor/organizer/organize.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  module Organizer
+    # Organizer organize methods. Because {Organize} is a module classes should include {Organize} rather than inherit
+    # from it.
+    #
+    # @author Aaron Allen <hello@aaronmallen.me>
+    # @since 1.0.0
+    module Organize
+      # Organizer organize 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
+        # {#organized Organize} {ActiveInteractor::Base interactors} to be called by the {Base organizer}.
+        # A block will be evaluated on the {#organized InteractorInterfaceCollection} if a block is given.
+        #
+        # @since 0.1.0
+        #
+        # @example Basic organization of {ActiveInteractor::Base interactors}
+        #   class MyInteractor1 < ActiveInteractor::Base; end
+        #   class MyInteractor2 < ActiveInteractor::Base; end
+        #   class MyOrganizer < ActiveInteractor::Organizer::Base
+        #     organize :my_interactor_1, :my_interactor_2
+        #   end
+        #
+        # @example Conditional organization of {ActiveInteractor::Base interactors}
+        #   class MyInteractor1 < ActiveInteractor::Base; end
+        #   class MyInteractor2 < ActiveInteractor::Base; end
+        #   class MyOrganizer < ActiveInteractor::Organizer::Base
+        #     organize do
+        #       add :my_interactor_1
+        #       add :my_interactor_2, if: -> { context.valid? }
+        #     end
+        #   end
+        #
+        # @example organization of {ActiveInteractor::Base interactors} with {Interactor::Perform::Options options}
+        #   class MyInteractor1 < ActiveInteractor::Base; end
+        #   class MyInteractor2 < ActiveInteractor::Base; end
+        #   class MyOrganizer < ActiveInteractor::Organizer::Base
+        #     organize do
+        #       add :my_interactor_1, validate: false
+        #       add :my_interactor_2, skip_perform_callbacks: true
+        #     end
+        #   end
+        #
+        # @param interactors [Array<Const, Symbol, String>, nil] the {ActiveInteractor::Base} interactor classes to be
+        #  {#organized organized}
+        # @return [InteractorInterfaceCollection] the {#organized} {ActiveInteractor::Base interactors}
+        def organize(*interactors, &block)
+          organized.concat(interactors) if interactors
+          organized.instance_eval(&block) if block
+          organized
+        end
+
+        # An organized collection of {ActiveInteractor::Base interactors}
+        #
+        # @return [InteractorInterfaceCollection] an instance of {InteractorInterfaceCollection}
+        def organized
+          @organized ||= ActiveInteractor::Organizer::InteractorInterfaceCollection.new
+        end
+      end
+    end
+  end
+end

data/lib/active_interactor/organizer/perform.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  module Organizer
+    # Organizer 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
+      # Organizer 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
+      #
+      # @!attribute [r] parallel
+      #  If `true` the {Base organizer} will call {Interactor::Perform#perform #perform} on its
+      #  {Organizer::Organize::ClassMethods#organize .organized} {ActiveInteractor::Base interactors} in parallel.
+      #  An {Base organizer} will have {.parallel} `false` by default.
+      #
+      #  @!scope class
+      #  @since 1.0.0
+      #
+      #  @return [Boolean] whether or not to call {Interactor::Perform#perform #perform} on its
+      #   {Organizer::Organize::ClassMethods#organize .organized} {ActiveInteractor::Base interactors} in parallel.
+      module ClassMethods
+        # Set {.parallel} to `true`
+        #
+        # @example a basic {Base organizer} set to perform in parallel
+        #   class MyOrganizer < ActiveInteractor::Organizer::Base
+        #     perform_in_parallel
+        #   end
+        def perform_in_parallel
+          self.parallel = true
+        end
+      end
+
+      def self.included(base)
+        base.class_eval do
+          class_attribute :parallel, instance_writer: false, default: false
+        end
+      end
+
+      # Call the {Organize::ClassMethods#organized .organized} {ActiveInteractor::Base interactors}
+      # {Interactor::Perform#perform #perform}. An {Base organizer} is expected not to define its own
+      # {Interactor::Perform#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 ActiveInteractor::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
+end

data/lib/active_interactor/rails.rb

@@ -1,14 +1,4 @@
 # frozen_string_literal: true
 
 require 'active_interactor'
-require 'active_interactor/rails/config'
-require 'active_interactor/rails/models'
 require 'active_interactor/rails/railtie'
-
-module ActiveInteractor
-  # Rails specific classes, helpers, and utlities
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 1.0.0
-  module Rails
-  end
-end

data/lib/active_interactor/rails/orm/active_record.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 ActiveSupport.on_load(:active_record) do
-  extend ActiveInteractor::Rails::Models::ClassMethods
+  extend ActiveInteractor::Models
 end

data/lib/active_interactor/rails/railtie.rb

@@ -2,23 +2,20 @@
 
 require 'rails'
 
-require 'active_interactor'
-
 module ActiveInteractor
+  # Rails classes and modules.
+  #
+  # @author Aaron Allen <hello@aaronmallen.me>
+  # @since 1.0.0
   module Rails
-    # Configure ActiveInteractor for rails
+    # The ActiveInteractor Railtie
+    #
     # @author Aaron Allen <hello@aaronmallen.me>
     # @since 1.0.0
+    #
+    # @see https://api.rubyonrails.org/classes/Rails/Railtie.html
     class Railtie < ::Rails::Railtie
-      config.active_interactor = ActiveInteractor::Rails.config
-
       config.eager_load_namespaces << ActiveInteractor
-
-      config.to_prepare do
-        ActiveInteractor.configure do |c|
-          c.logger = ::Rails.logger
-        end
-      end
     end
   end
 end

data/lib/active_interactor/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveInteractor
+  # The ActiveInteractor version
   # @return [String] the ActiveInteractor version
-  VERSION = '1.0.0.beta.7'
+  VERSION = '1.0.0'
 end

data/lib/rails/generators/active_interactor.rb

@@ -1,42 +1,5 @@
 # frozen_string_literal: true
 
-require 'rails/generators/named_base'
-require 'active_interactor'
-
-module ActiveInteractor
-  module Generators
-    module Generator
-      private
-
-      def interactor_directory
-        @interactor_directory ||= ActiveInteractor::Rails.config.directory
-      end
-    end
-
-    module GeneratesContext
-      def self.included(base)
-        base.class_eval do
-          argument :context_attributes, type: :array, default: [], banner: 'attribute attribute'
-          class_option :skip_context, type: :boolean, desc: 'Whether or not to generate a context class'
-        end
-      end
-
-      private
-
-      def skip_context?
-        options[:skip_context] == true || ActiveInteractor::Rails.config.generate_context_classes == false
-      end
-    end
-
-    class Base < ::Rails::Generators::Base
-      include Generator
-    end
-
-    class NamedBase < ::Rails::Generators::NamedBase
-      include Generator
-    end
-  end
-end
-
 Dir[File.expand_path('active_interactor/*.rb', __dir__)].sort.each { |file| require file }
+Dir[File.expand_path('interactor/context/*.rb', __dir__)].sort.each { |file| require file }
 Dir[File.expand_path('interactor/*.rb', __dir__)].sort.each { |file| require file }

data/lib/rails/generators/active_interactor/application_context_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_interactor/base'
+
+module ActiveInteractor
+  module Generators
+    class ApplicationContextGenerator < Base
+      def create_application_organizer
+        return if File.exist?(file_path)
+
+        template 'application_context.rb', file_path
+      end
+
+      private
+
+      def file_path
+        "app/#{active_interactor_directory}/application_context.rb"
+      end
+    end
+  end
+end

data/lib/rails/generators/active_interactor/application_interactor_generator.rb

@@ -1,30 +1,20 @@
 # frozen_string_literal: true
 
-require_relative '../active_interactor'
+require 'rails/generators/active_interactor/base'
 
 module ActiveInteractor
   module Generators
     class ApplicationInteractorGenerator < Base
-      source_root File.expand_path('templates', __dir__)
-
       def create_application_interactor
-        template 'application_interactor.rb', File.join(target_path, 'application_interactor.rb')
-      end
-
-      def create_application_organizer
-        template 'application_organizer.rb', File.join(target_path, 'application_organizer.rb')
-      end
-
-      def create_application_context
-        return if ActiveInteractor::Rails.config.generate_context_classes == false
+        return if File.exist?(file_path)
 
-        template 'application_context.rb', File.join(target_path, 'application_context.rb')
+        template 'application_interactor.rb', file_path
       end
 
       private
 
-      def target_path
-        "app/#{interactor_directory}"
+      def file_path
+        "app/#{active_interactor_directory}/application_interactor.rb"
       end
     end
   end

data/lib/rails/generators/active_interactor/application_organizer_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_interactor/base'
+
+module ActiveInteractor
+  module Generators
+    class ApplicationOrganizerGenerator < Base
+      def create_application_organizer
+        return if File.exist?(file_path)
+
+        template 'application_organizer.rb', file_path
+      end
+
+      private
+
+      def file_path
+        "app/#{active_interactor_directory}/application_organizer.rb"
+      end
+    end
+  end
+end

data/lib/rails/generators/active_interactor/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+require 'rails/generators/active_interactor/generator'
+
+module ActiveInteractor
+  module Generators
+    class Base < ::Rails::Generators::Base
+      extend Generator
+      include Generator
+    end
+
+    class NamedBase < ::Rails::Generators::NamedBase
+      extend Generator
+      include Generator
+
+      private
+
+      def active_interactor_file(parent_dir: 'app', suffix: nil)
+        File.join(parent_dir, active_interactor_directory, class_path, "#{file_name_with_suffix(suffix)}.rb")
+      end
+
+      def file_name_with_suffix(suffix)
+        suffix ? "#{file_name}_#{suffix}" : file_name
+      end
+    end
+  end
+end

data/lib/rails/generators/active_interactor/generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  module Generators
+    module Generator
+      def source_root
+        File.expand_path('../templates', __dir__)
+      end
+
+      private
+
+      def active_interactor_directory
+        active_interactor_options.fetch(:dir, 'interactors')
+      end
+
+      def active_interactor_options
+        ::Rails.application.config.generators.options.fetch(:active_interactor, {})
+      end
+    end
+  end
+end

data/lib/rails/generators/active_interactor/install_generator.rb

@@ -1,22 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../active_interactor'
+require 'rails/generators/active_interactor/base'
 
 module ActiveInteractor
   module Generators
     class InstallGenerator < Base
-      source_root File.expand_path('templates', __dir__)
-
       desc 'Install ActiveInteractor'
       class_option :orm
-      argument :directory, type: :string, default: 'interactors', banner: 'directory'
 
       def create_initializer
-        template 'initializer.erb', File.join('config', 'initializers', 'active_interactor.rb')
-      end
-
-      def create_application_interactor_and_context
-        generate :'active_interactor:application_interactor'
+        template 'active_interactor.erb', File.join('config', 'initializers', 'active_interactor.rb')
       end
     end
   end

data/lib/rails/generators/interactor/context/rspec_generator.rb

@@ -1,22 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../../active_interactor'
+require 'rails/generators/active_interactor/base'
 
 module Interactor
   module Context
     module Generators
       class RspecGenerator < ActiveInteractor::Generators::NamedBase
-        source_root File.expand_path('templates', __dir__)
-        desc 'Generate an interactor spec'
+        desc 'Generate an interactor context spec'
 
         def create_spec
-          template 'rspec.erb', file_path
-        end
-
-        private
-
-        def file_path
-          File.join('spec', interactor_directory, File.join(class_path), "#{file_name}_context_spec.rb")
+          template 'context_spec.erb', active_interactor_file(parent_dir: 'spec', suffix: 'context_spec')
         end
       end
     end