aux 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cf122c1dc9b99cf9e0b875586c740617087f7d59c06b50e31a9b9f632874dcc
-  data.tar.gz: 185dd787c6d3ee866e9c67c8ffc4135a28565eb63167bd19f85c1e63e9bb397f
+  metadata.gz: a5a8f2a8523d27a026f50b5e10f3d87c0603a7e2a6710ec0f788b824075c98e0
+  data.tar.gz: 9e5873e8a90853626176568ddd63013a09e5dff9da442a54e6f5955344e2461f
 SHA512:
-  metadata.gz: a393a2f312dfc8dc83bfe74ac4e8b77d0525158d6d7a34e2a9889aae8d269478fa2c16c0e44ecfefc236408696e5ceaa007944d4f486e7c2d39595b23f63e67a
-  data.tar.gz: '00679c6c77e2a668f7ee39accb292e19495ffaae3118232f1dd122bc3c31f3250d8517b66cbd863603cbd490b9a35cf292b66181a95de6069e071a0bf6503b28'
+  metadata.gz: a4a734ffb338fdb30efc987eaadc47378f733818681a126ceddd2d609116ced8cf23474607e8c5e633d65d7f71c232081c2da04b51ef2c840c242d6a1850b26e
+  data.tar.gz: 4a8982b1e6d9e1763676537c8ffb8c900f7209af29c096dab88acced564e5b1d25ef6f17644f2227e40fc872bea30a25f2db5a541a48c3e314db92444026bf68

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2022 Evgeny Boyko
+
+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.

data/aux.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |specification|
   specification.name = 'aux'
   specification.version = Aux::VERSION
   specification.summary = 'Supplementary tools for more effective development'
-  specification.files = Dir['LICENSE', 'README.md', 'aux.gemspec', 'lib/**/*']
+  specification.files = Dir['MIT-LICENSE', 'README.md', 'aux.gemspec', 'lib/**/*']
 
   specification.authors = ['Evgeny Boyko']
   specification.email = ['eboyko@eboyko.ru']
@@ -13,9 +13,6 @@ Gem::Specification.new do |specification|
   specification.add_dependency 'concurrent-ruby', '~> 1.2', '>= 1.2.3'
   specification.add_dependency 'activemodel', '>= 6.1', '< 8'
 
-  specification.add_development_dependency 'zeitwerk', '~> 2.6', '>= 2.6.13'
-  specification.add_development_dependency 'rubocop', '~> 1.62', '>= 1.62.1'
-
   specification.required_ruby_version = '>= 2.7.1'
   specification.metadata['rubygems_mfa_required'] = 'true'
 

data/lib/aux/carriers/failure.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Aux
+  module Carriers
+    # Describes a service failure
+    class Failure
+      # @!attribute [r] code
+      #   @return [Symbol]
+      # @!attribute [r] details
+      #   @return [Object, nil]
+      # @!attribute [r] payload
+      #   @return [Object, nil]
+      attr_reader :code, :details, :payload
+
+      # @param code [Symbol]
+      # @param details [Object, nil]
+      # @param payload [Object, nil]
+      def initialize(code, details = nil, payload = nil)
+        @code = code
+        @details = details
+        @payload = payload
+      end
+
+      # @return [FalseClass]
+      def succeeded?
+        false
+      end
+
+      # @!method successful?
+      #   @return [FalseClass]
+      alias successful? succeeded?
+
+      # @!method success?
+      #   @return [FalseClass]
+      alias success? succeeded?
+
+      # @return [TrueClass]
+      def failed?
+        true
+      end
+
+      # @!method failure?
+      #   @return [TrueClass]
+      alias failure? failed?
+    end
+  end
+end

data/lib/aux/carriers/success.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Aux
+  module Carriers
+    class Success
+      # @!attribute [r] code
+      #   @return [Symbol]
+      # @!attribute [r] payload
+      #   @return [Object, nil]
+      attr_reader :code, :payload
+
+      # @param code [Symbol]
+      # @param payload [Object, nil]
+      def initialize(code, payload = nil)
+        @code = code
+        @payload = payload
+      end
+
+      # @return [TrueClass]
+      def succeeded?
+        true
+      end
+
+      # @!method successful?
+      #   @return [TrueClass]
+      alias successful? succeeded?
+
+      # @!method success?
+      #   @return [TrueClass]
+      alias success? succeeded?
+
+      # @return [FalseClass]
+      def failed?
+        false
+      end
+
+      # @!method failure?
+      #   @return [FalseClass]
+      alias failure? failed?
+    end
+  end
+end

