activeinteractor 0.1.7 → 1.0.0.beta.1

data/spec/active_interactor/error_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ActiveInteractor::Error::ContextFailure do
+  subject { described_class.new }
+
+  it { is_expected.to respond_to :context }
+
+  context 'when context is equal to nil' do
+    subject { described_class.new(nil) }
+
+    it { is_expected.to have_attributes(message: 'Context failed!') }
+  end
+
+  context 'when context is an instance of "TestContext"' do
+    before { build_context }
+    subject { described_class.new(TestContext.new) }
+
+    it { is_expected.to have_attributes(message: 'TestContext failed!') }
+    it 'is expected to have an instance of TestContext' do
+      expect(subject.context).to be_a TestContext
+    end
+  end
+end
+
+RSpec.describe ActiveInteractor::Error::InvalidContextClass do
+  subject { described_class.new }
+
+  it { is_expected.to respond_to :class_name }
+
+  context 'when class_name is equal to nil' do
+    subject { described_class.new(nil) }
+
+    it { is_expected.to have_attributes(message: 'invalid context class ') }
+  end
+
+  context 'when class_name is equal to "MyContect"' do
+    subject { described_class.new('MyContext') }
+
+    it { is_expected.to have_attributes(message: 'invalid context class MyContext') }
+  end
+end

data/spec/active_interactor/interactor/worker_spec.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ActiveInteractor::Interactor::Worker do
+  context 'with interactor class TestInteractor' do
+    before { build_interactor }
+    let(:interactor) { TestInteractor.new }
+
+    describe '#execute_perform' do
+      subject { described_class.new(interactor).execute_perform }
+
+      it { is_expected.to be_an TestInteractor.context_class }
+
+      context 'when context fails' do
+        before do
+          allow_any_instance_of(TestInteractor).to receive(:perform)
+            .and_raise(ActiveInteractor::Error::ContextFailure)
+        end
+
+        it { expect { subject }.not_to raise_error }
+        it { is_expected.to be_an TestInteractor.context_class }
+      end
+    end
+
+    describe '#execute_perform!' do
+      subject { described_class.new(interactor).execute_perform! }
+
+      it { is_expected.to be_an TestInteractor.context_class }
+
+      it 'is expected to run perform callbacks on interactor' do
+        expect_any_instance_of(TestInteractor).to receive(:run_callbacks)
+          .with(:perform)
+        subject
+      end
+
+      it 'calls #perform on interactor instance' do
+        expect_any_instance_of(TestInteractor).to receive(:perform)
+        subject
+      end
+
+      context 'when interactor context is invalid on :calling' do
+        before do
+          allow_any_instance_of(TestInteractor.context_class).to receive(:valid?)
+            .with(:calling)
+            .and_return(false)
+        end
+
+        it { expect { subject }.to raise_error(ActiveInteractor::Error::ContextFailure) }
+        it 'rollsback the interactor context' do
+          expect_any_instance_of(TestInteractor).to receive(:context_rollback!)
+          expect { subject }.to raise_error(ActiveInteractor::Error::ContextFailure)
+        end
+      end
+
+      context 'when interactor context is invalid on :called' do
+        before do
+          allow_any_instance_of(TestInteractor.context_class).to receive(:valid?)
+            .with(:calling)
+            .and_return(true)
+          allow_any_instance_of(TestInteractor.context_class).to receive(:valid?)
+            .with(:called)
+            .and_return(false)
+        end
+
+        it { expect { subject }.to raise_error(ActiveInteractor::Error::ContextFailure) }
+        it 'rollsback the interactor context' do
+          expect_any_instance_of(TestInteractor).to receive(:context_rollback!)
+          expect { subject }.to raise_error(ActiveInteractor::Error::ContextFailure)
+        end
+      end
+    end
+
+    describe '#execute_rollback' do
+      subject { described_class.new(interactor).execute_rollback }
+
+      it 'is expected to run rollback callbacks on interactor' do
+        expect_any_instance_of(TestInteractor).to receive(:run_callbacks)
+          .with(:rollback)
+        subject
+      end
+
+      it 'calls #context_rollback on interactor instance' do
+        expect_any_instance_of(TestInteractor).to receive(:context_rollback!)
+        subject
+      end
+    end
+  end
+end

