flip2 1.1.1

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

@@ -0,0 +1,9 @@
+class Flip::InstallGenerator < Rails::Generators::Base
+
+  def invoke_generators
+    %w{ model migration routes }.each do |name|
+      generate "flip:#{name}"
+    end
+  end
+
+end

data/lib/generators/flip/migration/USAGE

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

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

@@ -0,0 +1,22 @@
+require "rails/generators/migration"
+
+class Flip::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 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/flip/migration/templates/create_features.rb

@@ -0,0 +1,11 @@
+# Created by the flip gem, see https://github.com/pda/flip
+class CreateFeatures < ActiveRecord::Migration
+  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/flip/model/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates the Feature database model class for Flip.
+
+Example:
+    rails generate flip:model
+
+    This will create:
+        app/models/feature.rb (class Feature < ActiveRecord::Base)

data/lib/generators/flip/model/model_generator.rb

@@ -0,0 +1,8 @@
+class Flip::ModelGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_feature_model_file
+    copy_file "feature.rb", "app/models/feature.rb"
+  end
+
+end

data/lib/generators/flip/model/templates/feature.rb

@@ -0,0 +1,15 @@
+class Feature < ActiveRecord::Base
+  extend Flip::Declarable
+
+  strategy Flip::CookieStrategy
+  strategy Flip::DatabaseStrategy
+  strategy Flip::DeclarationStrategy
+  default false
+
+  # Declare your features here, e.g:
+  #
+  # feature :world_domination,
+  #   default: true,
+  #   description: "Take over the world."
+
+end

data/lib/generators/flip/routes/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Add routes for the Flip control page.
+
+Example:
+    rails generate flip:routes
+
+    This will add routes to app/routes.rb

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

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

data/lib/generators/flip/views/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates flip/features/index view template.
+
+Example:
+    rails generate flip:views
+
+    This will create:
+        app/views/flip/features/index.html.erb

data/lib/generators/flip/views/templates/index.html.erb

@@ -0,0 +1,54 @@
+<div class="flip">
+  <h1>Feature Flippers</h1>
+  <table>
+    <thead>
+      <th class="name">Feature Name</th>
+      <th class="description">Description</th>
+      <th class="status">Status</th>
+      <% @p.strategies.each do |strategy| %>
+        <th>
+          <%= strategy.name %>
+          <span class="description"><%= strategy.description %></span>
+        </th>
+      <% end %>
+      <th>
+        Default
+        <span class="description">The system default when no strategies match.</span>
+      </th>
+    </thead>
+    <tbody>
+      <% @p.definitions.each do |definition| %>
+        <tr>
+          <td class="name"><%= definition.name %></td>
+          <td class="description"><%= definition.description %></td>
+          <%= content_tag :td, class: @p.status(definition) do %>
+            <%= @p.status definition %>
+          <% end %>
+          <% @p.strategies.each do |strategy| %>
+            <%= content_tag :td, class: @p.strategy_status(strategy, definition) || "pass" do %>
+              <%= @p.strategy_status strategy, definition %>
+              <% if strategy.switchable? %>
+                <%= form_tag(@p.switch_url(strategy, definition), method: :put) do %>
+                  <% unless @p.strategy_status(strategy, definition) == "on" %>
+                    <%= submit_tag "Switch On" %>
+                  <% end %>
+                  <% unless @p.strategy_status(strategy, definition) == "off" %>
+                    <%= submit_tag "Switch Off" %>
+                  <% end %>
+                <% end %>
+                <% unless @p.strategy_status(strategy, definition).blank? %>
+                  <%= form_tag(@p.switch_url(strategy, definition), method: :delete) do %>
+                    <%= submit_tag "Delete" %>
+                  <% end %>
+                <% end %>
+              <% end %>
+            <% end %>
+          <% end %>
+          <%= content_tag :td, class: @p.default_status(definition) do %>
+            <%= @p.default_status definition %>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/lib/generators/flip/views/views_generator.rb

@@ -0,0 +1,8 @@
+class Flip::ViewsGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_view_index_file
+    copy_file "index.html.erb", "app/views/flip/features/index.html.erb"
+  end
+
+end

data/spec/abstract_strategy_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+# Perhaps this is silly, but it provides some
+# coverage to an important base class.
+describe Flip::AbstractStrategy do
+
+  its(:name) { should == "abstract" }
+  its(:description) { should == "" }
+  it { should_not be_switchable }
+
+end

