activeinteractor 0.1.0

data/lib/active_interactor/organizer.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  # The Base Interactor class inherited by all Interactor::Organizers
+  #
+  # @author Aaron Allen <hello@aaronmallen.me>
+  # @since 0.0.1
+  # @version 0.1
+  class Organizer < ActiveInteractor::Base
+    class << self
+      # Declare Interactors to be invoked as part of the
+      #  organizer's invocation. These interactors are invoked in
+      #  the order in which they are declared.
+      #
+      # @example
+      #   class MyFirstOrganizer < ActiveInteractor::Organizer
+      #     organize InteractorOne, InteractorTwo
+      #   end
+      #
+      #   class MySecondOrganizer < ActiveInteractor::Organizer
+      #     organize [InteractorThree, InteractorFour]
+      #   end
+      #
+      # @param interactors [Array<ActiveInteractor::Base>] the interactors to call
+      def organize(*interactors)
+        @organized = interactors.flatten
+      end
+
+      # An Array of declared Interactors to be invoked.
+      # @private
+      def organized
+        @organized ||= []
+      end
+    end
+
+    # Invoke the organized interactors. An organizer is
+    #  expected not to define its own {ActiveInteractor::Interactor#perform #perform} method
+    #  in favor of this default implementation.
+    def perform
+      self.class.organized.each do |interactor|
+        self.context = context.merge(
+          interactor.new(context).tap(&:skip_clean_context!).execute_perform!
+        )
+      end
+    end
+  end
+end

data/lib/active_interactor/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  # The ActiveInteractor gem version
+  # @return [String] the gem version
+  VERSION = '0.1.0'
+end

data/lib/rails/generators/active_interactor.rb

@@ -0,0 +1,35 @@
+# 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 self.base_root
+          __dir__
+        end
+
+        def source_root
+          File.expand_path('templates', __dir__)
+        end
+      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 }

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../active_interactor'
+
+module ActiveInteractor
+  module Generators
+    class InstallGenerator < Base
+      def create_initializer
+        template 'initializer.rb', File.join('config', 'initializers', 'active_interactor.rb')
+      end
+
+      def create_application_interactor
+        template 'application_interactor.erb', File.join('app', 'interactors', 'application_interactor.rb')
+      end
+
+      def create_interactor_concerns
+        create_file 'app/interactors/concerns/.keep'
+      end
+
+      def autoload_interactors
+        application do
+          <<~CONFIG
+             # autoload interactors
+            config.autoload_paths += %w[app/interactors]
+
+          CONFIG
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../active_interactor'
+
+class InteractorGenerator < ActiveInteractor::Generators::NamedBase
+  desc 'Generate an interactor'
+
+  def create_interactor
+    template 'interactor.erb', File.join('app', 'interactors', class_path, "#{file_name}.rb")
+  end
+
+  hook_for :test_framework, in: :interactor
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../active_interactor'
+
+module Interactor
+  module Generators
+    class OrganizerGenerator < ActiveInteractor::Generators::NamedBase
+      desc 'Generate an interactor organizer'
+      argument :interactors, type: :array, default: [], banner: 'name name'
+
+      def create_organizer
+        template 'organizer.erb', File.join('app', 'interactors', class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework, in: :interactor
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../active_interactor'
+
+module Interactor
+  module Generators
+    class RspecGenerator < ActiveInteractor::Generators::NamedBase
+      desc 'Generate an interactor spec'
+
+      def create_spec
+        template 'rspec.erb', File.join('spec', 'interactors', class_path, "#{file_name}_spec.rb")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../active_interactor'
+
+module Interactor
+  module Generators
+    class TestUnitGenerator < ActiveInteractor::Generators::NamedBase
+      desc 'Generate an interactor unit test'
+
+      def create_test
+        template 'test_unit.erb', File.join('test', 'interactors', class_path, "#{file_name}_test.rb")
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'active_interactor'
+
+ActiveInteractor.configure do |config|
+  # Set the ActiveInteractor.logger to Rails.logger
+  config.logger = Rails.logger
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < ApplicationInteractor
+
+  def perform
+    # TODO implement <%= class_name %> call
+  end
+
+  def rollback
+    # TODO implement <%= class_name %> rollback
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < ActiveInteractor::Organizer
+
+<%- if interactors.any? -%>
+  organize <%= interactors.map(&:classify).join(", ") %>
+<%- else -%>
+  # organize Interactor1, Interactor2
+<%- end -%>
+end

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

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

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

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

metadata

@@ -0,0 +1,269 @@
+--- !ruby/object:Gem::Specification
+name: activeinteractor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.66'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.66'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-activesupport-concern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: |
+  Ruby interactors with ActiveModel::Validations based on the interactors gem.
+  Rich support for attributes, callbacks, and validations, and thread safe performance methods.
+email:
+- hello@aaronmallen.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/active_interactor.rb
+- lib/active_interactor/base.rb
+- lib/active_interactor/configuration.rb
+- lib/active_interactor/context.rb
+- lib/active_interactor/interactor.rb
+- lib/active_interactor/interactor/callbacks.rb
+- lib/active_interactor/interactor/context.rb
+- lib/active_interactor/interactor/execution.rb
+- lib/active_interactor/interactor/worker.rb
+- lib/active_interactor/organizer.rb
+- lib/active_interactor/version.rb
+- lib/rails/generators/active_interactor.rb
+- lib/rails/generators/active_interactor/install_generator.rb
+- lib/rails/generators/interactor/interactor_generator.rb
+- lib/rails/generators/interactor/organizer_generator.rb
+- lib/rails/generators/interactor/rspec_generator.rb
+- lib/rails/generators/interactor/test_unit_generator.rb
+- lib/rails/generators/templates/application_interactor.erb
+- lib/rails/generators/templates/initializer.rb
+- lib/rails/generators/templates/interactor.erb
+- lib/rails/generators/templates/organizer.erb
+- lib/rails/generators/templates/rspec.erb
+- lib/rails/generators/templates/test_unit.erb
+homepage: https://github.com/aaronmallen/activeinteractor
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/aaronmallen/activeinteractor/issues
+  hompage_uri: https://github.com/aaronmallen/activeinteractor
+  source_code_uri: https://github.com/aaronmallen/activeinteractor/tree/v0.1.0
+  changelog_uri: https://github.com/aaronmallen/activeinteractor/blob/v0.1.0/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby interactors with ActiveModel::Validations
+test_files: []