flipflop 2.0.0

data/lib/generators/flipflop/features/templates/features.rb

@@ -0,0 +1,21 @@
+Flipflop.configure do
+  # Strategies will be used in the order listed here.
+  strategy :cookie
+  strategy :active_record
+  strategy :default
+
+  # Other strategies:
+  #
+  # strategy :session
+  # strategy :query_string
+  #
+  # strategy :my_strategy do |feature|
+  #   # ... your custom code here; return true/false/nil.
+  # end
+
+  # Declare your features, e.g:
+  #
+  # feature :world_domination,
+  #   default: true,
+  #   description: "Take over the world."
+end

data/lib/generators/flipflop/install/install_generator.rb

@@ -0,0 +1,21 @@
+require "generators/flipflop/features/features_generator"
+require "generators/flipflop/migration/migration_generator"
+require "generators/flipflop/routes/routes_generator"
+
+class Flipflop::InstallGenerator < Rails::Generators::Base
+  def invoke_generators
+    Flipflop::FeaturesGenerator.new([], options).invoke_all
+    Flipflop::MigrationGenerator.new([], options).invoke_all
+    Flipflop::RoutesGenerator.new([], options).invoke_all
+  end
+
+  def configure_dashboard
+    environment <<-CONFIG
+# Replace this with your own 'before_action' filter in ApplicationController
+    # to implement access control for the Flipflop dashboard, or provide a
+    # filter as lambda directly.
+    config.flipflop.dashboard_access_filter = :require_development
+
+CONFIG
+  end
+end

data/lib/generators/flipflop/migration/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Generates migration to create the features table for the Feature model.
+
+Example:
+    rails generate flipflop:migration

data/lib/generators/flipflop/migration/migration_generator.rb

@@ -0,0 +1,23 @@
+require "rails"
+require "rails/generators/migration"
+require "rails/generators/active_record"
+
+class Flipflop::MigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  def create_migration_file
+    migration_template("create_features.rb", "db/migrate/create_features.rb")
+  end
+
+  # Stubbed in railties/lib/rails/generators/migration.rb
+  #
+  # This implementation is a simplified version of:
+  #   activerecord/lib/rails/generators/active_record/migration.rb
+  #
+  # See: http://www.ruby-forum.com/topic/203205
+  def self.next_migration_number(dirname)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+end

data/lib/generators/flipflop/migration/templates/create_features.rb

@@ -0,0 +1,10 @@
+class CreateFeatures < ActiveRecord::Migration<%= Rails.version >= "5" ? "[#{ActiveRecord::Migration.current_version}]" : "" %>
+  def change
+    create_table :features do |t|
+      t.string :key, null: false
+      t.boolean :enabled, null: false, default: false
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/flipflop/routes/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Add routes for the Flipflop dashboard.
+
+Example:
+    rails generate flipflop:routes
+
+    This will add routes to app/routes.rb

data/lib/generators/flipflop/routes/routes_generator.rb

@@ -0,0 +1,5 @@
+class Flipflop::RoutesGenerator < Rails::Generators::Base
+  def add_route
+    route %{mount Flipflop::Engine => "/flipflop"}
+  end
+end

data/test/integration/app_test.rb

@@ -0,0 +1,32 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+describe Flipflop do
+  before do
+    @app = TestApp.new
+  end
+
+  subject do
+    @app
+  end
+
+  describe "middleware" do
+    it "should include cache middleware" do
+      middlewares = Rails.application.middleware.map(&:klass)
+      assert_includes middlewares, Flipflop::FeatureCache::Middleware
+    end
+  end
+
+  describe "module" do
+    before do
+      Flipflop::FeatureSet.current.instance_variable_set(:@features, {})
+      Module.new do
+        extend Flipflop::Configurable
+        feature :world_domination
+      end
+    end
+
+    it "should allow querying for features" do
+      assert_equal false, Flipflop.world_domination?
+    end
+  end
+end