data/spec/cacheable_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Flip::Cacheable do
+
+  subject(:model_class) do
+    class Sample
+      attr_accessor :key
+    end
+
+    Class.new do
+      extend Flip::Declarable
+      extend Flip::Cacheable
+
+      strategy Flip::DeclarationStrategy
+      default false
+
+      feature :one
+      feature :two, description: "Second one."
+      feature :three, default: true
+
+      def self.all
+        list = []
+        i = 65
+        3.times do
+          list << Sample.new
+          list.last.key = i.chr()
+          i += 1
+        end
+        list
+      end
+    end
+  end
+
+  describe "with feature cache" do
+    context "initial context" do
+      it { should respond_to(:use_feature_cache) }
+      it { should respond_to(:start_feature_cache) }
+      it { should respond_to(:feature_cache) }
+      specify { model_class.use_feature_cache.should be_nil }
+    end
+
+    context "after a cache clear" do
+      before { model_class.start_feature_cache }
+      specify { model_class.use_feature_cache.should eq true }
+      specify { model_class.feature_cache.size == 3}
+    end
+  end
+
+end

data/spec/controller_filters_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+class ControllerWithFlipFilters
+  include Flip::ControllerFilters
+end
+
+describe ControllerWithFlipFilters do
+
+  describe ".require_feature" do
+
+    it "adds before_action without options" do
+      ControllerWithFlipFilters.tap do |klass|
+        klass.should_receive(:before_action).with({})
+        klass.send(:require_feature, :testable)
+      end
+    end
+
+    it "adds before_action with options" do
+      ControllerWithFlipFilters.tap do |klass|
+        klass.should_receive(:before_action).with({ only: [ :show ] })
+        klass.send(:require_feature, :testable, only: [ :show ])
+      end
+    end
+
+  end
+
+end

data/spec/cookie_strategy_spec.rb

@@ -0,0 +1,112 @@
+require "spec_helper"
+
+class ControllerWithoutCookieStrategy; end
+class ControllerWithCookieStrategy
+  def self.before_action(_); end
+  def self.after_action(_); end
+  def cookies; []; end
+  include Flip::CookieStrategy::Loader
+end
+
+describe Flip::CookieStrategy do
+
+  let(:cookies) do
+    { strategy.cookie_name(:one) => "true",
+      strategy.cookie_name(:two) => "false" }
+  end
+  let(:strategy) do
+    Flip::CookieStrategy.new.tap do |s|
+      s.stub(:cookies) { cookies }
+    end
+  end
+
+  its(:description) { should be_present }
+  it { should be_switchable }
+
+  describe "cookie interrogration" do
+    context "enabled feature" do
+      specify "#knows? is true" do
+        strategy.knows?(:one).should be true
+      end
+      specify "#on? is true" do
+        strategy.on?(:one).should be true
+      end
+    end
+    context "disabled feature" do
+      specify "#knows? is true" do
+        strategy.knows?(:two).should be true
+      end
+      specify "#on? is false" do
+        strategy.on?(:two).should be false
+      end
+    end
+    context "feature with no cookie present" do
+      specify "#knows? is false" do
+        strategy.knows?(:three).should be false
+      end
+      specify "#on? is false" do
+        strategy.on?(:three).should be false
+      end
+    end
+  end
+
+  describe "cookie manipulation" do
+    it "can switch known features on" do
+      strategy.switch! :one, true
+      strategy.on?(:one).should be true
+    end
+    it "can switch unknown features on" do
+      strategy.switch! :three, true
+      strategy.on?(:three).should be true
+    end
+    it "can switch features off" do
+      strategy.switch! :two, false
+      strategy.on?(:two).should be false
+    end
+    it "can delete knowledge of a feature" do
+      strategy.delete! :one
+      strategy.on?(:one).should be false
+      strategy.knows?(:one).should be false
+    end
+  end
+
+end
+
+describe Flip::CookieStrategy::Loader do
+
+  it "adds filters when included in controller" do
+    ControllerWithoutCookieStrategy.tap do |klass|
+      klass.should_receive(:before_action).with(:flip_cookie_strategy_before)
+      klass.should_receive(:after_action).with(:flip_cookie_strategy_after)
+      klass.send :include, Flip::CookieStrategy::Loader
+    end
+  end
+
+  describe "filter methods" do
+    let(:strategy) { Flip::CookieStrategy.new }
+    let(:controller) { ControllerWithCookieStrategy.new }
+    describe "#flip_cookie_strategy_before" do
+      it "passes controller cookies to CookieStrategy" do
+        controller.should_receive(:cookies).and_return(strategy.cookie_name(:test) => "true")
+        expect {
+          controller.flip_cookie_strategy_before
+        }.to change {
+          [ strategy.knows?(:test), strategy.on?(:test) ]
+        }.from([false, false]).to([true, true])
+      end
+    end
+    describe "#flip_cookie_strategy_after" do
+      before do
+        Flip::CookieStrategy.cookies = { strategy.cookie_name(:test) => "true" }
+      end
+      it "passes controller cookies to CookieStrategy" do
+        expect {
+          controller.flip_cookie_strategy_after
+        }.to change {
+          [ strategy.knows?(:test), strategy.on?(:test) ]
+        }.from([true, true]).to([false, false])
+      end
+    end
+  end
+
+end