data/lib/aux/carriers.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'aux/carriers/success'
+require 'aux/carriers/failure'
+
+module Aux
+  module Carriers
+    private
+
+    # @overload success
+    #   @return [Success]
+    # @overload success(code)
+    #   @param code [Symbol]
+    #   @return [Success]
+    # @overload success(payload)
+    #   @param payload [Object]
+    #   @return [Success]
+    # @overload success(code, payload)
+    #   @param code [Symbol]
+    #   @param payload [Object]
+    #   @return [Success]
+    def success(*arguments)
+      case arguments
+      in [Symbol] | [Symbol, Object]
+        Success.new(*arguments)
+      in [Object]
+        Success.new(:ok, *arguments)
+      else
+        Success.new(:ok)
+      end
+    end
+
+    # @overload failure
+    #   @return [Failure]
+    # @overload failure(code)
+    #   @param code [Symbol]
+    #   @return [Failure]
+    # @overload failure(details)
+    #   @param details [Object]
+    #   @return [Failure]
+    # @overload failure(code, details)
+    #   @param code [Symbol]
+    #   @param details [Object]
+    #   @return [Failure]
+    # @overload failure(code, details, payload)
+    #   @param code [Symbol]
+    #   @param details [Object]
+    #   @param payload [Object]
+    #   @return [Failure]
+    def failure(*arguments)
+      case arguments
+      in [Symbol] | [Symbol, Object] | [Symbol, Object, Object]
+        Failure.new(*arguments)
+      else
+        Failure.new(:internal_server_error, *arguments)
+      end
+    end
+  end
+end

data/lib/aux/pluggable/class_methods.rb

@@ -20,7 +20,7 @@ module Aux
 
         # Configure dependencies that come from the registry
         pluggable.dependencies.each do |dependency|
-          instance.instance_variable_set("@#{dependency.pointer}", dependency.target)
+          instance.instance_variable_set(:"@#{dependency.pointer}", dependency.target)
 
           # The next lines are required to make resolved dependencies available
           # by its reader methods within customized initialization
@@ -28,7 +28,7 @@ module Aux
           # TODO: Discuss whether this is appropriate behaviour
           next if instance.respond_to?(dependency.pointer, true)
 
-          define_method(dependency.pointer) { instance_variable_get("@#{dependency.pointer}") }
+          define_method(dependency.pointer) { instance_variable_get(:"@#{dependency.pointer}") }
           next unless dependency.private
 
           private(dependency.pointer)
@@ -37,7 +37,7 @@ module Aux
         # Configure dependencies that come from the customized initialization procedure
         dependencies_overrides = keyword_arguments.slice(*dependencies_keys)
         dependencies_overrides.each do |pointer, target|
-          instance.instance_variable_set("@#{pointer}", target)
+          instance.instance_variable_set(:"@#{pointer}", target)
         end
 
         # Run the origin's initialization procedure if any other arguments given

data/lib/aux/pluggable/connector.rb

@@ -45,13 +45,13 @@ module Aux
 
         if @initialization_required
           @subject.class_eval do
-            define_method(dependency.pointer) { instance_variable_get("@#{dependency.pointer}") }
+            define_method(dependency.pointer) { instance_variable_get(:"@#{dependency.pointer}") }
             private(dependency.pointer) if dependency.private
           end
         else
-          @subject.instance_variable_set("@#{dependency.pointer}", dependency.target)
+          @subject.instance_variable_set(:"@#{dependency.pointer}", dependency.target)
           @subject.singleton_class.class_eval do
-            define_method(dependency.pointer) { instance_variable_get("@#{dependency.pointer}") }
+            define_method(dependency.pointer) { instance_variable_get(:"@#{dependency.pointer}") }
             private(dependency.pointer) if dependency.private
           end
         end

data/lib/aux/validations/error.rb

