activeinteractor 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 491bd06fcc2f9baf372f817dab6e40c69a07d5ff15721f5136815bcdeb04656b
-  data.tar.gz: 80e520f97369ab0f9465842eb31f9b0c0e638135cdc73ee27ded9cdc12272cf1
+  metadata.gz: bbabe89a7d29d7b1faba5a48f6d7cc105db0bc783ce6b14ecef236534a69c2e2
+  data.tar.gz: 6716e1bba69f443f360632aa8af7f3c5c89f3b60d5bf3679427e63c12d65b454
 SHA512:
-  metadata.gz: 3409d7c2a1c81fcfa6482493569a015356f6239635b4ea539947687c2e2ba44947825b8914ee264df7280e7f612184b35ae67cc10010a6df793087f249aacc81
-  data.tar.gz: dd892f0304bd572a8074c56cad88a231a9ca328b6365ffb96cf87ea7c60c5121f11ed32c3de70a550e3d9ea7fdeb5489667b653041e41c64e90dd661ea35d5e7
+  metadata.gz: 34bbeb89139ffdccb6a1fc38e73f125995a21a9ad2026bbde21ac6a251ff0bec533d35143ce13e569fe2f55c33feafb03e8eac142b2e1577d127f359b4b52d4c
+  data.tar.gz: dc8e8775074d0d451678597c459ed6bc4b55043c89755c6be0d34ca56ab4cf74624686bad25e4111e7457fed5f0bcd3ee8d3cab6316b4d5a13567b8ac004e6ad

data/CHANGELOG.md

