error_craft 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b417849617fdcf77ee883aff3d83ef9c49a377716aa0b2df5efcb8f0baeabf4
+  data.tar.gz: 5f07939d1cf7aa51bfd7dc4461c6fee98869f2febd801e8d7e8c8f7b29e5d6a6
+SHA512:
+  metadata.gz: 0ee37226c6988cd0748cc906e1f7d973512f447dd7e262d2c238fe7cf6c1a8b913a565167072c66b68bde64818183e513b9147d36248f424299b6f5e01dac076
+  data.tar.gz: 75746991990bac80a35313716d73ff400ca275c51de3b08b6ef2150aa510fa8a9d883edcb9d54c6603a06a8207dbd3b41a0d12db704837cc12b69de0cecaca10

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,51 @@
+# ErrorCraft
+
+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_craft
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install error_craft
+
+## Usage
+
+### Configuration
+
+If you have to use in Rails:
+1. Add to `Gemfile`
+```ruby
+  gem 'error_craft'
+```
+
+2. Run `bundle i`
+
+## 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_craft. 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_craft/blob/main/CODE_OF_CONDUCT.md). You can find a list of contributors in the [CONTRIBUTORS.md](https://github.com/mmarusyk/error_craft/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_craft project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mmarusyk/error_craft/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_craft/builder.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ErrorCraft
+  class Builder
+    SUPPORTED_FORMATS = {
+      array: -> { [] },
+      hash: -> { {} }
+    }.freeze
+
+    def initialize(format: [])
+      @format = format || ErrorCraft.configuration.default_format
+      @errors = initialize_errors(@format)
+    end
+
+    def add_error(key, value)
+      formatted_value = format_value(value)
+
+      add_to_errors(key, formatted_value)
+    end
+
+    def build
+      @errors
+    end
+
+    private
+
+    def initialize_errors(format)
+      SUPPORTED_FORMATS.fetch(format) { raise ArgumentError, "Unsupported format: #{format}" }.call
+    end
+
+    def format_value(value)
+      case value
+      when Array then value
+      when String then [value]
+      when Hash then format_hash(value)
+      else
+        raise ArgumentError, "Invalid error value. Must be a string, array, or hash."
+      end
+    end
+
+    def format_hash(value)
+      value.transform_values { |v| format_value(v) }.then do |formatted_hash|
+        @format == :array ? hash_to_array(formatted_hash) : formatted_hash
+      end
+    end
+
+    def hash_to_array(hash)
+      hash.map { |k, v| { key: k, value: v } }
+    end
+
+    def add_to_errors(key, value)
+      case @errors
+      when Array then @errors << { key: key, value: value }
+      when Hash then @errors[key] = value
+      end
+    end
+  end
+end

data/lib/error_craft/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ErrorCraft
+  class Configuration
+    attr_accessor :default_format
+
+    def initialize
+      @default_format = :hash
+    end
+  end
+end

data/lib/error_craft/version.rb

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

data/lib/error_craft.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "error_craft/version"
+require_relative "error_craft/configuration"
+require_relative "error_craft/builder"
+
+module ErrorCraft
+  class Error < StandardError; end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/sig/error_craft.rbs

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: error_craft
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Marusyk
+bindir: exe
+cert_chain: []
+date: 2025-03-30 00:00:00.000000000 Z
+dependencies: []
+description: error_craft 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_craft.rb
+- lib/error_craft/builder.rb
+- lib/error_craft/configuration.rb
+- lib/error_craft/version.rb
+- sig/error_craft.rbs
+homepage: https://github.com/mmarusyk/error_craft
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mmarusyk/error_craft
+  source_code_uri: https://github.com/mmarusyk/error_craft
+  changelog_uri: https://github.com/yourusername/error_craft/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: []