servactory 2.4.3 → 2.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 326823cbdccc9f0f3dfca48c5b2ddbf518d50a713c45280b19da21ddf4483907
-  data.tar.gz: ebf05e0ebdd4b9941809137d3f1e092ac72560fc199689d91713c253edcb3cd1
+  metadata.gz: 46aa75596d1b4afaef52eb55ad99884c13f7c2b62d5d264a54e88c4d840f8588
+  data.tar.gz: a40bdcc6ab7922f6358c94502683854b3897930633f90656a498798e74804606
 SHA512:
-  metadata.gz: b99933c23fd601a8e5164a425695799b94648da7ba02232a676938f00466ce8bc60ecc59db4257f3d9e1b60ba98dbabb3f021bfbff263c085fe7c800c0b47976
-  data.tar.gz: db16a9b4bbdfcfa4fdd11c6eabf8ae45468c8989d34ddc6a268df17e29e68878c5be9db72fda4a5e07529d2a6ccd3a9e2a1a2eb73b60389e9bd9fd637b894a56
+  metadata.gz: b14c88eed72b89ab6fa6a9e37e7403466c14def2265df8a75b496700b3cb57ab7e19407b1564bd48bb01a180ec05ca07c473ae32e904a048c7bbb6b052f06507
+  data.tar.gz: 3112d0f9f1f03e00f64c5e2e36c0c503b3c4854fe12b7f6e961eec679135263e05d804384a7e0e269dee0681817174d0917a4b0022e93bdb6f6a2cb215bd3ae7

data/README.md

@@ -38,13 +38,15 @@ class UserService::Authenticate < Servactory::Base
 
   output :user, type: User
 
+  make :authenticate!
+
   private
 
-  def call
+  def authenticate!
     if (user = User.authenticate_by(email: inputs.email, password: inputs.password)).present?
       outputs.user = user
     else
-      fail!(message: "Authentication failed")
+      fail!(message: "Authentication failed", meta: { email: inputs.email })
     end
   end
 end
