error_builder 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17afb5de8cfc97f5dc0d6618ae6397e938c64b3abe36de5fae6e9fd12b54173c
+  data.tar.gz: e06de617586f31e251e154dc7b7c7abbbf92a5f04e7c73ba0ceb8ba4bb17ca6b
+SHA512:
+  metadata.gz: 04abd9e0e2ad14d96a78ce758cbe5788dfa8f6488b6d58fcfe0831855a26a5ce2f05a7a090d22fb7e469436c8bf5957517636a4d23863409fd488582d2cae048
+  data.tar.gz: '0394b4e8612224edc4cd25b677a02788ddb663a0a803f55abe0535b4157075a6aae5281f6a4683b8af59164f302b8c7d8b04d0065f01cff320f6c2e73531a608'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/spec/**/*_spec.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-30
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Michael Marusyk
+
+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/README.md

@@ -0,0 +1,94 @@
+# ErrorBuilder
+
+This is a Ruby gem that allows you to build structured error objects in a flexible and configurable way.
+
+## Requirements
+
+Before you begin, ensure you have met the following requirements:
+
+- Ruby version 3.1.0 or newer. You can check your Ruby version by running `ruby -v`.
+- Bundler installed. You can install Bundler with `gem install bundler`.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add error_builder
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install error_builder
+
+## Usage
+
+### Configuration
+
+If you have to use in Rails:
+1. Add to `Gemfile`
+```ruby
+  gem 'error_builder'
+```
+
+2. Run `bundle i`
+
+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.message_format = :string # Supported formats: :string, :array
+end
+```
+
+### How To Use
+
+1. Create an Error Engine
+```ruby
+errors = ErrorBuilder::Engine.new
+```
+
+2. Add Errors
+```ruby
+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"] } }
+```
+
+### Including in Classes
+You can include ErrorBuilder in your classes to use the `errors` method:
+```ruby
+class MyService
+  include ErrorBuilder
+
+  def call 
+    errors.add(:base, "Something went wrong")
+
+    true
+  end
+end
+
+my_service = MyService.new
+my_service.call
+my_service.errors.to_h    #=> { errors: { base: ["Something went wrong"] } }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. Then, eun `rake rubocop` to run the rubocop. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mmarusyk/error_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mmarusyk/error_builder/blob/main/CODE_OF_CONDUCT.md). You can find a list of contributors in the [CONTRIBUTORS.md](https://github.com/mmarusyk/error_builder/blob/main/CONTRIBUTORS.md) file.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the error_builder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mmarusyk/error_builder/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/error_builder/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ErrorBuilder
+  class Configuration
+    attr_accessor :format, :message_format
+
+    def initialize
+      @format         = :hash
+      @message_format = :array
+    end
+  end
+end

data/lib/error_builder/engine.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ErrorBuilder
+  class Engine
+    attr_reader :format, :errors
+
+    def initialize(format: ErrorBuilder.configuration.format)
+      @format = format
+      @errors = []
+    end
+
+    def add(key, message)
+      error = ErrorBuilder::Error.new(key)
+      error.add_message(message)
+
+      @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
+    end
+  end
+end

data/lib/error_builder/error.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ErrorBuilder
+  class Error
+    attr_reader :key, :message, :format
+
+    def initialize(key)
+      @key     = key
+      @format  = ErrorBuilder.configuration.message_format
+      @message = initialize_message(format)
+    end
+
+    def add_message(message)
+      case format
+      when :array
+        @message << message
+      when :string
+        @message = message
+      else
+        raise ArgumentError, "Unsupported message format: #{format}"
+      end
+    end
+
+    def to_h
+      {
+        key: @key,
+        message: @message
+      }
+    end
+
+    def keys
+      [key] if key.is_a?(Symbol)
+
+      key.to_s.delete(":").split(".")
+    end
+
+    private
+
+    def initialize_message(format)
+      case format
+      when :array
+        []
+      when :string
+        ""
+      else
+        raise ArgumentError, "Unsupported message format: #{format}"
+      end
+    end
+  end
+end

data/lib/error_builder/formats/array.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ErrorBuilder
+  module Formats
+    class Array < Base
+      def to_h
+        formatted = errors.map do |error|
+          build_nested_error(error.keys, error.message)
+        end
+
+        { errors: formatted }
+      end
+
+      private
+
+      def build_nested_error(keys, value)
+        key = keys.shift
+
+        if keys.empty?
+          [{ key: key.to_sym, value: value }]
+        else
+          [{ key: key.to_sym, value: build_nested_error(keys, value) }]
+        end
+      end
+    end
+  end
+end

data/lib/error_builder/formats/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ErrorBuilder
+  module Formats
+    class Base
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+      end
+
+      def to_h
+        raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+      end
+    end
+  end
+end

data/lib/error_builder/formats/hash.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+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: formatted }
+      end
+
+      private
+
+      def set_nested_key(hash, keys, value)
+        key = keys.shift
+
+        if keys.empty?
+          hash[key.to_sym] = value
+        else
+          hash[key.to_sym] ||= {}
+
+          set_nested_key(hash[key.to_sym], keys, value)
+        end
+      end
+    end
+  end
+end

data/lib/error_builder/version.rb

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

data/lib/error_builder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module ErrorBuilder
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.included(base)
+    base.include(InstanceMethods)
+  end
+
+  module InstanceMethods
+    def errors
+      @errors ||= Engine.new
+    end
+  end
+end

data/sig/error_builder.rbs

@@ -0,0 +1,4 @@
+module ErrorBuilder
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: error_builder
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Mykhailo Marusyk
+bindir: exe
+cert_chain: []
+date: 2025-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+description: error_builder provides a customizable way to format and structure error
+  messages as arrays or hashes. It supports multiple formats, including string, array,
+  and nested hash representations.
+email:
+- misha.marusyk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/error_builder.rb
+- lib/error_builder/configuration.rb
+- lib/error_builder/engine.rb
+- lib/error_builder/error.rb
+- lib/error_builder/formats/array.rb
+- lib/error_builder/formats/base.rb
+- lib/error_builder/formats/hash.rb
+- lib/error_builder/version.rb
+- sig/error_builder.rbs
+homepage: https://github.com/mmarusyk/error_builder
+licenses:
+- MIT
+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
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A flexible Ruby gem for building structured error objects.
+test_files: []