data/spec/database_strategy_spec.rb

@@ -0,0 +1,110 @@
+require "spec_helper"
+
+describe Flip::DatabaseStrategy do
+
+  let(:definition) { double("definition", key: "one") }
+  let(:strategy) { Flip::DatabaseStrategy.new(model_klass) }
+  let(:model_klass) do
+    class Sample
+      attr_accessor :key
+
+      def enabled?
+        true
+      end
+    end
+
+    Class.new do
+      extend Flip::Cacheable
+      extend Flip::Declarable
+      feature :one
+      feature :two, description: "Second one."
+      feature :three, default: true
+
+      def self.all
+        list = []
+        keys = ['one', 'two', 'three']
+        3.times do |i|
+          list << Sample.new
+          list.last.key = keys[i]
+        end
+        list
+      end
+    end
+  end
+
+  let(:enabled_record) { model_klass.new.tap { |m| m.stub(:enabled?) { true } } }
+  let(:disabled_record) { model_klass.new.tap { |m| m.stub(:enabled?) { false } } }
+
+  subject { strategy }
+
+  its(:switchable?) { should be true }
+  its(:description) { should be_present }
+
+  let(:db_result) { [] }
+  before do
+    allow(model_klass).to(receive(:where).with(key: "one").and_return(db_result))
+  end
+
+  describe "#knows?" do
+    context "for unknown key" do
+      it "returns true" do
+        expect(strategy.knows?(definition)).to eq(false)
+      end
+    end
+    context "for known key" do
+      let(:db_result) { [disabled_record] }
+      it "returns false" do
+        expect(strategy.knows?(definition)).to eq(true)
+      end
+    end
+  end
+
+  describe "#on? with feature cache" do
+    before { model_klass.start_feature_cache }
+    context "for an enabled record" do
+      let(:db_result) { [enabled_record] }
+      it "returns true" do
+        expect(strategy.on?(definition)).to eq(true)
+      end
+    end
+  end
+
+  describe "#on?" do
+    context "for an enabled record" do
+      let(:db_result) { [enabled_record] }
+      it "returns true" do
+        expect(strategy.on?(definition)).to eq(true)
+      end
+    end
+    context "for a disabled record" do
+      let(:db_result) { [disabled_record] }
+      it "returns true" do
+        expect(strategy.on?(definition)).to eq(false)
+      end
+    end
+  end
+
+  describe "#switch!" do
+    it "can switch a feature on" do
+      expect(db_result).to receive(:first_or_initialize).and_return(disabled_record)
+      expect(disabled_record).to receive(:enabled=).with(true)
+      expect(disabled_record).to receive(:save!)
+      strategy.switch! :one, true
+    end
+    it "can switch a feature off" do
+      expect(db_result).to receive(:first_or_initialize).and_return(enabled_record)
+      expect(enabled_record).to receive(:enabled=).with(false)
+      expect(enabled_record).to receive(:save!)
+      strategy.switch! :one, false
+    end
+  end
+
+  describe "#delete!" do
+    let(:db_result) { [enabled_record] }
+    it "can delete a feature record" do
+      enabled_record.should_receive(:try).with(:destroy)
+      strategy.delete! :one
+    end
+  end
+
+end