[![CircleCI](https://circleci.com/gh/faizalzakaria/fflags/tree/master.svg?style=svg)](https://circleci.com/gh/faizalzakaria/fflags/tree/master)
[![Maintainability](https://api.codeclimate.com/v1/badges/2c8af5d2a0560570a5b7/maintainability)](https://codeclimate.com/github/faizalzakaria/fflags/maintainability)

# FFlags

Feature flags that can be overwritten on the fly. It could be per instance or per environment. Depending on how you set your key, either dynamically per instance or constant per environment.

It uses Redis to store the information, and the size should be very small, depending on how many flags you need to track.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'fflags'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install fflags
    
    
## How to Configure FFlags

To configure the FFlags, 

```ruby
FFlags.config { |config .. }
```

#### Supported Configs

| Config    | Description       | Default |
|-----------|-------------------|---------|
| key       | Key to store the flags, in Redis, it would look something like, `{ key: <flags as a Hash> }` | code3.io |
| flags     | Flags to be tracked as a Hash, and value as a boolean) | {} |
| redis_url | Redis url, where the flags will be stored | redis://127.0.0.1:6379 |
| debug     | For debugging, NOT BEING USED RIGHT NOW | false |

## Example of Usage

- If you want the flags to be unique per instance, you can use hostname of the instance as such:

```ruby
FFlags.config do |config|
  config.key   = Socket.gethostname
  config.flags = { new_view: true }
end
```

- If you want the flags to be unique per environment, you can use the key as such:

```ruby
FFlags.config do |config|
  config.key   = Rails.environment,
  config.flags = { new_view: true }
end
```

Then in the code,

```ruby
# Verify if the flag is enabled
if FFlags.enabled?(:new_view)
  # Do something
end
# or
if FFlags.new_view?
  # Do something
end


# Overwrite flag
FFlags.toggle(:new_view)
# or
FFlags.set(:new_view, false)

# To reset, and get back to the default settings.
FFlags.reset

# To read all flags
FFlags.all
```

## Development

After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests.

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/faizalzakaria/fflags.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).