awesome_errors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0951933e2b1086c2892f460f6b9638ef8efe84ad46c1e6ac7dc6c24a466ba948'
+  data.tar.gz: d3e4e426890d0bafa9abca9cff9582cf774c21c66803d32175597c3496a212a8
+SHA512:
+  metadata.gz: 70517d7f974670e8d3f77fabacd2ac4d95b2c37cf33e77273a3206fdb373f4c219d0ef5b1363254b54658f4f082b793109e7576584ce5a4cce4df4b7d2ae977c
+  data.tar.gz: 7688f227d3b823506f3abd43f3298b43313baf9bf5692e967217a7e1db8840013dee70bc35c0348fafce0b007eb0f5b46e912d838a5807cad02ce16c94b91fd2

data/.byebug_history

@@ -0,0 +1,9 @@
+exit
+c
+@errors.size
+@errors << error
+@errors << errpr
+@errors.size
+errors.first == error
+errors.first
+error

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,39 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+
+inherit_from:
+  - .rubocop_rspec.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7.2
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/**/**'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'awesome_errors.gemspec'

data/.rubocop_rspec.yml

@@ -0,0 +1,15 @@
+require:
+  - rubocop-rspec
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/Dialect:
+  PreferredMethods:
+    setup: before
+
+RSpec/NestedGroups:
+  Max: 6

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in awesome_errors.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry-byebug"
+end
+
+group :test do
+  gem "rspec-github", require: false
+  gem "simplecov", "~> 0.21.2", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    awesome_errors (0.1.0)
+      zeitwerk (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.2)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-github (2.3.1)
+      rspec-core (~> 3.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  awesome_errors!
+  bundler (~> 2.3)
+  pry-byebug
+  rake (~> 12.3, >= 12.3.3)
+  rspec (~> 3.0)
+  rspec-github
+  rubocop (~> 1.7)
+  rubocop-performance
+  rubocop-rspec
+  simplecov (~> 0.21.2)
+
+BUNDLED WITH
+   2.3.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Rui Freitas
+
+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,96 @@
+# AwesomeErrors
+
+Easily add errors to your service objects and classes. `AwesomeErrors` is inspired by the `ActiveModel::Errors` API, but ensures that each error contains an error `code` attribute and is not concerned with translating error messages.
+
+## Installation
+
+Install from RubyGems by adding it to your `Gemfile`, then bundling.
+
+```ruby
+# Gemfile
+gem 'awesome_errors'
+```
+
+## Usage
+
+Include `AwesomeErrors` in your class:
+
+```ruby
+class ApplicationService
+  include AwesomeErrors
+
+  # ...
+end
+
+service = ApplicationService.new
+service.errors # => []
+```
+
+or set up the errors object manually
+
+```ruby
+class ApplicationService
+    def errors
+      @errors ||= AwesomeErrors::Errors.new
+    end
+  # ...
+end
+
+service = ApplicationService.new
+service.errors # => []
+```
+
+By default, errors are added with the an `:invalid` code and `"is invalid"` message:
+
+```ruby
+errors = AwesomeErrors::Errors.new
+errors.add(:name)
+errors.first.key # => :name
+errors.first.code # => :invalid
+errors.first.message # => "is invalid"
+```
+
+But you can specify a custom `code`, `message` and `metadata`
+
+```ruby
+errors = AwesomeErrors::Errors.new
+errors.add(:name, code: :too_long, message: "is too long", metadata: { line: 1, column: 6 })
+errors.first.key # => :name
+errors.first.code # => :too_long
+errors.first.message # => "is too long"
+errors.first.metadata # => { line: 1, column: 6 }
+```
+
+## Example
+
+```ruby
+class SendApiRequest
+    include AwesomeErrors
+
+    def call
+        if api_response.success?
+          # do something
+        else
+            errors.add(:api, code: :failed_request, message: "failed request")
+        end
+    end
+end
+```
+
+## Why this gem?
+
+I have used `ActiveModel::Errors` in many service objects and Ruby classes and enjoy its API, but often I am forced to add methods related to the translation of messages that I wouldn't need. Also, `ActiveModel::Errors` allows you to add errors where the message will be used as the error `type`, and I wanted to ensure a more consistent experience of always having an error `code` that is `Symbol` or an `Integer` so that services and objects can exchange errors while being able to rely on the `code` to better construct a user-facing error message.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/awesome_errors.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/awesome_errors/error.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AwesomeErrors
+  class Error
+    attr_reader :key, :code, :message, :metadata
+
+    def initialize(key:, code: :invalid, message: "is invalid", metadata: {})
+      raise ArgumentError unless code.is_a?(Symbol) || code.is_a?(Integer)
+
+      @key = key
+      @code = code
+      @message = message
+      @metadata = metadata
+
+      freeze
+    end
+
+    def full_message(include_key: true)
+      if include_key
+        [key, message].compact.join(" ")
+      else
+        message
+      end
+    end
+
+    def to_hash(full_message: false)
+      message_method = full_message ? :full_message : :message
+      {
+        key: key,
+        code: code,
+        message: public_send(message_method),
+        metadata: metadata
+      }
+    end
+
+    def ==(other)
+      return false unless other.is_a?(AwesomeErrors::Error)
+
+      to_hash == other.to_hash
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      to_hash.hash
+    end
+  end
+end

data/lib/awesome_errors/errors.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module AwesomeErrors
+  class Errors
+    include Enumerable
+
+    extend Forwardable
+
+    def_delegators :@errors, :each, :clear, :empty?, :size, :uniq!
+
+    attr_reader :errors
+
+    def initialize
+      @errors = Set.new
+    end
+
+    def [](key)
+      @errors.filter_map { |error| error.message if error.key == key }
+    end
+
+    def keys
+      @errors.map(&:key).uniq.freeze
+    end
+
+    def add(key, **options)
+      error = Error.new(key: key.to_sym, **options)
+      @errors << error
+
+      error
+    end
+
+    def merge!(other)
+      other.errors.each do |error|
+        import(error)
+      end
+    end
+
+    def import(error)
+      @errors << error
+    end
+
+    def as_json(options = {})
+      to_hash(full_messages: options[:full_messages] || false)
+    end
+
+    def to_hash(full_messages: false)
+      message_method = full_messages ? :full_message : :message
+      group_by_key.transform_values do |err_objects|
+        err_objects.map(&message_method)
+      end
+    end
+
+    def group_by_key
+      errors.group_by(&:key)
+    end
+
+    def messages
+      hash = to_hash
+      hash.default = [].freeze
+      hash.freeze
+      hash
+    end
+
+    def messages_for(key)
+      @errors.filter_map { |error| error.message if error.key == key }
+    end
+
+    def full_messages
+      errors.map(&:full_message)
+    end
+  end
+end

data/lib/awesome_errors/version.rb

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

data/lib/awesome_errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.ignore(
+    "#{__dir__}/awesome_errors/version.rb"
+  )
+end.setup
+
+module AwesomeErrors
+  require_relative "awesome_errors/version"
+
+  def self.included(base)
+    base.include(InstanceMethods)
+  end
+
+  module InstanceMethods
+    def errors
+      @errors ||= AwesomeErrors::Errors.new
+    end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: awesome_errors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rui Freitas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: AwesomeErrors is a simply way to add errors to your Ruby objects and
+  classes.
+email:
+- rui.ferreira.freitas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_rspec.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/awesome_errors.rb
+- lib/awesome_errors/error.rb
+- lib/awesome_errors/errors.rb
+- lib/awesome_errors/version.rb
+homepage: https://github.com/rodloboz/awesome_errors
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rodloboz/awesome_errors
+  source_code_uri: https://github.com/rodloboz/awesome_errors
+  changelog_uri: https://github.com/rodloboz/awesome_errors/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Easily add errors to your service objects and Ruby classes.
+test_files: []