https://github.com/ess/needful_things-ruby
https://github.com/ess/needful_things-ruby
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ess/needful_things-ruby
- Owner: ess
- License: mit
- Created: 2020-12-25T12:51:30.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2020-12-25T13:03:59.000Z (over 5 years ago)
- Last Synced: 2025-06-06T03:04:35.912Z (about 1 year ago)
- Language: Ruby
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# NeedfulThings #
A required hash fields checker. At present, it rolls with the assumption that not only is the hash key present, but its associated value is also non-nil.
## Installation ##
Add this line to your application's Gemfile:
```ruby
gem 'needful_things'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install needful_things
## Usage ##
In lieu of real documentation, here's an example.
```ruby
require 'needful_things'
class SomeOperation
include NeedfulThings
needs name: :widget_id, otherwise: :widget_id_not_present
def call(input = {})
neediness(input) do |needs|
needs.fulfilled do
true
end
needs.unmet do |reason|
false
end
end
end
end
```
## Development ##
After checking out the repo, run `bin/setup` to install dependencies. 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/ess/needful_things.
## License ##
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).