activeinteractor 1.0.0.beta.4 → 1.0.0.beta.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b887e29c2334d776e28d0df4e79ba53b42123d47e4e6f4da6c94a2fa5b38ea78
-  data.tar.gz: e6ca29f29e435b5b73e405c41eccfa6dea8837a7316c3d3143abd97cda241347
+  metadata.gz: 4d3d5616823da9559ae98eab086893b6daf7b9030b6baa2cf1cf29c0bc5b4ea3
+  data.tar.gz: e97629bee106e82dc438c227354f9ef598c8c1945f8f28a0a03e99e012e86ece
 SHA512:
-  metadata.gz: 8f766aa0e2c50d7cec5c74def38f7e2ea9d3918354f511d2ec127cf4054c9484638f1cd6f984686e1b12ca09116f53708fd4e5f714620178c4dd73ab745d6ee3
-  data.tar.gz: 2ece11503295a16bfba3860cb8d4ad3653eca4a1399c5b8928b2780884ca81b48b3a6128c9fce11b464cd0bf2928d4f22924a7d2d6a4c4a00e71d9c7603375a2
+  metadata.gz: 6f0b4ebbf1e49d32536d07b52e4d92608df89a4413a215edb1c4f330da2ad5f4e63b6c1e7eff908bd93f74ecb42f5a7e5a829df3ddab86d4aa739c1dfbf0f89c
+  data.tar.gz: 2666da64595c132aa988c3b7818c4bee589935d826a4e9d480ab5467a31e9c45106f6ca1aaee4b4a0069f95c411c420472535a723409d9f369b6c5c239bacea2

