Lite::Errors

Lite::Errors provides an API for generating and accessing error messages. The API is ~90% compatible with ActiveModel::Errors except that it returns hashes instead of error objects (use Rails =< 6.0 documentation). There are few extra handy methods for interacting with errors so we encourage you to look through the lib files.

NOTE: If you are coming from ActiveErrors, please read the port section.

Installation

Add this line to your application’s Gemfile:

gem 'lite-errors'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lite-errors

Table of Contents

• Usage
• Port

Usage

class Shipment

  def errors
    @errors ||= Lite::Errors::Messages.new
  end

  def messages
    @errors.full_messages
  end

  def process
    ShipmentItem.each do |item|
      item.add_to_box!
    rescue Shipment::OutOfStock => e
      errors.add(item.name, :out_of_stock)
    rescue Shipment::DoesNotExist => e
      errors[item.name] = I18n.t('errors.does_not_exist')
    rescue ActiveRecord::RecordInvalid
      errors.merge!(item.errors)
    end
  end

end

Port

Lite::Errors is a compatible port of ActiveErrors.

Switching is as easy as renaming ActiveError::Messages to Lite::Errors::Messages.

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lite-errors. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Lite::Errors project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.