flipper 0.3.0 → 0.4.0

data/lib/flipper/toggle.rb

@@ -1,21 +1,29 @@
 require 'forwardable'
 
 module Flipper
+  # Internal: Used by gate to toggle values (true/false, add/delete from set, etc.).
+  # Named poorly maybe, but haven't come up with a better name yet.
   class Toggle
     extend Forwardable
 
     attr_reader :gate
 
-    def_delegators :@gate, :key, :feature, :adapter
+    def_delegators :@gate, :adapter_key, :feature, :adapter
 
     def initialize(gate)
       @gate = gate
     end
 
+    # Internal: Enables thing for gate and adds feature to known features.
+    #
+    # Returns Boolean (currently always true).
     def enable(thing)
       add_feature_to_set
     end
 
+    # Internal: Disables thing for gate and adds feature to known features.
+    #
+    # Returns Boolean (currently always true).
     def disable(thing)
       add_feature_to_set
     end
@@ -24,10 +32,19 @@ module Flipper
       raise 'Not implemented'
     end
 
+    # Public: Pretty string version for debugging.
+    def inspect
+      attributes = [
+        "gate=#{gate.inspect}",
+        "value=#{value}",
+      ]
+      "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
+    end
+
     private
 
     def add_feature_to_set
-      adapter.feature_add key.prefix
+      adapter.feature_add adapter_key.feature_name
     end
   end
 end

data/lib/flipper/toggles/boolean.rb

@@ -1,20 +1,53 @@
 module Flipper
   module Toggles
     class Boolean < Toggle
+      TruthMap = {
+        true    => true,
+        'true'  => true,
+        'TRUE'  => true,
+        'True'  => true,
+        't'     => true,
+        'T'     => true,
+        '1'     => true,
+        'on'    => true,
+        'ON'    => true,
+        1       => true,
+        1.0     => true,
+        false   => false,
+        'false' => false,
+        'FALSE' => false,
+        'False' => false,
+        'f'     => false,
+        'F'     => false,
+        '0'     => false,
+        'off'   => false,
+        'OFF'   => false,
+        0       => false,
+        0.0     => false,
+        nil     => false,
+      }
+
       def enable(thing)
         super
-        adapter.write key, thing.value
+        adapter.write adapter_key, thing.value
+        true
       end
 
       def disable(thing)
         super
         feature.gates.each do |gate|
-          gate.adapter.delete gate.key
+          gate.adapter.delete gate.adapter_key
         end
+        true
       end
 
       def value
-        adapter.read key
+        value = adapter.read(adapter_key)
+        !!TruthMap[value]
+      end
+
+      def enabled?
+        value
       end
     end
   end

data/lib/flipper/toggles/set.rb

@@ -3,16 +3,22 @@ module Flipper
     class Set < Toggle
       def enable(thing)
         super
-        adapter.set_add key, thing.value
+        adapter.set_add adapter_key, thing.value
+        true
       end
 
       def disable(thing)
         super
-        adapter.set_delete key, thing.value
+        adapter.set_delete adapter_key, thing.value
+        true
       end
 
       def value
-        adapter.set_members key
+        adapter.set_members adapter_key
+      end
+
+      def enabled?
+        !value.empty?
       end
     end
   end

data/lib/flipper/toggles/value.rb

@@ -3,16 +3,22 @@ module Flipper
     class Value < Toggle
       def enable(thing)
         super
-        adapter.write key, thing.value
+        adapter.write adapter_key, thing.value
+        true
       end
 
       def disable(thing)
         super
-        adapter.delete key
+        adapter.delete adapter_key
+        true
       end
 
       def value
-        adapter.read key
+        adapter.read adapter_key
+      end
+
+      def enabled?
+        !value.nil? && value.to_i > 0
       end
     end
   end

data/lib/flipper/type.rb

@@ -1,4 +1,5 @@
 module Flipper
+  # Internal: Root class for all flipper types. You should never need to use this.
   class Type
     def value
       raise 'Not implemented'

data/lib/flipper/types/actor.rb

@@ -2,9 +2,9 @@ module Flipper
   module Types
     class Actor < Type
       def self.wrappable?(thing)
-        thing.is_a?(Flipper::Types::Actor) ||
-          thing.respond_to?(:identifier) ||
-          thing.respond_to?(:to_i)
+        return false if thing.nil?
+        return true if thing.is_a?(Flipper::Types::Actor)
+        thing.respond_to?(:flipper_id)
       end
 
       def self.wrap(thing)
@@ -15,21 +15,19 @@ module Flipper
         end
       end
 
-      attr_reader :identifier
+      attr_reader :value
 
       def initialize(thing)
-        raise ArgumentError, "thing cannot be nil" if thing.nil?
+        if thing.nil?
+          raise ArgumentError.new("thing cannot be nil")
+        end
 