data/test/integration/dashboard_test.rb

@@ -0,0 +1,162 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+require "capybara/dsl"
+
+describe Flipflop do
+  include Capybara::DSL
+
+  before do
+    @app = TestApp.new
+  end
+
+  subject do
+    @app
+  end
+
+  describe "outside development and test" do
+    before do
+      Rails.env.stub(:test?, false) do
+        visit "/flipflop"
+      end
+    end
+
+    it "should be forbidden" do
+      assert_equal 403, page.status_code
+    end
+  end
+
+  describe "without features" do
+    before do
+      visit "/flipflop"
+    end
+
+    it "should show feature table with header" do
+      assert_equal ["Cookie", "Active record", "Default"],
+        all("thead th").map(&:text)[3..-1]
+    end
+
+    it "should show no features" do
+      assert all("tbody tr").empty?
+    end
+  end
+
+  describe "with features" do
+    before do
+      Flipflop::FeatureSet.current.instance_variable_set(:@features, {})
+      Module.new do
+        extend Flipflop::Configurable
+        feature :world_domination, description: "Try and take over the world!"
+        feature :shiny_things, default: true
+      end
+
+      Capybara.current_session.driver.browser.clear_cookies
+      Flipflop::Feature.delete_all
+
+      visit "/flipflop"
+    end
+
+    it "should show feature rows" do
+      assert_equal ["World domination", "Shiny things"],
+        all("tr[data-feature] td.name").map(&:text)
+    end
+
+    it "should show feature descriptions" do
+      assert_equal ["Try and take over the world!", "Shiny things."],
+        all("tr[data-feature] td.description").map(&:text)
+    end
+
+    describe "with cookie strategy" do
+      it "should enable feature" do
+        within("tr[data-feature=world-domination] td[data-strategy=cookie]") do
+          click_on "on"
+        end
+
+        within("tr[data-feature=world-domination]") do
+          assert_equal "on", first("td.status").text
+          assert_equal "on", first("td[data-strategy=cookie] input.active[type=submit]").value
+        end
+      end
+
+      it "should disable feature" do
+        within("tr[data-feature=world-domination] td[data-strategy=cookie]") do
+          click_on "off"
+        end
+
+        within("tr[data-feature=world-domination]") do
+          assert_equal "off", first("td.status").text
+          assert_equal "off", first("td[data-strategy=cookie] input.active[type=submit]").value
+        end
+      end
+
+      it "should enable and clear feature" do
+        within("tr[data-feature=world-domination] td[data-strategy=cookie]") do
+          click_on "on"
+        end
+
+        within("tr[data-feature=world-domination] td[data-strategy=cookie]") do
+          click_on "clear"
+        end
+
+        within("tr[data-feature=world-domination]") do
+          assert_equal "off", first("td.status").text
+          refute has_selector?("td[data-strategy=cookie] input.active[type=submit]")
+        end
+      end
+    end
+
+    describe "with active record strategy" do
+      it "should enable feature" do
+        within("tr[data-feature=world-domination] td[data-strategy=active-record]") do
+          click_on "on"
+        end
+
+        within("tr[data-feature=world-domination]") do
+          assert_equal "on", first("td.status").text
+          assert_equal "on", first("td[data-strategy=active-record] input.active[type=submit]").value
+        end
+      end
+
+      it "should disable feature" do
+        within("tr[data-feature=world-domination] td[data-strategy=active-record]") do
+          click_on "off"
+        end
+
+        within("tr[data-feature=world-domination]") do
+          assert_equal "off", first("td.status").text
+          assert_equal "off", first("td[data-strategy=active-record] input.active[type=submit]").value
+        end
+      end
+
+      it "should enable and clear feature" do
+        within("tr[data-feature=world-domination] td[data-strategy=active-record]") do
+          click_on "on"
+        end
+
+        within("tr[data-feature=world-domination] td[data-strategy=active-record]") do
+          click_on "clear"
+        end
+
+        within("tr[data-feature=world-domination]") do
+          assert_equal "off", first("td.status").text
+          refute has_selector?("td[data-strategy=active-record] input.active[type=submit]")
+        end
+      end
+    end
+  end
+
+  describe "with hidden strategy" do
+    before do
+      Flipflop::FeatureSet.current.instance_variable_set(:@strategies, {})
+      Module.new do
+        extend Flipflop::Configurable
+        strategy :query_string, hidden: true
+      end
+
+      visit "/flipflop"
+    end
+
+    it "should not show hidden strategy" do
+      assert_equal [], all("thead th").map(&:text)[3..-1]
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,96 @@
+require "bundler/setup"
+require "flipflop"
+
+gem "minitest"
+require "minitest/autorun"
+
+require "action_controller"
+
+# Who is setting this to true? :o
+$VERBOSE = false
+
+def create_request
+  env = Rack::MockRequest.env_for("/example")
+  request = ActionDispatch::TestRequest.new(env)
+  request.host = "example.com"
+
+  class << request
+    def cookie_jar
+      @cookie_jar ||= begin
+        method = ActionDispatch::Cookies::CookieJar.method(:build)
+        if method.arity == 2 # Rails 5.0
+          method.call(self, {})
+        else
+          method.call(self)
+        end
+      end
+    end
+  end
+
+  request
+end
+
+def reload_constant(name)
+  ActiveSupport::Dependencies.remove_constant(name.to_s)
+  path = ActiveSupport::Dependencies.search_for_file(name.to_s.underscore).sub!(/\.rb\z/, "")
+  ActiveSupport::Dependencies.loaded.delete(path)
+  Object.const_get(name)
+end
+
+class TestApp
+  class << self
+    def new
+      ActiveSupport::Dependencies.remove_constant("App")
+      super.tap do |current|
+        current.create!
+        current.load!
+        current.migrate!
+        reload_constant("Flipflop::Feature")
+      end
+    end
+  end
+
+  def create!
+    require "rails/generators"
+    require "rails/generators/rails/app/app_generator"
+    require "generators/flipflop/install/install_generator"
+
+    FileUtils.rm_rf(File.expand_path("../../tmp/app", __FILE__))
+    Dir.chdir(File.expand_path("../..", __FILE__))
+
+    Rails::Generators::AppGenerator.new(["tmp/app"],
+      quiet: true,
+      skip_active_job: true,
+      skip_bundle: true,
+      skip_gemfile: true,
+      skip_git: true,
+      skip_javascript: true,
+      skip_keeps: true,
+      skip_spring: true,
+      skip_test_unit: true,
+      skip_turbolinks: true,
+    ).invoke_all
+
+    Flipflop::InstallGenerator.new([],
+      quiet: true,
+    ).invoke_all
+  end
+
+  def load!
+    ENV["RAILS_ENV"] = "test"
+    require "rails"
+    require "flipflop/engine"
+    require File.expand_path("../../tmp/app/config/environment", __FILE__)
+    ActiveSupport::Dependencies.mechanism = :load
+    load(Rails.application.paths["config/features.rb"].existent.first)
+    require "capybara/rails"
+  end
+
+  def migrate!
+    ActiveRecord::Base.establish_connection
+
+    ActiveRecord::Tasks::DatabaseTasks.create_current
+    ActiveRecord::Migration.verbose = false
+    ActiveRecord::Migrator.migrate(Rails.application.paths["db/migrate"].to_a)
+  end
+end

