activeinteractor 2.0.0.alpha.2.3.2 → 2.0.0.alpha.2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1db6f6df66049791647fd77a005364d34352ee6dcdc8e3e06d96bf3a0f0fe7aa
-  data.tar.gz: 720d4d08c58ee263bdd4b199ab89e7d8142f97cf37c87c1c60a3a81f6de6703c
+  metadata.gz: d75851d221fb7d266849601c5eef65939edfb615419818393ca9ea9b165a4279
+  data.tar.gz: '08f62a487d21f34df03f63b0dc112010df68fbb0a6aa6f3931d972eb0dbaed36'
 SHA512:
-  metadata.gz: e0b72abcf5ba60f5223dea9107280e9813d084ed416dc1ab8d810ab618554b27602dc08dd8d6d671e12851fe90e94ab9552503c30c11b65294858afb447732b7
-  data.tar.gz: 3d7ac38cfbe1ec554033213f84a8e2a6bc253bead86f0b192376f1886e500b80f7a8715cf92c9ab448472d724ef63fb567363ebf8fd1e382c29f154f49ba284c
+  metadata.gz: 533fa79817a6d0598c1dac316da54f19ac5e96067ede7f65869f26a2c84b5481a134fab044ed947061d6a19f9021c829dc428456e4cb25483ea276b44c5ba6a7
+  data.tar.gz: 9efe50f237b0bd204678158dd9ba27482b93e640193f8c3f3cbd71025d2b46fb1490bbb19bf25b31adeecdb02298947dbf41a1bd7cb03659c3bc1871faf1605e

data/lib/active_interactor/{has_active_model_errors.rb → active_model_error_methods.rb}

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 module ActiveInteractor
-  module HasActiveModelErrors
+  # @private
+  module ActiveModelErrorMethods
     extend ActiveSupport::Concern
 
     attr_reader :errors
 
+    # @private
     module ClassMethods
       def human_attribute_name(attribute, _options = {})
         attribute.respond_to?(:to_s) ? attribute.to_s.humanize : attribute

data/lib/active_interactor/base.rb

@@ -1,112 +1,9 @@
 # frozen_string_literal: true
 
 module ActiveInteractor
-  class Base
-    include Type::HasTypes
-
-    class << self
-      delegate :argument, :argument_names, :arguments, to: :input_context_class
-      delegate :returns, :field_names, :fields, to: :output_context_class
-
-      def input_context_class
-        @input_context_class ||= const_set(:InputContext, Class.new(Context::Input))
-      end
-
-      def accepts_arguments_matching(set_input_context_class)
-        @input_context_class = set_input_context_class
-      end
-      alias input_context accepts_arguments_matching
-
-      def output_context_class
-        @output_context_class ||= const_set(:OutputContext, Class.new(Context::Output))
-      end
-
-      def perform!(input_context = {})
-        new(input_context).perform!
-      end
-
-      def perform(input_context = {})
-        perform!(input_context)
-      rescue Error => e
-        e.result
-      rescue StandardError => e
-        Result.failure(errors: e.message)
-      end
-
-      def returns_data_matching(set_output_context_class)
-        @output_context_class = set_output_context_class
-      end
-      alias output_context returns_data_matching
-
-      def runtime_context_class
-        @runtime_context_class ||= begin
-          context_class = const_set(:RuntimeContext, Class.new(Context::Runtime))
-          context_class.send(:attribute_set).merge(input_context_class.send(:attribute_set).attributes)
-          context_class.send(:attribute_set).merge(output_context_class.send(:attribute_set).attributes)
-          context_class
-        end
-      end
-    end
-
-    def initialize(input = {})
-      @raw_input = input.dup
-      validate_input_and_generate_runtime_context!
-    end
-
-    def perform!
-      with_notification(:perform) do |payload|
-        interact
-        generate_and_validate_output_context!
-        payload[:result] = Result.success(data: @output)
-      end
-    end
-
-    def perform
-      perform!
-    rescue Error => e
-      e.result
-    rescue StandardError => e
-      Result.failure(errors: e.message)
-    end
-
-    def interact; end
-    def rollback; end
-
-    protected
-
-    attr_accessor :context
-
-    def fail!(errors = {})
-      result = nil
-      with_notification(:rollback) do |payload|
-        rollback
-        result = Result.failure(data: parse_output!, errors: errors)
-        payload[:result] = result
-      end
-
-      raise Error, result
-    end
-
-    def generate_and_validate_output_context!
-      @output = self.class.output_context_class.new(context.attributes)
-      @output.validate!
-      return @output if @output.errors.empty?
-
-      raise Error, Result.failure(errors: @output.errors, status: Result::STATUS[:failed_at_output])
-    end
-
-    def validate_input_and_generate_runtime_context!
-      @input = self.class.input_context_class.new(@raw_input)
-      @input.validate!
-      return (@context = self.class.runtime_context_class.new(@raw_input)) if @input.errors.empty?
-
-      raise Error, Result.failure(errors: @input.errors, status: Result::STATUS[:failed_at_input])
-    end
-
-    def with_notification(action)
-      ActiveSupport::Notifications.instrument("#{self.class.name}::#{action.to_s.classify}") do |payload|
-        yield payload if block_given?
-      end
-    end
-  end
+  # The Main interface for ActiveInteractor
+  #
+  # @deprecated will be removed in version 2.0.0-alpha.3.0.0
+  #   use {ActiveInteractor::Interactor::Base} instead
+  class Base < ActiveInteractor::Interactor::Base; end
 end