@@ -6,22 +6,22 @@ module Aux
     class Error
       # @!attribute [r] attribute
       #   @return [Symbol]
-      # @!attribute [r] type
-      #   @return [Symbol]
       # @!attribute [r] scope
       #   @return [String]
+      # @!attribute [r] type
+      #   @return [Symbol]
       # @!attribute [r] details
       #   @return [Hash]
-      attr_reader :attribute, :type, :scope, :details
+      attr_reader :attribute, :scope, :type, :details
 
       # @param attribute [Symbol]
-      # @param type [Symbol]
       # @param scope [String]
+      # @param type [Symbol]
       # @param details [Hash]
-      def initialize(attribute, type, scope, **details)
+      def initialize(attribute, scope, type, **details)
         @attribute = attribute
-        @type = type
         @scope = scope
+        @type = type
         @details = details
       end
     end

data/lib/aux/validations/error_handler.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Aux
+  module Validations
+    # Describes methods that represent validation errors in simple structures pretty enough for the API response.
+    module ErrorHandler
+      private
+
+      DEFAULT_ERROR_SCOPE_PREFIX = 'errors'
+      GENERIC_ERROR_SCOPE = 'errors.generic'
+
+      # @overload format_errors(error_batch, scope)
+      #   @param error_batch [Array]
+      #   @param scope [Symbol, String, nil]
+      #   @raise [ArgumentError]
+      #   @return [Array<Hash>]
+      # @overload format_errors(error_collection, scope)
+      #   @param error_collection [Errors]
+      #   @param scope [Symbol, String, nil]
+      #   @raise [ArgumentError]
+      #   @return [Array<Hash>]
+      # @overload format_errors(error, scope)
+      #   @param scope [Symbol, String, nil]
+      #   @param error [Error]
+      #   @raise [ArgumentError]
+      #   @return [Hash]
+      def format_errors(payload, scope = nil)
+        case payload
+        when Array
+          format_error_batch(payload, scope)
+        when Errors
+          format_error_collection(payload, scope)
+        when Error
+          format_error(payload, scope)
+        else
+          raise ArgumentError
+        end
+      end
+
+      # @param batch [Array<Error, Errors>]
+      # @param scope [Symbol, String, nil]
+      # @return [Array<Hash>]
+      def format_error_batch(batch, scope = nil)
+        batch.flat_map { |element| format_errors(element, scope) }
+      end
+
+      # @param collection [Errors]
+      # @param scope [Symbol, String, nil]
+      def format_error_collection(collection, scope = nil)
+        return format_primary_error_collection(collection, scope || collection.scope) unless collection.attribute
+
+        format_secondary_error_collection(collection, "#{scope}.#{collection.attribute}")
+      end
+
+      # @param collection [Errors]
+      # @param scope [Symbol, String, nil]
+      # @return [Array<Hash>]
+      def format_primary_error_collection(collection, scope = nil)
+        collection.group_by_attribute.map do |attribute, entities|
+          {
+            kind: entities.all?(Error) ? 'collection' : 'batch',
+            attribute: attribute,
+            errors: format_errors(entities, scope)
+          }
+        end
+      end
+
+      # @param collection [Errors]
+      # @param scope [Symbol, String, nil]
+      # @return [Array<Hash>]
+      def format_secondary_error_collection(collection, scope = nil)
+        collection.group_by_attribute.flat_map do |_attribute, items|
+          format_errors(items.one? ? items.first : items, scope)
+        end
+      end
+
+      # @param error [Error]
+      # @param scope [Symbol, String, nil]
+      # @return [Hash]
+      def format_error(error, scope = nil)
+        {
+          type: error.type,
+          details: error.details,
+          message: format_message(error, scope)
+        }
+      end
+
+      # @param error [Error]
+      # @param scope [Symbol, String, nil]
+      # @return [String]
+      def format_message(error, scope = nil)
+        scope ? format_secondary_message(error, scope) : format_primary_message(error)
+      end
+
+      # @param error [Error]
+      # @return [String]
+      def format_primary_message(error)
+        I18n.translate(
+          error.type,
+          scope: "#{self.class::DEFAULT_ERROR_SCOPE_PREFIX}.#{error.scope}.#{error.attribute}",
+          default: proc { format_fallback_message(error) },
+          **error.details
+        )
+      end
+
+      # @param error [Error]
+      # @param scope [Symbol, String, nil]
+      # @return [String]
+      def format_secondary_message(error, scope)
+        I18n.translate(
+          error.type,
+          scope: "#{self.class::DEFAULT_ERROR_SCOPE_PREFIX}.#{scope}.#{error.attribute}",
+          default: proc { format_primary_message(error) },
+          **error.details
+        )
+      end
+
+      # @param error [Error]
+      # @return [String]
+      def format_fallback_message(error)
+        I18n.translate(error.type, scope: self.class::GENERIC_ERROR_SCOPE, default: error.type)
+      end
+    end
+  end
+end