@@ -55,14 +57,14 @@ end
 ```ruby
 class SessionsController < ApplicationController
   def create
-    service_result = UserService::Authenticate.call(**session_params)
+    service = UserService::Authenticate.call(**session_params)
 
-    if service_result.success?
-      session[:current_user_id] = service_result.user.id
-      redirect_to service_result.user
+    if service.success?
+      session[:current_user_id] = service.user.id
+      redirect_to service.user
     else
-      flash.now[:message] = service_result.error.message
-      render :new
+      flash.now[:alert] = service.error.message
+      render :new, status: :unprocessable_entity
     end
   end
 

data/lib/servactory/actions/dsl.rb

@@ -17,6 +17,25 @@ module Servactory
 
         private
 
+        # NOTE: Based on https://github.com/rails/rails/blob/main/activesupport/lib/active_support/rescuable.rb
+        def fail_on!(*class_names, with: nil, &block) # rubocop:disable Metrics/MethodLength
+          with ||= block || ->(exception:) { exception.message }
+
+          class_names.each do |class_name|
+            key = if class_name.is_a?(Module) && class_name.respond_to?(:===)
+                    class_name.name
+                  elsif class_name.is_a?(String)
+                    class_name
+                  else
+                    raise ArgumentError,
+                          "#{class_name.inspect} must be an Exception class or a String referencing an Exception class"
+                  end
+
+            # Put the new handler at the end because the list is read in reverse.
+            config.action_rescue_handlers += [[key, with]]
+          end
+        end
+
         def stage(&block)
           @current_stage = Stages::Stage.new(position: next_position)
 

data/lib/servactory/actions/rescue_handlers/collection.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Actions
+    module RescueHandlers
+      class Collection
+        extend Forwardable
+        def_delegators :@collection, :+, :detect, :reverse_each
+
+        def initialize(*)
+          @collection = Set.new
+        end
+      end
+    end
+  end
+end

data/lib/servactory/actions/tools/runner.rb

@@ -57,6 +57,8 @@ module Servactory
 
         def call_method(method)
           @context.send(method.name)
+        rescue StandardError => e
+          rescue_with_handler(e) || raise
         end
 
         def unnecessary_for_stage?(stage)
@@ -83,6 +85,23 @@ module Servactory
 
           !condition.call(context: @context)
         end
+
+        def rescue_with_handler(exception) # rubocop:disable Metrics/MethodLength
+          _, handler = @context.class.config.action_rescue_handlers.reverse_each.detect do |class_or_name, _|
+            if (detected_exception = Servactory::Utils.constantize_class(class_or_name))
+              detected_exception === exception # rubocop:disable Style/CaseEquality
+            end
+          end
+
+          return if handler.nil?
+
+          @context.fail!(
+            message: handler.call(exception: exception),
+            meta: {
+              original_exception: exception
+            }
+          )
+        end
       end
     end
   end

data/lib/servactory/configuration/dsl.rb

@@ -18,6 +18,8 @@ module Servactory
           child.config.success_class = config.success_class
           child.config.failure_class = config.failure_class
 
+          child.config.result_class = config.result_class
+
           child.config.collection_mode_class_names = config.collection_mode_class_names
 
           child.config.input_option_helpers = config.input_option_helpers
@@ -26,6 +28,7 @@ module Servactory
 
           child.config.action_aliases = config.action_aliases
           child.config.action_shortcuts = config.action_shortcuts
+          child.config.action_rescue_handlers = config.action_rescue_handlers
         end
 
         def config

data/lib/servactory/configuration/factory.rb

@@ -63,6 +63,12 @@ module Servactory
         raise_error_about_wrong_exception_class_with(:failure_class, failure_class)
       end
 
+      def result_class(result_class)
+        return @config.result_class = result_class if subclass_of_result?(result_class)
+
+        raise_error_about_wrong_result_class_with(:result_class, result_class)
+      end
+
       def collection_mode_class_names(collection_mode_class_names)
         @config.collection_mode_class_names.merge(collection_mode_class_names)
       end
@@ -91,19 +97,34 @@ module Servactory
         @config.action_shortcuts.merge(action_shortcuts)
       end
 
-      ##########################################################################
+      private
+
+      # def action_rescue_handlers(action_rescue_handlers)
+      #   @config.action_rescue_handlers.merge(action_rescue_handlers)
+      # end
 
       def subclass_of_exception?(value)
         value.is_a?(Class) && value <= Exception
       end
 
+      def subclass_of_result?(value)
+        value.is_a?(Class) && value <= Servactory::Result
+      end
+
       ##########################################################################
 
       def raise_error_about_wrong_exception_class_with(config_name, value)
         raise ArgumentError,
               "Error in `#{config_name}` configuration. " \
               "The `#{value}` value must be a subclass of `Exception`. " \
-              "See example configuration here: https://servactory.com/guide/configuration"
+              "See configuration example here: https://servactory.com/guide/configuration"
+      end
+
+      def raise_error_about_wrong_result_class_with(config_name, value)
+        raise ArgumentError,
+              "Error in `#{config_name}` configuration. " \
+              "The `#{value}` value must be a subclass of `Servactory::Result`. " \
+              "See configuration example here: https://servactory.com/guide/configuration"
       end
     end
   end

data/lib/servactory/configuration/setup.rb

@@ -8,15 +8,17 @@ module Servactory
                     :output_exception_class,
                     :success_class,
                     :failure_class,
+                    :result_class,
                     :collection_mode_class_names,
                     :hash_mode_class_names,
                     :input_option_helpers,
                     :internal_option_helpers,
                     :output_option_helpers,
                     :action_aliases,
-                    :action_shortcuts
+                    :action_shortcuts,
+                    :action_rescue_handlers
 
-      def initialize # rubocop:disable Metrics/MethodLength
+      def initialize # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         @input_exception_class = Servactory::Exceptions::Input
         @internal_exception_class = Servactory::Exceptions::Internal
         @output_exception_class = Servactory::Exceptions::Output
@@ -24,6 +26,8 @@ module Servactory
         @success_class = Servactory::Exceptions::Success
         @failure_class = Servactory::Exceptions::Failure
 