data/test/unit/configurable_test.rb

@@ -0,0 +1,104 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+describe Flipflop::Configurable do
+  subject do
+    Flipflop::FeatureSet.current.reset!
+    Module.new do
+      extend Flipflop::Configurable
+    end
+  end
+
+  describe "feature" do
+    it "should append feature definition" do
+      subject.feature(:one, default: true)
+      subject.feature(:two, default: false)
+
+      assert_equal [:one, :two],
+        Flipflop::FeatureSet.current.features.map(&:key)
+    end
+
+    it "should append feature definition with default" do
+      subject.feature(:one, default: true)
+      subject.feature(:two, default: false)
+
+      assert_equal [true, false],
+        Flipflop::FeatureSet.current.features.map(&:default)
+    end
+  end
+
+  describe "strategy" do
+    it "should append strategy objects" do
+      strategy_class = Class.new(Flipflop::Strategies::AbstractStrategy)
+      strategies = [
+        strategy_class.new,
+        strategy_class.new,
+      ]
+
+      subject.strategy(strategies[0])
+      subject.strategy(strategies[1])
+
+      assert_equal strategies, Flipflop::FeatureSet.current.strategies
+    end
+
+    it "should append strategy classes" do
+      strategies = [
+        Class.new(Flipflop::Strategies::AbstractStrategy),
+        Class.new(Flipflop::Strategies::AbstractStrategy),
+      ]
+
+      subject.strategy(strategies[0])
+      subject.strategy(strategies[1])
+
+      assert_equal strategies, Flipflop::FeatureSet.current.strategies.map(&:class)
+    end
+
+    it "should append strategy classes with options" do
+      strategy_class = Class.new(Flipflop::Strategies::AbstractStrategy)
+
+      subject.strategy(strategy_class, name: "my strategy")
+      subject.strategy(strategy_class, name: "awesome strategy")
+
+      assert_equal ["my strategy", "awesome strategy"],
+        Flipflop::FeatureSet.current.strategies.map(&:name)
+    end
+
+    it "should append strategy symbols" do
+      subject.strategy(:cookie)
+      subject.strategy(:query_string)
+
+      assert_equal [
+        Flipflop::Strategies::CookieStrategy,
+        Flipflop::Strategies::QueryStringStrategy
+      ], Flipflop::FeatureSet.current.strategies.map(&:class)
+    end
+
+    it "should append strategy symbols with options" do
+      subject.strategy(:cookie, name: "my strategy")
+      subject.strategy(:query_string, name: "awesome strategy")
+
+      assert_equal ["my strategy", "awesome strategy"],
+        Flipflop::FeatureSet.current.strategies.map(&:name)
+    end
+
+    it "should append strategy lambda" do
+      subject.strategy { |feature| "hi!" }
+
+      assert_equal [Flipflop::Strategies::LambdaStrategy],
+        Flipflop::FeatureSet.current.strategies.map(&:class)
+    end
+
+    it "should append strategy lambda with name" do
+      subject.strategy(:my_strategy) { |feature| "hi!" }
+
+      assert_equal ["my_strategy"],
+        Flipflop::FeatureSet.current.strategies.map(&:name)
+    end
+
+    it "should append strategy lambda with name and options" do
+      subject.strategy("my strategy", description: "awesome") { |feature| "hi!" }
+
+      assert_equal ["awesome"],
+        Flipflop::FeatureSet.current.strategies.map(&:description)
+    end
+  end
+end