data/spec/active_interactor/organizer_spec.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ActiveInteractor::Organizer do
+  let(:interactor_class) { described_class }
+  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 '.contextualize_with' do
+    subject { described_class.contextualize_with(klass) }
+
+    context 'with an class that does not exist' do
+      let(:klass) { 'SomeClassThatDoesNotExist' }
+
+      it { expect { subject }.to raise_error(ActiveInteractor::Error::InvalidContextClass) }
+    end
+
+    context 'with context class TestContext' do
+      before { build_context }
+
+      context 'when passed as a string' do
+        let(:klass) { 'TestContext' }
+
+        it 'assigns the context class' do
+          subject
+          expect(described_class.context_class).to eq TestContext
+        end
+      end
+
+      context 'when passed as a symbol' do
+        let(:klass) { :test_context }
+
+        it 'assigns the context class' do
+          subject
+          expect(described_class.context_class).to eq TestContext
+        end
+      end
+
+      context 'when passed as a constant' do
+        let(:klass) { TestContext }
+
+        it 'assigns the context class' do
+          subject
+          expect(described_class.context_class).to eq TestContext
+        end
+      end
+    end
+  end
+
+  describe '.organize' do
+    subject { interactor_class }
+    context 'with two existing interactors' do
+      let!(:interactor1) { build_interactor('TestInteractor1') }
+      let!(:interactor2) { build_interactor('TestInteractor2') }
+
+      context 'when interactors are passed as contants' do
+        let(:interactor_class) do
+          build_organizer do
+            organize TestInteractor1, TestInteractor2
+          end
+        end
+
+        it { is_expected.to have_attributes(organized: [TestInteractor1, TestInteractor2]) }
+      end
+
+      context 'when interactors are passed as symbols' do
+        let(:interactor_class) do
+          build_organizer do
+            organize :test_interactor_1, :test_interactor_2
+          end
+        end
+
+        it { is_expected.to have_attributes(organized: [TestInteractor1, TestInteractor2]) }
+
+        context 'having a non existance interactor' do
+          let(:interactor_class) do
+            build_organizer do
+              organize :test_interactor_1, :interactor_that_doesnt_exist, :test_interactor_2
+            end
+          end
+
+          it { is_expected.to have_attributes(organized: [TestInteractor1, TestInteractor2]) }
+        end
+      end
+
+      context 'when interactors are passed as strings' do
+        let(:interactor_class) do
+          build_organizer do
+            organize 'TestInteractor1', 'TestInteractor2'
+          end
+        end
+
+        it { is_expected.to have_attributes(organized: [TestInteractor1, TestInteractor2]) }
+
+        context 'having a non existance interactor' do
+          let(:interactor_class) do
+            build_organizer do
+              organize 'TestInteractor1', 'InteractorThatDoesntExist', 'TestInteractor2'
+            end
+          end
+
+          it { is_expected.to have_attributes(organized: [TestInteractor1, TestInteractor2]) }
+        end
+      end
+    end
+  end
+
+  describe '#perform' do
+    subject { interactor_class.perform }
+    context 'with two existing interactors' do
+      let!(:interactor1) { build_interactor('TestInteractor1') }
+      let!(:interactor2) { build_interactor('TestInteractor2') }
+      let(:interactor_class) do
+        build_organizer do
+          organize TestInteractor1, TestInteractor2
+        end
+      end
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it 'is expected to call #perform on both interactors' do
+        expect_any_instance_of(interactor1).to receive(:perform)
+        expect_any_instance_of(interactor2).to receive(:perform)
+        subject
+      end
+
+      context 'when the first interactor context fails' do
+        let!(:interactor1) do
+          build_interactor('TestInteractor1') do
+            def perform
+              context.fail!
+            end
+          end
+        end
+
+        it { expect { subject }.not_to raise_error }
+        it { is_expected.to be_a interactor_class.context_class }
+        it 'is expected to call #perform on the first interactor' do
+          expect_any_instance_of(interactor1).to receive(:perform)
+          subject
+        end
+        it 'is expected to not call #perform on the second interactor' do
+          expect_any_instance_of(interactor2).not_to receive(:perform)
+          subject
+        end
+        it 'is expected to call #rollback on the first interactor' do
+          expect_any_instance_of(interactor1).to receive(:rollback)
+          subject
+        end
+      end
+
+      context 'when the second interactor context fails' do
+        let!(:interactor2) do
+          build_interactor('TestInteractor2') do
+            def perform
+              context.fail!
+            end
+          end
+        end
+
+        it { expect { subject }.not_to raise_error }
+        it { is_expected.to be_a interactor_class.context_class }
+        it 'is expected to call #perform on both interactors' do
+          expect_any_instance_of(interactor1).to receive(:perform)
+          expect_any_instance_of(interactor2).to receive(:perform)
+          subject
+        end
+        it 'is expected to call #rollback on both interactors' do
+          expect_any_instance_of(interactor1).to receive(:rollback)
+          expect_any_instance_of(interactor2).to receive(:rollback)
+          subject
+        end
+      end
+    end
+  end
+end