-        @thing = thing
-        @identifier = if thing.respond_to?(:identifier)
-          thing.identifier
-        else
-          thing
-        end.to_i
-      end
+        unless thing.respond_to?(:flipper_id)
+          raise ArgumentError.new("#{thing.inspect} must respond to flipper_id, but does not")
+        end
 
-      def value
-        @identifier
+        @thing = thing
+        @value = thing.flipper_id.to_s
       end
 
       def respond_to?(*args)

data/lib/flipper/types/percentage.rb

@@ -4,13 +4,19 @@ module Flipper
       attr_reader :value
 
       def initialize(value)
-        @value = value.to_i
+        value = value.to_i
+
+        if value < 0 || value > 100
+          raise ArgumentError, "value must be a positive number less than or equal to 100, but was #{value}"
+        end
+
+        @value = value
       end
 
       def eql?(other)
         self.class.eql?(other.class) && value == other.value
       end
-      alias :== :eql?
+      alias_method :==, :eql?
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/flipper/adapter_spec.rb

@@ -1,13 +1,15 @@
 require 'helper'
 require 'flipper/adapter'
 require 'flipper/adapters/memory'
+require 'flipper/instrumenters/memory'
 
 describe Flipper::Adapter do
   let(:local_cache)  { {} }
-  let(:adapter)      { Flipper::Adapters::Memory.new }
+  let(:source)       { {} }
+  let(:adapter)      { Flipper::Adapters::Memory.new(source) }
   let(:features_key) { described_class::FeaturesKey }
 
-  subject { described_class.new(adapter, local_cache) }
+  subject { described_class.new(adapter, :local_cache => local_cache) }
 
   describe ".wrap" do
     context "with Flipper::Adapter instance" do
@@ -15,8 +17,12 @@ describe Flipper::Adapter do
         @result = described_class.wrap(subject)
       end
 
-      it "returns self" do
-        @result.should be(subject)
+      it "returns same Flipper::Adapter instance" do
+        @result.should equal(subject)
+      end
+
+      it "wraps adapter that instance was wrapping" do
+        @result.adapter.should be(subject.adapter)
       end
     end
 
@@ -30,11 +36,54 @@ describe Flipper::Adapter do
       end
 
       it "wraps adapter" do
-        @result.adapter.should eq(adapter)
+        @result.adapter.should be(adapter)
+      end
+    end
+
+    context "with adapter instance and options" do
+      let(:instrumenter) { double('Instrumentor') }
+
+      before do
+        @result = described_class.wrap(adapter, :instrumenter => instrumenter)
+      end
+
+      it "returns Flipper::Adapter instance" do
+        @result.should be_instance_of(described_class)
+      end
+
+      it "wraps adapter" do
+        @result.adapter.should be(adapter)
+      end
+
+      it "passes options to initialization" do
+        @result.instrumenter.should be(instrumenter)
       end
     end
   end
 
+  describe "#initialize" do
+    it "sets adapter" do
+      instance = described_class.new(adapter)
+      instance.adapter.should be(adapter)
+    end
+
+    it "sets adapter name" do
+      instance = described_class.new(adapter)
+      instance.name.should be(:memory)
+    end
+
+    it "defaults instrumenter" do
+      instance = described_class.new(adapter)
+      instance.instrumenter.should be(Flipper::Instrumenters::Noop)
+    end
+
+    it "allows overriding instrumenter" do
+      instrumenter = double('Instrumentor', :instrument => nil)
+      instance = described_class.new(adapter, :instrumenter => instrumenter)
+      instance.instrumenter.should be(instrumenter)
+    end
+  end
+
   describe "#use_local_cache=" do
     it "sets value" do
       subject.use_local_cache = true
@@ -86,18 +135,18 @@ describe Flipper::Adapter do
 
     describe "#set_members" do
       before do
-        adapter.write 'foo', Set[1, 2]
+        source['foo'] = Set['1', '2']
         @result = subject.set_members('foo')
       end
 
       it "returns result of adapter set members" do
-        @result.should eq(Set[1, 2])
+        @result.should eq(Set['1', '2'])
       end
 
       it "memoizes key" do
-        local_cache['foo'].should eq(Set[1, 2])
+        local_cache['foo'].should eq(Set['1', '2'])
         adapter.should_not_receive(:set_members)
-        subject.set_members('foo').should eq(Set[1, 2])
+        subject.set_members('foo').should eq(Set['1', '2'])
       end
     end
 
@@ -132,13 +181,13 @@ describe Flipper::Adapter do
 
     describe "#set_add" do
       before do
-        adapter.write 'foo', Set[1]
-        local_cache['foo'] = Set[1]
-        subject.set_add 'foo', 2
+        source['foo'] = Set['1']
+        local_cache['foo'] = Set['1']
+        subject.set_add 'foo', '2'
       end
 
       it "returns result of adapter set members" do
-        adapter.set_members('foo').should eq(Set[1, 2])
+        adapter.set_members('foo').should eq(Set['1', '2'])
       end
 
       it "unmemoizes key" do
@@ -148,13 +197,13 @@ describe Flipper::Adapter do
 
     describe "#set_delete" do
       before do
