Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kanety/enum_ish
A ruby and rails extension to generate enum-like methods.
https://github.com/kanety/enum_ish
Last synced: 2 months ago
JSON representation
A ruby and rails extension to generate enum-like methods.
- Host: GitHub
- URL: https://github.com/kanety/enum_ish
- Owner: kanety
- License: mit
- Created: 2018-02-14T02:18:17.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T00:43:10.000Z (3 months ago)
- Last Synced: 2024-10-21T04:07:21.739Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 105 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EnumIsh
A ruby and rails extension to generate enum-like methods.
## Dependencies
* ruby 2.3+
* activerecord 5.0+
* activesupport 5.0+
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'enum_ish'
```
Then execute:
$ bundle
## Usage
Extend your class using EnumIsh and define an enum-like field:
```ruby
class User
include EnumIsh::Base
attr_accessor :status # status is a string field
enum_ish :status, ['enable', 'disable'] # status has 'enable' or 'disable'
end
```
Then define i18n translations (example below shows japanese translations):
```yaml
ja:
enum_ish:
user:
enable: 有効
disable: 無効
```
Enum-like methods are generated as follows:
```ruby
user = User.new
user.status = 'enable'
user.status_text #=> "有効"
User.status_options #=> [["有効", "enable"], ["無効", "disable"]]
User.status_options(only: 'enable') #=> [["有効", "enable"]]
User.status_options(except: 'enable') #=> [["無効", "disable"]]
```
### Additional translations
Define additional translations:
```yaml
ja:
enum_ish:
user:
status:
enable: 有効
disable: 無効
status/short:
enable: 有
disable: 無
```
```ruby
user = User.new
user.status = 'enable'
user.status_text(format: :short) #=> "有"
User.status_options(format: :short) #=> [["有", "enable"], ["無", "disable"]]
```
### Default value
Set default value:
```ruby
class User
include EnumIsh::Base
attr_accessor :status
enum_ish :status, ['enable', 'disable'], default: 'enable'
end
user = User.new
user.status #=> "enable"
```
Use default value with block:
```ruby
class User
include EnumIsh::Base
attr_accessor :status, :flag
enum_ish :status, ['enable', 'disable'], default: -> { flag ? 'enable' : 'disable' }
end
user = User.new
user.status #=> "disable"
```
### Predicates
Generate predicate methods:
```ruby
class User
include EnumIsh::Base
attr_accessor :status
enum_ish :status, ['enable', 'disable'], predicate: true
end
user = User.new
user.status = 'enable'
user.status_enable? #=> true
user.status_disable? #=> false
```
Without prefix:
```ruby
class User
include EnumIsh::Base
attr_accessor :status
enum_ish :status, ['enable', 'disable'], predicate: { prefix: false }
end
user = User.new
user.status = 'enable'
user.enable? #=> true
user.disable? #=> false
```
### Accessor
Generate getter and setter for aliased symbols instead of raw values:
```ruby
class User
include EnumIsh::Base
attr_accessor :status
enum_ish :status, { _enable: 'enable', _disable: 'disable' }, accessor: true
end
user = User.new
user.status = :_enable
user.status #=> :_enable
user.status_raw #=> "enable"
```
### ActiveRecord features
#### Accessor
Generate accessor:
```ruby
class User < ActiveRecord::Base
include EnumIsh::Base
enum_ish :status, { _enable: 'enable', _disable: 'disable' }, accessor: true
end
User.where(status: :_enable) #=> SELECT "users".* FROM "users" WHERE "users"."status" = "enable"
```
#### Scope
Generate scope:
```ruby
class User < ActiveRecord::Base
include EnumIsh::Base
enum_ish :status, ['enable', 'disable'], scope: true
end
User.with_status(:enable) #=> SELECT "users".* FROM "users" WHERE "users"."status" = "enable"
User.with_status_not(:enable) #=> SELECT "users".* FROM "users" WHERE "users"."status" != 'enable'
```
#### Validation
Generate validation:
```ruby
class User < ActiveRecord::Base
include EnumIsh::Base
enum_ish :status, ['enable', 'disable'], validate: true
end
user = User.new
user.status = 'INVALID'
user.valid? #=> false
```
### Dictionary cache
You can enable dictionary cache using rack middleware:
```ruby
Rails.application.config.middleware.use EnumIsh::DictionaryCache
```
This middleware enables dictionary cache for each request.
Performance of dictionary lookup will be improved in case one dictionary is used repeatedly in the same request.
## Contributing
Bug reports and pull requests are welcome at https://github.com/kanety/enum_ish.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).