Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AlexWayfer/sequel-enum_values
Sequel plugin that provides method for getting `pg_enum` values
https://github.com/AlexWayfer/sequel-enum_values
ruby sequel sequel-enum-values sequel-plugin
Last synced: about 2 months ago
JSON representation
Sequel plugin that provides method for getting `pg_enum` values
- Host: GitHub
- URL: https://github.com/AlexWayfer/sequel-enum_values
- Owner: AlexWayfer
- License: mit
- Created: 2017-10-16T17:43:21.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T08:45:33.000Z (about 2 months ago)
- Last Synced: 2024-08-06T04:59:18.103Z (about 2 months ago)
- Topics: ruby, sequel, sequel-enum-values, sequel-plugin
- Language: Ruby
- Size: 116 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Sequel enum_values plugin
[](https://cirrus-ci.com/github/AlexWayfer/sequel-enum_values)
[](https://codecov.io/gh/AlexWayfer/sequel-enum_values)
[](https://codeclimate.com/github/AlexWayfer/sequel-enum_values)
[](https://depfu.com/repos/github/AlexWayfer/sequel-enum_values)
[](https://inch-ci.org/github/AlexWayfer/sequel-enum_values)
[](https://rubygems.org/gems/sequel-enum_values)
[](LICENSE.txt)
A Sequel plugin that provides `enum_values(field)` method to your models.
## Installation
### Bundler
Add this line to your project's Gemfile:
```ruby
gem 'sequel-enum_values', require: 'sequel/plugins/enum_values'
```
And then execute:
```
$ bundle
```
### Manually
Install this gem as:
```
$ gem install sequel-enum_values
```
And then require it in your project:
```ruby
require 'sequel/plugins/enum_values'
```
## Usage
If you have database schema like this:
```ruby
create_enum :item_type, %w[first second third]
create_enum :item_status, %w[created selected canceled]
create_table :items do
primary_key :id
column :type, :item_type
column :status, :item_status
end
```
Then you can use it like this:
```ruby
class Item < Sequel::Model
plugin :enum_values
end
Item.enum_values(:type) # => ["first", "second", "third"]
Item.enum_values(:status) # => ["created", "selected", "canceled"]
```
### Caching
Plugin caches enum values for each field by default.
But you can disable it:
```ruby
Item.plugin :enum_values, caching: false
```
### Predicate methods
Plugin can define instance methods for all enum values:
```ruby
Item.plugin :enum_values, predicate_methods: true # default is `false`
item = Item.new(type: 'first', status: 'created')
item.first? # => true
item.second? # => false
item.created? # => true
item.selected? # => false
```
Or just for specific fields:
```ruby
Item.plugin :enum_values, predicate_methods: %i[status]
# or just `:status` for single value
item = Item.new(type: 'first', status: 'created')
item.first? # => NoMethodError
item.created? # => true
item.selected? # => false
```
## Development
After checking out the repo, run `bundle install` to install dependencies.
Then, run `toys rspec` to run the tests.
To install this gem onto your local machine, run `toys gem install`.
To release a new version, run `toys gem release %version%`.
See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
## Contributing
Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/sequel-enum_values).
## License
The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT).