activeinteractor 1.2.2 → 2.0.0.alpha.1.0.0

data/lib/active_interactor/organizer/organize.rb

@@ -1,67 +0,0 @@
-# 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

@@ -1,112 +0,0 @@
-# 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
-        run_callbacks :all_perform do
-          if self.class.parallel
-            perform_in_parallel
-          else
-            perform_in_order
-          end
-        end
-      end
-
-      def run_deferred_after_perform_callbacks_on_children
-        self.class.organized.each do |interface|
-          next unless interface.interactor_class.after_callbacks_deferred_when_organized
-
-          context.merge!(interface.execute_deferred_after_perform_callbacks(context))
-        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 execute_and_merge_contexts(interface)
-        interface.execute_inplace_callback(self, :before)
-        result = execute_interactor_with_callbacks(interface, true)
-        return if result.nil?
-
-        context.merge!(result)
-        context_fail! if result.failure?
-        interface.execute_inplace_callback(self, :after)
-      end
-
-      def perform_in_order
-        self.class.organized.each do |interface|
-          execute_and_merge_contexts(interface)
-        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/orm/active_record.rb

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

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

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require 'dynamoid/document'
-
-Dynamoid::Document::ClassMethods.include ActiveInteractor::Models

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

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-ActiveSupport.on_load(:mongoid) do
-  Mongoid::Document::ClassMethods.include ActiveInteractor::Models
-end

data/lib/active_interactor/rails/railtie.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails'
-
-module ActiveInteractor
-  # Rails classes and modules.
-  #
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 1.0.0
-  module 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.eager_load_namespaces << ActiveInteractor
-    end
-  end
-end

data/lib/active_interactor/rails.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_interactor'
-require 'active_interactor/rails/railtie'

data/lib/active_interactor/version.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveInteractor
-  # The ActiveInteractor version info
-  #
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since unreleased
-  module Version
-    # The ActiveInterctor major version number
-    # @return [Integer] The ActiveInteractor major version number
-    MAJOR = 1
-
-    # The ActiveInterctor minor version number
-    # @return [Integer] The ActiveInteractor minor version number
-    MINOR = 2
-
-    # The ActiveInterctor patch version number
-    # @return [Integer] The ActiveInteractor patch version number
-    PATCH = 2
-
-    # The ActiveInterctor pre-release version
-    # @return [String | nil] The ActiveInteractor pre-release version
-    PRE = nil
-
-    # The ActiveInterctor meta version
-    # @return [String | nil] The ActiveInteractor meta version
-    META = nil
-
-    # The ActiveInterctor rubygems version
-    # @return [String] The ActiveInteractor rubygems version
-    def self.gem_version
-      pre_meta = PRE.nil? ? nil : [PRE, META].compact.join('.').freeze
-      [MAJOR, MINOR, PATCH, pre_meta].compact.join('.').freeze
-    end
-
-    # The ActiveInterctor semver version
-    # @return [String] The ActiveInteractor semver version
-    def self.semver
-      version = [MAJOR, MINOR, PATCH].join('.')
-      version = "#{version}-#{PRE}" if PRE
-      version = "#{version}+#{META}" if META
-      version.freeze
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# 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,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_interactor/base'
-
-module ActiveInteractor
-  module Generators
-    class ApplicationInteractorGenerator < Base
-      def create_application_interactor
-        return if File.exist?(file_path)
-
-        template 'application_interactor.rb', file_path
-      end
-
-      private
-
-      def file_path
-        "app/#{active_interactor_directory}/application_interactor.rb"
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# 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

@@ -1,29 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_interactor/base'
-
-module ActiveInteractor
-  module Generators
-    class InstallGenerator < Base
-      desc 'Install ActiveInteractor'
-      class_option :orm
-
-      def create_initializer
-        template 'active_interactor.erb', File.join('config', 'initializers', 'active_interactor.rb')
-      end
-    end
-  end
-end

data/lib/rails/generators/active_interactor.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-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/interactor/context/rspec_generator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_interactor/base'
-
-module Interactor
-  module Context
-    module Generators
-      class RspecGenerator < ActiveInteractor::Generators::NamedBase
-        desc 'Generate an interactor context spec'
-
-        def create_spec
-          template 'context_spec.erb', active_interactor_file(parent_dir: 'spec', suffix: 'context_spec')
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_interactor/base'
-
-module Interactor
-  module Context
-    module Generators
-      class TestUnitGenerator < ActiveInteractor::Generators::NamedBase
-        desc 'Generate an interactor context unit test'
-
-        def create_spec
-          template 'context_test_unit.erb', active_interactor_file(parent_dir: 'test', suffix: 'context_test')
-        end
-      end
-    end
-  end
-end