data/lib/active_interactor/context/base.rb

@@ -3,11 +3,10 @@
 module ActiveInteractor
   module Context
     class Base
-      include ActiveModel::Validations
-      include HasActiveModelErrors
+      include ActiveModelErrorMethods
       include AttributeRegistration
       include AttributeAssignment
-      include Type::HasTypes
+      include Type::DeclerationMethods
 
       def initialize(attributes = {})
         super

data/lib/active_interactor/context/result.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  module Context
+    class Result
+      def self.register_owner(owner)
+        owner.const_set(:ResultContext, Class.new(self))
+      end
+
+      def self.for_output_context(owner, context)
+        context.fields.each_key { |field| owner::ResultContext.send(:attr_reader, field) }
+        owner::ResultContext.new(context.fields)
+      end
+
+      def initialize(attributes = {})
+        attributes.each_pair { |key, value| instance_variable_set(:"@#{key}", value) }
+      end
+    end
+  end
+end

data/lib/active_interactor/context.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module ActiveInteractor
+  # The Context namespace
   module Context
     extend ActiveSupport::Autoload
 
@@ -11,6 +12,7 @@ module ActiveInteractor
     autoload :Base
     autoload :Input
     autoload :Output
+    autoload :Result
     autoload :Runtime
   end
 end

data/lib/active_interactor/errors.rb

@@ -1,9 +1,22 @@
 # frozen_string_literal: true
 
 module ActiveInteractor
+  # Raised when an interactor fails
+  #
+  # @!attribute [r] result
+  #  @return [ActiveInteractor::Result] An instance of {ActiveInteractor::Result} for the
+  #    {ActiveInteractor::Interactor::Base interactor} that failed
   class Error < StandardError
     attr_reader :result
 
+    # Create a new instance of {ActiveInteractor::Error}
+    #
+    # @param result [ActiveInteractor::Result] An instance of {ActiveInteractor::Result} for the
+    #   {ActiveInteractor::Interactor::Base interactor} that failed
+    # @param message [String] The error message
+    #
+    # @private
+    # @return [ActiveInteractor::Error]
     def initialize(result, message = nil)
       @result = result
       super(message)

