activeinteractor 1.2.1 → 2.0.0.alpha.1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47d39868b8ed69a4ae27d9cf931e42ed6e5a5daa893a7adc0c6b696bd0b4035d
-  data.tar.gz: 9e4ae3e6102d6f6ead6d8fb4af150dc8d67124adfba1afd26420a54e57708cc7
+  metadata.gz: b84d76be97bd543c4583c588b6f7dae50424c640fa675b7a4fb154bc8bdb1051
+  data.tar.gz: c0846db96ac34ed824b79118395afea967e528f4b8eb797eb7411c156ddb5d55
 SHA512:
-  metadata.gz: 06e1686b7e98a6ed13f136e5f847c836a4f018ba4a89c1b42e6666a4063600c22c2b6b7ad48a378462a9b0fc18f3dd28d88325bd7344c9a9647c2274804d1e01
-  data.tar.gz: 925e3b0ab0a9562efe52d4d30d55b71b327d9169f02eed1ab1b22b9c72caa00ca5c72b1a587782f0d7c9e820465739538240666263dc9a2c999037e00e060710
+  metadata.gz: 2ce8f776d073318c6bfdc47e6d822febde4570aa4777eab9ff2096bac4e8162a5849e01b929f8ed4e33f04b45edeca018e9a7381e651a3ec1556b68826c2e891
+  data.tar.gz: 822f52d219f12aaec5f373e1eed23f70568b3dd44972eda16f6a2c27f03fb1895b3566d605602448443db263765dae6e0b7a0c2e1dfdd0f61d0392c92c064977

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [v1.2.2] - 2023-09-30
+
+### Fixed
+
+- [\#366] Fixes a minor timing issue for when deferred after_perform callbacks are run.
+
 ## [v1.2.1] - 2022-09-26
 
 ### Fixed
@@ -21,7 +27,7 @@ and this project adheres to [Semantic Versioning].
 
 ## [v1.2.0] - 2022-09-08
 
-### Added
+
 
 - `ActiveInteractor::Base.defer_after_callbacks_when_organized`
 - `ActiveInteractor::Organizer::Base.after_all_perform`
@@ -270,9 +276,10 @@ and this project adheres to [Semantic Versioning].
 
 <!-- versions -->
 
-[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v1.2.1...HEAD
+[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v2.0.0-alpha.1.0.0...HEAD
+[v1.2.2]: https://github.com/aaronmallen/activeinteractor/compare/v1.2.1...v1.2.2
 [v1.2.1]: https://github.com/aaronmallen/activeinteractor/compare/v1.2.0...v1.2.1
-[v1.2.0]: https://github.com/aaronmallen/activeinteractor/compare/v1.1.6...v1.2.0
+[v1.2.0]: https://github.com/aaronmallen/activeinteractor/compare/v1.1.7...v1.2.0
 [v1.1.7]: https://github.com/aaronmallen/activeinteractor/compare/v1.1.6...v1.1.7
 [v1.1.6]: https://github.com/aaronmallen/activeinteractor/compare/v1.1.4...v1.1.6
 [v1.1.4]: https://github.com/aaronmallen/activeinteractor/compare/v1.1.3...v1.1.4

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Aaron Allen
+Copyright (c) 2023 Aaron Allen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,69 +1,9 @@
 # ActiveInteractor
 
 [![Version](https://img.shields.io/gem/v/activeinteractor.svg?logo=ruby)](https://rubygems.org/gems/activeinteractor)
-[![Build Status](https://github.com/aaronmallen/activeinteractor/workflows/Build/badge.svg)](https://github.com/aaronmallen/activeinteractor/actions)
-[![Maintainability](https://api.codeclimate.com/v1/badges/2f1cb318f681a1eebb27/maintainability)](https://codeclimate.com/github/aaronmallen/activeinteractor/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/2f1cb318f681a1eebb27/test_coverage)](https://codeclimate.com/github/aaronmallen/activeinteractor/test_coverage)
-[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/activeinteractor)
-[![Inline docs](http://inch-ci.org/github/aaronmallen/activeinteractor.svg?branch=main)](http://inch-ci.org/github/aaronmallen/activeinteractor)
-[![License](https://img.shields.io/github/license/aaronmallen/activeinteractor.svg?maxAge=300)](https://github.com/aaronmallen/activeinteractor/blob/main/LICENSE)
+[![Build](https://github.com/activeinteractor/activeinteractor/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/activeinteractor/activeinteractor/actions/workflows/build.yml)
+[![License](https://img.shields.io/github/license/activeinteractor/activeinteractor.svg?maxAge=300)](https://github.com/activeinteractor/activeinteractor/blob/main/LICENSE)
 
-An implementation of the [command pattern] for Ruby with [ActiveModel::Validations] inspired by the
-[interactor][collective_idea_interactors] gem. Rich support for attributes, callbacks, and validations,
-and thread safe performance methods.
+## DISCLAIMER
 
-Reduce controller bloat with procedural service objects. Checkout this [Medium article] for a crash
-course on how to use ActiveInteractors. Read the [wiki] for detailed usage information.
-
-## Features
-
-* [Context validation][wiki_context_validation]
-* [Callbacks][wiki_callbacks]
-* Thread safe performance calls
-* Organize multiple interactors [conditionally][wiki_organizers_conditionally] or in [parallel][wiki_organizers_parallel]
-
-## Documentation
-
-Be sure to read the [wiki] for detailed information on how to use ActiveInteractor.
-
-For technical documentation please see the gem's [ruby docs].
-
-## Install
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'activeinteractor', require: 'active_interactor'
-```
-
-Or install it yourself as:
-
-```sh
-gem install activeinteractor
-```
-
-## Contributing
-
-Read our guidelines for [Contributing](CONTRIBUTING.md).
-
-## Acknowledgements
-
-ActiveInteractor is made possible by wonderful [humans].
-
-## License
-
-The gem is available as open source under the terms of the [MIT License][mit_license].
-
-[ActiveModel::Validations]: https://api.rubyonrails.org/classes/ActiveModel/Validations.html
-[business_logic_wikipedia]: https://en.wikipedia.org/wiki/Business_logic
-[collective_idea_interactors]: https://github.com/collectiveidea/interactor
-[command pattern]: https://en.wikipedia.org/wiki/Command_pattern
-[humans]: https://github.com/aaronmallen/activeinteractor/tree/main/HUMANS.md
-[Medium article]: https://medium.com/@aaronmallen/activeinteractor-8557c0dc78db
-[mit_license]: https://opensource.org/licenses/MIT
-[ruby docs]: https://www.rubydoc.info/gems/activeinteractor
-[wiki]: https://github.com/aaronmallen/activeinteractor/wiki
-[wiki_callbacks]: https://github.com/aaronmallen/activeinteractor/wiki/Callbacks
-[wiki_context_validation]: https://github.com/aaronmallen/activeinteractor/wiki/Context#validating-the-context
-[wiki_organizers_conditionally]: https://github.com/aaronmallen/activeinteractor/wiki/Interactors#organizing-interactors-conditionally
-[wiki_organizers_parallel]: https://github.com/aaronmallen/activeinteractor/wiki/Interactors#running-interactors-in-parallel
+This project is a work in progress.  Go [here](https://github.com/aaronmallen/activeinteractor) for information on the current version of ActiveInteractor.

data/lib/active_interactor/base.rb

@@ -1,35 +1,83 @@
 # frozen_string_literal: true
 
 module ActiveInteractor
-  # The base class all {Base interactors} should inherit from.
-  #
-  # When {Base} is loaded by your application an
-  # {https://api.rubyonrails.org/classes/ActiveSupport/LazyLoadHooks.html ActiveSupport load hook} is called
-  # with `:active_interactor` and {Base}.
-  #
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 0.1.0
-  #
-  # @example a basic {Base interactor}
-  #   class MyInteractor < ActiveInteractor::Base
-  #     def perform
-  #       # TODO: implement the perform method
-  #     end
-  #
-  #     def rollback
-  #       # TODO: implement the rollback method
-  #     end
-  #   end
   class Base
-    extend ActiveInteractor::Interactor::Callbacks::ClassMethods
-    extend ActiveInteractor::Interactor::Context::ClassMethods
-    extend ActiveInteractor::Interactor::Perform::ClassMethods
-
-    include ActiveSupport::Callbacks
-    include ActiveInteractor::Interactor::Callbacks
-    include ActiveInteractor::Interactor::Context
-    include ActiveInteractor::Interactor::Perform
-  end
+    class << self
+      def argument(name, type, description = nil, **options)
+        attributes[:arguments][name.to_sym] = { name: name, type: type, description: description }.merge(options)
+      end
+
+      def perform(input_context = {})
+        new(input_context).send(:exec_perform!)
+      rescue Error => e
+        e.result
+      rescue StandardError => e
+        Result.failure(errors: e.message)
+      end
+
+      def returns(name, type, description = nil, **options)
+        attributes[:fields][name.to_sym] = { name: name, type: type, description: description }.merge(options)
+      end
+
+      private
+
+      def attributes
+        @attributes ||= { arguments: {}, fields: {} }
+      end
+    end
+
+    def initialize(input = {})
+      @input = input.freeze
+      @context = parse_input!
+    end
+
+    def perform; end
+    def rollback; end
+
+    protected
+
+    attr_accessor :context
+
+    def exec_perform!
+      perform
+      Result.success(data: parse_output!)
+    end
 
-  ActiveSupport.run_load_hooks(:active_interactor, Base)
+    def fail!(errors = {})
+      rollback
+      raise Error, Result.failure(data: context, errors: errors)
+    end
+
+    def parse_input!
+      errors = {}
+      context = self.class.send(:attributes)[:arguments].each_with_object({}) do |(name, options), hash|
+        errors = validate_attribute_value(@input[name], name, options, errors)
+        hash[name] = @input[name] || options[:default]
+      end
+
+      raise Error, Result.failure(errors: errors, status: Result::STATUS[:failed_on_input]) unless errors.empty?
+
+      context
+    end
+
+    def parse_output!
+      errors = {}
+      context = self.class.send(:attributes)[:fields].each_with_object({}) do |(name, options), hash|
+        errors = validate_attribute_value(self.context[name], name, options, errors)
+        hash[name] = self.context[name] || options[:default]
+      end
+
+      raise Error, Result.failure(errors: errors, status: Result::STATUS[:failed_on_output]) unless errors.empty?
+
+      context
+    end
+
+    def validate_attribute_value(value, attribute_name, attribute_options, errors)
+      return errors unless value.blank? && attribute_options[:required] && !attribute_options[:default]
+
+      errors[attribute_name] ||= []
+      errors[attribute_name] << :blank
+      errors
+    end
+  end
 end

data/lib/active_interactor/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  class Error < StandardError
+    attr_reader :result
+
+    def initialize(result, message = nil)
+      @result = result
+      super(message)
+    end
+  end
+end

data/lib/active_interactor/result.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  class Result
+    extend ActiveModel::Naming
+
+    STATUS = {
+      success: 0,
+      failed_at_input: 1,
+      failed_at_runtime: 2,
+      failed_at_output: 3
+    }.freeze
+
+    attr_reader :data, :errors
+
+    class << self
+      def success(data: {})
+        new(status: STATUS[:success], data: data)
+      end
+
+      def failure(data: {}, errors: {}, status: STATUS[:failed_at_runtime])
+        result = new(status: status, data: data)
+        parse_errors(errors).each_pair do |attribute, messages|
+          Array.wrap(messages).each { |message| result.errors.add(attribute, message) }
+        end
+        result
+      end
+
+      def human_attribute_name(attribute, _options = {})
+        attribute.respond_to?(:to_s) ? attribute.to_s.humanize : attribute
+      end
+
+      def lookup_ancestors
+        [self]
+      end
+
+      private
+
+      def parse_errors(errors)
+        case errors
+        when String
+          { generic: [errors] }
+        when ActiveModel::Errors
+          errors.as_json
+        else
+          errors
+        end
+      end
+    end
+
+    private_class_method :new
+
+    def initialize(status:, data: {})
+      @status = status
+      @data = data
+      @errors = ActiveModel::Errors.new(self)
+    end
+
+    def failure?
+      !success?
+    end
+    alias failed? failure?
+
+    def read_attribute_for_validation(attribute_name)
+      data[attribute_name]
+    end
+
+    def success?
+      @status == STATUS[:success]
+    end
+    alias successful? success?
+  end
+end

data/lib/active_interactor.rb

@@ -1,111 +1,13 @@
 # frozen_string_literal: true
 
 require 'active_model'
-require 'active_support/callbacks'
-require 'active_support/core_ext/array/extract_options'
-require 'active_support/core_ext/class/attribute'
-require 'active_support/core_ext/string/inflections'
-require 'active_support/dependencies/autoload'
-require 'logger'
-require 'ostruct'
+require 'active_support'
 
-require 'active_interactor/configurable'
-require 'active_interactor/config'
-require 'active_interactor/version'
+require_relative 'active_interactor/errors'
 
-# An {Base interactor} is a simple, single-purpose service object. {Base Interactors} can be used to reduce the
-# responsibility of your controllers, workers, and models and encapsulate your application's
-# {https://en.wikipedia.org/wiki/Business_logic business logic}. Each {Base interactor} represents one thing that your
-# application does.
-#
-# Each {Base interactor} has it's own immutable {Context::Base context} which contains everything the
-# {Base interactor} needs to do its work. When an {Base interactor} does its single purpose, it affects its given
-# {Context::Base context}.
-#
-# @see https://medium.com/@aaronmallen/activeinteractor-8557c0dc78db Basic Usage
-# @see https://github.com/aaronmallen/activeinteractor/wiki Advanced Usage
-# @see https://github.com/aaronmallen/activeinteractor Source Code
-# @see https://github.com/aaronmallen/activeinteractor/issues Issues
-#
-# ## License
-#
-# Copyright (c) 2019 Aaron Allen
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
 module ActiveInteractor
   extend ActiveSupport::Autoload
 
   autoload :Base
-
-  # {Context::Base Context} classes and modules
-  #
-  # @see https://github.com/aaronmallen/activeinteractor/wiki/Context Context
-  #
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 0.1.0
-  module Context
-    extend ActiveSupport::Autoload
-
-    autoload :Attributes
-    autoload :Base
-    autoload :Errors
-    autoload :Loader
-    autoload :Status
-  end
-
-  # {Base Interactor} classes and modules
-  #
-  # @see https://github.com/aaronmallen/activeinteractor/wiki/Interactors Interactors
-  #
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 0.1.0
-  module Interactor
-    extend ActiveSupport::Autoload
-
-    autoload :Callbacks
-    autoload :Context
-    autoload :Perform
-    autoload :Worker
-  end
-
-  autoload :Models
-
-  # {Organizer::Base Organizer} classes and modules
-  #
-  # @see https://github.com/aaronmallen/activeinteractor/wiki/Interactors#organizers Organizers
-  #
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 0.1.0
-  module Organizer
-    extend ActiveSupport::Autoload
-
-    autoload :Base
-    autoload :Callbacks
-    autoload :InteractorInterface
-    autoload :InteractorInterfaceCollection
-    autoload :Organize
-    autoload :Perform
-  end
-
-  eager_autoload do
-    autoload :Error
-  end
+  autoload :Result
 end
-
-require 'active_interactor/rails' if defined?(::Rails)

data/sig/active_interactor.rbs

@@ -0,0 +1,3 @@
+module Activeinteractor
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end