The project is in a healthy, maintained state
A Rails engine which can be used to activate and deactivate feature toggles
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Project Readme

Defra Ruby Features

Build Status Maintainability Rating Coverage security Gem Version Licence

A Rails Engine used by the Ruby services team in their digital services.

We use it to set, update and delete feature toggles on our rails services.

When mounted in an app, it will add additional endpoints and views to manage feature toggles.

Things to note

  • We have gone with an engine rather than an additional service, to simplify management of feature toggles in our environments

Prerequisites

Make sure you already have:

  • Ruby 2.7.1
  • Bundler – for installing Ruby gems

Mounting the engine

Add the engine to your Gemfile:

gem "defra_ruby_features",
    git: "https://github.com/DEFRA/defra-ruby-features"

Install it with bundle install.

Then mount the engine in your routes.rb file:

Rails.application.routes.draw do
  mount DefraRubyFeatures::Engine => "/defra-ruby-featuress"
end

The engine should now be mounted at /defra-ruby-features of your project. You can change "/defra-ruby-features" to a different route if you'd prefer it to be elsewhere.

Configuration

For the feature toggles to be persisted, you need to create a model class with a String attribute called key and a Boolean attribute named active.

This will work with MongoId models as well as ActiveRecord models.

# config/initializers/defra_ruby_features.rb
require "defra_ruby_features"

DefraRubyFeatures.configure do |config|
  config.feature_toggle_model_name = "FeatureToggle"
end

Testing the engine

The engine is mounted in a dummy Rails 6 app (in /spec/dummy) so we can properly test its behaviour.

The test suite is written in RSpec.

To run all the tests, use bundle exec rspec.

Contributing to this project

If you have an idea you'd like to contribute please log an issue.

All contributions should be submitted via a pull request.

License

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3

The following attribution statement MUST be cited in your products and applications when using this information.

Contains public sector information licensed under the Open Government license v3

About the license

The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.

It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.