Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fidme/active_flags
Rails engine that allows you to flag any model instance. Get rid of all those useless booleans !
https://github.com/fidme/active_flags
flags gem rails ruby
Last synced: 24 days ago
JSON representation
Rails engine that allows you to flag any model instance. Get rid of all those useless booleans !
- Host: GitHub
- URL: https://github.com/fidme/active_flags
- Owner: FidMe
- License: mit
- Created: 2019-03-06T10:21:44.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-28T09:59:18.000Z (over 4 years ago)
- Last Synced: 2024-12-16T00:48:45.060Z (about 1 month ago)
- Topics: flags, gem, rails, ruby
- Language: Ruby
- Size: 76.2 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# ActiveFlags
[](https://travis-ci.org/FidMe/active_flags)
[](https://badge.fury.io/rb/active_flags)
Active Flags allows you to use automatic flags on models. You won't have to create useless booleans with view logic in your core tables. They should not have been there in the first place, let Active Flags handle them for you!
## Installation
(You need at least rails 5.0 to use the gem)
Add this line to your application's Gemfile:
```ruby
gem 'active_flags'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install active_flags
```
Then import Active Flags' migrations
```bash
$ bin/rails active_flags:install:migrations
```
Adapt them if needed and run db:migrate
```bash
$ rails db:migrate
```
## Usage
Let's say you're building a networking app, with users connecting each other.
But you want it to be so relevant that it only makes active users (connecting often enough) visibles on the search.
To do so you would add a boolean `active` or `visible` in your user's table.
It works, but it is view logic and shouldn't be there. Imagine your app is growing and you have 10 more booleans on your user table, and then 10 more on another model. It will only pollute your tables.
Once Active Flags is set, you can easily declare that your model has flags like that:
```ruby
class User < ApplicationRecord
has_flags :visible, :active
end
```
And that's it!
You can now add flags on a user like that:
```ruby
user.flags = { visible: true, active: true }
user.save!
```
A flag won't be saved if you don't explicitly declare it as has_flags attributes in the model.
But if you do not want to handle explicit flags, you could also declare:
```ruby
class User < ApplicationRecord
has_flags
end
```
And then you can declare as much flags as you want with no restriction:
```ruby
user.update!(flags: { visible: true, active: true, diet: 'vegan', power: 'super saiyan' })
```
To access your flags, you now have 2 ways.
Either as a hash, with the `flags` method or as an ActiveFlag::Flag collection with the `flags_as_collection` method.
Note: You can call `converted_value` on an `ActiveFlag::Flag` instance returned by flags_as_collection, to retrieved your 'true' or 'false' value as a boolean.
## Flags as scopes
When you develop an app without active_flags, you will generally query the equivalent of flags as simple booleans.
ActiveFlags gives you a clean and simple way to query your model based on defined flags.
Any flag can be queried as a scope using the `flagged_as` method
```ruby
user = User.create!(flags: { visible: true })
User.flagged_as_visible
# #]>
User.flagged_as_visible(false)
# #
User.flagged_as_intelligent
# #
user.update!(flags: { intelligent: true })
User.flagged_as_intelligent
# #]>
user.update!(flags: { intelligent: 'a bit' })
User.flagged_as_intelligent('a_bit')
# #]>
```
To query flags the other way around you can use the `not_flagged_as` method
```ruby
User.not_flagged_as_intelligent
# or with value
User.not_flagged_as_intelligent('a bit')
```
## Contributing
https://github.com/FidMe/active_flags
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).