data/lib/active_interactor/interactor/base.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  module Interactor
+    class Base
+      include ContextMethods
+      include InteractionMethods
+      include Type::DeclerationMethods
+
+      def initialize(input = {})
+        @raw_input = input.dup
+        validate_input_and_generate_runtime_context!
+      end
+
+      def perform!
+        with_notification(:perform) do |payload|
+          interact
+          generate_and_validate_output_context!
+          payload[:result] = Result.success(data: output_to_result_context!)
+        end
+      end
+
+      protected
+
+      def fail!(errors = {})
+        result = nil
+        with_notification(:rollback) do |payload|
+          rollback
+          result = Result.failure(data: parse_output!, errors: errors)
+          payload[:result] = result
+        end
+
+        raise Error, result
+      end
+
+      def with_notification(action)
+        ActiveSupport::Notifications.instrument("#{self.class.name}::#{action.to_s.classify}") do |payload|
+          yield payload if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/active_interactor/interactor/context_methods.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  module Interactor
+    module ContextMethods
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        delegate :argument, :argument_names, :arguments, to: :input_context_class
+        delegate :returns, :field_names, :fields, to: :output_context_class
+
+        def input_context_class
+          @input_context_class ||= const_set(:InputContext, Class.new(Context::Input))
+        end
+
+        def accepts_arguments_matching(set_input_context_class)
+          @input_context_class = set_input_context_class
+        end
+        alias input_context accepts_arguments_matching
+        alias input_type accepts_arguments_matching
+
+        def output_context_class
+          @output_context_class ||= const_set(:OutputContext, Class.new(Context::Output))
+        end
+
+        def returns_data_matching(set_output_context_class)
+          @output_context_class = set_output_context_class
+        end
+        alias output_context returns_data_matching
+        alias output_type returns_data_matching
+
+        def runtime_context_class
+          @runtime_context_class ||= begin
+            context_class = const_set(:RuntimeContext, Class.new(Context::Runtime))
+            context_class.send(:attribute_set).merge(input_context_class.send(:attribute_set).attributes)
+            context_class.send(:attribute_set).merge(output_context_class.send(:attribute_set).attributes)
+            context_class
+          end
+        end
+
+        protected
+
+        def result_context
+          @result_context ||= Context::Result.register_owner(self)
+        end
+      end
+
+      included do
+        extend ClassMethods
+
+        protected
+
+        attr_reader :context
+      end
+
+      protected # rubocop:disable Lint/UselessAccessModifier
+
+      def generate_and_validate_output_context!
+        @output = self.class.output_context_class.new(context.attributes)
+        @output.validate!
+        return if @output.errors.empty?
+
+        raise Error, Result.failure(errors: @output.errors, status: Result::STATUS[:failed_at_output])
+      end
+
+      def output_to_result_context!
+        self.class.send(:result_context).for_output_context(self.class, @output)
+      end
+
+      def validate_input_and_generate_runtime_context!
+        @input = self.class.input_context_class.new(@raw_input)
+        @input.validate!
+        return (@context = self.class.runtime_context_class.new(@raw_input)) if @input.errors.empty?
+
+        raise Error, Result.failure(errors: @input.errors, status: Result::STATUS[:failed_at_input])
+      end
+    end
+  end
+end

data/lib/active_interactor/interactor/interaction_methods.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  module Interactor
+    module InteractionMethods
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def perform!(input_context = {})
+          new(input_context).perform!
+        end
+
+        def perform(input_context = {})
+          perform!(input_context)
+        rescue Error => e
+          e.result
+        rescue StandardError => e
+          Result.failure(errors: e.message)
+        end
+      end
+
+      included do
+        extend ClassMethods
+      end
+
+      def perform
+        perform!
+      rescue Error => e
+        e.result
+      rescue StandardError => e
+        Result.failure(errors: e.message)
+      end
+
+      def interact; end
+      def rollback; end
+    end
+  end
+end

data/lib/active_interactor/interactor.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  # The Interactor namespace
+  module Interactor
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :ContextMethods
+    autoload :InteractionMethods
+  end
+end

data/lib/active_interactor/result.rb

@@ -1,11 +1,64 @@
 # frozen_string_literal: true
 
 module ActiveInteractor
+  # The object returned by an {ActiveInteractor::Interactor::Base interactor}
+  #
+  # @!attribute [r] data
+  #
+  #  @example Given an {ActiveInteractor::Interactor::Base interactor} that creates an ActiveRecord User
+  #   class CreateUser < ActiveInteractor::Interactor::Base
+  #     argument :login, String, 'The login for the User', required: true
+  #     argument :password, String, 'The password for the User', required: true
+  #     argument :password_confirmation, String, 'The password confirmation for the user', required: true
+  #
+  #     returns :user, User, 'The created User', required: true
+  #
+  #     def interact
+  #       context.user = User.new(context)
+  #       fail!(context.user.errors) unless context.user.save
+  #     end
+  #   end
+  #
+  #   result = CreateUser.perform(login: 'johndoe', password: 'password', password_confirmation: 'password')
+  #   result.data.user
+  #
+  #   #=> <# User @login='johndoe'>
+  #
+  #  @return [ActiveInteractor::Context::Result] the data returned by the
+  #   {ActiveInteractor::Interactor::Base interactor}
+  #
+  # @!attribute [r] errors
+  #  @return [ActiveModel::Errors] the errors returned by the
+  #   {ActiveInteractor::Interactor::Base interactor}
+  #  @see https://github.com/rails/rails/blob/main/activemodel/lib/active_model/errors.rb ActiveModel::Errors
   class Result
