flipper 0.1.0

data/spec/flipper/feature_spec.rb

@@ -0,0 +1,401 @@
+require 'helper'
+require 'flipper/feature'
+require 'flipper/adapters/memory'
+
+describe Flipper::Feature do
+  subject           { Flipper::Feature.new(:search, adapter) }
+
+  let(:source)      { {} }
+  let(:adapter)     { Flipper::Adapters::Memory.new(source) }
+
+  let(:actor_key)   { Flipper::Gates::Actor::Key }
+  let(:boolean_key) { Flipper::Gates::Boolean::Key }
+  let(:group_key)   { Flipper::Gates::Group::Key }
+
+  let(:admin_group) { Flipper.group(:admins) }
+  let(:dev_group)   { Flipper.group(:devs) }
+
+  let(:admin_thing) { double 'Non Flipper Thing', :admin? => true, :dev? => false }
+  let(:dev_thing)   { double 'Non Flipper Thing', :admin? => false, :dev? => true }
+
+  let(:pitt)        { Flipper::Types::Actor.new(1) }
+  let(:clooney)     { Flipper::Types::Actor.new(10) }
+
+  let(:five_percent_of_actors)   { Flipper::Types::PercentageOfActors.new(5) }
+  let(:percentage_of_actors_key) { Flipper::Gates::PercentageOfActors::Key }
+
+  let(:five_percent_of_random)     { Flipper::Types::PercentageOfRandom.new(5) }
+  let(:percentage_of_random_key)   { Flipper::Gates::PercentageOfRandom::Key }
+
+  before do
+    Flipper.register(:admins) { |thing| thing.admin? }
+    Flipper.register(:devs)   { |thing| thing.dev? }
+  end
+
+  it "initializes with name and adapter" do
+    feature = Flipper::Feature.new(:search, adapter)
+    feature.should be_instance_of(Flipper::Feature)
+  end
+
+  describe "#name" do
+    it "returns name" do
+      subject.name.should eq(:search)
+    end
+  end
+
+  describe "#adapter" do
+    it "returns adapter" do
+      subject.adapter.should eq(adapter)
+    end
+  end
+
+  describe "#enable" do
+    context "with no arguments" do
+      before do
+        subject.enable
+      end
+
+      it "enables feature for all" do
+        subject.enabled?.should be_true
+      end
+    end
+
+    context "with a group" do
+      before do
+        subject.enable(admin_group)
+      end
+
+      it "enables feature for non flipper thing in group" do
+        subject.enabled?(admin_thing).should be_true
+      end
+
+      it "does not enable feature for non flipper thing in other group" do
+        subject.enabled?(dev_thing).should be_false
+      end
+
+      it "does not enable feature for all" do
+        subject.enabled?.should be_false
+      end
+    end
+
+    context "with an actor" do
+      before do
+        subject.enable(pitt)
+      end
+
+      it "enables feature for actor" do
+        subject.enabled?(pitt).should be_true
+      end
+
+      it "does not enable feature for other actors" do
+        subject.enabled?(clooney).should be_false
+      end
+    end
+
+    context "with a percentage of actors" do
+      before do
+        subject.enable(five_percent_of_actors)
+      end
+
+      it "enables feature for actor within percentage" do
+        subject.enabled?(pitt).should be_true
+      end
+
+      it "does not enable feature for actors not within percentage" do
+        subject.enabled?(clooney).should be_false
+      end
+    end
+
+    context "with a percentage of time" do
+      before do
+        @gate = Flipper::Gates::PercentageOfRandom.new(subject)
+        Flipper::Gates::PercentageOfRandom.should_receive(:new).and_return(@gate)
+        subject.enable(five_percent_of_random)
+      end
+
+      it "enables feature for time within percentage" do
+        @gate.stub(:rand => 0.04)
+        subject.enabled?.should be_true
+      end
+
+      it "does not enable feature for time not within percentage" do
+        @gate.stub(:rand => 0.10)
+        subject.enabled?.should be_false
+      end
+    end
+
+    context "with argument that has no gate" do
+      it "raises error" do
+        thing = Object.new
+        expect {
+          subject.enable(thing)
+        }.to raise_error(Flipper::GateNotFound, "Could not find gate for #{thing.inspect}")
+      end
+    end
+  end
+
+  describe "#disable" do
+    context "with no arguments" do
+      before do
+        adapter.set_add("#{subject.name}#{Flipper::Gate::Separator}#{group_key}", admin_group.name)
+        subject.disable
+      end
+
+      it "disables feature" do
+        subject.enabled?.should be_false
+      end
+
+      it "disables feature for non flipper thing in previously enabled groups" do
+        subject.enabled?(admin_thing).should be_false
+      end
+    end
+
+    context "with a group" do
+      before do
+        adapter.set_add("#{subject.name}#{Flipper::Gate::Separator}#{group_key}", dev_group.name)
+        adapter.set_add("#{subject.name}#{Flipper::Gate::Separator}#{group_key}", admin_group.name)
+        subject.disable(admin_group)
+      end
+
+      it "disables the feature for non flipper thing in the group" do
+        subject.enabled?(admin_thing).should be_false
+      end
+
+      it "does not disable feature for non flipper thing in other groups" do
+        subject.enabled?(dev_thing).should be_true
+      end
+    end
+
+    context "with an actor" do
+      before do
+        adapter.set_add("#{subject.name}#{Flipper::Gate::Separator}#{actor_key}", pitt.identifier)
+        adapter.set_add("#{subject.name}#{Flipper::Gate::Separator}#{actor_key}", clooney.identifier)
+        subject.disable(pitt)
+      end
+
+      it "disables feature for actor" do
+        subject.enabled?(pitt).should be_false
+      end
+
+      it "does not disable feature for other actors" do
+        subject.enabled?(clooney).should be_true
+      end
+    end
+
+    context "with a percentage of actors" do
+      before do
+        subject.disable(five_percent_of_actors)
+      end
+
+      it "disables feature for actor within percentage" do
+        subject.enabled?(pitt).should be_false
+      end
+
+      it "disables feature for actors not within percentage" do
+        subject.enabled?(clooney).should be_false
+      end
+    end
+
+    context "with a percentage of time" do
+      before do
+        @gate = Flipper::Gates::PercentageOfRandom.new(subject)
+        Flipper::Gates::PercentageOfRandom.should_receive(:new).and_return(@gate)
+        subject.disable(five_percent_of_random)
+      end
+
+      it "disables feature for time within percentage" do
+        @gate.stub(:rand => 0.04)
+        subject.enabled?.should be_false
+      end
+
+      it "disables feature for time not within percentage" do
+        @gate.stub(:rand => 0.10)
+        subject.enabled?.should be_false
+      end
+    end
+
+    context "with argument that has no gate" do
+      it "raises error" do
+        thing = Object.new
+        expect {
+          subject.disable(thing)
+        }.to raise_error(Flipper::GateNotFound, "Could not find gate for #{thing.inspect}")
+      end
+    end
+  end
+
+  describe "#enabled?" do
+    context "with no arguments" do
+      it "defaults to false" do
+        subject.enabled?.should be_false
+      end
+    end
+
+    context "with no arguments, but boolean enabled" do
+      before do
+        adapter.write("#{subject.name}#{Flipper::Gate::Separator}#{boolean_key}", true)
+      end
+
+      it "returns true" do
+        subject.enabled?.should be_true
+      end
+    end
+
+    context "for enabled actor" do
+      before do
+        adapter.set_add("#{subject.name}#{Flipper::Gate::Separator}#{actor_key}", pitt.identifier)
+      end
+
+      it "returns true" do
+        subject.enabled?(pitt).should be_true
+      end
+    end
+
+    context "for not enabled actor" do
+      it "returns false" do
+        subject.enabled?(clooney).should be_false
+      end
+
+      it "returns true if boolean enabled" do
+        adapter.write("#{subject.name}#{Flipper::Gate::Separator}#{boolean_key}", true)
+        subject.enabled?(clooney).should be_true
+      end
+    end
+
+    context "for actor in percentage of actors enabled" do
+      before do
+        adapter.write("#{subject.name}#{Flipper::Gate::Separator}#{percentage_of_actors_key}", five_percent_of_actors.value)
+      end
+
+      it "returns true" do
+        subject.enabled?(pitt).should be_true
+      end
+    end
+
+    context "for actor not in percentage of actors enabled" do
+      before do
+        adapter.write("#{subject.name}#{Flipper::Gate::Separator}#{percentage_of_actors_key}", five_percent_of_actors.value)
+      end
+
+      it "returns false" do
+        subject.enabled?(clooney).should be_false
+      end
+
+      it "returns true if boolean enabled" do
+        adapter.write("#{subject.name}#{Flipper::Gate::Separator}#{boolean_key}", true)
+        subject.enabled?(clooney).should be_true
+      end
+    end
+
+    context "during enabled percentage of time" do
+      before do
+        @gate = Flipper::Gates::PercentageOfRandom.new(subject)
+        @gate.stub(:rand => 0.04)
+        Flipper::Gates::PercentageOfRandom.should_receive(:new).and_return(@gate)
+        adapter.write("#{subject.name}#{Flipper::Gate::Separator}#{percentage_of_random_key}", five_percent_of_random.value)
+      end
+
+      it "returns true" do
+        subject.enabled?.should be_true
+        subject.enabled?(nil).should be_true
+        subject.enabled?(pitt).should be_true
+        subject.enabled?(admin_thing).should be_true
+      end
+    end
+
+    context "during not enabled percentage of time" do
+      before do
+        @gate = Flipper::Gates::PercentageOfRandom.new(subject)
+        @gate.stub(:rand => 0.10)
+        Flipper::Gates::PercentageOfRandom.should_receive(:new).and_return(@gate)
+        adapter.write("#{subject.name}#{Flipper::Gate::Separator}#{percentage_of_random_key}", five_percent_of_random.value)
+      end
+
+      it "returns false" do
+        subject.enabled?.should be_false
+        subject.enabled?(nil).should be_false
+        subject.enabled?(pitt).should be_false
+        subject.enabled?(admin_thing).should be_false
+      end
+
+      it "returns true if boolean enabled" do
+        adapter.write("#{subject.name}#{Flipper::Gate::Separator}#{boolean_key}", true)
+        subject.enabled?.should be_true
+        subject.enabled?(nil).should be_true
+        subject.enabled?(pitt).should be_true
+        subject.enabled?(admin_thing).should be_true
+      end
+    end
+
+    context "for a non flipper thing" do
+      before do
+        adapter.set_add("#{subject.name}#{Flipper::Gate::Separator}#{group_key}", admin_group.name)
+      end
+
+      it "returns true if in enabled group" do
+        subject.enabled?(admin_thing).should be_true
+      end
+
+      it "returns false if not in enabled group" do
+        subject.enabled?(dev_thing).should be_false
+      end
+
+      it "returns true if boolean enabled" do
+        adapter.write("#{subject.name}#{Flipper::Gate::Separator}#{boolean_key}", true)
+        subject.enabled?(admin_thing).should be_true
+        subject.enabled?(dev_thing).should be_true
+      end
+    end
+
+    context "for a non flipper thing that does not respond to something in group block" do
+      let(:actor) { double('Actor') }
+
+      before do
+        adapter.set_add("#{subject.name}#{Flipper::Gate::Separator}#{group_key}", admin_group.name)
+      end
+
+      it "returns false" do
+        expect { subject.enabled?(actor) }.to raise_error
+      end
+    end
+
+    context "for a non flipper thing when group in adapter, but not defined in code" do
+      let(:actor) { double('Actor') }
+
+      before do
+        adapter.set_add("#{subject.name}#{Flipper::Gate::Separator}#{group_key}", :support)
+      end
+
+      it "returns false" do
+        subject.enabled?(actor).should be_false
+      end
+    end
+  end
+
+  context "#disabled?" do
+    it "returns the opposite of enabled" do
+      subject.stub(:enabled? => true)
+      subject.disabled?.should be_false
+
+      subject.stub(:enabled? => false)
+      subject.disabled?.should be_true
+    end
+  end
+
+  context "enabling multiple groups, disabling everything, then enabling one group" do
+    before do
+      subject.enable(admin_group)
+      subject.enable(dev_group)
+      subject.disable
+      subject.enable(admin_group)
+    end
+
+    it "enables feature for object in enabled group" do
+      subject.enabled?(admin_thing).should be_true
+    end
+
+    it "does not enable feature for object in not enabled group" do
+      subject.enabled?(dev_thing).should be_false
+    end
+  end
+end