+        @result_class = Servactory::Result
+
         @collection_mode_class_names =
           Servactory::Maintenance::CollectionMode::ClassNamesCollection.new(default_collection_mode_class_names)
 
@@ -41,6 +45,7 @@ module Servactory
 
         @action_aliases = Servactory::Actions::Aliases::Collection.new
         @action_shortcuts = Servactory::Actions::Shortcuts::Collection.new
+        @action_rescue_handlers = Servactory::Actions::RescueHandlers::Collection.new
       end
 
       private

data/lib/servactory/context/callable.rb

@@ -8,9 +8,9 @@ module Servactory
 
         _call!(context, **arguments)
 
-        Servactory::Result.success_for(context: context)
+        config.result_class.success_for(context: context)
       rescue config.success_class => e
-        Servactory::Result.success_for(context: e.context)
+        config.result_class.success_for(context: e.context)
       end
 
       def call(arguments = {})
@@ -18,11 +18,11 @@ module Servactory
 
         _call!(context, **arguments)
 
-        Servactory::Result.success_for(context: context)
+        config.result_class.success_for(context: context)
       rescue config.success_class => e
-        Servactory::Result.success_for(context: e.context)
+        config.result_class.success_for(context: e.context)
       rescue config.failure_class => e
-        Servactory::Result.failure_for(context: context, exception: e)
+        config.result_class.failure_for(context: context, exception: e)
       end
 
       private

data/lib/servactory/maintenance/collection_mode/class_names_collection.rb

@@ -5,7 +5,7 @@ module Servactory
     module CollectionMode
       class ClassNamesCollection
         extend Forwardable
-        def_delegators :@collection, :include?
+        def_delegators :@collection, :merge, :include?
 
         def initialize(collection)
           @collection = collection

data/lib/servactory/maintenance/validations/collection.rb

@@ -68,11 +68,7 @@ module Servactory
 
         def prepared_types_from(types)
           types.map do |type|
-            if type.is_a?(String)
-              Object.const_get(type)
-            else
-              type
-            end
+            Servactory::Utils.constantize_class(type)
           end
         end
 

data/lib/servactory/maintenance/validations/types.rb

@@ -89,11 +89,7 @@ module Servactory
 
         def prepared_types_from(types)
           types.map do |type|
-            if type.is_a?(String)
-              Object.const_get(type)
-            else
-              type
-            end
+            Servactory::Utils.constantize_class(type)
           end
         end
       end

data/lib/servactory/test_kit/result.rb

@@ -4,11 +4,15 @@ module Servactory
   module TestKit
     class Result
       def self.as_success(attributes = {})
-        Servactory::Result.success_for(context: new(attributes))
+        context = new(attributes)
+
+        Servactory::Result.success_for(context: context)
       end
 
       def self.as_failure(attributes = {}, exception: nil)
-        Servactory::Result.failure_for(context: new(attributes), exception: exception)
+        context = new(attributes)
+
+        Servactory::Result.failure_for(context: context, exception: exception)
       end
 
       def initialize(attributes = {})

data/lib/servactory/utils.rb

@@ -84,5 +84,18 @@ module Servactory
         end
       end
     end
+
+    def constantize_class(class_or_name)
+      case class_or_name
+      when String, Symbol
+        begin
+          Object.const_get(class_or_name)
+        rescue NameError
+          class_or_name.safe_constantize
+        end
+      else
+        class_or_name
+      end
+    end
   end
 end

data/lib/servactory/version.rb

@@ -3,9 +3,9 @@
 module Servactory
   module VERSION
     MAJOR = 2
-    MINOR = 4
-    PATCH = 3
-    PRE = nil
+    MINOR = 5
+    PATCH = 0
+    PRE = "rc1"
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.5.0.rc1
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -242,6 +242,7 @@ files:
 - lib/servactory/actions/aliases/collection.rb
 - lib/servactory/actions/collection.rb
 - lib/servactory/actions/dsl.rb
+- lib/servactory/actions/rescue_handlers/collection.rb
 - lib/servactory/actions/shortcuts/collection.rb
 - lib/servactory/actions/stages/collection.rb
 - lib/servactory/actions/stages/stage.rb
@@ -339,7 +340,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="