error_builder 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17afb5de8cfc97f5dc0d6618ae6397e938c64b3abe36de5fae6e9fd12b54173c
-  data.tar.gz: e06de617586f31e251e154dc7b7c7abbbf92a5f04e7c73ba0ceb8ba4bb17ca6b
+  metadata.gz: 18b518b8436e2ef66d0bb88f820bef052f36df55a4e41bb28324fe0aebe237d8
+  data.tar.gz: 3c2430d0678d632349469410999bb82825ae5e07c1f36e185857222864e59a59
 SHA512:
-  metadata.gz: 04abd9e0e2ad14d96a78ce758cbe5788dfa8f6488b6d58fcfe0831855a26a5ce2f05a7a090d22fb7e469436c8bf5957517636a4d23863409fd488582d2cae048
-  data.tar.gz: '0394b4e8612224edc4cd25b677a02788ddb663a0a803f55abe0535b4157075a6aae5281f6a4683b8af59164f302b8c7d8b04d0065f01cff320f6c2e73531a608'
+  metadata.gz: 3d67f22c74f876da70c19d27267aa4036c796bed1737a18f3ca3da380e446f90705cf5e19a246bba2314bf8c126346545f385102e9a9c325b958205d508c1a3b
+  data.tar.gz: 91deb51af311a62b39edec12ddfc6440e7c02c8f13227d8cc7922ce5c59e0e198b4f728dc1ba085efd1619bdab6df7c107b4fd6173283f09daa4112cda6b570a

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.4.0] - 2025-04-13
+- Added support of custom format classes.
+
+## [0.3.0] - 2025-04-06
+
+- Changed Array and Hash formats.
+- Added support for nested and flat error structures in both hash and array formats.
+- Updated documentation and usage examples.
+- Covered tests.
+
+## [0.2.0] - 2025-04-05
+
+- Provide advanced way of error collecting
+
 ## [0.1.0] - 2025-03-30
 
 - Initial release

data/README.md

@@ -34,7 +34,7 @@ If you have to use in Rails:
 3. You can configure the gem by using the ErrorBuilder.configure block:
 ```ruby
 ErrorBuilder.configure do |config|
-  config.format         = :hash   # Supported formats: :hash, :array
+  config.format         = :hash   # Supported formats: :hash, :array, custom class format
   config.message_format = :string # Supported formats: :string, :array
 end
 ```
@@ -53,7 +53,7 @@ errors.add(:base, "Something went wrong")
 
 3. Convert Errors to Hash or Array (depends on configuration)
 ```ruby
-errors.to_h    #=> { errors: { base: ["Something went wrong"] } }
+errors.to_h    #=> { base: ["Something went wrong"] }
 ```
 
 ### Including in Classes
@@ -71,7 +71,46 @@ end
 
 my_service = MyService.new
 my_service.call
