servactory 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6c205eaf58dfc9f10040d0b5a60324ee63ed72dfc1643df149646232ce73c46
-  data.tar.gz: b88daadf5ed2d8645eca11d1d4ea9bdd86175b52a3297f57f232b068239a070b
+  metadata.gz: 5662ba4d5b8ad475c0cd03c3b74d8ab74f4b319799ae16b7a125bb6be7493337
+  data.tar.gz: ed21fb0f82de78b4672da98b7692d857da56d96fb4e855c39ada1b303b32535c
 SHA512:
-  metadata.gz: 4f08e497b7044ab6c6ec5c53d2e87538ef7666cea055cdd3fac5d86c8ff699367ca606b508eebc25c022e9f8ad9c44d70a9bd5ce8d4d0b48634c5268aea88f29
-  data.tar.gz: 5b3bdb880e5251115e21ddf47f66350cd1f1f86ae434080190d04277c8d60d8e9c0d3628c5f84c91d4a31f4c7a3df3266d5f35bfe88fadc842a4c9596d9e4554
+  metadata.gz: 5b50b74907895549d97c97b09dfeada580bf98e1dd53d96eb25ebdde73da447177350f2cabff2278adb78353b798f1f64c694ffe9f3c950b2ba6242f1442db12
+  data.tar.gz: bad8e985072c7a6c1b47a7392d04b7e9adeedfcfc4d269082c74c50c3f31a5060d09faac462bc07e45b5b5609a51528fc13fc5cbee316ba31aa8eed0a6eb8b0f

data/lib/servactory/configuration/dsl.rb

@@ -8,12 +8,12 @@ module Servactory
       end
 
       module ClassMethods
-        def inherited(child) # rubocop:disable Metrics/AbcSize
+        def inherited(child) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
           super
 
-          child.config.input_error_class = config.input_error_class
-          child.config.internal_error_class = config.internal_error_class
-          child.config.output_error_class = config.output_error_class
+          child.config.input_exception_class = config.input_exception_class
+          child.config.internal_exception_class = config.internal_exception_class
+          child.config.output_exception_class = config.output_exception_class
 
           child.config.success_class = config.success_class
           child.config.failure_class = config.failure_class
@@ -21,6 +21,8 @@ module Servactory
           child.config.collection_mode_class_names = config.collection_mode_class_names
 
           child.config.input_option_helpers = config.input_option_helpers
+          child.config.internal_option_helpers = config.internal_option_helpers
+          child.config.output_option_helpers = config.output_option_helpers
 
           child.config.action_aliases = config.action_aliases
           child.config.action_shortcuts = config.action_shortcuts

data/lib/servactory/configuration/factory.rb

@@ -7,20 +7,60 @@ module Servactory
         @config = config
       end
 
+      # DEPRECATED: These configs must be deleted after release 2.4.
       def input_error_class(input_error_class)
-        @config.input_error_class = input_error_class
+        Kernel.warn "DEPRECATION WARNING: " \
+                    "Configuration `input_error_class` is deprecated; " \
+                    "use `internal_exception_class` instead. " \
+                    "It will be removed in one of the next releases."
+
+        input_exception_class(input_error_class)
+      end
+
+      # DEPRECATED: These configs must be deleted after release 2.4.
+      def internal_error_class(internal_error_class)
+        Kernel.warn "DEPRECATION WARNING: " \
+                    "Configuration `internal_error_class` is deprecated; " \
+                    "use `internal_exception_class` instead. " \
+                    "It will be removed in one of the next releases."
+
+        internal_exception_class(internal_error_class)
       end
 
+      # DEPRECATED: These configs must be deleted after release 2.4.
       def output_error_class(output_error_class)
-        @config.output_error_class = output_error_class
+        Kernel.warn "DEPRECATION WARNING: " \
+                    "Configuration `output_error_class` is deprecated; " \
+                    "use `output_exception_class` instead. " \
+                    "It will be removed in one of the next releases."
+
+        output_exception_class(output_error_class)
       end
 