data/test/unit/feature_cache_test.rb

@@ -0,0 +1,142 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+describe Flipflop::FeatureCache do
+  subject do
+    Flipflop::FeatureCache.current
+  end
+
+  after do
+    Flipflop::FeatureCache.current.disable!
+  end
+
+  describe "current" do
+    it "should return same instance" do
+      current = subject
+      assert_equal current, Flipflop::FeatureCache.current
+    end
+
+    it "should return new instance in different thread" do
+      current = subject
+      refute_equal current, Thread.new { Flipflop::FeatureCache.current }.value
+    end
+  end
+
+  describe "when enabled" do
+    before do
+      subject.enable!
+    end
+
+    describe "enabled" do
+      it "should return true" do
+        assert_equal true, subject.enabled?
+      end
+    end
+
+    describe "fetch" do
+      it "should store value by key" do
+        subject.fetch(:key) { 1 }
+        assert_equal 1, subject.fetch(:key) { 2 }
+      end
+
+      it "should not call block if cached" do
+        called = false
+        subject.fetch(:key) { 1 }
+        subject.fetch(:key) { called = true }
+        assert_equal false, called
+      end
+    end
+
+    describe "clear" do
+      it "should empty cache" do
+        subject.fetch(:key) { 1 }
+        subject.clear!
+        assert_equal 2, subject.fetch(:key) { 2 }
+      end
+    end
+  end
+
+  describe "when disabled" do
+    before do
+      subject.disable!
+    end
+
+    describe "enabled" do
+      it "should return false" do
+        assert_equal false, subject.enabled?
+      end
+    end
+
+    describe "fetch" do
+      it "should not store value" do
+        subject.fetch(:key) { 1 }
+        assert_equal 2, subject.fetch(:key) { 2 }
+      end
+
+      it "should always call block" do
+        called = false
+        subject.fetch(:key) { 1 }
+        subject.fetch(:key) { called = true }
+        assert_equal true, called
+      end
+    end
+  end
+
+  describe "enable" do
+    it "should not clear cache" do
+      subject.enable!
+      subject.fetch(:key) { 1 }
+      subject.enable!
+      assert_equal 1, subject.fetch(:key) { 2 }
+    end
+  end
+
+  describe "disable" do
+    it "should clear cache" do
+      subject.enable!
+      subject.fetch(:key) { 1 }
+      subject.disable!
+      subject.enable!
+      assert_equal 2, subject.fetch(:key) { 2 }
+    end
+  end
+
+  describe "middleware" do
+    subject do
+      app = ->(env) {
+        raise env["error"] if env["error"]
+        env["cache"] = Flipflop::FeatureCache.current.enabled?
+        return [200, {}, ["ok"]]
+      }
+      Flipflop::FeatureCache::Middleware.new(app)
+    end
+
+    it "should call app" do
+      response = subject.call({})
+      assert_equal "ok", response[2].to_a.join
+    end
+
+    it "should enable cache before request" do
+      response = subject.call(env = {})
+      response[2].try(:close)
+      assert_equal true, env["cache"]
+    end
+
+    it "should disable cache after request" do
+      response = subject.call({})
+      response[2].try(:close)
+      assert_equal false, Flipflop::FeatureCache.current.enabled?
+    end
+
+    it "should disable cache after error" do
+      subject.call({ "error" => "boo!" }) rescue nil
+      assert_equal false, Flipflop::FeatureCache.current.enabled?
+    end
+
+    it "should not change cache if already enabled" do
+      Flipflop::FeatureCache.current.enable!
+      response = subject.call({})
+      response[2].try(:close)
+      assert_equal true, Flipflop::FeatureCache.current.enabled?
+    end
+  end
+end

data/test/unit/feature_definition_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+describe Flipflop::FeatureDefinition do
+  describe "with defaults" do
+    subject do
+      Flipflop::FeatureDefinition.new(:my_key)
+    end
+
+    it "should have specified key" do
+      assert_equal :my_key, subject.key
+    end
+
+    it "should have humanized description" do
+      assert_equal "My key.", subject.description
+    end
+
+    it "should default to false" do
+      assert_equal false, subject.default
+    end
+  end
+
+  describe "with options" do
+    subject do
+      Flipflop::FeatureDefinition.new(:my_key,
+        default: true,
+        description: "Awesome feature",
+      )
+    end
+
+    it "should have specified key" do
+      assert_equal :my_key, subject.key
+    end
+
+    it "should have specified description" do
+      assert_equal "Awesome feature", subject.description
+    end
+
+    it "should have specified default" do
+      assert_equal true, subject.default
+    end
+  end
+end