flipflop 2.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Mjk5MWNkOGUyOGViMGIxOTJmZmY0NTc5NjU3Yjk3NjM0NWIyNDE1ZA==
+  data.tar.gz: !binary |-
+    NjRiOGU3YTg3ZDAyYmMxM2RmZmEzZDcyOTBlZTNjZmRlMWI4YTdiNA==
+SHA512:
+  metadata.gz: !binary |-
+    YTRkOTdlMjAyMzVjYjdjOWJlMDkxOWYxZmYwMmUzMDMxYmE3YjcyNmI5ZWZk
+    MWMxYjY1ZTU2MTBiOWYxMDNlOGI0MDE2Y2RmYWQ3ZTZiMTUzNjE5ZDA2NmEw
+    YTViYjdmNzNkNTljZWFiMTUwOWZmNDhhMDgzYThiNGJmMTdlM2I=
+  data.tar.gz: !binary |-
+    MTllZjMwYjA5YWZmMzVjNGM3YjRmMGE0Mjk0NTg3MGY4NmY2MTgwNjcxOWVk
+    NzE3NzllOWQwZDgzN2FkYjg2YThiMThlMDI4ZGMzODk5ZjFiYTIzYzQ3MGU5
+    NDU0OTcxYjdjYzJkZWIwNTI5OTdkOWIxMGRjYmJkZDVmYmM4OTI=

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*

data/.travis.yml

@@ -0,0 +1,51 @@
+language: ruby
+rvm:
+- 2.0
+- 2.1
+- 2.2
+- 2.3.0
+- jruby-9.0.5.0
+- rbx-head
+- ruby-head
+- jruby-head
+env:
+- RAILS_VERSION=4.0
+- RAILS_VERSION=4.1
+- RAILS_VERSION=4.2
+- RAILS_VERSION=5.0.0.beta3
+- RAILS_VERSION=master
+matrix:
+  exclude:
+  - rvm: 2.0
+    env: RAILS_VERSION=5.0.0.beta3
+  - rvm: 2.0
+    env: RAILS_VERSION=master
+  - rvm: 2.1
+    env: RAILS_VERSION=5.0.0.beta3
+  - rvm: 2.1
+    env: RAILS_VERSION=master
+  - rvm: 2.2
+    env: RAILS_VERSION=5.0.0.beta3
+  - rvm: 2.2
+    env: RAILS_VERSION=master
+  allow_failures:
+  - rvm: jruby-9.0.5.0
+    env: RAILS_VERSION=5.0.0.beta3
+  - rvm: jruby-9.0.5.0
+    env: RAILS_VERSION=master
+  - rvm: rbx-head
+  - rvm: ruby-head
+  - rvm: jruby-head
+notifications:
+  email: false
+  slack:
+    secure: crOO1QGnFn9T1DpVgxkukTSiN8lQq09X8WF8oi1Eoa7Liex4gzWq7f8wlIXPrRFAsNjU47fSrz+L1C6Eg068Vd2df9pkqjW0pLNeqUViJ35TzpYISTtzJrX+x3nvCQLlvS4leP6lkijlsvlu1IN0xnXadW5cmcMoEcPo4Yma1RUklwlreSRIEmJiutYKVFRw3gIZA9vsnXNEcD408mvSY/8Kuw+hmRQupODUalXDpZo1q3HH+ZPQq+/rGuJ7XRf9sBtxjpUF0G4FJZQhVP4CrLNYVBE/83rHJ6HSf6u3SlYVIMiautq0nWpVLPHUrkOPJVeVh6EPtoFeI/cehH1NyoAVvL5a39wFRBlJ4jVPWUrrnihJT/6+P6GM9PSnYogxtIoTsdrYES2FgtWGgwG5uLyw8U6bW7G7rCzQwBP7enVHWVCbDgdSSjE1Mg1I9qhRuL6pHs5des4VKk6pfD3p+BRqLmOZR2jx4v8MFwakSFqQWOMxaD0U1lfxecqSx9OkwWEhCFSnHeXeHInEhY6qKCdZZzT+beYn0xppUMPJGMTqe5+po8gL+5MxQwI8Xs/5hSve5frfmuS7UQf5BnFMOzwoThQrXCFRz58wXvcZTD9eTdVBV44Hsi5OLdYn9K58sNUhgcxGfRgdE7Gy9P7DD4fHPGakD/Tz++HuCmCUXNs=
+deploy:
+  provider: rubygems
+  api_key:
+    secure: ObuFc5QWnSgraKzYXLT5EhnlGm/+BQ2IN46q3ykXdk8m80ajpWD0/rqtCmu5SiBd6Z56CVZe2zSsEpGhN7/pC5kdG0hYzdpvbgX9IxJNMjYb7rNh2onXdIHVd3yk3qdNgI8hmrgtocJPdtPXqbZSY6KOSH6eb5rPDmA/bWwyREdicW5KN8ZWsXiLzKXoFZ6xvkNFbAjY8AicIfG+dHBFbx+q1xBOvbS44M+VIt/Qsknt9m5CYaWJ0AK/RZoyRhs0F0yYQSLu0mVt7JbHOL05SqQ3uCNlwiEqX+fIiN2mPb24Xxy6SVXr1kD0+H4EZHpgDeUlylO2myYJBFBnjzKXXr0qh3YTxaEKlWO7HnUdnJDRQ+bjyT0USBv7gXO2fEIBN864AGZf+3cL0aKRW3n3cyqrhiUxim7gro7eQSh6t6x5o+LGYw6dDdhR53XIFZoh0s/azYBbgl0bfM3juBMrD3e4w/ieaE9iI+NVj4Z4DYDRtbGIqxsuLwRmSkg3epvBc4Pa7vTDuCyVtd9lpFK55V1TysxhcPu0lqHf+SNnW3+DDwp+CQusQhFIsOcIQdr6PBNSTP5ZtEEqyEMfmt2QK2BEOYUuL6TxIUa9xuu8zMUahSaLOvekM5R+EwW04C3T5hWbPs7W1Ks2jcVzkL2iNd3I18pW9VvkXNAqveuoT28=
+  gem: flipflop
+  on:
+    tags: true
+    repo: voormedia/flipflop
+    ruby: 2.3.0

data/Gemfile

@@ -0,0 +1,20 @@
+source "https://rubygems.org"
+gemspec
+
+group :test do
+  version = ENV["RAILS_VERSION"] || "master"
+  if version == "master"
+    gem "rails", github: "rails/rails"
+  else
+    gem "rails", "~> #{version}.0"
+  end
+
+  gem "sqlite3", ">= 1.3", platform: :ruby
+  gem "activerecord-jdbcsqlite3-adapter", platform: :jruby
+  gem "minitest", ">= 4.2"
+  gem "capybara", ">= 2.6"
+
+  if ENV["RAILS_VERSION"] == "4.0"
+    gem "minitest-rails", platform: :jruby
+  end
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2011-2013 Learnable Pty Ltd
+Copyright (c) 2016 Voormedia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,261 @@
+[<img src="https://travis-ci.org/voormedia/flipflop.svg?branch=master" alt="Build Status">](https://travis-ci.org/voormedia/flipflop)
+
+# Flipflop your features
+
+**Flipflop** provides a declarative, layered way of enabling and disabling
+application functionality at run-time. It is originally based on
+[Flip](https://github.com/pda/flip). Compared to the original gem **Flipflop** has:
+* an improved dashboard
+* thread safety
+* better database performance due to per-request caching, enabled by default
+* more strategies (query strings, sessions, custom code)
+* more strategy options (cookie options, strategy names and descriptions, custom database models)
+* the ability to use the same strategy twice, with different options
+* configuration in a fixed location (`config/features.rb`) that is usable even if you don't use the database strategy
+* dashboard is inaccessible in production by default, for safety in case of misconfiguration
+* removes controller filters and view helpers, to promote uniform semantics to check for features (facilitates project-wide searching)
+
+You can configure strategy layers that will evaluate if a feature is currently
+enabled or disabled. Available strategies are:
+* a per-feature default setting
+* database (with Active Record), to flipflop features site-wide for all users
+* cookie or session, to flipflop features for single users
+* query string parameters, to flipflop features occasionally (in development mode for example)
+* custom strategy code
+
+Flipflop has a dashboard interface that's easy to understand and use.
+
+[<img src="https://raw.githubusercontent.com/voormedia/flipflop/screenshots/dashboard.png" alt="Dashboard">](https://raw.githubusercontent.com/voormedia/flipflop/screenshots/dashboard.png)
+
+## Installation
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem "flipflop"
+```
+
+Generate routes, feature settings and database migration:
+
+```
+rails g flipflop:install
+```
+
+Run the migration to store feature settings in your database:
+
+```
+rake db:migrate
+```
+
+## Declaring features
+
+Features and strategies are declared in `config/features.rb`:
+
+```ruby
+Flipflop.configure do
+  # Strategies will be used in the order listed here.
+  strategy :cookie
+  strategy :active_record
+  strategy :default
+
+  # Basic feature declaration:
+  feature :shiny_things
+
+  # Enable features by default:
+  feature :world_domination, default: true
+end
+```
+
+This file is automatically reloaded in development mode. No need to restart
+your server after making changes.
+
+## Strategies
+
+The following strategies are provided:
+* `:active_record` – Save feature settings in the database.
+    * `:class` – Provide the feature model. `Flipflop::Feature` by default (which uses the table `features`). Honors `default_scope` when features are resolved or switched on/off.
+* `:cookie` – Save feature settings in browser cookies for the current user.
+    * `:path` – The path for which the cookies apply. Defaults to the root of the application.
+    * `:domain` – Cookie domain. Is `nil` by default (no specific domain). Can be `:all` to use the topmost domain. Can be an array of domains.
+    * `:secure` – Only set cookies if the connection is secured with TLS. Default is `false`.
+    * `:httponly` – Whether the cookies are accessible via scripting or only HTTP. Default is `false`.
+* `:query_string` – Interpret query string parameters as features. This strategy is only used for resolving. It does not allow switching features on/off.
+* `:session` – Save feature settings in the current user's application session.
+* `:default` – Not strictly needed, all feature defaults will be applied if no strategies match a feature. Include this strategy to determine the order of using the default value, and to make it appear in the dashboard.
+
+All strategies support these options, to change the appearance of the dashboard:
+* `:name` – The name of the strategy. Defaults to the name of the selected strategy.
+* `:description` – The description of the strategy. Every strategy has a default description.
+* `:hidden` – Optionally hides the strategy from the dashboard. Default is `false`.
+
+## Checking if a feature is enabled
+
+`Flipflop.enabled?` or the dynamic predicate methods can be used to check
+feature state:
+
+```ruby
+Flipflop.enabled?(:world_domination)  # true
+Flipflop.world_domination?            # true
+
+Flipflop.enabled?(:shiny_things)      # false
+Flipflop.shiny_things?                # false
+```
+
+This works everywhere. In your views:
+
+```erb
+<div>
+  <% if Flipflop.world_domination? %>
+    <%= link_to "Dominate World", world_dominations_path %>
+  <% end %>
+</div>
+```
+
+In your controllers:
+
+```ruby
+class ShinyThingsController < ApplicationController
+  def index
+    return head :forbidden unless Flipflop.shiny_things?
+    # Proceed with shiny things...
+  end
+end
+```
+
+In your models:
+
+```ruby
+class ShinyThing < ActiveRecord::Base
+  after_initialize do
+    if !Flipflop.shiny_things?
+      raise ActiveRecord::RecordNotFound
+    end
+  end
+end
+```
+
+## Custom strategies
+
+Custom light-weight strategies can be defined with a block:
+
+```ruby
+Flipflop.configure do
+  strategy :random do |feature|
+    rand(2).zero?
+  end
+  # ...
+end
+```
+
+You can define your own custom strategies by inheriting from `Flipflop::Strategies::AbstractStrategy`:
+
+```ruby
+class UserPreferenceStrategy < Flipflop::Strategies::AbstractStrategy
+  class << self
+    def default_description
+      "Allows configuration of features per user."
+    end
+  end
+
+  def switchable?
+    # Can only switch features on/off if we have the user's session.
+    # The `request` method is provided by AbstractStrategy.
+    request?
+  end
+
+  def enabled?(feature)
+    # Can only check features if we have the user's session.
+    return unless request?
+    find_current_user.enabled_features[feature]
+  end
+
+  def switch!(feature, enabled)
+    user = find_current_user
+    user.enabled_features[feature] = enabled
+    user.save!
+  end
+
+  def clear!(feature)
+    user = find_current_user
+    user.enabled_features.delete(feature)
+    user.save!
+  end
+
+  private
+
+  def find_current_user
+    # The `request` method is provided by AbstractStrategy.
+    User.find_by_id(request.session[:user_id])
+  end
+end
+```
+
+Use it in `config/features.rb`:
+
+```ruby
+Flipflop.configure do
+  strategy UserPreferenceStrategy # name: "my strategy", description: "..."
+end
+```
+
+## Dashboard access control
+
+The dashboard provides visibility and control over the features.
+
+You don't want the dashboard to be public. For that reason it is only available
+in the development and test environments by default. Here's one way of
+implementing access control.
+
+In `app/config/application.rb`:
+
+```ruby
+config.flipflop.dashboard_access_filter = :require_authenticated_user
+```
+
+In `app/controllers/application_controller.rb`:
+
+```ruby
+class ApplicationController < ActionController::Base
+  def require_authenticated_user
+    head :forbidden unless User.logged_in?
+  end
+end
+```
+
+Or directly in `app/config/application.rb`:
+
+```ruby
+config.flipflop.dashboard_access_filter = -> {
+  head :forbidden unless User.logged_in?
+}
+```
+
+## Testing
+
+In your test environment, you typically want to keep your features. But to make
+testing easier, you may not want to use any of the strategies you use in
+development and production. You can replace all strategies with a single
+`:test` strategy by calling `Flipflop::FeatureSet.current.test!`. The test
+strategy will be returned. You can use this strategy to enable and disable
+features.
+
+```ruby
+describe WorldDomination do
+  before do
+    test_strategy = Flipflop::FeatureSet.current.test!
+    test_strategy.switch!(:world_domination, true)
+  end
+
+  it "should dominate the world" do
+     # ...
+  end
+end
+```
+
+If you are not happy with the default test strategy (which is essentially a
+simple thread-safe hash object), you can provide your own implementation as
+argument to the `test!` method.
+
+## License
+
+This software is licensed under the MIT License. [View the license](LICENSE).

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new("test") do |test|
+  test.pattern = "test/**/*_test.rb"
+end
+
+Rake::TestTask.new("test:unit") do |test|
+  test.pattern = "test/unit/**/*_test.rb"
+end
+
+Rake::TestTask.new("test:integration") do |test|
+  test.pattern = "test/integration/**/*_test.rb"
+end
+
+task default: :test

data/app/assets/stylesheets/flipflop.scss

@@ -0,0 +1,109 @@
+$enable-transitions: true;
+@import "bootstrap";
+
+section.flipflop {
+  @extend .container-fluid;
+  margin: 5rem 0 0;
+
+  table {
+    @extend .table;
+    @extend .table-striped;
+
+    thead {
+      @extend .thead-inverse;
+
+      th {
+        position: relative;
+        cursor: default;
+
+        &[data-tooltip]:before, &[data-tooltip]:after {
+          @include transition(all 0.2s ease-out);
+          transform: translateY(0.2rem) translateZ(0);
+          opacity: 0;
+
+          display: block;
+          position: absolute;
+        }
+
+        &[data-tooltip]:before {
+          content: attr(data-tooltip);
+          width: 98%;
+          left: 0;
+          bottom: 3.75rem;
+          margin: 0;
+          padding: 0.5rem 0.75rem;
+          background: $gray;
+          border-radius: 0.2rem;
+          font-size: 0.875rem;
+          font-weight: normal;
+          pointer-events: none;
+        }
+
+        &[data-tooltip]:after {
+          content: " ";
+          width: 0;
+          height: 0;
+          left: 1rem;
+          bottom: 3.25rem;
+          border-left: solid transparent 0.5rem;
+          border-right: solid transparent 0.5rem;
+          border-top: solid $gray 0.5rem;
+        }
+
+        &:hover {
+          &[data-tooltip]:before, &[data-tooltip]:after {
+            transform: translateY(0) translateZ(0);
+            opacity: 1;
+          }
+        }
+      }
+    }
+
+    tbody {
+      td.status {
+        width: 2rem;
+        font-size: 1.1rem;
+
+        span {
+          width: 2rem;
+          @extend .label;
+          @extend .label-pill;
+          &.on { @extend .label-success; }
+          &.off { @extend .label-default; }
+        }
+      }
+
+      td.name {
+        min-width: 11rem;
+        padding-top: 0.9rem;
+        font-weight: bold;
+      }
+
+      td.description {
+        min-width: 11rem;
+        padding-top: 0.9rem;
+      }
+
+      td.toggle {
+        min-width: 11rem;
+
+        div.toolbar {
+          @extend .btn-toolbar;
+          margin-left: 0;
+
+          div.group {
+            @extend .btn-group;
+            @extend .btn-group-sm;
+
+            input[type=submit] {
+              @extend .btn;
+              @extend .btn-sm;
+              &.active { @extend .btn-primary; }
+              &:not(.active) { @extend .btn-secondary; }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/app/controllers/concerns/flipflop/environment_filters.rb

@@ -0,0 +1,5 @@
+module Flipflop::EnvironmentFilters
+  def require_development
+    head :forbidden unless Rails.env.development? or Rails.env.test?
+  end
+end

data/app/controllers/flipflop/features_controller.rb

@@ -0,0 +1,59 @@
+require "bootstrap"
+
+module Flipflop
+  class FeaturesController < ApplicationController
+    include EnvironmentFilters
+
+    layout "flipflop"
+
+    def index
+      @feature_set = FeaturesPresenter.new(FeatureSet.current)
+    end
+
+    class FeaturesPresenter
+      include Flipflop::Engine.routes.url_helpers
+
+      def initialize(feature_set)
+        @cache = {}
+        @feature_set = feature_set
+      end
+
+      def strategies
+        @feature_set.strategies.reject(&:hidden?)
+      end
+
+      def features
+        @feature_set.features
+      end
+
+      def status(feature)
+        cache(nil, feature) do
+          status_to_s(@feature_set.enabled?(feature.key))
+        end
+      end
+
+      def strategy_status(strategy, feature)
+        cache(strategy, feature) do
+          status_to_s(strategy.enabled?(feature.key))
+        end
+      end
+
+      def switch_url(strategy, feature)
+        feature_strategy_path(feature.key, strategy.key)
+      end
+
+      private
+
+      def cache(strategy, feature)
+        key = feature.key.to_s + (strategy ? "-" + strategy.key.to_s : "")
+        return @cache[key] if @cache.has_key?(key)
+        @cache[key] = yield
+      end
+
+      def status_to_s(status)
+        return "on" if status == true
+        return "off" if status == false
+      end
+    end
+  end
+end

data/app/controllers/flipflop/strategies_controller.rb

@@ -0,0 +1,30 @@
+module Flipflop
+  class StrategiesController < ApplicationController
+    include EnvironmentFilters
+    include Engine.routes.url_helpers
+
+    def update
+      strategy.switch!(feature_key, enable?)
+      redirect_to(flipflop.features_url)
+    end
+
+    def destroy
+      strategy.clear!(feature_key)
+      redirect_to(flipflop.features_url)
+    end
+
+    private
+
+    def enable?
+      params[:commit].to_s.downcase.include?("on")
+    end
+
+    def feature_key
+      params[:feature_id].to_sym
+    end
+
+    def strategy
+      FeatureSet.current.strategy(params[:id])
+    end
+  end
+end

data/app/models/flipflop/feature.rb

@@ -0,0 +1,3 @@
+class Flipflop::Feature < ActiveRecord::Base
+  self.table_name = "features"
+end

data/app/views/flipflop/features/index.html.erb

@@ -0,0 +1,60 @@
+<section class="flipflop">
+  <h1>Feature Flipflop</h1>
+  <table>
+    <thead>
+      <tr>
+        <th></th>
+        <th class="name">Feature</th>
+        <th class="description">Description</th>
+        <% @feature_set.strategies.each do |strategy| -%>
+          <th data-tooltip="<%= strategy.description -%>">
+            <%= strategy.name.humanize -%>
+          </th>
+        <% end -%>
+      </tr>
+    </thead>
+    <tbody>
+    <% @feature_set.features.each do |feature| -%>
+      <tr data-feature="<%= feature.name.dasherize.parameterize %>">
+        <td class="status">
+          <span class="<%= @feature_set.status(feature) -%>"><%= @feature_set.status(feature) -%></span>
+        </td>
+        <td class="name"><%= feature.name.humanize -%></td>
+        <td class="description"><%= feature.description -%></td>
+
+        <% @feature_set.strategies.each do |strategy| -%>
+          <td class="toggle" data-strategy="<%= strategy.name.dasherize.parameterize %>">
+            <div class="toolbar">
+              <%= form_tag(@feature_set.switch_url(strategy, feature), method: :put) do -%>
+                <div class="group">
+                  <%= submit_tag "on",
+                    type: "submit",
+                    class: @feature_set.strategy_status(strategy, feature) == "on" ? "active" : nil,
+                    disabled: strategy.switchable? ? false : true
+                  -%>
+
+                  <%= submit_tag "off",
+                    type: "submit",
+                    class: @feature_set.strategy_status(strategy, feature) == "off" ? "active" : nil,
+                    disabled: strategy.switchable? ? false : true
+                  -%>
+                </div>
+              <% end -%>
+
+              <% if strategy.switchable? -%>
+                <div class="group">
+                  <% unless @feature_set.strategy_status(strategy, feature).blank? -%>
+                    <%= form_tag(@feature_set.switch_url(strategy, feature), method: :delete) do -%>
+                      <%= submit_tag "clear", type: "submit" -%>
+                    <% end -%>
+                  <% end -%>
+                </div>
+              <% end -%>
+            </div>
+          </td>
+        <% end -%>
+      </tr>
+    <% end -%>
+    </tbody>
+  </table>
+</div>

data/app/views/layouts/flipflop.html.erb

@@ -0,0 +1 @@
+<!doctype html><head><title></title><%= stylesheet_link_tag :flipflop -%></head><body><%= yield %></body>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Flipflop::Engine.routes.draw do
+  resources :features, path: "", only: [:index] do
+    resources :strategies, only: [:update, :destroy]
+  end
+end