data/lib/rails/generators/interactor/context_generator.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_interactor/base'
-
-module Interactor
-  module Generators
-    class ContextGenerator < ActiveInteractor::Generators::NamedBase
-      desc 'Generate an interactor context'
-      argument :context_attributes, type: :array, default: [], banner: 'attribute attribute'
-
-      def generate_application_context
-        generate :'active_interactor:application_context'
-      end
-
-      def create_context
-        template 'context.erb', active_interactor_file(suffix: 'context')
-      end
-
-      hook_for :test_framework, in: :'interactor:context'
-    end
-  end
-end

data/lib/rails/generators/interactor/generates_context.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Interactor
-  module Generators
-    module GeneratesContext
-      module WithArguments
-        def self.included(base)
-          base.class_eval do
-            include GeneratesContext
-            argument :context_attributes, type: :array, default: [], banner: 'attribute attribute'
-          end
-        end
-      end
-
-      def self.included(base)
-        base.class_eval do
-          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 || active_interactor_options.fetch(:generate_context, true) == false
-      end
-    end
-  end
-end

data/lib/rails/generators/interactor/interactor_generator.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_interactor/base'
-require 'rails/generators/interactor/generates_context'
-
-class InteractorGenerator < ActiveInteractor::Generators::NamedBase
-  include Interactor::Generators::GeneratesContext::WithArguments
-  desc 'Generate an interactor'
-
-  def generate_application_interactor
-    generate :'active_interactor:application_interactor'
-  end
-
-  def create_interactor
-    template 'interactor.erb', active_interactor_file
-  end
-
-  def create_context
-    return if skip_context?
-
-    generate :'interactor:context', class_name, *context_attributes
-  end
-
-  hook_for :test_framework, in: :interactor
-end

data/lib/rails/generators/interactor/organizer_generator.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_interactor/base'
-require 'rails/generators/interactor/generates_context'
-
-module Interactor
-  module Generators
-    class OrganizerGenerator < ActiveInteractor::Generators::NamedBase
-      include GeneratesContext
-      desc 'Generate an interactor organizer'
-      argument :interactors, type: :array, default: [], banner: 'interactor interactor'
-
-      class_option :context_attributes, type: :array, default: [], banner: 'attribute attribute',
-                                        desc: 'Attributes for the context'
-
-      def generate_application_organizer
-        generate :'active_interactor:application_organizer'
-      end
-
-      def create_organizer
-        template 'organizer.erb', active_interactor_file
-      end
-
-      def create_context
-        return if skip_context?
-
-        generate :'interactor:context', class_name, *context_attributes
-      end
-
-      hook_for :test_framework, in: :interactor
-
-      private
-
-      def context_attributes
-        options[:context_attributes]
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_interactor/base'
-
-module Interactor
-  module Generators
-    class RspecGenerator < ActiveInteractor::Generators::NamedBase
-      desc 'Generate an interactor spec'
-
-      def create_spec
-        template 'interactor_spec.erb', active_interactor_file(parent_dir: 'spec', suffix: 'spec')
-      end
-    end
-  end
-end

data/lib/rails/generators/interactor/test_unit_generator.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators/active_interactor/base'
-
-module Interactor
-  module Generators
-    class TestUnitGenerator < ActiveInteractor::Generators::NamedBase
-      desc 'Generate an interactor unit test'
-
-      def create_spec
-        template 'interactor_test_unit.erb', active_interactor_file(parent_dir: 'test', suffix: 'test')
-      end
-    end
-  end
-end

data/lib/rails/generators/templates/active_interactor.erb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_interactor'
-
-ActiveInteractor.configure do |config|
-  # ORM configuration
-  # Load and configure the ORM. Supports :active_record (default)
-  # Other ORMs may be available as additional gems.
-<%- if options[:orm] -%>
-  require 'active_interactor/rails/orm/<%= options[:orm] %>'
-<%- else -%>
-  # require 'active_interactor/rails/orm/<MY_ORM>'
-<%- end -%>
-
-  # Set the ActiveInteractor.logger
-  config.logger = ::Rails.logger
-end

data/lib/rails/generators/templates/application_context.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class ApplicationContext < ActiveInteractor::Context::Base
-end

data/lib/rails/generators/templates/application_interactor.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class ApplicationInteractor < ActiveInteractor::Base
-end

data/lib/rails/generators/templates/application_organizer.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class ApplicationOrganizer < ActiveInteractor::Organizer::Base
-end

data/lib/rails/generators/templates/context.erb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class <%= class_name %>Context < ApplicationContext
-<%- unless context_attributes.empty? -%>
-  attributes <%= context_attributes.map { |a| ":#{a}" }.join(', ') %>
-<%- end -%>
-end

data/lib/rails/generators/templates/context_spec.erb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe <%= class_name %>Context, type: :interactor do
-  pending "add some examples to (or delete) #{__FILE__}"
-end

data/lib/rails/generators/templates/context_test_unit.erb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class <%= class_name %>ContextTest < ActiveSupport::TestCase
-  # test "the truth" do
-  #   assert true
-  # end
-end