-    include HasActiveModelErrors
+    include ActiveModelErrorMethods
 
+    # @!method to_json
+    # The {ActiveInteractor::Interactor::Base result} as a Hash
+    #
+    # @example When an {ActiveInteractor::Interactor::Base interactor} succeeds
+    #  result = CreateUser.perform(login: 'johndoe', password: 'password', password_confirmation: 'password')
+    #  result.to_hash
+    #
+    #  #=> { :success => true, :errors => {}, :data => { :login => 'johndoe' } }
+    #
+    # @example When an {ActiveInteractor::Interactor::Base interactor} fails
+    #  result = CreateUser.perform(login: 'johndoe', password: 'password', password_confirmation: 'notpassword')
+    #  result.to_hash
+    #
+    #  #=> {
+    #  #=>   :success => false,
+    #  #=>   :errors => { :password_confirmation => ["doesn't match Password"] },
+    #  #=>   :data => { :login => 'johndoe' }
+    #  #=> }
+    #
+    # @deprecated will be removed in version 2.0.0-alpha.3.0.0
+    #  use {#to_hash} instead
+    # @return [Hash {Symbol => Boolean, Hash}]
     delegate :to_json, to: :to_hash
 
+    # @private
     STATUS = {
       success: 0,
       failed_at_input: 1,
@@ -16,10 +69,12 @@ module ActiveInteractor
     attr_reader :data
 
     class << self
+      # @private
       def success(data: {})
         new(status: STATUS[:success], data: data)
       end
 
+      # @private
       def failure(data: {}, errors: {}, status: STATUS[:failed_at_runtime])
         result = new(status: status, data: data)
         parse_errors(errors).each_pair do |attribute, messages|
@@ -43,32 +98,70 @@ module ActiveInteractor
     end
 
     private_class_method :new
-
+    # @private
     def initialize(status:, data: {})
       @status = status
       @data = data
       @errors = ActiveModel::Errors.new(self)
     end
 
+    # Whether or not the {ActiveInteractor::Interactor::Base result} is a failure
+    #
+    # @example When an {ActiveInteractor::Interactor::Base interactor} fails
+    #  result = CreateUser.perform(login: 'johndoe', password: 'password', password_confirmation: 'notpassword')
+    #  result.failure?
+    #
+    #  #=> true
+    #
+    # @example When an {ActiveInteractor::Interactor::Base interactor} succeeds
+    #  result = CreateUser.perform(login: 'johndoe', password: 'password', password_confirmation: 'password')
+    #  result.failure?
+    #
+    #  #=> false
+    #
+    # @return [Boolean]
     def failure?
       !success?
     end
     alias failed? failure?
 
+    # @private
     def read_attribute_for_validation(attribute_name)
       data.send(attribute_name.to_sym)
     end
 
+    # Whether or not the {ActiveInteractor::Interactor::Base result} is a success
+    #
+    # @return [Boolean]
     def success?
       @status == STATUS[:success]
     end
     alias successful? success?
 
+    # The {ActiveInteractor::Interactor::Base result} as a Hash
+    #
+    # @example When an {ActiveInteractor::Interactor::Base interactor} succeeds
+    #  result = CreateUser.perform(login: 'johndoe', password: 'password', password_confirmation: 'password')
+    #  result.to_hash
+    #
+    #  #=> { :success => true, :errors => {}, :data => { :login => 'johndoe' } }
+    #
+    # @example When an {ActiveInteractor::Interactor::Base interactor} fails
+    #  result = CreateUser.perform(login: 'johndoe', password: 'password', password_confirmation: 'notpassword')
+    #  result.to_hash
+    #
+    #  #=> {
+    #  #=>   :success => false,
+    #  #=>   :errors => { :password_confirmation => ["doesn't match Password"] },
+    #  #=>   :data => { :login => 'johndoe' }
+    #  #=> }
+    #
+    # @return [Hash {Symbol => Boolean, Hash}]
     def to_hash
       {
         success: success?,
         errors: errors.to_hash,
-        data: data.to_hash
+        data: data.to_json
       }
     end
     alias to_h to_hash

data/lib/active_interactor/type/{has_types.rb → decleration_methods.rb}

@@ -2,7 +2,7 @@
 
 module ActiveInteractor
   module Type
-    module HasTypes
+    module DeclerationMethods
       extend ActiveSupport::Concern
 
       Boolean = ActiveInteractor::Type::Boolean

data/lib/active_interactor/type.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 module ActiveInteractor
+  # @private
   module Type
     extend ActiveSupport::Autoload
 
     autoload :Base
     autoload :Boolean
-    autoload :HasTypes
+    autoload :DeclerationMethods
     autoload :List
     autoload :Union
   end

data/lib/active_interactor.rb

@@ -6,12 +6,43 @@ require 'active_support/core_ext'
 
 require_relative 'active_interactor/errors'
 
+# ## License
+#
+# 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
+# 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.
+#
+# {file:CHANGELOG.md Changelog}
+#
+# {file:HUMANS.md Acknowledgements}
+#
+# {file:SECURITY.md Security Policy}
+#
+# @author {hello@aaronmallen.me Aaron Allen}
+
 module ActiveInteractor
   extend ActiveSupport::Autoload
 
+  autoload :ActiveModelErrorMethods
   autoload :Base
   autoload :Context
-  autoload :HasActiveModelErrors
+  autoload :Interactor
   autoload :Result
   autoload :Type
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeinteractor
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha.2.3.2
+  version: 2.0.0.alpha.2.3.4
 platform: ruby
 authors:
 - Aaron Allen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -63,6 +63,7 @@ files:
 - LICENSE
 - README.md
 - lib/active_interactor.rb
+- lib/active_interactor/active_model_error_methods.rb
 - lib/active_interactor/base.rb
 - lib/active_interactor/context.rb
 - lib/active_interactor/context/attribute.rb
@@ -72,14 +73,18 @@ files:
 - lib/active_interactor/context/base.rb
 - lib/active_interactor/context/input.rb
 - lib/active_interactor/context/output.rb
+- lib/active_interactor/context/result.rb
 - lib/active_interactor/context/runtime.rb
 - lib/active_interactor/errors.rb
-- lib/active_interactor/has_active_model_errors.rb
+- lib/active_interactor/interactor.rb
+- lib/active_interactor/interactor/base.rb
+- lib/active_interactor/interactor/context_methods.rb
+- lib/active_interactor/interactor/interaction_methods.rb
 - lib/active_interactor/result.rb
 - lib/active_interactor/type.rb
 - lib/active_interactor/type/base.rb
 - lib/active_interactor/type/boolean.rb
-- lib/active_interactor/type/has_types.rb
+- lib/active_interactor/type/decleration_methods.rb
 - lib/active_interactor/type/list.rb
 - lib/active_interactor/type/union.rb
 - sig/active_interactor.rbs
@@ -88,9 +93,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/activeinteractor/activeinteractor/issues
-  changelog_uri: https://github.com/activeinteractor/activeinteractor/blob/v2.0.0-alpha.2.3.2/CHANGELOG.md
+  changelog_uri: https://github.com/activeinteractor/activeinteractor/blob/v2.0.0-alpha.2.3.4/CHANGELOG.md
   homepage_uri: https://github.com/activeinteractor/activeinteractor
-  source_code_uri: https://github.com/activeinteractor/activeinteractor/tree/v2.0.0-alpha.2.3.2
+  source_code_uri: https://github.com/activeinteractor/activeinteractor/tree/v2.0.0-alpha.2.3.4
+  documentation_uri: https://api.activeinteractor.io
   wiki_uri: https://github.com/activeinteractor/activeinteractor/wiki
   rubygems_mfa_required: 'true'
 post_install_message: