detour 0.0.1

data/spec/lib/active_record/rollout/feature_spec.rb

@@ -0,0 +1,280 @@
+require "spec_helper"
+require "fakefs/spec_helpers"
+
+describe Detour::Feature do
+  it { should have_many(:flaggable_flags) }
+  it { should have_many(:group_flags) }
+  it { should have_many(:percentage_flags) }
+  it { should have_many(:opt_out_flags) }
+  it { should have_many(:flags).dependent(:destroy) }
+  it { should validate_presence_of :name }
+  it { should validate_uniqueness_of :name }
+  it { should allow_mass_assignment_of :name }
+
+  describe ".all_with_lines" do
+    include FakeFS::SpecHelpers
+
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.grep_dirs = ["/foo/**/*.rb"]
+
+      FileUtils.mkdir("/foo")
+
+      File.open("/foo/bar.rb", "w") do |file|
+        file.write <<-EOF
+          current_user.has_feature?(:foo) do
+          end
+
+          current_user.has_feature?(:bar) do
+          end
+
+          current_user.has_feature?(:foo) do
+          end
+        EOF
+      end
+
+      File.open("/foo/baz.rb", "w") do |file|
+        file.write <<-EOF
+          current_user.has_feature?(:foo) || current_user.has_feature?(:bar)
+
+          current_user.has_feature? :bar do
+          end
+        EOF
+      end
+    end
+
+    it "fetches lines for persisted features" do
+      persisted_feature = Detour::Feature.all_with_lines.detect { |f| f.name == feature.name }
+      persisted_feature.lines.should eq %w[/foo/bar.rb#L1 /foo/bar.rb#L7 /foo/baz.rb#L1]
+    end
+
+    it "fetches lines for un-persisted features" do
+      unpersisted_feature = Detour::Feature.all_with_lines.detect { |f| f.name == "bar" }
+      unpersisted_feature.lines.should eq %w[/foo/bar.rb#L4 /foo/baz.rb#L1 /foo/baz.rb#L3]
+    end
+  end
+
+  describe ".define_{klass}_group" do
+    let(:block) { Proc.new {} }
+    it "defines a group for the given class" do
+      Detour::Feature.should_receive(:define_group_for_class).with("User", :id_is_1)
+      Detour::Feature.define_user_group :id_is_1, block
+    end
+  end
+
+  describe ".add_record_to_feature" do
+    let(:user) { User.create }
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.add_record_to_feature user, :foo
+    end
+
+    it "creates a flag for the given instance and feature" do
+      user.features.should include feature
+    end
+  end
+
+  describe ".remove_record_from_feature" do
+    let(:user) { User.create }
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.add_record_to_feature user, :foo
+      Detour::Feature.remove_record_from_feature user, :foo
+    end
+
+    it "creates a flag for the given instance and feature" do
+      user.features.should_not include feature
+    end
+  end
+
+  describe ".opt_record_out_of_feature" do
+    let(:user) { User.create }
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.add_percentage_to_feature "User", 100, "foo"
+      Detour::Feature.opt_record_out_of_feature user, "foo"
+    end
+
+    it "opts the record out of the feature" do
+      user.has_feature?("foo").should be_false
+    end
+  end
+
+  describe ".un_opt_record_out_of_feature" do
+    let(:user) { User.create }
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.add_percentage_to_feature "User", 100, "foo"
+      Detour::Feature.opt_record_out_of_feature user, "foo"
+      Detour::Feature.un_opt_record_out_of_feature user, "foo"
+    end
+
+    it "opts the record out of the feature" do
+      user.has_feature?("foo").should be_true
+    end
+  end
+
+  describe ".add_group_to_feature" do
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.define_user_group :bar do
+      end
+      Detour::Feature.add_group_to_feature "User", :bar, "foo"
+    end
+
+    it "creates a flag for the given group and feature" do
+      feature.group_flags.where(flaggable_type: "User", group_name: "bar").first.should_not be_nil
+    end
+  end
+
+  describe ".remove_group_from_feature" do
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.define_user_group :bar do
+      end
+      Detour::Feature.add_group_to_feature "User", :bar, "foo"
+      Detour::Feature.remove_group_from_feature "User", :bar, "foo"
+    end
+
+    it "destroys flags for the given group and feature" do
+      feature.group_flags.where(flaggable_type: "User", group_name: "bar").first.should be_nil
+    end
+  end
+
+  describe ".add_percentage_to_feature" do
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.add_percentage_to_feature "User", 50, "foo"
+    end
+
+    it "creates a flag for the given percentage and feature" do
+      feature.percentage_flags.where(flaggable_type: "User", percentage: 50).first.should_not be_nil
+    end
+  end
+
+  describe ".remove_percentage_from_feature" do
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.add_percentage_to_feature "User", 50, "foo"
+      Detour::Feature.remove_percentage_from_feature "User", "foo"
+    end
+
+    it "creates a flag for the given percentage and feature" do
+      feature.percentage_flags.where(flaggable_type: "User").first.should be_nil
+    end
+  end
+
+  describe ".define_group_for_class" do
+    let(:block) { Proc.new {} }
+    before do
+      Detour::Feature.send :define_group_for_class, "User", "user_id_1", &block
+    end
+
+    it "defines a group for the given class" do
+      Detour::Feature.defined_groups["User"].should eq({ "user_id_1" => block })
+    end
+  end
+
+  describe "#match?" do
+    let(:user) { User.create }
+    let(:feature) { Detour::Feature.create(name: "foo") }
+
+    it "checks if the user is flagged individually" do
+      feature.should_receive(:match_id?).with(user)
+      feature.match?(user)
+    end
+
+    it "checks if the user is flagged as part of a percentage" do
+      feature.should_receive(:match_percentage?).with(user)
+      feature.match?(user)
+    end
+
+    it "checks if the user is flagged as part of a group" do
+      feature.should_receive(:match_groups?).with(user)
+      feature.match?(user)
+    end
+  end
+
+  describe "#match_id?" do
+    let(:user) { User.create }
+    let(:user2) { User.create }
+    let!(:feature) { Detour::Feature.create!(name: "foo") }
+
+    before do
+      Detour::Feature.add_record_to_feature user, :foo
+    end
+
+    context "when the feature exists for the instance" do
+      it "returns true" do
+        feature.match_id?(user).should be_true
+      end
+    end
+
+    context "when the feature does not exist for the instance" do
+      it "returns false" do
+        feature.match_id?(user2).should be_false
+      end
+    end
+  end
+
+  describe "#match_percentage?" do
+    let(:user) { User.create }
+    let(:feature) { Detour::Feature.create!(name: "foo") }
+    let!(:flag) { feature.percentage_flags.create(flaggable_type: "User", percentage: 50) }
+
+    context "when the user's ID matches `id % 10 < percentage / 10" do
+      it "returns true" do
+        user.stub(:id) { 1 }
+        feature.match_percentage?(user).should be_true
+      end
+    end
+
+    context "when the user's ID does not match `id % 10 < percentage / 10" do
+      it "returns false" do
+        user.stub(:id) { 5 }
+        feature.match_percentage?(user).should be_false
+      end
+    end
+  end
+
+  describe "#match_groups?" do
+    let!(:user) { User.create(name: "foo") }
+    let!(:user2) { User.create(name: "bar") }
+    let!(:organization) { Organization.create(name: "foo") }
+    let(:feature) { Detour::Feature.create!(name: "baz") }
+    let!(:flag) { feature.group_flags.create(flaggable_type: "User", group_name: "foo_users") }
+
+    before do
+      Detour::Feature.define_user_group "foo_users" do |user|
+        user.name == "foo"
+      end
+    end
+
+    context "when the instance matches the block" do
+      it "returns true" do
+        feature.match_groups?(user).should be_true
+      end
+    end
+
+    context "when the instance does not match the block" do
+      it "returns false" do
+        feature.match_groups?(user2).should be_false
+      end
+    end
+
+    context "when the instance is not of the type of the block" do
+      it "returns false" do
+        feature.match_groups?(organization).should be_false
+      end
+    end
+  end
+end

data/spec/lib/active_record/rollout/flag_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Detour::Flag do
+  it { should belong_to :feature }
+  it { should validate_presence_of :feature_id }
+  it { should validate_presence_of :flaggable_type }
+  it { should allow_mass_assignment_of :flaggable_type }
+end

data/spec/lib/active_record/rollout/flaggable_flag_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe Detour::FlaggableFlag do
+  it { should be_a Detour::Flag }
+  it { should belong_to :flaggable }
+  it { should validate_presence_of :flaggable_id }
+  it { should allow_mass_assignment_of :flaggable }
+  it { should validate_uniqueness_of :feature_id }
+end

data/spec/lib/active_record/rollout/flaggable_spec.rb

@@ -0,0 +1,149 @@
+require "spec_helper"
+
+describe Detour::Flaggable do
+  subject { User.new }
+
+  describe "#flaggable_find!" do
+    context "when a non-default find_by is not specified" do
+      it "finds by id" do
+        User.should_receive(:find_by_id!).with(1)
+        User.flaggable_find!(1)
+      end
+    end
+
+    context "when a non-default find_by is not specified" do
+      class Foo < ActiveRecord::Base
+        acts_as_flaggable find_by: :email
+      end
+
+      it "finds by id" do
+        Foo.should_receive(:find_by_email!).with("user@example.com")
+        Foo.flaggable_find!("user@example.com")
+      end
+    end
+  end
+
+  describe "#has_feature?" do
+    let(:user) { User.create(name: "foo") }
+    let(:feature) { Detour::Feature.create(name: "bar") }
+
+    it "memoizes found features" do
+      Detour::Feature.stub(:find_by_name) { feature }
+      feature.flaggable_flags.create(flaggable: user)
+
+      feature.should_receive(:match?).with(user).and_return(true)
+      user.has_feature?(:bar)
+
+      feature.should_not_receive(:match?).with(user)
+      user.has_feature?(:bar)
+    end
+
+    context "when given a block" do
+      context "and the user is flagged in" do
+        before do
+          feature.flaggable_flags.create(flaggable: user)
+        end
+
+        it "calls the block" do
+          foo = "foo"
+          user.has_feature?(:bar) { foo = "bar" }
+          foo.should eq "bar"
+        end
+
+        it "returns the match" do
+          foo = "foo"
+
+          if user.has_feature? :not_feature do
+          end; else
+            foo = "bar"
+          end
+
+          foo.should eq "bar"
+        end
+
+        context "when the block raises an exception" do
+          it "increments the failure_count of the feature" do
+            begin
+              user.has_feature? :bar do
+                raise "This is an exception"
+              end
+            rescue
+              feature.reload.failure_count.should eq 1
+            end
+          end
+
+          it "raises the exception" do
+            expect do
+              user.has_feature? :bar do
+                raise "This is an exception"
+              end
+            end.to raise_error "This is an exception"
+          end
+        end
+      end
+
+      context "and the user is not flagged in" do
+        it "does not call the block" do
+          foo = "foo"
+          user.has_feature?(:bar) { foo = "bar" }
+          foo.should eq "foo"
+        end
+      end
+    end
+
+    context "when the user is not flagged in" do
+      it "returns false" do
+        user.has_feature?(:bar).should be_false
+      end
+    end
+
+    context "when the user is flagged in" do
+      context "and the user is opted out" do
+        before do
+          feature.flaggable_flags.create(flaggable: user)
+          feature.opt_out_flags.create(flaggable: user)
+        end
+
+        it "returns false" do
+          user.has_feature?(:bar).should be_false
+        end
+      end
+
+      context "and the user is not opted out" do
+        context "and the user is flagged in individually" do
+          before do
+            feature.flaggable_flags.create(flaggable: user)
+          end
+
+          it "returns true" do
+            user.has_feature?(:bar).should be_true
+          end
+        end
+
+        context "and the user is flagged in as a percentage" do
+          before do
+            feature.percentage_flags.create(flaggable_type: "User", percentage: 100)
+          end
+
+          it "returns true" do
+            user.has_feature?(:bar).should be_true
+          end
+        end
+
+        context "and the user is flagged in via a group" do
+          before do
+            Detour::Feature.define_user_group "name_foo" do |user|
+              user.name == "foo"
+            end
+
+            feature.group_flags.create(flaggable_type: "User", group_name: "name_foo")
+          end
+
+          it "returns true" do
+            user.has_feature?(:bar).should be_true
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/active_record/rollout/group_flag_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Detour::GroupFlag do
+  it { should be_a Detour::Flag }
+  it { should validate_presence_of :group_name }
+  it { should allow_mass_assignment_of :group_name }
+  it { should validate_uniqueness_of :feature_id }
+end

data/spec/lib/active_record/rollout/opt_out_flag_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe Detour::OptOutFlag do
+  it { should be_a Detour::Flag }
+  it { should belong_to :flaggable }
+  it { should validate_presence_of :flaggable_id }
+  it { should allow_mass_assignment_of :flaggable}
+  it { should validate_uniqueness_of :feature_id }
+end

data/spec/lib/active_record/rollout/percentage_flag_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe Detour::PercentageFlag do
+  subject { Detour::PercentageFlag.new(feature_id: 1, flaggable_type: "User") }
+
+  it { should be_a Detour::Flag }
+  it { should validate_numericality_of(:percentage).is_greater_than(0).is_less_than_or_equal_to(100) }
+  it { should allow_mass_assignment_of :percentage }
+  it { should validate_uniqueness_of :feature_id }
+end

data/spec/lib/tasks/detour_rake_spec.rb

@@ -0,0 +1,162 @@
+require "spec_helper"
+
+describe "detour:create" do
+  include_context "rake"
+
+  it "creates the given feature" do
+    Detour::Feature.should_receive(:find_or_create_by_name!).with("foo")
+    subject.invoke("foo")
+  end
+end
+
+describe "detour:destroy" do
+  include_context "rake"
+
+  let(:feature) { Detour::Feature.create(name: "foo") }
+
+  it "destroys the given feature" do
+    Detour::Feature.should_receive(:find_by_name!).with(feature.name).and_return(feature)
+    feature.should_receive(:destroy)
+    subject.invoke("foo")
+  end
+end
+
+describe "detour:activate" do
+  include_context "rake"
+
+  let(:user) { User.create(name: "foo") }
+  let!(:feature) { Detour::Feature.create(name: "foo") }
+
+  it "activates the feature for the record" do
+    Detour::Feature.should_receive(:add_record_to_feature).with(user, "foo")
+    subject.invoke("foo", "User", user.id.to_s)
+  end
+
+  it "does not require a class if defined_flaggable_class is set" do
+    Detour::Feature.should_receive(:add_record_to_feature).with(user, "foo")
+    Detour::Feature.instance_variable_set "@default_flaggable_class_name", "User"
+    expect { subject.invoke("foo", user.id.to_s) }.to_not raise_error
+  end
+end
+
+describe "detour:deactivate" do
+  include_context "rake"
+
+  let(:user) { User.create(name: "foo") }
+  let!(:feature) { Detour::Feature.create(name: "foo") }
+
+  it "deactivates the feature for the record" do
+    Detour::Feature.should_receive(:remove_record_from_feature).with(user, "foo")
+    subject.invoke("foo", "User", user.id.to_s)
+  end
+
+  it "does not require a class if defined_flaggable_class is set" do
+    Detour::Feature.should_receive(:remove_record_from_feature).with(user, "foo")
+    Detour::Feature.instance_variable_set "@default_flaggable_class_name", "User"
+    expect { subject.invoke("foo", user.id.to_s) }.to_not raise_error
+  end
+end
+
+describe "detour:opt_out" do
+  include_context "rake"
+
+  let(:user) { User.create(name: "foo") }
+  let!(:feature) { Detour::Feature.create(name: "foo") }
+
+  it "deactivates the feature for the record" do
+    Detour::Feature.should_receive(:opt_record_out_of_feature).with(user, "foo")
+    subject.invoke("foo", "User", user.id.to_s)
+  end
+
+  it "does not require a class if defined_flaggable_class is set" do
+    Detour::Feature.should_receive(:opt_record_out_of_feature).with(user, "foo")
+    Detour::Feature.instance_variable_set "@default_flaggable_class_name", "User"
+    expect { subject.invoke("foo", user.id.to_s) }.to_not raise_error
+  end
+end
+
+describe "detour:un_opt_out" do
+  include_context "rake"
+
+  let(:user) { User.create(name: "foo") }
+  let!(:feature) { Detour::Feature.create(name: "foo") }
+
+  it "deactivates the feature for the record" do
+    Detour::Feature.should_receive(:un_opt_record_out_of_feature).with(user, "foo")
+    subject.invoke("foo", "User", user.id.to_s)
+  end
+
+  it "does not require a class if defined_flaggable_class is set" do
+    Detour::Feature.should_receive(:un_opt_record_out_of_feature).with(user, "foo")
+    Detour::Feature.instance_variable_set "@default_flaggable_class_name", "User"
+    expect { subject.invoke("foo", user.id.to_s) }.to_not raise_error
+  end
+end
+
+describe "detour:activate_group" do
+  include_context "rake"
+
+  let!(:feature) { Detour::Feature.create(name: "foo") }
+
+  it "activates the feature for the group" do
+    Detour::Feature.should_receive(:add_group_to_feature).with("User", "admins", "foo")
+    subject.invoke("foo", "User", "admins")
+  end
+
+  it "does not require a class if defined_flaggable_class is set" do
+    Detour::Feature.should_receive(:add_group_to_feature).with("User", "admins", "foo")
+    Detour::Feature.instance_variable_set "@default_flaggable_class_name", "User"
+    expect { subject.invoke("foo", "admins") }.to_not raise_error
+  end
+end
+
+describe "detour:deactivate_group" do
+  include_context "rake"
+
+  let!(:feature) { Detour::Feature.create(name: "foo") }
+
+  it "deactivates the feature for the group" do
+    Detour::Feature.should_receive(:remove_group_from_feature).with("User", "admins", "foo")
+    subject.invoke("foo", "User", "admins")
+  end
+
+  it "does not require a class if defined_flaggable_class is set" do
+    Detour::Feature.should_receive(:remove_group_from_feature).with("User", "admins", "foo")
+    Detour::Feature.instance_variable_set "@default_flaggable_class_name", "User"
+    expect { subject.invoke("foo", "admins") }.to_not raise_error
+  end
+end
+
+describe "detour:activate_percentage" do
+  include_context "rake"
+
+  let!(:feature) { Detour::Feature.create(name: "foo") }
+
+  it "activates the feature for the percentage" do
+    Detour::Feature.should_receive(:add_percentage_to_feature).with("User", 50, "foo")
+    subject.invoke("foo", "User", "50")
+  end
+
+  it "does not require a class if defined_flaggable_class is set" do
+    Detour::Feature.should_receive(:add_percentage_to_feature).with("User", 50, "foo")
+    Detour::Feature.instance_variable_set "@default_flaggable_class_name", "User"
+    expect { subject.invoke("foo", "50") }.to_not raise_error
+  end
+end
+
+describe "detour:deactivate_percentage" do
+  include_context "rake"
+
+  let!(:feature) { Detour::Feature.create(name: "foo") }
+
+  it "deactivates the feature for the percentage" do
+    Detour::Feature.should_receive(:remove_percentage_from_feature).with("User", "foo")
+    subject.invoke("foo", "User")
+  end
+
+  it "does not require a class if defined_flaggable_class is set" do
+    Detour::Feature.should_receive(:remove_percentage_from_feature).with("User", "foo")
+    Detour::Feature.instance_variable_set "@default_flaggable_class_name", "User"
+    expect { subject.invoke("foo") }.to_not raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require "rails"
+require "active_record"
+require "detour"
+require "shoulda-matchers"
+require "generators/templates/migration"
+require "support/shared_contexts/rake"
+require "pry"
+
+class User < ActiveRecord::Base
+  acts_as_flaggable
+end
+
+class Organization < ActiveRecord::Base
+  acts_as_flaggable
+end
+
+RSpec.configure do |config|
+  config.before :suite do
+    ActiveRecord::Base.establish_connection \
+      adapter: "sqlite3",
+      database: File.dirname(__FILE__) + "/spec.sqlite3"
+
+    require File.dirname(__FILE__) + "/support/schema.rb"
+  end
+
+  config.before :each do
+    SetupDetour.migrate :up
+    ActiveRecord::Schema.migrate :up
+  end
+
+  config.after :each do
+    SetupDetour.migrate :down
+    ActiveRecord::Schema.migrate :down
+  end
+
+  config.after :each do
+    Detour::Feature.instance_variable_set "@defined_groups", {}
+    Detour::Feature.instance_variable_set "@default_flaggable_class_name", nil
+  end
+end

data/spec/support/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, force: true do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :organizations, force: true do |t|
+    t.string :name
+    t.timestamps
+  end
+end