activeinteractor 0.1.7 → 1.0.0.beta.1

data/lib/active_interactor/version.rb

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

data/lib/rails/generators/active_interactor.rb

@@ -1,39 +1,4 @@
 # frozen_string_literal: true
 
-require 'rails/generators/base'
-require 'rails/generators/named_base'
-
-require 'active_interactor'
-
-module ActiveInteractor
-  module Generators
-    module Generator
-      extend ActiveSupport::Concern
-
-      class_methods do
-        def base_root
-          __dir__
-        end
-
-        def source_root
-          File.expand_path('templates', __dir__)
-        end
-      end
-
-      def app_dir_name
-        ActiveInteractor.configuration.dir_name
-      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__)].each { |file| require file }
-Dir[File.expand_path('interactor/*.rb', __dir__)].each { |file| require file }
+Dir[File.expand_path('active_interactor/*.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_interactor_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module ActiveInteractor
+  module Generators
+    class ApplicationInteractorGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def create_application_interactor
+        template 'application_interactor.rb', Rails.root.join('app', 'interactors', 'application_interactor.rb')
+      end
+
+      def create_application_organizer
+        template 'application_organizer.rb', Rails.root.join('app', 'interactors', 'application_organizer.rb')
+      end
+
+      def create_application_context
+        template 'application_context.rb', Rails.root.join('app', 'interactors', 'application_context.rb')
+      end
+    end
+  end
+end

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

@@ -1,30 +1,26 @@
 # frozen_string_literal: true
 
-require_relative '../active_interactor'
+require 'rails/generators/base'
 
 module ActiveInteractor
   module Generators
-    class InstallGenerator < Base
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
       desc 'Install ActiveInteractor'
-      argument :directory, type: :string, default: 'interactors', banner: 'directory'
 
       def create_initializer
         template 'initializer.erb', Rails.root.join('config', 'initializers', 'active_interactor.rb')
       end
 
-      def create_application_interactor
-        template 'application_interactor.erb', Rails.root.join('app', directory, 'application_interactor.rb')
-      end
-
-      def create_interactor_concerns
-        create_file Rails.root.join('app', directory, 'concerns', '.keep')
+      def create_application_interactor_and_context
+        generate :'active_interactor:application_interactor'
       end
 
       def autoload_interactors
         application do
-          <<~CONFIG
-             # autoload interactors
-            config.autoload_paths += %w[app/#{directory}]
+          <<-CONFIG
+          # autoload interactors
+          config.autoload_paths += %w[app/interactors]
 
           CONFIG
         end

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

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

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

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

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'active_interactor'
+
+ActiveInteractor.logger = ::Rails.logger

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module Interactor
+  module Context
+    module Generators
+      class RspecGenerator < ::Rails::Generators::NamedBase
+        source_root File.expand_path('templates', __dir__)
+        desc 'Generate an interactor spec'
+
+        def create_spec
+          file_path = Rails.root.join('spec/interactors', File.join(class_path), "#{file_name}_context_spec.rb")
+          template 'rspec.erb', file_path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# 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/interactor/context/templates/test_unit.erb

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

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module Interactor
+  module Context
+    module Generators
+      class TestUnitGenerator < ::Rails::Generators::NamedBase
+        source_root File.expand_path('templates', __dir__)
+        desc 'Generate an interactor unit test'
+
+        def create_test
+          file_path = Rails.root.join('test/interactors', File.join(class_path), "#{file_name}_context_test.rb")
+          template 'test_unit.erb', file_path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module Interactor
+  module Generators
+    class ContextGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+      desc 'Generate an interactor context'
+      argument :interactors, type: :array, default: [], banner: 'name name'
+
+      def create_context
+        template 'context.erb', Rails.root.join('app/interactors', File.join(class_path), "#{file_name}_context.rb")
+      end
+
+      hook_for :test_framework, in: :'interactor:context'
+    end
+  end
+end

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

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
-require_relative '../active_interactor'
+require 'rails/generators/named_base'
 
-class InteractorGenerator < ActiveInteractor::Generators::NamedBase
+class InteractorGenerator < ::Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
   desc 'Generate an interactor'
 
   def create_interactor
-    template 'interactor.erb', Rails.root.join('app', app_dir_name, File.join(class_path), "#{file_name}.rb")
+    template 'interactor.erb', Rails.root.join('app/interactors', File.join(class_path), "#{file_name}.rb")
+  end
+
+  def create_context
+    generate :'interactor:context', class_name
   end
 
   hook_for :test_framework, in: :interactor

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

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
-require_relative '../active_interactor'
+require 'rails/generators/named_base'
 
 module Interactor
   module Generators
-    class OrganizerGenerator < ActiveInteractor::Generators::NamedBase
+    class OrganizerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
       desc 'Generate an interactor organizer'
       argument :interactors, type: :array, default: [], banner: 'name name'
 
       def create_organizer
-        template 'organizer.erb', Rails.root.join('app', app_dir_name, File.join(class_path), "#{file_name}.rb")
+        template 'organizer.erb', Rails.root.join('app/interactors', File.join(class_path), "#{file_name}.rb")
+      end
+
+      def create_context
+        generate :'interactor:context', class_name
       end
 
       hook_for :test_framework, in: :interactor

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

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../active_interactor'
+require 'rails/generators/named_base'
 
 module Interactor
   module Generators
-    class RspecGenerator < ActiveInteractor::Generators::NamedBase
+    class RspecGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
       desc 'Generate an interactor spec'
 
       def create_spec
-        template 'rspec.erb', Rails.root.join('spec', app_dir_name, File.join(class_path), "#{file_name}_spec.rb")
+        template 'rspec.erb', Rails.root.join('spec/interactors', File.join(class_path), "#{file_name}_spec.rb")
       end
     end
   end

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class <%= class_name %>Context < ApplicationContext
+end

data/lib/rails/generators/{templates → interactor/templates}/organizer.erb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class <%= class_name %> < ActiveInteractor::Organizer
+class <%= class_name %> < ApplicationOrganizer
 
 <%- if interactors.any? -%>
   organize <%= interactors.map(&:classify).join(", ") %>

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

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../active_interactor'
+require 'rails/generators/named_base'
 
 module Interactor
   module Generators
-    class TestUnitGenerator < ActiveInteractor::Generators::NamedBase
+    class TestUnitGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
       desc 'Generate an interactor unit test'
 
       def create_test
-        template 'test_unit.erb', Rails.root.join('test', app_dir_name, File.join(class_path), "#{file_name}_test.rb")
+        template 'test_unit.erb', Rails.root.join('test/interactors', File.join(class_path), "#{file_name}_test.rb")
       end
     end
   end

data/spec/active_interactor/base_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ActiveInteractor::Base 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'
+
+  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
+end

data/spec/active_interactor/context/base_spec.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ActiveInteractor::Context::Base do
+  after(:each) { described_class.instance_variable_set('@__attributes', []) }
+
+  describe '#attributes' do
+    context 'when no arguments are passed' do
+      subject { described_class.attributes }
+      it { is_expected.to eq [] }
+
+      context 'when an attribute :foo was previously defined' do
+        before { described_class.instance_variable_set('@__attributes', %i[foo]) }
+
+        it { is_expected.to eq %i[foo] }
+      end
+    end
+
+    context 'when given arguments :foo and :bar' do
+      subject { described_class.attributes(:foo, :bar) }
+
+      it { is_expected.to eq %i[bar foo] }
+
+      context 'when an attribute :foo was previously defined' do
+        before { described_class.instance_variable_set('@__attributes', %i[foo]) }
+
+        it { is_expected.to eq %i[bar foo] }
+      end
+    end
+  end
+
+  describe '.attributes' do
+    subject { instance.attributes }
+
+    context 'with class attributes []' do
+      context 'with an instance having attributes { :foo => "foo", :bar => "bar", :baz => "baz" }' do
+        let(:instance) { described_class.new(foo: 'foo', bar: 'bar', baz: 'baz') }
+
+        it { is_expected.to be_a Hash }
+        it { is_expected.to be_empty }
+      end
+    end
+
+    context 'with class attributes [:foo, :bar, :baz]' do
+      before { described_class.attributes(:foo, :bar, :baz) }
+
+      context 'with an instance having attributes { :foo => "foo", :bar => "bar", :baz => "baz" }' do
+        let(:instance) { described_class.new(foo: 'foo', bar: 'bar', baz: 'baz') }
+
+        it { is_expected.to be_a Hash }
+        it { is_expected.to eq(bar: 'bar', baz: 'baz', foo: 'foo') }
+      end
+    end
+  end
+
+  describe '#called!' do
+    subject do
+      instance.called!(interactor1)
+      instance.called!(interactor2)
+    end
+
+    let(:instance) { described_class.new }
+    let(:interactor1) { double(:interactor1) }
+    let(:interactor2) { double(:interactor2) }
+
+    it 'is expected to append interactors to instance variable _called' do
+      expect { subject }.to change { instance.send(:_called) }
+        .from([])
+        .to([interactor1, interactor2])
+    end
+  end
+
+  describe '#fail!' do
+    subject { instance.fail!(errors) }
+    let(:instance) { described_class.new }
+
+    context 'with errors equal to nil' do
+      let(:errors) { nil }
+
+      it { expect { subject }.to raise_error(ActiveInteractor::Error::ContextFailure) }
+
+      it 'is expected not to merge errors' do
+        expect(instance.errors).not_to receive(:merge!)
+        subject
+      rescue ActiveInteractor::Error::ContextFailure # rubocop:disable Lint/SuppressedException
+      end
+
+      it 'is expected to be a failure' do
+        subject
+      rescue ActiveInteractor::Error::ContextFailure
+        expect(instance).to be_a_failure
+      end
+    end
+
+    context 'with errors from another instance on the attribute :foo' do
+      let(:errors) { instance2.errors }
+      let(:instance2) { described_class.new }
+
+      before { instance2.errors.add(:foo, 'foo') }
+
+      it { expect { subject }.to raise_error(ActiveInteractor::Error::ContextFailure) }
+
+      it 'is expected to merge errors' do
+        subject
+      rescue ActiveInteractor::Error::ContextFailure
+        expect(instance.errors[:foo]).to eq instance2.errors[:foo]
+      end
+
+      it 'is expected to be a failure' do
+        subject
+      rescue ActiveInteractor::Error::ContextFailure
+        expect(instance).to be_a_failure
+      end
+    end
+
+    context 'with errors "foo"' do
+      let(:errors) { 'foo' }
+
+      it { expect { subject }.to raise_error(ActiveInteractor::Error::ContextFailure) }
+
+      it 'is expected to have error on :context equal to "foo"' do
+        subject
+      rescue ActiveInteractor::Error::ContextFailure
+        expect(instance.errors[:context]).to include 'foo'
+      end
+
+      it 'is expected to be a failure' do
+        subject
+      rescue ActiveInteractor::Error::ContextFailure
+        expect(instance).to be_a_failure
+      end
+    end
+  end
+
+  describe '#new' do
+    subject { described_class.new(attributes) }
+
+    context 'with a previous instance having attributes { :foo => "foo" }' do
+      let(:attributes) { described_class.new(foo: 'foo') }
+
+      it { is_expected.to be_a described_class }
+      it { is_expected.to have_attributes(foo: 'foo') }
+
+      context 'having instance variable @_called equal to ["foo"]' do
+        before { attributes.instance_variable_set('@_called', %w[foo]) }
+
+        it { is_expected.to be_a described_class }
+        it { is_expected.to have_attributes(foo: 'foo') }
+        it 'is expected to preserve @_called instance variable' do
+          expect(subject.instance_variable_get('@_called')).to eq %w[foo]
+        end
+      end
+
+      context 'having instance variable @_failed equal to true' do
+        before { attributes.instance_variable_set('@_failed', true) }
+
+        it { is_expected.to be_a described_class }
+        it { is_expected.to have_attributes(foo: 'foo') }
+        it 'is expected to preserve @_failed instance variable' do
+          expect(subject.instance_variable_get('@_failed')).to eq true
+        end
+      end
+
+      context 'having instance variable @_rolled_back equal to true' do
+        before { attributes.instance_variable_set('@_rolled_back', true) }
+
+        it { is_expected.to be_a described_class }
+        it { is_expected.to have_attributes(foo: 'foo') }
+        it 'is expected to preserve @_rolled_back instance variable' do
+          expect(subject.instance_variable_get('@_rolled_back')).to eq true
+        end
+      end
+    end
+  end
+
+  describe '#failure?' do
+    subject { instance.failure? }
+    let(:instance) { described_class.new }
+
+    it { is_expected.to eq false }
+
+    context 'when context has failed' do
+      before { instance.instance_variable_set('@_failed', true) }
+
+      it { is_expected.to eq true }
+    end
+  end
+
+  describe '#rollback!' do
+    subject { instance.rollback! }
+    let(:instance) { described_class.new }
+
+    context 'with #called! interactors' do
+      let(:interactor1) { double(:interactor1) }
+      let(:interactor2) { double(:interactor2) }
+
+      before do
+        allow(instance).to receive(:_called).and_return([interactor1, interactor2])
+      end
+
+      it 'is expected to rollback each interactor in reverse order' do
+        expect(interactor2).to receive(:rollback).once.with(no_args).ordered
+        expect(interactor1).to receive(:rollback).once.with(no_args).ordered
+        subject
+      end
+
+      it 'is expected to ignore subsequent attempts' do
+        expect(interactor2).to receive(:rollback).once
+        expect(interactor1).to receive(:rollback).once
+        subject
+        subject
+      end
+    end
+  end
+
+  describe '#success?' do
+    subject { instance.success? }
+    let(:instance) { described_class.new }
+
+    it { is_expected.to eq true }
+
+    context 'when context has failed' do
+      before { instance.instance_variable_set('@_failed', true) }
+
+      it { is_expected.to eq false }
+    end
+  end
+end