data/spec/active_interactor_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ActiveInteractor do
+  describe '::VERSION' do
+    subject { described_class::VERSION }
+
+    it { is_expected.to be_a String }
+  end
+
+  describe '.logger' do
+    subject { described_class.logger }
+
+    it { is_expected.to be_a Logger }
+  end
+
+  describe '.logger=' do
+    subject { described_class.logger = logger }
+    let!(:original_logger) { described_class.logger }
+    let(:logger) { double(:logger) }
+    after { described_class.logger = original_logger }
+
+    it { expect { subject }.to change { described_class.logger }.to(logger) }
+  end
+end

data/spec/integration/basic_callback_integration_spec.rb

@@ -0,0 +1,355 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Basic Callback Integration', type: :integration do
+  describe 'An interactor with after context validation callbacks' do
+    let(:interactor_class) do
+      build_interactor do
+        context_validates :test_field, presence: true
+        after_context_validation :downcase_test_field
+
+        private
+
+        def downcase_test_field
+          context.test_field = context.test_field.downcase
+        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'
+
+    describe '.perform' do
+      subject { interactor_class.perform(context_attributes) }
+
+      context 'with valid context attributes' do
+        let(:context_attributes) { { test_field: 'TEST' } }
+
+        it { is_expected.to be_a interactor_class.context_class }
+        it { is_expected.to be_successful }
+        it { is_expected.to have_attributes(test_field: 'test') }
+      end
+    end
+  end
+
+  describe 'An interactor with conditional after context validation callbacks' do
+    let(:interactor_class) do
+      build_interactor do
+        context_validates :test_field, presence: true
+        after_context_validation :downcase_test_field, if: -> { context.should_downcase }
+
+        private
+
+        def downcase_test_field
+          context.test_field = context.test_field.downcase
+        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'
+
+    describe '.perform' do
+      subject { interactor_class.perform(context_attributes) }
+
+      context 'with :test_field "TEST" and :should_downcase true' do
+        let(:context_attributes) { { test_field: 'TEST', should_downcase: true } }
+
+        it { is_expected.to be_a interactor_class.context_class }
+        it { is_expected.to be_successful }
+        it { is_expected.to have_attributes(test_field: 'test') }
+      end
+
+      context 'with :test_field "TEST" and :should_downcase false' do
+        let(:context_attributes) { { test_field: 'TEST', should_downcase: false } }
+
+        it { is_expected.to be_a interactor_class.context_class }
+        it { is_expected.to be_successful }
+        it { is_expected.to have_attributes(test_field: 'TEST') }
+      end
+    end
+  end
+
+  describe 'An interactor with after perform callbacks' do
+    let(:interactor_class) do
+      build_interactor do
+        after_perform :test_after_perform
+
+        private
+
+        def test_after_perform; 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'
+
+    describe '.perform' do
+      subject { interactor_class.perform }
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it { is_expected.to be_successful }
+      it 'is expected to call #test_after_perform' do
+        expect_any_instance_of(interactor_class).to receive(:test_after_perform)
+        subject
+      end
+    end
+  end
+
+  describe 'An interactor with after rollback callbacks' do
+    let(:interactor_class) do
+      build_interactor do
+        after_rollback :test_after_rollback
+
+        def perform
+          context.fail!
+        end
+
+        private
+
+        def test_after_rollback; 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'
+
+    describe '.perform' do
+      subject { interactor_class.perform }
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it 'is expected to call #test_after_rollback' do
+        expect_any_instance_of(interactor_class).to receive(:test_after_rollback)
+        subject
+      end
+    end
+  end
+
+  describe 'An interactor with around perform callbacks' do
+    let(:interactor_class) do
+      build_interactor do
+        around_perform :test_around_perform
+
+        def perform
+          context.perform_step << 2
+        end
+
+        private
+
+        def test_around_perform
+          context.perform_step = []
+          context.perform_step << 1
+          yield
+          context.perform_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'
+
+    describe '.perform' do
+      subject { interactor_class.perform }
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it { is_expected.to have_attributes(perform_step: [1, 2, 3]) }
+    end
+  end
+
+  describe 'An interactor with around rollback callbacks' do
+    let(:interactor_class) do
+      build_interactor do
+        around_rollback :test_around_rollback
+
+        def perform
+          context.fail!
+        end
+
+        def rollback
+          context.rollback_step << 2
+        end
+
+        private
+
+        def test_around_rollback
+          context.rollback_step = []
+          context.rollback_step << 1
+          yield
+          context.rollback_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'
+
+    describe '.perform' do
+      subject { interactor_class.perform }
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it { is_expected.to have_attributes(rollback_step: [1, 2, 3]) }
+    end
+  end
+
+  describe 'An interactor with before perform callbacks' do
+    let(:interactor_class) do
+      build_interactor do
+        before_perform :test_before_perform
+
+        private
+
+        def test_before_perform; 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'
+
+    describe '.perform' do
+      subject { interactor_class.perform }
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it { is_expected.to be_successful }
+      it 'is expected to call #test_before_perform' do
+        expect_any_instance_of(interactor_class).to receive(:test_before_perform)
+        subject
+      end
+    end
+  end
+
+  describe 'An interactor with before rollback callbacks' do
+    let(:interactor_class) do
+      build_interactor do
+        before_rollback :test_before_rollback
+
+        def perform
+          context.fail!
+        end
+
+        private
+
+        def test_before_rollback; 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'
+
+    describe '.perform' do
+      subject { interactor_class.perform }
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it 'is expected to call #test_before_rollback' do
+        expect_any_instance_of(interactor_class).to receive(:test_before_rollback)
+        subject
+      end
+    end
+  end
+
+  describe 'An organizer with after each callbacks' do
+    let!(:interactor1) { build_interactor('TestInteractor1') }
+    let!(:interactor2) { build_interactor('TestInteractor2') }
+    let(:interactor_class) do
+      build_organizer do
+        after_each_perform :test_after_each_perform
+        organize TestInteractor1, TestInteractor2
+
+        private
+
+        def test_after_each_perform; 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 }
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it 'is expected to call #test_after_each_perform twice' do
+        expect_any_instance_of(interactor_class).to receive(:test_after_each_perform)
+          .exactly(:twice)
+        subject
+      end
+    end
+  end
+
+  describe 'An organizer with around each callbacks' do
+    let!(:interactor1) { build_interactor('TestInteractor1') }
+    let!(:interactor2) { build_interactor('TestInteractor2') }
+    let(:interactor_class) do
+      build_organizer do
+        around_each_perform :test_around_each_perform
+        organize TestInteractor1, TestInteractor2
+
+        private
+
+        def find_index
+          (context.around_each_step.last || 0) + 1
+        end
+
+        def test_around_each_perform
+          context.around_each_step ||= []
+          context.around_each_step << find_index
+          yield
+          context.around_each_step << find_index
+        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 }
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it { is_expected.to have_attributes(around_each_step: [1, 2, 3, 4]) }
+    end
+  end
+
+  describe 'An organizer with before each callbacks' do
+    let!(:interactor1) { build_interactor('TestInteractor1') }
+    let!(:interactor2) { build_interactor('TestInteractor2') }
+    let(:interactor_class) do
+      build_organizer do
+        before_each_perform :test_before_each_perform
+        organize TestInteractor1, TestInteractor2
+
+        private
+
+        def test_before_each_perform; 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 }
+
+      it { is_expected.to be_a interactor_class.context_class }
+      it 'is expected to call #test_before_each_perform twice' do
+        expect_any_instance_of(interactor_class).to receive(:test_before_each_perform)
+          .exactly(:twice)
+        subject
+      end
+    end
+  end
+end