-my_service.errors.to_h    #=> { errors: { base: ["Something went wrong"] } }
+my_service.errors.to_h    #=> { base: ["Something went wrong"] }
+```
+
+### Examples
+
+#### Using nested keys
+
+```ruby
+class MyService
+  include ErrorBuilder
+
+  def call 
+    errors.add("user.locations[0].name", "must be present")
+
+    true
+  end
+end
+
+my_service = MyService.new
+my_service.call
+my_service.errors.to_h             #=> { "user" => { "locations" => { 0 => { "name" => ["must be present"] } } } } }
+my_service.errors.to_h(flat: true) #=> { "user.locations[0].name" => ["must be present"] }
+```
+
+#### Using custom formats
+
+```ruby
+class CustomFormat
+  def initialize(errors, **)
+    @errors = errors
+  end
+
+  def to_h
+    @errors.map { |error| "#{error.key} #{error.message.join(", ")}" }
+  end
+end
+
+errors = ErrorBuilder::Engine.new(format: CustomFormat)
+errors.add(:base, "Something went wrong")
+errors.to_h    #=> ["base Something went wrong"]
 ```
 
 ## Development

data/lib/error_builder/engine.rb

@@ -16,15 +16,12 @@ module ErrorBuilder
       @errors << error
     end
 
-    def to_h
-      case format
-      when :array
-        Formats::Array.new(@errors).to_h
-      when :hash
-        Formats::Hash.new(@errors).to_h
-      else
-        raise ArgumentError, "Unsupported format: #{format}"
-      end
+    def to_h(flat: false)
+      formatter.new(errors, flat:).to_h
+    end
+
+    def formatter
+      FormatResolver.new(format).formatter
     end
   end
 end

data/lib/error_builder/error.rb

@@ -29,9 +29,9 @@ module ErrorBuilder
     end
 
     def keys
-      [key] if key.is_a?(Symbol)
+      return [key] unless key.to_s.include?(".")
 
-      key.to_s.delete(":").split(".")
+      deflat_key
     end
 
     private
@@ -46,5 +46,26 @@ module ErrorBuilder
         raise ArgumentError, "Unsupported message format: #{format}"
       end
     end
+
+    def deflat_key
+      key
+        .to_s
+        .split(".")
+        .flat_map { |part| part.split(/[\[\]]+/) }
+        .reject(&:empty?)
+        .map { |part| parse_part(part) }
+    end
+
+    def parse_part(part)
+      if integer?(part)
+        part.to_i
+      else
+        key.is_a?(String) ? part : part.to_sym
+      end
+    end
+
+    def integer?(part)
+      part.match?(/\A\d+\z/)
+    end
   end
 end

data/lib/error_builder/format_resolver.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ErrorBuilder
+  class FormatResolver
+    attr_reader :format
+
+    def initialize(format)
+      @format = format
+    end
+
+    def formatter
+      return built_in_formatter unless format.is_a?(Class)
+
+      format
+    end
+
+    def built_in_formatter
+      case format
+      when :array
+        Formats::Array
+      when :hash
+        Formats::Hash
+      else
+        raise ArgumentError, "Unsupported format: #{format}"
+      end
+    end
+  end
+end

data/lib/error_builder/formats/array.rb

@@ -4,22 +4,36 @@ module ErrorBuilder
   module Formats
     class Array < Base
       def to_h
-        formatted = errors.map do |error|
-          build_nested_error(error.keys, error.message)
-        end
+        errors.each_with_object([]) do |error, array|
+          keys = flat ? [error.key] : error.keys
 
-        { errors: formatted }
+          build_nested_error(array, keys, error.message)
+        end
       end
 
       private
 
-      def build_nested_error(keys, value)
+      def build_nested_error(array, keys, value)
         key = keys.shift
 
         if keys.empty?
-          [{ key: key.to_sym, value: value }]
+          array << [key, value]
+        else
+          nested_array = find_or_create_nested_array(array, key)
+
+          build_nested_error(nested_array, keys, value)
+        end
+      end
+
+      def find_or_create_nested_array(array, key)
+        existing = array.find { |e| e.is_a?(::Array) && e.first == key }
+
+        if existing
+          existing[1]
         else
-          [{ key: key.to_sym, value: build_nested_error(keys, value) }]
+          new_array = [key, []]
+          array << new_array
+          new_array[1]
         end
       end
     end

data/lib/error_builder/formats/base.rb

@@ -3,10 +3,11 @@
 module ErrorBuilder
   module Formats
     class Base
-      attr_reader :errors
+      attr_reader :errors, :flat
 
-      def initialize(errors)
+      def initialize(errors, flat: false)
         @errors = errors
+        @flat   = flat
       end
 
       def to_h

data/lib/error_builder/formats/hash.rb

@@ -4,24 +4,34 @@ module ErrorBuilder
   module Formats
     class Hash < Base
       def to_h
-        formatted = errors.each_with_object({}) do |error, hash|
-          set_nested_key(hash, error.keys, error.message)
-        end
+        errors.each_with_object({}) do |error, hash|
+          keys = flat ? [error.key] : error.keys
 
-        { errors: formatted }
+          add_nested_key(hash, keys, error.message)
+        end
       end
 
       private
 
-      def set_nested_key(hash, keys, value)
+      def add_nested_key(hash, keys, value)
         key = keys.shift
 
         if keys.empty?
-          hash[key.to_sym] = value
+          add_message(hash, key, value)
         else
-          hash[key.to_sym] ||= {}
+          hash[key] ||= {}
 
-          set_nested_key(hash[key.to_sym], keys, value)
+          add_nested_key(hash[key], keys, value)
+        end
+      end
+
+      def add_message(hash, key, value)
+        if value.is_a?(::Array)
+          hash[key] ||= []
+
+          hash[key] += value
+        else
+          hash[key] = value
         end
       end
     end

data/lib/error_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErrorBuilder
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: error_builder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mykhailo Marusyk
 bindir: exe
 cert_chain: []
-date: 2025-04-05 00:00:00.000000000 Z
+date: 2025-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -43,6 +43,7 @@ files:
 - lib/error_builder/configuration.rb
 - lib/error_builder/engine.rb
 - lib/error_builder/error.rb
+- lib/error_builder/format_resolver.rb
 - lib/error_builder/formats/array.rb
 - lib/error_builder/formats/base.rb
 - lib/error_builder/formats/hash.rb
@@ -55,7 +56,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/mmarusyk/error_builder
   source_code_uri: https://github.com/mmarusyk/error_builder
-  changelog_uri: https://github.com/yourusername/error_builder/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/mmarusyk/error_builder/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib