error_normalizer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a2b14320f32c8b5b9709d2a7963941ff27cebe857533a3a38401e4ccb08709a
-  data.tar.gz: 5d9f38f16ea5aac77e3a0318eb4cacac7b9aab5d24574e8d55c5c3de4b3cb08f
+  metadata.gz: 4035feeceb8c759e702989ff2d013b40a935fcf4b4ca2afe79b9742738ff39a6
+  data.tar.gz: f7235ca637c3503f126ff091724d80d672462b08b6b7ade550bba1ad4ab801ef
 SHA512:
-  metadata.gz: ea13a01344de75bd4161ff70a70f268aaa2d6b393273f14e000da2b8213ca61eae426d12e97acdbe06eaf9f2dbbe4fa3d4427214e47ad46558de8422105dd058
-  data.tar.gz: 58fd33623c68e76af2bf94fbd7ec1cd8dea6a17baae99315bfddc687862c00e6f9dbdf38d3ebd6f83f69cb06b6c5232986548bac98c9e4ddb15baf4e4e118136
+  metadata.gz: 252e4a3d03e3c1a1f190c77774fa0ca2ac23adb6ca5bd02afc93a9e7cc4fbe819c63fee1c98c6fee7d9d0a4a485032773a2b56f935b16b8c7d958a17bb9cc7da
+  data.tar.gz: e50077ea3edd89c7c091aa92138f54fd49bc41ac1f0670fbed866c829e63f7094be1b646613f058ff6ea1775713564af7fec106f0c84b85f4a2083dac6dd0e4e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    error_normalizer (0.1.0)
+    error_normalizer (0.1.1)
       dry-configurable (~> 0.7.0)
 
 GEM

data/error_normalizer.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['di.kondratenko@gmail.com']
 
   spec.summary       = 'Normalize dry-validation and ActiveModel errors to the universal format'
-  spec.homepage      = 'https://gitlab.yalantis.com/web/error_normalizer'
+  spec.homepage      = 'https://gitlab.yalantis.com/public-repo/error_normalizer/'
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.

data/lib/error_normalizer/error.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 class ErrorNormalizer
+  #
   # Error struct which makes cosmetic normalization
-  # upon calling either #to_hash and #to_json.
-  # Supports case equality check (#===) for hash structs.
+  # upon calling either {Error#to_hash} or {Error#to_json}.
+  # Provides case equality check {Error.===} to support plain Hash structs.
   #
   # @example
   #   Error.new('not_plausible', message: "can't recognize your phone", path: 'user.phone')
@@ -29,14 +30,17 @@ class ErrorNormalizer
       @payload = payload
     end
 
+    # Case equality check
+    # @return [Boolean]
     def self.===(other)
       return true if other.is_a?(Error)
       return false unless other.is_a?(Hash)
 
       h = other.transform_keys(&:to_s)
-      h.key?('key') & h.key?('message') && h.key?('payload') && h.key?('type')
+      h.key?('key') && h.key?('message') && h.key?('payload') && h.key?('type')
     end
 
+    # @return [Hash] error Hash representation
     def to_hash
       {
         key: @key,
@@ -46,6 +50,7 @@ class ErrorNormalizer
       }
     end
 
+    # @return [String] error JSON string representation
     def to_json
       to_hash.to_json
     end

data/lib/error_normalizer/message_parser.rb

@@ -8,9 +8,9 @@ class ErrorNormalizer
   # In case message isn't recognized we set error to be a simple
   # normalized message (no spaces and special characters).
   #
-  # Here are the links to AM::Errors and Dry::Validation list of error messages:
-  #   - Dry: https://github.com/dry-rb/dry-validation/blob/8417e8/config/errors.yml
-  #   - AM: https://github.com/svenfuchs/rails-i18n/blob/70b38b/rails/locale/en-US.yml#L111
+  # Here are the links to ActiveModel::Errors and Dry::Validation list of error messages:
+  # - {https://github.com/dry-rb/dry-validation/blob/8417e8/config/errors.yml dry-validation}
+  # - {https://github.com/svenfuchs/rails-i18n/blob/70b38b/rails/locale/en-US.yml#L111 ActiveModel::Errors}
   #
   class MessageParser
     VALUE_MATCHERS = [
@@ -41,6 +41,8 @@ class ErrorNormalizer
       @payload = {}
     end
 
+    # Parse error message
+    # @return (see #to_a)
     def parse
       parse_value_message
       return to_a if @key
@@ -52,6 +54,7 @@ class ErrorNormalizer
       to_a
     end
 
+    # @return [Array] a tuple of parsed [key, message, payload]
     def to_a
       [@key, @message, @payload]
     end

data/lib/error_normalizer/normalizer.rb

@@ -5,7 +5,7 @@ require_relative 'message_parser'
 
 class ErrorNormalizer
   #
-  # Responsible for converting input to the array of normalized errors.
+  # Convert given input to the array of normalized errors.
   #
   # @example
   #   errors = { phone: ['not plausible'] }
@@ -18,7 +18,7 @@ class ErrorNormalizer
   #   # }]
   #
   class Normalizer
-    UnsupportedInputType = Class.new(StandardError)
+    UnsupportedInputTypeError = Class.new(StandardError)
 
     attr_reader :errors
 
@@ -29,6 +29,9 @@ class ErrorNormalizer
       @config = config
     end
 
+    # Add new error object to the collection of processed errors.
+    # This is a more low-level method which is used by {#normalize}.
+    # @return [Error, Hash]
     def add_error(error, path: nil, **options)
       @errors <<
         case error
@@ -39,19 +42,21 @@ class ErrorNormalizer
         end
     end
 
+    # Primary method to normalize the given input
+    # @return [self]
     def normalize
-      case @input
-      when Hash
+      if @input.is_a?(Hash)
         normalize_hash(@input.dup)
-      when ActiveModel::Errors
+      elsif @input.respond_to?(:to_hash)
         normalize_hash(@input.to_hash)
       else
-        raise "Don't know how to normalize errors"
+        raise UnsupportedInputTypeError
       end
 
       self
     end
 
+    # @return [Array<Hash>] normalized errors of {Error#to_hash}
     def to_a
       @errors.map(&:to_hash)
     end
@@ -69,7 +74,7 @@ class ErrorNormalizer
           ns = namespaced_path(key)
           Normalizer.new(value, namespace: ns).normalize.errors.each { |e| add_error(e) }
         else
-          raise UnsupportedInputType
+          raise UnsupportedInputTypeError
         end
       end
     end

data/lib/error_normalizer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class ErrorNormalizer
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/error_normalizer.rb

@@ -5,7 +5,7 @@ require 'error_normalizer/version'
 require 'error_normalizer/normalizer'
 
 #
-# Intended to normalize errors to the single format:
+# This class provides high-level API to normalize errors to the single format:
 #
 #     {
 #       key: 'has_already_been_taken',
@@ -16,9 +16,6 @@ require 'error_normalizer/normalizer'
 #       }
 #     }
 #
-# We shall be able to automatically convert dry-validation output to this format
-# and since we're using rails also automatically convert ActiveModel::Errors.
-#
 class ErrorNormalizer
   extend Dry::Configurable
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: error_normalizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Denis Kondratenko
@@ -115,7 +115,7 @@ files:
 - lib/error_normalizer/message_parser.rb
 - lib/error_normalizer/normalizer.rb
 - lib/error_normalizer/version.rb
-homepage: https://gitlab.yalantis.com/web/error_normalizer
+homepage: https://gitlab.yalantis.com/public-repo/error_normalizer/
 licenses:
 - MIT
 metadata: {}