https://github.com/nxt-insurance/nxt_error_registry
Registry to organize errors in a sane way
https://github.com/nxt-insurance/nxt_error_registry
Last synced: 7 months ago
JSON representation
Registry to organize errors in a sane way
- Host: GitHub
- URL: https://github.com/nxt-insurance/nxt_error_registry
- Owner: nxt-insurance
- License: mit
- Created: 2019-03-21T14:42:28.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T07:22:55.000Z (about 1 year ago)
- Last Synced: 2024-04-25T08:29:28.591Z (about 1 year ago)
- Language: Ruby
- Homepage: https://rubygems.org/gems/nxt_error_registry
- Size: 103 KB
- Stars: 8
- Watchers: 16
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://circleci.com/gh/nxt-insurance/nxt_error_registry)
# NxtErrorRegistry
Register all your errors in a sane way.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'nxt_error_registry'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install nxt_error_registry
## Usage
```ruby
class LevelOne
extend NxtErrorRegistry
# This will set the LevelOne::LevelOneError constant that you can raise anywhere
register_error :LevelOneError, type: StandardError, code: '84b67c94-efb4-48e8-a5e9-ed1fa1beb988'
# You can also pass in additional options when registering your errors. These will be available on you error class
register_error :LevelTwoError, type: LevelOneError, code: 'a7fc9a8c-9f83-4a2d-8808-75dbef8e376f', capture: true, reraise: false
def raise_level_one_error
raise LevelOneError, 'There was an error on level'
rescue LevelOneError => e
puts e.code # would output '100.100'
rescue LevelTwoError => e
puts e.options # { capture: true, reraise: false }
end
end
```
`register_error` will make sure that the code was not already registered anywhere else in your app.
### Generate an register_error statement to include in your code with the rails generator
All arguments are optional and will be set to a placeholder if not provided
```ruby
rails g register_error --name NewErrorName --type SomeKindOfError
# => register_error :NewErrorName, type: SomeKindOfError, code: 'fa7afa83-6c68-4186-ada4-a573b6a72bd9'
```
### Or use the rake task instead.
All arguments are optional and will be set to a placeholder if not provided
```ruby
rake nxt_error_registry:generate_code\[ErrorName,ParentType\]
# => register_error :ErrorName, type: ParentType, code: '5c8152cd-b8b9-4fb0-a5fe-5c11d200affc'
```
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/nxt-insurance/nxt_error_registry.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).