data/lib/aux/validations/errors.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
-require 'aux/validations/error'
-require 'aux/validations/errors_tree_presenter'
-
 module Aux
   module Validations
-    # Describes a batch of errors that can be initialized using an attribute name or an object that should be validated
+    # Describes a collection of errors that can be initialized with an attribute name or an object to be validated
     class Errors
       # @!attribute [r] scope
       #   @return [String, nil]
@@ -14,16 +11,13 @@ module Aux
       attr_reader :scope, :attribute
 
       # @overload initialize(subject)
-      #   @param base [Object]
-      #   @return [self]
+      #   @param subject [Object]
       # @overload initialize(attribute, errors)
-      #   Use this approach to handle nested errors
       #   @param attribute [Symbol]
-      #   @param errors [Aux::Validation::Errors]
-      #   @return [self]
-      def initialize(base, errors = [])
-        @scope = base.is_a?(Symbol) ? nil : base.class.name.underscore.tr('/', '.')
-        @attribute = base.is_a?(Symbol) ? base : nil
+      #   @param errors [Errors]
+      def initialize(subject, errors = [])
+        @scope = subject.is_a?(Symbol) ? nil : subject.class.name.underscore.tr('/', '.')
+        @attribute = subject.is_a?(Symbol) ? subject : nil
         @errors = errors
       end
 
@@ -34,35 +28,25 @@ module Aux
       #   @raise [StandardError]
       # @overload add(attribute, errors)
       #   @param attribute [Symbol]
-      #   @param errors [Array<Aux::Validations::Errors, Aux::Validations::Error>]
+      #   @param errors [Array<Errors, Error>]
       #   @raise [StandardError]
       # @overload add(attribute, errors)
       #   @param attribute [Symbol]
-      #   @param errors [Aux::Validations::Errors]
+      #   @param errors [Errors]
       #   @raise [StandardError]
-      def add(attribute, payload, **details)
-        case payload
+      def add(attribute, subject, **details)
+        case subject
         when Symbol
-          add_error(attribute, payload, **details)
+          add_error(attribute, subject, **details)
         when Array
-          add_nested_error(attribute, payload)
-        when Aux::Validations::Errors
-          add_nested_error(attribute, [payload])
+          add_nested_error(attribute, subject)
+        when Errors
+          add_nested_error(attribute, [subject])
         else
-          raise StandardError, :unsupported_type
+          raise(ArgumentError, "Unsupported argument given (#{subject.class})")
         end
       end
 
-      # @return [Hash]
-      def tree
-        tree_presenter.render(self)
-      end
-
-      # @return [Hash]
-      def group_by_attribute
-        errors.group_by(&:attribute)
-      end
-
       def clear
         self.errors = []
       end
@@ -72,25 +56,20 @@ module Aux
         errors.empty?
       end
 
+      # @param block [Proc]
       def map(&block)
         errors.map(&block)
       end
 
-      # @return [Array<Aux::Validations::Error>]
-      def all
-        errors.map do |error|
-          if error.is_a?(Array)
-            error.map { |e| e.respond_to?(:all) ? e.all : e }
-          else
-            error.respond_to?(:all) ? error.all : error
-          end
-        end.flatten
+      # @return [Hash<Symbol, Array>]
+      def group_by_attribute
+        errors.group_by(&:attribute)
       end
 
       private
 
       # @!attribute [rw] errors
-      #   @return [Array<Aux::Validations::Errors, Aux::Validations::Error>]
+      #   @return [Array<Error, Errors>]
       attr_accessor :errors
 
       # @param attribute [Symbol]