data/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [v1.0.0-beta.5] - 2020-01-21
+
+### Added
+
+- [#122] `ActiveInteractor::Rails::Railtie`
+- [#122] `ActiveInteractor::Rails.config`
+- [#122] `ActiveInteractor::Rails.configure`
+
+### Removed
+
+- [#122] `ActiveInteractor::Railtie` use `ActiveInteractor::Rails::Railtie` instead
+- [#122] `ActiveInteractor::Config#rails` use `ActiveInteractor::Rails.configure` instead
+
 ## [v1.0.0-beta.4] - 2020-01-14
 
 ### Added
@@ -169,7 +182,8 @@ and this project adheres to [Semantic Versioning].
 
 <!-- versions -->
 
-[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.0-beta.4...HEAD
+[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.0-beta.5...HEAD
+[v1.0.0-beta.5]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.0-beta.4...v1.0.0-beta.5
 [v1.0.0-beta.4]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.0-beta.3...v1.0.0-beta.4
 [v1.0.0-beta.3]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.0-beta.2...v1.0.0-beta.3
 [v1.0.0-beta.2]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.0-beta.1...v1.0.0-beta.2
@@ -206,3 +220,4 @@ and this project adheres to [Semantic Versioning].
 [#110]: https://github.com/aaronmallen/activeinteractor/pull/110
 [#114]:https://github.com/aaronmallen/activeinteractor/pull/114
 [#115]: https://github.com/aaronmallen/activeinteractor/pull/115
+[#122]: https://github.com/aaronmallen/activeinteractor/pull/122

data/README.md

@@ -5,9 +5,8 @@
 [![Dependencies](https://img.shields.io/depfu/aaronmallen/activeinteractor.svg?maxAge=300)](https://depfu.com/github/aaronmallen/activeinteractor)
 
 [![Build Status](https://github.com/aaronmallen/activeinteractor/workflows/Build/badge.svg)](https://github.com/aaronmallen/activeinteractor/actions)
-[![Maintainability](https://img.shields.io/codeclimate/maintainability/aaronmallen/activeinteractor.svg?maxAge=300)](https://codeclimate.com/github/aaronmallen/activeinteractor/maintainability)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/be92c4ecf12347da82d266f6a4368b6e)](https://www.codacy.com/manual/aaronmallen/activeinteractor?utm_source=github.com&utm_medium=referral&utm_content=aaronmallen/activeinteractor&utm_campaign=Badge_Grade)
-[![Test Coverage](https://img.shields.io/codeclimate/coverage/aaronmallen/activeinteractor.svg?maxAge=300)](https://codeclimate.com/github/aaronmallen/activeinteractor/test_coverage)
+[![Code Quality](https://api.codacy.com/project/badge/Grade/be92c4ecf12347da82d266f6a4368b6e)](https://www.codacy.com/manual/aaronmallen/activeinteractor?utm_source=github.com&utm_medium=referral&utm_content=aaronmallen/activeinteractor&utm_campaign=Badge_Grade)
+[![Test Coverage](https://api.codacy.com/project/badge/Coverage/be92c4ecf12347da82d266f6a4368b6e)](https://www.codacy.com/manual/aaronmallen/activeinteractor?utm_source=github.com&utm_medium=referral&utm_content=aaronmallen/activeinteractor&utm_campaign=Badge_Coverage)
 
 Ruby interactors with [ActiveModel::Validations] based on the [interactor][collective_idea_interactors] gem.
 
@@ -50,7 +49,7 @@ see [v0.1.7](https://github.com/aaronmallen/activeinteractor/tree/0-1-stable)**
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'activeinteractor', '~> 1.0.0.beta.3'
+gem 'activeinteractor', '~> 1.0.0.beta.5'
 ```
 
 And then execute:
@@ -191,9 +190,8 @@ See [Using Interactors](#using-interactors), below, for the recommended usage of
 
 #### Context Attributes
 
-Each context instance have basic attribute assignment methods which can be invoked directly from the interactor.
-You never need to directly interface with an interactor's context class. Assigning attributes to a context is a
-simple way to explicitly defined what properties a context should have after an interactor has done it's work.
+Each context instance has basic attribute assignment methods. Assigning attributes to a context is a simple way to
+explicitly defined what properties a context should have after an interactor has done it's work.
 
 You can see what attributes are defined on a given context with the `#attributes` method:
 
@@ -218,10 +216,10 @@ result.occupation #=> 'Software Dude'
 
 #### Validating the Context
 
-ActiveInteractor delegates all the validation methods provided by [ActiveModel::Validations] onto an interactor's
-context class from the interactor itself. All of the methods found in [ActiveModel::Validations] can be invoked directly
-on your interactor with the prefix `context_`. However this can be confusing and it is recommended to make all validation
-calls on a context class directly.
+All context instances include [ActiveModel::Validations]; additionally ActiveInteractor delegates all the validation methods
+provided by [ActiveModel::Validations] onto an interactor's context class from the interactor itself. All of the methods
+found in [ActiveModel::Validations] can be invoked directly on your interactor with the prefix `context_`.
+However this can be confusing and it is recommended to make all validation calls on a context class directly.
 
 ActiveInteractor provides two validation callback steps:
 
@@ -343,17 +341,17 @@ class AuthenticateUser < ActiveInteractor::Base
 end
 ```
 
-The `perform` class method is the proper way to invoke an interactor. The hash argument is converted to the interactor instance's
-context. The `perform` instance method is invoked along with any callbacks and validations that the interactor might define.
+The `.perform` class method is the proper way to invoke an interactor. The hash argument is converted to the interactor instance's
+context. The `#perform` instance method is invoked along with any callbacks and validations that the interactor might define.
 Finally, the context (along with any changes made to it) is returned.
 
 #### Kinds of Interactors
 
-There are two kinds of interactors built into the Interactor library: basic interactors and organizers.
+There are two kinds of interactors built into ActiveInteractor: basic interactors and organizers.
 
 ##### Interactors
 
-A basic interactor is a class that includes Interactor and defines `perform`.\
+A basic interactor is a class that inherits from `ActiveInteractor::Base` and defines `perform`.
 
 ```ruby
 class AuthenticateUser < ActiveInteractor::Base
@@ -428,14 +426,14 @@ change that context before it's passed along to the next interactor.
 
 ###### Organizing Interactors Conditionally
 
-We can also add conditional statements to our organizer by passing a block to the `#organize` method:
+We can also add conditional statements to our organizer by passing a block to the `.organize` method:
 
 ```ruby
 class PlaceOrder < ActiveInteractor::Organizer
   organize do
     add :create_order, if :user_registered?
-    add :charge_card, if: -> { context.order_number }
-    add :send_thank_you, if: -> { context.order_number }
+    add :charge_card, if: -> { context.order }
+    add :send_thank_you, if: -> { context.order }
   end
 
   private
@@ -448,9 +446,9 @@ end
 
 ###### Running Interactors In Parallel
 
-Organizers can be told to run their interactors in parallel with the `#perform_in_parallel` class method.  This
-will run each interactor in parallel with one and other only passing the original context to each organizer.
-This means each interactor must be able to perform without dependencies on prior interactor runs.
+Organizers can be told to run their interactors in parallel with the `.perform_in_parallel` class method.  This
+will run each interactor in parallel with one and other only passing the original context to each interactor.
+This means each interactor must be able to perform without dependencies on prior interactor invokations.
 
 ```ruby
 class CreateNewUser < ActiveInteractor::Base
@@ -515,7 +513,7 @@ outlined in those two modules.
 
 ##### Validation Callbacks
 
-We can do work before an interactor's context is validated with the `before_context_validation` method:
+We can do work before an interactor's context is validated with the `.before_context_validation` method:
 
 ```ruby
 class MyInteractorContext < ActiveInteractor::Context::Base
@@ -532,7 +530,7 @@ result.valid? #=> true
 result.last_name #=> 'Unknown'
 ```
 
-We can do work after an interactor's context is validated with the `after_context_validation` method:
+We can do work after an interactor's context is validated with the `.after_context_validation` method:
 
 ```ruby
 class MyInteractorContext < ActiveInteractor::Context::Base
@@ -552,7 +550,7 @@ result.email #=> 'hello@aaronmallen.me'
 
 ##### Perform Callbacks
 
-We can do work before `perform` is invoked with the `before_perform` method:
+We can do work before `#perform` is invoked with the `.before_perform` method:
 
 ```ruby
 class MyInteractor < ActiveInteractor::Base
@@ -575,7 +573,7 @@ MyInteractor.perform
 #=> <#MyInteractor::Context...>
 ```
 
-We can do work around `perform` invokation with the `around_perform` method:
+We can do work around `#perform` invokation with the `.around_perform` method:
 
 ```ruby
 class MyInteractor < ActiveInteractor::Base
@@ -599,7 +597,7 @@ result.start_time #=> 2019-01-01 00:00:00 UTC
 result.end_time #=> 2019-01-01 00:00:01 UTC
 ```
 
-We can do work after `perform` is invoked with the `after_perform` method:
+We can do work after `#perform` is invoked with the `.after_perform` method:
 
 ```ruby
 class MyInteractor < ActiveInteractor::Base
@@ -624,7 +622,7 @@ MyInteractor.perform
 
 ##### Rollback Callbacks
 
-We can do work before `rollback` is invoked with the `before_rollback` method:
+We can do work before `#rollback` is invoked with the `.before_rollback` method:
 
 ```ruby
 class MyInteractor < ActiveInteractor::Base
@@ -651,7 +649,7 @@ MyInteractor.perform
 #=> <#MyInteractor::Context...>
 ```
 
-We can do work around `rollback` invokation with the `around_rollback` method:
+We can do work around `#rollback` invokation with the `.around_rollback` method:
 
 ```ruby
 class MyInteractor < ActiveInteractor::Base
@@ -679,7 +677,7 @@ result.start_time #=> 2019-01-01 00:00:00 UTC
 result.end_time #=> 2019-01-01 00:00:01 UTC
 ```
 
-We can do work after `rollback` is invoked with the `after_rollback` method:
+We can do work after `#rollback` is invoked with the `.after_rollback` method:
 
 ```ruby
 class MyInteractor < ActiveInteractor::Base
@@ -708,8 +706,8 @@ MyInteractor.perform
 
 ##### Organizer Callbacks
 
-We can do worker before `perform` is invoked on each interactor in an [Organizer](#organizers) with the
-`before_each_perform` method:
+We can do worker before `#perform` is invoked on each interactor in an [Organizer](#organizers) with the
+`.before_each_perform` method:
 
 ```ruby
 class MyInteractor1 < ActiveInteractor::Base
@@ -744,8 +742,8 @@ MyOrganizer.perform
 #=> <MyOrganizer::Context...>
 ```
 
-We can do worker around `perform` is invokation on each interactor in an [Organizer](#organizers) with the
-`around_each_perform` method:
+We can do worker around `#perform` invokation on each interactor in an [Organizer](#organizers) with the
+`.around_each_perform` method:
 
 ```ruby
  class MyInteractor1 < ActiveInteractor::Base
@@ -786,8 +784,8 @@ MyOrganizer.perform
 #=> <MyOrganizer::Context...>
 ```
 
-We can do worker after `perform` is invoked on each interactor in an [Organizer](#organizers) with the
-`after_each_perform` method:
+We can do worker after `#perform` is invoked on each interactor in an [Organizer](#organizers) with the
+`.after_each_perform` method:
 
 ```ruby
 class MyInteractor1 < ActiveInteractor::Base

data/lib/active_interactor/config.rb

@@ -13,23 +13,6 @@ module ActiveInteractor
   class Config
     include Configurable
     defaults logger: Logger.new(STDOUT)
-
-    # @!method initialize(options = {})
-    # @param options [Hash] the options for the configuration
-    # @option options [Logger] :logger the configuration logger instance
-    # @return [Config] a new instance of {Config}
-
-    # The rails configuration object
-    # @return [Rails::Config|nil] an instance of {Rails::Config} if `Rails` is
-    #  defined or `nil`.
-    def rails
-      @rails ||= begin
-        return unless defined?(::Rails)
-
-        require 'active_interactor/rails/config'
-        Rails::Config.new
-      end
-    end
   end
 
   # The ActiveInteractor configuration

data/lib/active_interactor/rails/config.rb

@@ -23,5 +23,23 @@ module ActiveInteractor
       #   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/railtie.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+require 'active_interactor'
+
+module ActiveInteractor
+  module Rails
+    # Configure ActiveInteractor for rails
+    # @author Aaron Allen <hello@aaronmallen.me>
+    # @since 1.0.0
+    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/rails.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+require 'rails'
+
+require 'active_interactor'
+require 'active_interactor/rails/config'
+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
-    extend ActiveSupport::Autoload
-
-    autoload :Config
   end
 end

data/lib/active_interactor/version.rb

@@ -2,5 +2,5 @@
 
 module ActiveInteractor
   # @return [String] the ActiveInteractor version
-  VERSION = '1.0.0.beta.4'
+  VERSION = '1.0.0.beta.5'
 end

data/lib/active_interactor.rb

@@ -36,4 +36,4 @@ module ActiveInteractor
   end
 end
 
-require 'active_interactor/railtie' if defined?(::Rails)
+require 'active_interactor/rails' if defined?(::Rails)

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

@@ -16,7 +16,7 @@ module ActiveInteractor
       end
 
       def create_application_context
-        return if ActiveInteractor.config.rails.generate_context_classes == false
+        return if ActiveInteractor::Rails.config.generate_context_classes == false
 
         template 'application_context.rb', File.join(target_path, 'application_context.rb')
       end

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

@@ -2,18 +2,16 @@
 
 require 'active_interactor'
 
-ActiveInteractor.configure do |config|
-  # set ActiveInteractor.logger to Rails.logger
-  config.logger = ::Rails.logger
+ActiveInteractor::Rails.configure do |config|
 
   # set the default directory for interactors
 <%- if directory != 'interactors' -%>
-  config.rails.directory = '<%= directory %>'
+  config.directory = '<%= directory %>'
 <%- else -%>
-  # config.rails.directory = 'interactors'
+  # config.directory = 'interactors'
 <%- end -%>
 
   # do not automatically generate context classes
   # when interactors are generated
-  # config.rails.generate_context_classes = false
+  # config.generate_context_classes = false
 end

data/lib/rails/generators/active_interactor.rb

@@ -9,7 +9,7 @@ module ActiveInteractor
       private
 
       def interactor_directory
-        @interactor_directory ||= ActiveInteractor.config.rails.directory
+        @interactor_directory ||= ActiveInteractor::Rails.config.directory
       end
     end
 
@@ -24,7 +24,7 @@ module ActiveInteractor
       private
 
       def skip_context?
-        options[:skip_context] == true || ActiveInteractor.config.rails.generate_context_classes == false
+        options[:skip_context] == true || ActiveInteractor::Rails.config.generate_context_classes == false
       end
     end
 

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

@@ -36,7 +36,7 @@ module Interactor
       end
 
       def skip_context?
-        options[:skip_context] == true || ActiveInteractor.config.rails.generate_context_classes == false
+        options[:skip_context] == true || ActiveInteractor::Rails.config.generate_context_classes == false
       end
     end
   end

data/spec/active_interactor/config_spec.rb

@@ -13,18 +13,4 @@ RSpec.describe ActiveInteractor::Config do
       expect(subject[:logger]).to be_a Logger
     end
   end
-
-  describe '.rails' do
-    subject { described_class.new.rails }
-
-    context 'with ::Rails not defined' do
-      it { is_expected.to be_nil }
-    end
-
-    context 'with ::Rails defined' do
-      before { stub_const('::Rails', 'Rails') }
-
-      it { is_expected.not_to be_nil }
-    end
-  end
 end

data/spec/active_interactor/rails_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'active_interactor/rails'
+
+RSpec.describe ActiveInteractor::Rails do
+  describe '.config' do
+    subject { described_class.config }
+
+    it { is_expected.to be_a ActiveInteractor::Rails::Config }
+  end
+
+  describe '.configure' do
+    it 'is expected to yield config' do
+      expect { |b| described_class.configure(&b) }.to yield_control
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeinteractor
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.4
+  version: 1.0.0.beta.5
 platform: ruby
 authors:
 - Aaron Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -123,7 +123,7 @@ files:
 - lib/active_interactor/organizer/interactor_interface_collection.rb
 - lib/active_interactor/rails.rb
 - lib/active_interactor/rails/config.rb
-- lib/active_interactor/railtie.rb
+- lib/active_interactor/rails/railtie.rb
 - lib/active_interactor/version.rb
 - lib/rails/generators/active_interactor.rb
 - lib/rails/generators/active_interactor/application_interactor_generator.rb
@@ -156,6 +156,7 @@ files:
 - spec/active_interactor/organizer/interactor_interface_spec.rb
 - spec/active_interactor/organizer_spec.rb
 - spec/active_interactor/rails/config_spec.rb
+- spec/active_interactor/rails_spec.rb
 - spec/active_interactor_spec.rb
 - spec/integration/basic_callback_integration_spec.rb
 - spec/integration/basic_context_integration_spec.rb
@@ -173,10 +174,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/aaronmallen/activeinteractor/issues
-  changelog_uri: https://github.com/aaronmallen/activeinteractor/blob/v1.0.0.beta.4/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/activeinteractor/1.0.0.beta.4
+  changelog_uri: https://github.com/aaronmallen/activeinteractor/blob/v1.0.0.beta.5/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/activeinteractor/1.0.0.beta.5
   hompage_uri: https://github.com/aaronmallen/activeinteractor
-  source_code_uri: https://github.com/aaronmallen/activeinteractor/tree/v1.0.0.beta.4
+  source_code_uri: https://github.com/aaronmallen/activeinteractor/tree/v1.0.0.beta.5
   wiki_uri: https://github.com/aaronmallen/activeinteractor/wiki
 post_install_message: 
 rdoc_options: []
@@ -217,6 +218,7 @@ test_files:
 - spec/active_interactor/organizer/interactor_interface_spec.rb
 - spec/active_interactor/organizer/interactor_interface_collection_spec.rb
 - spec/active_interactor/rails/config_spec.rb
+- spec/active_interactor/rails_spec.rb
 - spec/active_interactor/interactor/worker_spec.rb
 - spec/active_interactor/interactor/perform_options_spec.rb
 - spec/active_interactor/error_spec.rb

data/lib/active_interactor/railtie.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_interactor'
-require 'active_interactor/rails'
-
-module ActiveInteractor
-  class Railtie < ::Rails::Railtie
-    config.active_interactor = ActiveInteractor.config
-  end
-end