https://github.com/satoryu/undine
Open your browser for searching the message of an unrescued exception.
https://github.com/satoryu/undine
developer-tools exception-handling ruby rubygem
Last synced: 11 months ago
JSON representation
Open your browser for searching the message of an unrescued exception.
- Host: GitHub
- URL: https://github.com/satoryu/undine
- Owner: satoryu
- License: mit
- Created: 2020-04-22T01:45:20.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-29T06:33:17.000Z (about 6 years ago)
- Last Synced: 2025-07-24T09:06:43.205Z (11 months ago)
- Topics: developer-tools, exception-handling, ruby, rubygem
- Language: Ruby
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Undine
[](https://badge.fury.io/rb/undine)
[](https://travis-ci.org/satoryu/undine)
Undine is a gem to help your development experience: When an exception unrescued in your code is raised, opens google search with the errror message in your browser.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'undine', group: :development
```
And then execute:
```sh
bundle install
```
Or install it yourself as:
```sh
gem install undine
```
## Usage
Just `require 'undine'` and `Undine.load`. That's it.
### Example
```ruby
require 'undine'
Undine.load
def something_function
'hoge'.foo
rescue => e
warn e.message
raise e
end
something_function
```
`Undine.load` registers a post process to catch an unrescued exception and google its message.
In this code, `NoMethodError` raises as `String` does not have `foo` method.
As executing this code, you are going to see google search page with the error message: https://www.google.com/search?q=undefined+method+%60foo%27+for+%22hoge%22%3AString%0ADid+you+mean%3F++for
## Configuration
`Undine.configure` is for users to customize behavior of `Undine`.
The method gives a given block `Undine::Configuration` object.
```ruby
Undine.configure do |config|
config.query_message_from = :message.to_proc # default
config.except_for = SystemExit # default
end
```
## 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/satoryu/undine. 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/satoryu/undine/blob/master/CODE_OF_CONDUCT.md).
## 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 Undine project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/satoryu/undine/blob/master/CODE_OF_CONDUCT.md).