Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hakamadare/rubygem-bsd_wtf
Rubygem to wrap BSD wtf
https://github.com/hakamadare/rubygem-bsd_wtf
Last synced: about 19 hours ago
JSON representation
Rubygem to wrap BSD wtf
- Host: GitHub
- URL: https://github.com/hakamadare/rubygem-bsd_wtf
- Owner: hakamadare
- License: mit
- Created: 2017-12-12T21:50:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T19:20:34.000Z (about 1 month ago)
- Last Synced: 2025-01-19T04:27:13.187Z (2 days ago)
- Language: Ruby
- Homepage: https://rubygems.org/gems/bsd_wtf
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# BsdWtf [![Travis](https://img.shields.io/travis/hakamadare/rubygem-bsd_wtf.svg)]()
This gem wraps the [BSD wtf](https://www.freebsd.org/cgi/man.cgi?query=wtf&manpath=NetBSD+7.1) command in a Ruby interface.
The `wtf` executable must already be present on this system and located in `$PATH`.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'bsd_wtf'
```And then execute:
$ bundle
Or install it yourself as:
$ gem install bsd_wtf
## Usage
```ruby
$ irb -r bsd_wtf
irb(main):001:0> BsdWtf.wtf("wtf")
=> {:success=>[{:acronym=>"WTF", :definition=>"where's the food"}], :failure=>[]}
irb(main):002:0> BsdWtf.wtf(["wtf","lolwut"]).to_json
=> "{\"success\":[{\"acronym\":\"WTF\",\"definition\":\"where's the food\"}],\"failure\":[\"lolwut\"]}"
```## 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`.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/hakamadare/rubygem-bsd_wtf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## 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 BsdWtf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hakamadare/rubygem-bsd_wtf/blob/master/CODE_OF_CONDUCT.md).