-        adapter.write 'foo', Set[1, 2, 3]
-        local_cache['foo'] = Set[1, 2, 3]
-        subject.set_delete 'foo', 3
+        source['foo'] = Set['1', '2', '3']
+        local_cache['foo'] = Set['1', '2', '3']
+        subject.set_delete 'foo', '3'
       end
 
       it "returns result of adapter set members" do
-        adapter.set_members('foo').should eq(Set[1, 2])
+        adapter.set_members('foo').should eq(Set['1', '2'])
       end
 
       it "unmemoizes key" do
@@ -185,12 +234,12 @@ describe Flipper::Adapter do
 
     describe "#set_members" do
       before do
-        adapter.write 'foo', Set[1, 2]
+        source['foo'] = Set['1', '2']
         @result = subject.set_members('foo')
       end
 
       it "returns result of adapter set members" do
-        @result.should eq(Set[1, 2])
+        @result.should eq(Set['1', '2'])
       end
 
       it "does not memoize the adapter set member result" do
@@ -232,13 +281,13 @@ describe Flipper::Adapter do
 
     describe "#set_add" do
       before do
-        adapter.write 'foo', Set[1]
-        local_cache['foo'] = Set[1]
-        subject.set_add 'foo', 2
+        source['foo'] = Set['1']
+        local_cache['foo'] = Set['1']
+        subject.set_add 'foo', '2'
       end
 
       it "performs adapter set add" do
-        adapter.set_members('foo').should eq(Set[1, 2])
+        adapter.set_members('foo').should eq(Set['1', '2'])
       end
 
       it "does not attempt to delete local cache key" do
@@ -248,13 +297,13 @@ describe Flipper::Adapter do
 
     describe "#set_delete" do
       before do
-        adapter.write 'foo', Set[1, 2, 3]
-        local_cache['foo'] = Set[1, 2, 3]
-        subject.set_delete 'foo', 3
+        source['foo'] = Set['1', '2', '3']
+        local_cache['foo'] = Set['1', '2', '3']
+        subject.set_delete 'foo', '3'
       end
 
       it "performs adapter set delete" do
-        adapter.set_members('foo').should eq(Set[1, 2])
+        adapter.set_members('foo').should eq(Set['1', '2'])
       end
 
       it "does not attempt to delete local cache key" do
@@ -324,4 +373,91 @@ describe Flipper::Adapter do
       end
     end
   end
+
+  describe "instrumentation" do
+    let(:instrumenter) { Flipper::Instrumenters::Memory.new }
+
+    subject {
+      described_class.new(adapter, :instrumenter => instrumenter)
+    }
+
+    it "is recorded for read" do
+      subject.read('foo')
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('adapter_operation.flipper')
+      event.payload[:key].should eq('foo')
+      event.payload[:operation].should eq(:read)
+      event.payload[:adapter_name].should eq(:memory)
+      event.payload[:result].should be_nil
+    end
+
+    it "is recorded for write" do
+      subject.write('foo', 'bar')
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('adapter_operation.flipper')
+      event.payload[:key].should eq('foo')
+      event.payload[:value].should eq('bar')
+      event.payload[:operation].should eq(:write)
+      event.payload[:adapter_name].should eq(:memory)
+      event.payload[:result].should eq('bar')
+    end
+
+    it "is recorded for delete" do
+      subject.delete('foo')
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('adapter_operation.flipper')
+      event.payload[:key].should eq('foo')
+      event.payload[:operation].should eq(:delete)
+      event.payload[:adapter_name].should eq(:memory)
+      event.payload[:result].should be_nil
+    end
+
+    it "is recorded for set_members" do
+      subject.set_members('foo')
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('adapter_operation.flipper')
+      event.payload[:key].should eq('foo')
+      event.payload[:operation].should eq(:set_members)
+      event.payload[:adapter_name].should eq(:memory)
+      event.payload[:result].should eq(Set.new)
+    end
+
+    it "is recorded for set_add" do
+      subject.set_add('foo', 'bar')
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('adapter_operation.flipper')
+      event.payload[:key].should eq('foo')
+      event.payload[:operation].should eq(:set_add)
+      event.payload[:adapter_name].should eq(:memory)
+      event.payload[:result].should eq(Set['bar'])
+    end
+
+    it "is recorded for set_delete" do
+      subject.set_delete('foo', 'bar')
+
+      event = instrumenter.events.last
+      event.should_not be_nil
+      event.name.should eq('adapter_operation.flipper')
+      event.payload[:key].should eq('foo')
+      event.payload[:operation].should eq(:set_delete)
+      event.payload[:adapter_name].should eq(:memory)
+      event.payload[:result].should eq(Set.new)
+    end
+  end
+
+  describe "#inspect" do
+    it "returns easy to read string representation" do
+      subject.inspect.should eq("#<Flipper::Adapter:#{subject.object_id} name=:memory, use_local_cache=nil>")
+    end
+  end
 end