@@ -101,7 +80,7 @@ module Aux
       end
 
       # @param attribute [Symbol]
-      # @param nested_errors [Aux::Validations::Errors]
+      # @param nested_errors [Errors]
       def add_nested_error(attribute, nested_errors)
         errors.push(build_nested_error(attribute, nested_errors))
       end
@@ -109,26 +88,21 @@ module Aux
       # @param attribute [Symbol]
       # @param type [Symbol]
       # @param details [Hash]
-      # @return [Aux::Validations::Error]
+      # @return [Error]
       def build_error(attribute, type, **details)
-        errors_factory.new(attribute, type, scope, **details)
+        factory.new(attribute, scope, type, **details)
       end
 
       # @param attribute [Symbol] 3
-      # @param errors [Aux::Validations::Errors]
-      # @return [Aux::Validations::Errors]
+      # @param errors [Errors]
+      # @return [Errors]
       def build_nested_error(attribute, errors)
         self.class.new(attribute, errors)
       end
 
-      # @return [Class<Aux::Validations::ErrorsTreePresenter>]
-      def tree_presenter
-        Aux::Validations::ErrorsTreePresenter
-      end
-
-      # @return [Class<Aux::Validations::Error>]
-      def errors_factory
-        Aux::Validations::Error
+      # @return [Class<Error>]
+      def factory
+        Error
       end
     end
   end

data/lib/aux/validations.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require 'active_model'
 require 'active_support'
-require 'active_model/validations/validates'
+require 'aux/validations/error'
 require 'aux/validations/errors'
+require 'aux/validations/error_handler'
 
 module Aux
   # Describes enhancement of {::ActiveModel::Validations}

data/lib/aux/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Aux
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/aux.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'aux/carriers'
 require 'aux/pluggable'
 require 'aux/validations'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aux
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Evgeny Boyko
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2024-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -50,56 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.6.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.6.13
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.62'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.62.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.62'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.62.1
-description: 
+description:
 email:
 - eboyko@eboyko.ru
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
 - README.md
 - aux.gemspec
 - lib/aux.rb
+- lib/aux/carriers.rb
+- lib/aux/carriers/failure.rb
+- lib/aux/carriers/success.rb
 - lib/aux/pluggable.rb
 - lib/aux/pluggable/class_methods.rb
 - lib/aux/pluggable/connector.rb
@@ -109,15 +73,15 @@ files:
 - lib/aux/registry/entry.rb
 - lib/aux/validations.rb
 - lib/aux/validations/error.rb
+- lib/aux/validations/error_handler.rb
 - lib/aux/validations/errors.rb
-- lib/aux/validations/errors_tree_presenter.rb
 - lib/aux/version.rb
 homepage: https://github.com/eboyko/aux
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Supplementary tools for more effective development
 test_files: []

data/lib/aux/validations/errors_tree_presenter.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Aux
-  module Validations
-    # Describes tree structure presentation scenario of errors
-    class ErrorsTreePresenter
-      class << self
-        # @return [Array, Hash, Aux::Validations::Error]
-        def render(payload)
-          case payload
-          when Array
-            process_array(payload)
-          when Aux::Validations::Errors
-            render_collection(payload)
-          when Aux::Validations::Error
-            payload
-          end
-        end
-
-        private
-
-        # @param errors [Array]
-        # @return [Array]
-        def process_array(errors)
-          errors.map { |item| render(item) }.flatten
-        end
-
-        # @param errors [Aux::Validations::Errors]
-        # @return [Array, Hash]
-        def render_collection(errors)
-          errors.attribute ? process_attribute_errors(errors) : process_errors(errors)
-        end
-
-        # @param errors [Aux::Validations::Errors]
-        # @return [Hash]
-        def process_errors(errors)
-          errors.group_by_attribute.transform_values do |items|
-            render(items.one? ? items.first : items)
-          end
-        end
-
-        # @param errors [Aux::Validations::Errors]
-        # @return [Array]
-        def process_attribute_errors(errors)
-          errors.group_by_attribute.map { |_attribute, items| render(items) }.flatten
-        end
-      end
-    end
-  end
-end