defra_ruby_features 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9b0b518a146ea7a2c3ac516a564d94f9791c5ffd758b03240924bd4178d544c
+  data.tar.gz: e197f19c6013c8225958f51145159bcf27767b54087e28eff5243e335b4393f2
+SHA512:
+  metadata.gz: 6fe6cee2c6aeab187d325491773d93a4eb2637e006315f973060a3af84dedefe98688825787753f090105a69438832b7a6fd7b6878c78f4defd24e7bad0d562f
+  data.tar.gz: e9a3c942ad37d26e0ff1dc99d4723641ff3f260be201220a8de34abba0fd15fb779c003b9efb1652bab0b83cbc4bc380f7e1aefcf4f87d310bf168dbb540f9e6

data/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2020 Defra
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

data/README.md

@@ -0,0 +1,92 @@
+# Defra Ruby Features
+
+[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-features.svg?branch=main)](https://travis-ci.com/DEFRA/defra-ruby-features)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-features&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-features)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_defra-ruby-features&metric=coverage)](https://sonarcloud.io/dashboard?id=DEFRA_defra-ruby-features)
+[![security](https://hakiri.io/github/DEFRA/defra-ruby-features/main.svg)](https://hakiri.io/github/DEFRA/defra-ruby-features/main)
+[![Gem Version](https://badge.fury.io/rb/defra_ruby_features.svg)](https://badge.fury.io/rb/defra_ruby_features)
+[![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
+
+A Rails Engine used by the [Ruby services team](https://github.com/DEFRA/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](http://bundler.io/) – for installing Ruby gems
+
+## Mounting the engine
+
+Add the engine to your Gemfile:
+
+```ruby
+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:
+
+```ruby
+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.*
+
+
+```ruby
+# 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.

data/Rakefile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "DefraRubyFeatures"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+load "rails/tasks/statistics.rake"
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), "lib/tasks/**/*.rake")].each { |f| load f }
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+# This is wrapped to prevent an error when rake is called in environments where
+# rspec may not be available, e.g. production. As such we don't need to handle
+# the error.
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/app/controllers/defra_ruby_features/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DefraRubyFeatures
+  class ApplicationController < ::ApplicationController
+
+  end
+end

data/app/controllers/defra_ruby_features/feature_toggles_controller.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module DefraRubyFeatures
+  class FeatureTogglesController < ::DefraRubyFeatures::ApplicationController
+    before_action :authenticate_user!
+    before_action :authorize_user!
+
+    helper DeleteLinkHelper
+
+    def index
+      # MongoId
+      @feature_toggles = model.order(key: "ASC") if model.respond_to?(:order)
+
+      # ActiveRecord
+      @feature_toggles = model.order_by(key: "ASC").all if model.respond_to?(:order_by)
+    end
+
+    def create
+      model.create!(feature_toggle_params)
+
+      redirect_to feature_toggles_path
+    end
+
+    def update
+      @feature_toggle = model.find_by(id: params[:id])
+
+      @feature_toggle.update!(feature_toggle_params)
+
+      redirect_to feature_toggles_path
+    end
+
+    def new
+      @feature_toggle = model.new
+    end
+
+    def destroy
+      @feature_toggle = model.find_by(id: params[:id])
+
+      @feature_toggle.destroy!
+
+      redirect_to feature_toggles_path
+    end
+
+    private
+
+    def authorize_user!
+      authorize! :manage, model
+    end
+
+    def model
+      @_model ||= DefraRubyFeatures.configuration.feature_toggle_model_name.constantize
+    end
+
+    def feature_toggle_params
+      params.fetch(:feature_toggle, {}).permit(:key, :active)
+    end
+  end
+end

data/app/helpers/defra_ruby_features/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DefraRubyFeatures
+  module ApplicationHelper
+  end
+end

data/app/helpers/delete_link_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Credits: viget.com/articles/delete-in-rails-without-jquery-and-ujs/
+
+module DeleteLinkHelper
+  def delete_button_to(title, url, options = {})
+    html_options = {
+      class: "delete_button_to",
+      method: "delete"
+    }.merge(options.delete(:html_options) || {})
+
+    form_for :delete, url: url, html: html_options do |f|
+      f.submit title, options
+    end
+  end
+end

data/app/views/defra_ruby_features/feature_toggles/index.html.erb

@@ -0,0 +1,48 @@
+<div class="text">
+  <h1 class="heading-large"><%= t(".heading") %></h1>
+
+  <table>
+    <thead>
+      <tr>
+        <th scope="col"><%= t(".table.key") %></th>
+        <th scope="col"><%= t(".table.status") %></th>
+        <th scope="col"></th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% @feature_toggles.each do |feature_toggle| %>
+        <tr>
+          <td><%= feature_toggle.key %></th>
+          <td>
+            <span class="status-tag <%= feature_toggle.active ? "status-tag--active" : "status-tag--inactive" %>">
+              <%= feature_toggle.active ? t(".status.enabled") : t(".status.disabled") %>
+            </span>
+          </td>
+
+          <td>
+            <ul class="list">
+              <li>
+                <%= form_for feature_toggle do |f| %>
+                  <%= f.hidden_field :active, value: !feature_toggle.active %>
+                  <%= f.submit t(".actions.toggle"), class: "button" %>
+                <% end %>
+              </li>
+              <li>
+                <%= delete_button_to t(".actions.delete"), feature_toggle_path(feature_toggle), {
+                  data: { confirm: "Are you sure?" },
+                  class: "button button-red"
+                } %>
+
+              </li>
+            </ul>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+
+  <p>
+    <%= link_to t(".new"), new_feature_toggle_path, class: "button" %>
+  </p>
+</div>

data/app/views/defra_ruby_features/feature_toggles/new.html.erb

@@ -0,0 +1,35 @@
+<div class="grid-row">
+  <div class="column-two-thirds">
+    <%= render("shared/back", back_path: feature_toggles_path) %>
+
+    <%= form_for(@feature_toggle) do |f| %>
+      <h1 class="heading-large">
+        <%= t(".heading") %>
+      </h1>
+
+      <div class="form-group <%= "form-group-error" if @feature_toggle.errors[:key].any? %>">
+        <% if @feature_toggle.errors[:key].any? %>
+          <span class="error-message"><%= @feature_toggle.errors[:key].join(", ") %></span>
+        <% end %>
+
+        <%= f.label :key, t(".fields.key"), class: "form-label" %>
+        <%= f.text_field :key, class: "form-control" %>
+      </div>
+
+      <div class="form-group <%= "form-group-error" if @feature_toggle.errors[:active].any? %>">
+        <% if @feature_toggle.errors[:key].any? %>
+          <span class="error-message"><%= @feature_toggle.errors[:key].join(", ") %></span>
+        <% end %>
+
+        <div class="multiple-choice">
+          <%= f.check_box :active %>
+          <%= f.label :active, t(".fields.active") %>
+        </div>
+      </div>
+
+      <div class="form-group">
+        <%= f.submit t(".submit"), class: "button" %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/shared/_back.html.erb

@@ -0,0 +1 @@
+<%= link_to(t(".back_link"), back_path, class: "link-back") %>

data/config/locales/defra_ruby_features.en.yml

@@ -0,0 +1,24 @@
+en:
+  defra_ruby_features:
+    feature_toggles:
+      index:
+        heading: "Feature Toggles"
+        new: "New"
+        table:
+          key: "Name"
+          status: "Status"
+        actions:
+          toggle: "Toggle"
+          delete: "Delete"
+        status:
+          enabled: "Enabled"
+          disabled: "Disabled"
+      new:
+        heading: "Add a new Feature Toggle"
+        fields:
+          key: "Name"
+          active: "Active"
+        submit: "Save"
+  shared:
+    back:
+      back_link: "Back"

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+DefraRubyFeatures::Engine.routes.draw do
+  resources :feature_toggles, except: %i[show edit], path: "feature-toggles"
+end

data/lib/defra_ruby_features.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "defra_ruby_features/engine"
+
+module DefraRubyFeatures
+  # Enable the ability to configure the gem from its host app, rather than
+  # reading directly from env vars. Derived from
+  # https://robots.thoughtbot.com/mygem-configure-block
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Added for testing. Without we cannot test both a config object with and
+    # with set values in the same rspec session
+    def reset_configuration
+      @configuration = nil
+    end
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/defra_ruby_features/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DefraRubyFeatures
+  class Configuration
+    attr_accessor :feature_toggle_model_name
+  end
+end

data/lib/defra_ruby_features/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "configuration"
+
+module DefraRubyFeatures
+  class Engine < ::Rails::Engine
+    isolate_namespace DefraRubyFeatures
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/defra_ruby_features/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DefraRubyFeatures
+  VERSION = "0.1.0"
+end

data/lib/tasks/changelog.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "github_changelog_generator/task"
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = "DEFRA"
+  config.project = "defra-ruby-features"
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link defra_ruby_features_manifest.js