-      def internal_error_class(internal_error_class)
-        @config.internal_error_class = internal_error_class
+      def input_exception_class(input_exception_class)
+        return @config.input_exception_class = input_exception_class if subclass_of_exception?(input_exception_class)
+
+        raise_error_about_wrong_exception_class_with(:input_exception_class, input_exception_class)
+      end
+
+      def internal_exception_class(internal_exception_class)
+        if subclass_of_exception?(internal_exception_class)
+          return @config.internal_exception_class = internal_exception_class
+        end
+
+        raise_error_about_wrong_exception_class_with(:internal_exception_class, internal_exception_class)
+      end
+
+      def output_exception_class(output_exception_class)
+        return @config.output_exception_class = output_exception_class if subclass_of_exception?(output_exception_class)
+
+        raise_error_about_wrong_exception_class_with(:output_exception_class, output_exception_class)
       end
 
       def failure_class(failure_class)
-        @config.failure_class = failure_class
+        return @config.failure_class = failure_class if subclass_of_exception?(failure_class)
+
+        raise_error_about_wrong_exception_class_with(:failure_class, failure_class)
       end
 
       def collection_mode_class_names(collection_mode_class_names)
@@ -50,6 +90,21 @@ module Servactory
       def action_shortcuts(action_shortcuts)
         @config.action_shortcuts.merge(action_shortcuts)
       end
+
+      ##########################################################################
+
+      def subclass_of_exception?(value)
+        value.is_a?(Class) && value <= Exception
+      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"
+      end
     end
   end
 end

data/lib/servactory/configuration/setup.rb

@@ -3,9 +3,9 @@
 module Servactory
   module Configuration
     class Setup
-      attr_accessor :input_error_class,
-                    :internal_error_class,
-                    :output_error_class,
+      attr_accessor :input_exception_class,
+                    :internal_exception_class,
+                    :output_exception_class,
                     :success_class,
                     :failure_class,
                     :collection_mode_class_names,
@@ -17,12 +17,12 @@ module Servactory
                     :action_shortcuts
 
       def initialize # rubocop:disable Metrics/MethodLength
-        @input_error_class = Servactory::Errors::InputError
-        @internal_error_class = Servactory::Errors::InternalError
-        @output_error_class = Servactory::Errors::OutputError
+        @input_exception_class = Servactory::Exceptions::Input
+        @internal_exception_class = Servactory::Exceptions::Internal
+        @output_exception_class = Servactory::Exceptions::Output
 
         @success_class = Servactory::Exceptions::Success
-        @failure_class = Servactory::Errors::Failure
+        @failure_class = Servactory::Exceptions::Failure
 
         @collection_mode_class_names =
           Servactory::Maintenance::CollectionMode::ClassNamesCollection.new(default_collection_mode_class_names)

data/lib/servactory/context/workspace/inputs.rb

@@ -104,7 +104,7 @@ module Servactory
             input_name: name
           )
 
-          raise @context.class.config.input_error_class.new(message: message_text, input_name: name)
+          raise @context.class.config.input_exception_class.new(message: message_text, input_name: name)
         end
       end
     end

data/lib/servactory/context/workspace/internals.rb

@@ -75,7 +75,7 @@ module Servactory
             internal_name: name
           )
 
-          raise @context.class.config.input_error_class.new(message: message_text)
+          raise @context.class.config.input_exception_class.new(message: message_text)
         end
       end
     end

data/lib/servactory/context/workspace/outputs.rb

@@ -75,7 +75,7 @@ module Servactory
             output_name: name
           )
 
-          raise @context.class.config.output_error_class.new(message: message_text)
+          raise @context.class.config.output_exception_class.new(message: message_text)
         end
       end
     end

data/lib/servactory/context/workspace.rb

@@ -30,21 +30,21 @@ module Servactory
       end
 
       def fail_input!(input_name, message:)
