⚡️ Lightning

An end-to-end feature flagging system that can be setup in <1 minute.

Lightning is a rails gem you can install into your Rails application to get both console and UI access to manage feature flags. Lightning saves you time to avoid building an in-house solution.

Install

Add the following link to Gemfile

gem 'lightningff', require: 'lightning'

and run bundle install. Note: You might need to run bundle update to resolve any incompatible issues with rails.

Script Installation

Run the following script to install the entire feature flag functionality without manual setup for your models (i.e. User, Workspace)

rails lightning:install User Workspace

If you want more control over the setup, run the command below and check out Manual Installation and skip the migrations part

rails lightning:install

Manual Installation

Set up feature flag migrations by running the following lines

bin/rails lightning:install:migrations
bin/rails db:migrate SCOPE=lightning

Create config/initializers/lightning.rb and set your flaggable entities

Lightning.flaggable_entities = ["User", "Workspace"]

For each flaggable model, add include Lightning::Flaggable.

class User < ApplicationRecord
  include Lightning::Flaggable
end

Usage

user = User.create(name: 'Dummy user')

# Check if feature is enabled for entity
Lightning.enabled?(user, 'homepage_v2')

# Opt in an entity
Lightning.opt_in('homepage_v2', user)

# Opt out an entity
Lightning.opt_out('homepage_v2', user)

# List entities opted in to a feature
Lightning.opt_ins('hompage_v2')

UI setup

Mount engine in routes.rb file

Rails.application.routes.draw do
  mount Lightning::Engine => "/lightning"
end

API

Create feature (state is disabled)

Lightning.create!('homepage_v2', 'New homepage with better logo')

Find a feature by key

Lightning.get('homepage_v2')

List all features

Lightning.list

Update feature state/description

Lightning.update('homepage_v2', { state: 'enabled_per_entity', description: 'Homepage with new nav' })

Delete feature

Lightning.delete('homepage_v2')

Advanced Configuration

Lightning makes is super easy to configure how data is represented through the UI.

Running Tests

To run the test suite, pull the repo locally and run rspec spec/. All tests live in the spec/ folder.

Contributing

You need to have ruby version 2.7.3 installed locally and rails version 6.1.3.

cd test/dummy
bundle install
bin/rails db:create
bin/rails db:migrate
bin/rails server

License

The gem is available as open source under the terms of the MIT License.