@@ -7,11 +7,23 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [v1.1.0] - 2020-10-04
+
+### Added
+
+- [\#247](https://github.com/aaronmallen/activeinteractor/issues/247) Support in place callbacks
+
+### Fixed
+
+- [\#242](https://github.com/aaronmallen/activeinteractor/issues/242) Optional attributes are always null
+- [\#243](https://github.com/aaronmallen/activeinteractor/issues/243) Nested Organizers do not rollback parent context
+
 ## [v1.0.5] - 2020-09-15
 
 ### Fixed
 
-- [\#200](https://github.com/aaronmallen/activeinteractor/issues/200) Context attributes assigned in interactor not accessible as element within interactor
+- [\#200](https://github.com/aaronmallen/activeinteractor/issues/200) Context attributes assigned in interactor not
+  accessible as element within interactor
 
 ## [v1.0.4] - 2020-02-11
 
@@ -200,7 +212,9 @@ and this project adheres to [Semantic Versioning].
 
 <!-- versions -->
 
-[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.4...HEAD
+[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v1.1.0...HEAD
+[v1.1.0]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.5...v1.1.0
+[v1.0.5]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.4...v1.0.5
 [v1.0.4]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.3...v1.0.4
 [v1.0.3]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.2...v1.0.3
 [v1.0.2]: https://github.com/aaronmallen/activeinteractor/compare/v1.0.1...v1.0.2

data/lib/active_interactor/context/attributes.rb

@@ -69,6 +69,19 @@ module ActiveInteractor
         @table[name.to_sym] || attributes[name.to_sym]
       end
 
+      # Sets value of a Hash attribute in context.attributes
+      #
+      # @since 1.1.0
+      #
+      # @param name [String, Symbol] the key name of the attribute
+      # @param value [*] the value to be given attribute name
+      # @returns [*] the attribute value
+      def []=(name, value)
+        public_send("#{name}=", value)
+
+        super
+      end
+
       # Get values defined on the instance of {Base context} whose keys are defined on the {Base context} class'
       # {ClassMethods#attributes .attributes}
       #
@@ -117,7 +130,8 @@ module ActiveInteractor
       def merge!(context)
         merge_errors!(context) if context.respond_to?(:errors)
         copy_flags!(context)
-        context.each_pair do |key, value|
+
+        merged_context_attributes(context).each_pair do |key, value|
           public_send("#{key}=", value) unless value.nil?
         end
         self
@@ -129,6 +143,13 @@ module ActiveInteractor
         @_called ||= []
       end
 
+      def merged_context_attributes(context)
+        attrs = {}
+        attrs.merge!(context.to_h) if context.respond_to?(:to_h)
+        attrs.merge!(context.attributes.to_h) if context.respond_to?(:attributes)
+        attrs
+      end
+
       def context_attributes_as_hash(context)
         return context.to_h if context&.respond_to?(:to_h)
         return context.attributes.to_h if context.respond_to?(:attributes)

data/lib/active_interactor/organizer/interactor_interface.rb

@@ -14,6 +14,13 @@ module ActiveInteractor
     #
     #  @return [Hash{Symbol=>Proc, Symbol}] conditional options for the {ActiveInteractor::Base interactor} class
     #
+    # @!attribute [r] callbacks
+    #   Callbacks for the interactor_class
+    #
+    #   @since 1.1.0
+    #
+    #   @return [Hash{Symbol=>*}] the interactor callbacks
+    #
     # @!attribute [r] interactor_class
     #  An {ActiveInteractor::Base interactor} class
     #
@@ -27,11 +34,12 @@ module ActiveInteractor
     #  @return [Hash{Symbol=>*}] {Interactor::Perform::Options} for the {ActiveInteractor::Base interactor}
     #   {Interactor::Perform#perform #perform}
     class InteractorInterface
-      attr_reader :filters, :interactor_class, :perform_options
+      attr_reader :filters, :callbacks, :interactor_class, :perform_options
 
       # Keywords for conditional filters
       # @return [Array<Symbol>]
       CONDITIONAL_FILTERS = %i[if unless].freeze
+      CALLBACKS = %i[before after].freeze
 
       # Initialize a new instance of {InteractorInterface}
       #
@@ -42,7 +50,8 @@ module ActiveInteractor
       def initialize(interactor_class, options = {})
         @interactor_class = interactor_class.to_s.camelize.safe_constantize
         @filters = options.select { |key, _value| CONDITIONAL_FILTERS.include?(key) }
-        @perform_options = options.reject { |key, _value| CONDITIONAL_FILTERS.include?(key) }
+        @callbacks = options.select { |key, _value| CALLBACKS.include?(key) }
+        @perform_options = options.reject { |key, _value| CONDITIONAL_FILTERS.include?(key) || CALLBACKS.include?(key) }
       end
 
       # Call the {#interactor_class} {Interactor::Perform::ClassMethods#perform .perform} or
@@ -57,21 +66,29 @@ module ActiveInteractor
       #  {Context::Status#fail! fails} its {Context::Base context}.
       # @return [Class] an instance of {Context::Base context}
       def perform(target, context, fail_on_error = false, perform_options = {})
-        return if check_conditionals(target, filters[:if]) == false
-        return if check_conditionals(target, filters[:unless]) == true
+        return if check_conditionals(target, :if) == false
+        return if check_conditionals(target, :unless) == true
 
         method = fail_on_error ? :perform! : :perform
         options = self.perform_options.merge(perform_options)
         interactor_class.send(method, context, options)
       end
 
+      def execute_inplace_callback(target, callback)
+        resolve_option(target, callbacks[callback])
+      end
+
       private
 
       def check_conditionals(target, filter)
-        return unless filter
+        resolve_option(target, filters[filter])
+      end
+
+      def resolve_option(target, opt)
+        return unless opt
 
-        return target.send(filter) if filter.is_a?(Symbol)
-        return target.instance_exec(&filter) if filter.is_a?(Proc)
+        return target.send(opt) if opt.is_a?(Symbol)
+        return target.instance_exec(&opt) if opt.is_a?(Proc)
       end
     end
   end

data/lib/active_interactor/organizer/perform.rb

@@ -73,10 +73,19 @@ module ActiveInteractor
         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|
-          result = execute_interactor_with_callbacks(interface, true)
-          context.merge!(result) if result
+          execute_and_merge_contexts(interface)
         end
       rescue ActiveInteractor::Error::ContextFailure => e
         context.merge!(e.context)

data/lib/active_interactor/version.rb

@@ -3,5 +3,5 @@
 module ActiveInteractor
   # The ActiveInteractor version
   # @return [String] the ActiveInteractor version
-  VERSION = '1.0.5'
+  VERSION = '1.1.0'
 end

data/spec/active_interactor/organizer/interactor_interface_spec.rb

@@ -84,6 +84,72 @@ RSpec.describe ActiveInteractor::Organizer::InteractorInterface do
         end
       end
 
+      context 'with options {:before => :some_method }' do
+        let(:options) { { before: :some_method } }
+
+        describe '#callbacks' do
+          subject { instance.callbacks }
+
+          it { is_expected.to eq(before: :some_method) }
+        end
+
+        describe '#perform_options' do
+          subject { instance.perform_options }
+
+          it { is_expected.to be_empty }
+        end
+      end
+
+      context 'with options {:before => -> { context.test = true } }' do
+        let(:options) { { before: -> { context.test = true } } }
+
+        describe '#callbacks' do
+          subject { instance.callbacks }
+
+          it { expect(subject[:before]).not_to be_nil }
+          it { expect(subject[:before]).to be_a Proc }
+        end
+
+        describe '#perform_options' do
+          subject { instance.perform_options }
+
+          it { is_expected.to be_empty }
+        end
+      end
+
+      context 'with options {:after => :some_method }' do
+        let(:options) { { after: :some_method } }
+
+        describe '#callbacks' do
+          subject { instance.callbacks }
+
+          it { is_expected.to eq(after: :some_method) }
+        end
+
+        describe '#perform_options' do
+          subject { instance.perform_options }
+
+          it { is_expected.to be_empty }
+        end
+      end
+
+      context 'with options {:after => -> { context.test = true } }' do
+        let(:options) { { after: -> { context.test = true } } }
+
+        describe '#callbacks' do
+          subject { instance.callbacks }
+
+          it { expect(subject[:after]).not_to be_nil }
+          it { expect(subject[:after]).to be_a Proc }
+        end
+
+        describe '#perform_options' do
+          subject { instance.perform_options }
+
+          it { is_expected.to be_empty }
+        end
+      end
+
       context 'with options { :validate => false }' do
         let(:options) { { validate: false } }
 
@@ -100,8 +166,8 @@ RSpec.describe ActiveInteractor::Organizer::InteractorInterface do
         end
       end
 
-      context 'with options { :if => :some_method, :validate => false }' do
-        let(:options) { { if: :some_method, validate: false } }
+      context 'with options { :if => :some_method, :validate => false, :before => :other_method }' do
+        let(:options) { { if: :some_method, validate: false, before: :other_method } }
 
         describe '#filters' do
           subject { instance.filters }
@@ -109,6 +175,12 @@ RSpec.describe ActiveInteractor::Organizer::InteractorInterface do
           it { is_expected.to eq(if: :some_method) }
         end
 
+        describe '#callbacks' do
+          subject { instance.callbacks }
+
+          it { is_expected.to eq(before: :other_method) }
+        end
+
         describe '#perform_options' do
           subject { instance.perform_options }
 

data/spec/integration/a_basic_organizer_spec.rb

@@ -140,6 +140,8 @@ RSpec.describe 'A basic organizer', type: :integration do
     let!(:test_context_class) do
       build_context('TestInteractor1Context') do
         attributes :foo
+        attributes :baz
+        attributes :zoo
       end
     end
 
@@ -151,6 +153,12 @@ RSpec.describe 'A basic organizer', type: :integration do
           context.has_foo_as_element = context[:foo].present?
           context.has_bar_as_method = context.bar.present?
           context.has_bar_as_element = context[:bar].present?
+          context.baz = 'baz'
+          context.has_baz_as_method = context.baz.present?
+          context.has_baz_as_element = context[:baz].present?
+          context[:zoo] = 'zoo'
+          context.has_zoo_as_method = context.zoo.present?
+          context.has_zoo_as_element = context[:zoo].present?
         end
       end
     end
@@ -167,13 +175,17 @@ RSpec.describe 'A basic organizer', type: :integration do
 
       describe '.perform' do
         subject(:result) { interactor_class.perform(context_attributes) }
-        it { is_expected.to have_attributes(foo: 'foo', bar: 'bar') }
+        it { is_expected.to have_attributes(foo: 'foo', bar: 'bar', baz: 'baz', zoo: 'zoo') }
 
         it 'is expected to copy all attributes in the contexts to each interactor' do
           expect(subject.has_foo_as_method).to be true
           expect(subject.has_foo_as_element).to be true
           expect(subject.has_bar_as_method).to be true
           expect(subject.has_bar_as_element).to be true
+          expect(subject.has_baz_as_method).to be true
+          expect(subject.has_baz_as_element).to be true
+          expect(subject.has_zoo_as_method).to be true
+          expect(subject.has_zoo_as_element).to be true
         end
 
         describe '#attributes' do

data/spec/integration/an_organizer_with_failing_nested_organizer_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'An organizer with failing nested organizer', type: :integration do
+  let!(:parent_interactor1) { build_interactor('TestParentInteractor1') }
+  let!(:parent_interactor2) { build_interactor('TestParentInteractor2') }
+  let!(:child_interactor1) { build_interactor('TestChildInteractor1') }
+  let!(:child_interactor2) do
+    build_interactor('TestChildInteractor2') do
+      def perform
+        context.fail!
+      end
+    end
+  end
+
+  let!(:child_interactor_class) do
+    build_organizer('TestChildOrganizer') do
+      organize TestChildInteractor1, TestChildInteractor2
+    end
+  end
+
+  let(:parent_interactor_class) do
+    build_organizer('TestParentOrganizer') do
+      organize TestParentInteractor1, TestChildOrganizer, TestParentInteractor2
+    end
+  end
+
+  describe '.perform' do
+    subject { parent_interactor_class.perform }
+
+    before do
+      expect_any_instance_of(child_interactor_class).to receive(:perform).exactly(:once).and_call_original
+      expect_any_instance_of(child_interactor1).to receive(:perform).exactly(:once).and_call_original
+      expect_any_instance_of(child_interactor2).to receive(:perform).exactly(:once).and_call_original
+      expect_any_instance_of(child_interactor2).to receive(:rollback).exactly(:once).and_call_original
+      expect_any_instance_of(child_interactor1).to receive(:rollback).exactly(:once).and_call_original
+      expect_any_instance_of(parent_interactor1).to receive(:rollback).exactly(:once).and_call_original
+      expect_any_instance_of(parent_interactor2).not_to receive(:perform).exactly(:once).and_call_original
+      expect_any_instance_of(parent_interactor2).not_to receive(:rollback).exactly(:once).and_call_original
+    end
+
+    it { is_expected.to be_a parent_interactor_class.context_class }
+
+    it { is_expected.to be_failure }
+  end
+end

data/spec/integration/an_organizer_with_options_callbacks_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'An organizer with options callbacks', type: :integration do
+  let!(:interactor1) do
+    build_interactor('TestInteractor1') do
+      def perform
+        context.step = 3 if context.step == 2
+        context.step = 6 if context.step == 5
+      end
+    end
+  end
+
+  let(:interactor_class) do
+    build_organizer do
+      organize do
+        add TestInteractor1, before: :test_before_method, after: :test_after_method
+        add TestInteractor1, before: lambda {
+          context.step = 5 if context.step == 4
+        }, after: lambda {
+          context.step = 7 if context.step == 6
+        }
+      end
+
+      private
+
+      def test_before_method
+        context.step = 2 if context.step == 1
+      end
+
+      def test_after_method
+        context.step = 4 if context.step == 3
+      end
+    end
+  end
+
+  include_examples 'a class with interactor methods'
+  include_examples 'a class with interactor callback methods'
+  include_examples 'a class with interactor context methods'
+  include_examples 'a class with organizer callback methods'
+
+  describe '.perform' do
+    subject { interactor_class.perform(step: 1) }
+
+    it { is_expected.to be_a interactor_class.context_class }
+    it 'is expected to receive #test_before_method once' do
+      expect_any_instance_of(interactor_class).to receive(:test_before_method)
+        .exactly(:once)
+      subject
+    end
+
+    it 'is expected to receive #test_after_method once' do
+      expect_any_instance_of(interactor_class).to receive(:test_after_method)
+        .exactly(:once)
+      subject
+    end
+
+    it 'runs callbacks in sequence' do
+      expect(subject.step).to eq(7)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeinteractor
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Aaron Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -188,6 +188,8 @@ files:
 - spec/integration/an_organizer_with_around_each_callbacks_spec.rb
 - spec/integration/an_organizer_with_before_each_callbacks_spec.rb
 - spec/integration/an_organizer_with_conditionally_organized_interactors_spec.rb
+- spec/integration/an_organizer_with_failing_nested_organizer_spec.rb
+- spec/integration/an_organizer_with_options_callbacks_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers/factories.rb
 - spec/support/shared_examples/a_class_that_extends_active_interactor_models_example.rb
@@ -201,10 +203,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/aaronmallen/activeinteractor/issues
-  changelog_uri: https://github.com/aaronmallen/activeinteractor/blob/v1.0.5/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/activeinteractor/1.0.5
+  changelog_uri: https://github.com/aaronmallen/activeinteractor/blob/v1.1.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/activeinteractor/1.1.0
   hompage_uri: https://github.com/aaronmallen/activeinteractor
-  source_code_uri: https://github.com/aaronmallen/activeinteractor/tree/v1.0.5
+  source_code_uri: https://github.com/aaronmallen/activeinteractor/tree/v1.1.0
   wiki_uri: https://github.com/aaronmallen/activeinteractor/wiki
 post_install_message: 
 rdoc_options: []
@@ -233,7 +235,9 @@ test_files:
 - spec/support/shared_examples/a_class_with_interactor_callback_methods_example.rb
 - spec/support/spec_helpers.rb
 - spec/support/helpers/factories.rb
+- spec/integration/an_organizer_with_options_callbacks_spec.rb
 - spec/integration/an_interactor_with_validations_on_calling_spec.rb
+- spec/integration/an_organizer_with_failing_nested_organizer_spec.rb
 - spec/integration/a_basic_interactor_spec.rb
 - spec/integration/a_basic_organizer_spec.rb
 - spec/integration/an_organizer_with_conditionally_organized_interactors_spec.rb