-        raise self.class.config.input_error_class.new(
+        raise self.class.config.input_exception_class.new(
           input_name: input_name,
           message: message
         )
       end
 
       def fail_internal!(internal_name, message:)
-        raise self.class.config.internal_error_class.new(
+        raise self.class.config.internal_exception_class.new(
           internal_name: internal_name,
           message: message
         )
       end
 
       def fail_output!(output_name, message:)
-        raise self.class.config.output_error_class.new(
+        raise self.class.config.output_exception_class.new(
           output_name: output_name,
           message: message
         )

data/lib/servactory/errors/failure.rb

@@ -2,6 +2,7 @@
 
 module Servactory
   module Errors
+    # DEPRECATED: This class will be deleted after release 2.4.
     class Failure < Servactory::Exceptions::Base
       attr_reader :type,
                   :message,

data/lib/servactory/errors/input_error.rb

@@ -2,6 +2,7 @@
 
 module Servactory
   module Errors
+    # DEPRECATED: This class will be deleted after release 2.4.
     class InputError < Servactory::Exceptions::Base
       attr_reader :message,
                   :input_name

data/lib/servactory/errors/internal_error.rb

@@ -2,6 +2,7 @@
 
 module Servactory
   module Errors
+    # DEPRECATED: This class will be deleted after release 2.4.
     class InternalError < Servactory::Exceptions::Base
       attr_reader :message,
                   :internal_name

data/lib/servactory/errors/output_error.rb

@@ -2,6 +2,7 @@
 
 module Servactory
   module Errors
+    # DEPRECATED: This class will be deleted after release 2.4.
     class OutputError < Servactory::Exceptions::Base
       attr_reader :message,
                   :output_name

data/lib/servactory/exceptions/failure.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Exceptions
+    class Failure < Base
+      attr_reader :type,
+                  :message,
+                  :meta
+
+      def initialize(type: :base, message:, meta: nil) # rubocop:disable Style/KeywordParametersOrder
+        @type = type
+        @message = message
+        @meta = meta
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/servactory/exceptions/input.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Exceptions
+    class Input < Base
+      attr_reader :message,
+                  :input_name
+
+      def initialize(message:, input_name: nil)
+        @message = message
+        @input_name = input_name&.to_sym
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/servactory/exceptions/internal.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Exceptions
+    class Internal < Base
+      attr_reader :message,
+                  :internal_name
+
+      def initialize(message:, internal_name: nil)
+        @message = message
+        @internal_name = internal_name&.to_sym
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/servactory/exceptions/output.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Exceptions
+    class Output < Base
+      attr_reader :message,
+                  :output_name
+
+      def initialize(message:, output_name: nil)
+        @message = message
+        @output_name = output_name&.to_sym
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/servactory/inputs/tools/rules.rb

@@ -35,7 +35,7 @@ module Servactory
             conflict_code: input.conflict_code
           )
 
-          raise @context.class.config.input_error_class.new(
+          raise @context.class.config.input_exception_class.new(
             message: message_text,
             input_name: input.name
           )

data/lib/servactory/inputs/tools/unnecessary.rb

@@ -23,7 +23,7 @@ module Servactory
             unnecessary_attributes: unnecessary_attributes.join(", ")
           )
 
-          raise @context.class.config.input_error_class.new(message: message_text)
+          raise @context.class.config.input_exception_class.new(message: message_text)
         end
 
         private

data/lib/servactory/inputs/tools/validation.rb

@@ -73,7 +73,7 @@ module Servactory
         def raise_errors
           return if (tmp_errors = errors.not_blank).empty?
 
-          raise @context.class.config.input_error_class.new(message: tmp_errors.first)
+          raise @context.class.config.input_exception_class.new(message: tmp_errors.first)
         end
       end
     end

data/lib/servactory/maintenance/attributes/tools/validation.rb

@@ -71,7 +71,7 @@ module Servactory
             return if (tmp_errors = errors.not_blank).empty?
 
             raise @context.class.config
-                          .public_send(:"#{@attribute.system_name}_error_class")
+                          .public_send(:"#{@attribute.system_name}_exception_class")
                           .new(message: tmp_errors.first)
           end
         end

data/lib/servactory/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -265,6 +265,10 @@ files:
 - lib/servactory/errors/internal_error.rb
 - lib/servactory/errors/output_error.rb
 - lib/servactory/exceptions/base.rb
+- lib/servactory/exceptions/failure.rb
+- lib/servactory/exceptions/input.rb
+- lib/servactory/exceptions/internal.rb
+- lib/servactory/exceptions/output.rb
 - lib/servactory/exceptions/success.rb
 - lib/servactory/info/dsl.rb
 - lib/servactory/info/result.rb