data/spec/flipper/registry_spec.rb

@@ -0,0 +1,71 @@
+require 'helper'
+require 'flipper/registry'
+
+describe Flipper::Registry do
+  subject { Flipper::Registry.new(source) }
+
+  let(:source) { {} }
+
+  describe "#add" do
+    it "adds to source" do
+      value = 'thing'
+      subject.add(:admins, value)
+      source[:admins].should eq(value)
+    end
+
+    it "raises exception if key already registered" do
+      subject.add(:admins, 'thing')
+
+      expect {
+        subject.add(:admins, 'again')
+      }.to raise_error(Flipper::Registry::DuplicateKey)
+    end
+  end
+
+  describe "#get" do
+    context "key registered" do
+      before do
+        source[:admins] = 'thing'
+      end
+
+      it "returns value" do
+        subject.get(:admins).should eq('thing')
+      end
+    end
+
+    context "key not registered" do
+      it "raises key not found" do
+        subject.get(:admins).should be_nil
+      end
+    end
+  end
+
+  describe "#each" do
+    before do
+      source[:admins] = 'admins'
+      source[:devs] = 'devs'
+    end
+
+    it "iterates source keys and values" do
+      results = {}
+      subject.each do |key, value|
+        results[key] = value
+      end
+      results.should eq({
+        :admins => 'admins',
+        :devs => 'devs',
+      })
+    end
+  end
+
+  describe "#clear" do
+    before do
+      source[:admins] = 'admins'
+    end
+
+    it "clears the source" do
+      subject.clear
+      source.should be_empty
+    end
+  end
+end