flipper 0.4.0 → 0.5.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies: []
 description: Feature flipper for any adapter
 email:
@@ -38,9 +38,12 @@ files:
 - flipper.gemspec
 - lib/flipper.rb
 - lib/flipper/adapter.rb
-- lib/flipper/adapters/memoized.rb
+- lib/flipper/adapters/decorator.rb
+- lib/flipper/adapters/instrumented.rb
+- lib/flipper/adapters/memoizable.rb
 - lib/flipper/adapters/memory.rb
 - lib/flipper/adapters/operation_logger.rb
+- lib/flipper/decorator.rb
 - lib/flipper/dsl.rb
 - lib/flipper/errors.rb
 - lib/flipper/feature.rb
@@ -55,14 +58,9 @@ files:
 - lib/flipper/instrumentation/metriks_subscriber.rb
 - lib/flipper/instrumenters/memory.rb
 - lib/flipper/instrumenters/noop.rb
-- lib/flipper/key.rb
-- lib/flipper/middleware/local_cache.rb
+- lib/flipper/middleware/memoizer.rb
 - lib/flipper/registry.rb
 - lib/flipper/spec/shared_adapter_specs.rb
-- lib/flipper/toggle.rb
-- lib/flipper/toggles/boolean.rb
-- lib/flipper/toggles/set.rb
-- lib/flipper/toggles/value.rb
 - lib/flipper/type.rb
 - lib/flipper/types/actor.rb
 - lib/flipper/types/boolean.rb
@@ -71,9 +69,10 @@ files:
 - lib/flipper/types/percentage_of_actors.rb
 - lib/flipper/types/percentage_of_random.rb
 - lib/flipper/version.rb
-- spec/flipper/adapter_spec.rb
-- spec/flipper/adapters/memoized_spec.rb
+- spec/flipper/adapters/instrumented_spec.rb
+- spec/flipper/adapters/memoizable_spec.rb
 - spec/flipper/adapters/memory_spec.rb
+- spec/flipper/adapters/operation_logger_spec.rb
 - spec/flipper/dsl_spec.rb
 - spec/flipper/feature_spec.rb
 - spec/flipper/gate_spec.rb
@@ -86,13 +85,8 @@ files:
 - spec/flipper/instrumentation/metriks_subscriber_spec.rb
 - spec/flipper/instrumenters/memory_spec.rb
 - spec/flipper/instrumenters/noop_spec.rb
-- spec/flipper/key_spec.rb
-- spec/flipper/middleware/local_cache_spec.rb
+- spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/registry_spec.rb
-- spec/flipper/toggle_spec.rb
-- spec/flipper/toggles/boolean_spec.rb
-- spec/flipper/toggles/set_spec.rb
-- spec/flipper/toggles/value_spec.rb
 - spec/flipper/types/actor_spec.rb
 - spec/flipper/types/boolean_spec.rb
 - spec/flipper/types/group_spec.rb
@@ -116,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 890771361704353632
+      hash: -4560839249202297958
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 890771361704353632
+      hash: -4560839249202297958
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -133,9 +127,10 @@ signing_key:
 specification_version: 3
 summary: Feature flipper for any adapter
 test_files:
-- spec/flipper/adapter_spec.rb
-- spec/flipper/adapters/memoized_spec.rb
+- spec/flipper/adapters/instrumented_spec.rb
+- spec/flipper/adapters/memoizable_spec.rb
 - spec/flipper/adapters/memory_spec.rb
+- spec/flipper/adapters/operation_logger_spec.rb
 - spec/flipper/dsl_spec.rb
 - spec/flipper/feature_spec.rb
 - spec/flipper/gate_spec.rb
@@ -148,13 +143,8 @@ test_files:
 - spec/flipper/instrumentation/metriks_subscriber_spec.rb
 - spec/flipper/instrumenters/memory_spec.rb
 - spec/flipper/instrumenters/noop_spec.rb
-- spec/flipper/key_spec.rb
-- spec/flipper/middleware/local_cache_spec.rb
+- spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/registry_spec.rb
-- spec/flipper/toggle_spec.rb
-- spec/flipper/toggles/boolean_spec.rb
-- spec/flipper/toggles/set_spec.rb
-- spec/flipper/toggles/value_spec.rb
 - spec/flipper/types/actor_spec.rb
 - spec/flipper/types/boolean_spec.rb
 - spec/flipper/types/group_spec.rb

data/lib/flipper/adapters/memoized.rb

@@ -1,55 +0,0 @@
-require 'set'
-
-module Flipper
-  module Adapters
-    class Memoized
-      # Public
-      def initialize(adapter, cache = {})
-        @adapter = adapter
-        @cache = cache
-      end
-
-      # Public
-      def read(key)
-        @cache.fetch(key) {
-          @cache[key] = @adapter.read(key)
-        }
-      end
-
-      # Public
-      def write(key, value)
-        result = @adapter.write(key, value)
-        @cache.delete(key)
-        result
-      end
-
-      # Public
-      def delete(key)
-        result = @adapter.delete(key)
-        @cache.delete(key)
-        result
-      end
-
-      # Public
-      def set_add(key, value)
-        result = @adapter.set_add(key, value)
-        @cache.delete(key)
-        result
-      end
-
-      # Public
-      def set_delete(key, value)
-        result = @adapter.set_delete(key, value)
-        @cache.delete(key)
-        result
-      end
-
-      # Public
-      def set_members(key)
-        @cache.fetch(key) {
-          @cache[key] = @adapter.set_members(key)
-        }
-      end
-    end
-  end
-end

data/lib/flipper/key.rb

@@ -1,38 +0,0 @@
-module Flipper
-  # Private: Used internally in flipper to create key to be used for feature in
-  # the adapter. You should never need to use this.
-  class Key
-    # Private
-    Separator = '/'
-
-    # Private
-    attr_reader :feature_name
-
-    # Private
-    attr_reader :gate_key
-
-    # Internal
-    def initialize(feature_name, gate_key)
-      @feature_name, @gate_key = feature_name, gate_key
-    end
-
-    # Private
-    def separator
-      Separator.dup
-    end
-
-    # Private
-    def to_s
-      "#{feature_name}#{separator}#{gate_key}"
-    end
-
-    # Internal: Pretty string version for debugging.
-    def inspect
-      attributes = [
-        "feature_name=#{feature_name.inspect}",
-        "gate_key=#{gate_key.inspect}",
-      ]
-      "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
-    end
-  end
-end

data/lib/flipper/middleware/local_cache.rb

@@ -1,36 +0,0 @@
-module Flipper
-  module Middleware
-    class LocalCache
-      class Body
-        def initialize(target, flipper, original)
-          @target   = target
-          @flipper  = flipper
-          @original = original
-        end
-
-        def each(&block)
-          @target.each(&block)
-        end
-
-        def close
-          @target.close if @target.respond_to?(:close)
-        ensure
-          @flipper.adapter.use_local_cache = @original
-        end
-      end
-
-      def initialize(app, flipper)
-        @app = app
-        @flipper = flipper
-      end
-
-      def call(env)
-        original = @flipper.adapter.using_local_cache?
-        @flipper.adapter.use_local_cache = true
-
-        status, headers, body = @app.call(env)
-        [status, headers, Body.new(body, @flipper, original)]
-      end
-    end
-  end
-end

data/lib/flipper/toggle.rb

@@ -1,54 +0,0 @@
-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, :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
-
-    def value
-      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 adapter_key.feature_name
-    end
-  end
-end
-
-require 'flipper/toggles/boolean'
-require 'flipper/toggles/set'
-require 'flipper/toggles/value'

data/lib/flipper/toggles/boolean.rb

@@ -1,54 +0,0 @@
-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 adapter_key, thing.value
-        true
-      end
-
-      def disable(thing)
-        super
-        feature.gates.each do |gate|
-          gate.adapter.delete gate.adapter_key
-        end
-        true
-      end
-
-      def value
-        value = adapter.read(adapter_key)
-        !!TruthMap[value]
-      end
-
-      def enabled?
-        value
-      end
-    end
-  end
-end

data/lib/flipper/toggles/set.rb

@@ -1,25 +0,0 @@
-module Flipper
-  module Toggles
-    class Set < Toggle
-      def enable(thing)
-        super
-        adapter.set_add adapter_key, thing.value
-        true
-      end
-
-      def disable(thing)
-        super
-        adapter.set_delete adapter_key, thing.value
-        true
-      end
-
-      def value
-        adapter.set_members adapter_key
-      end
-
-      def enabled?
-        !value.empty?
-      end
-    end
-  end
-end

data/lib/flipper/toggles/value.rb

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

data/spec/flipper/adapter_spec.rb

@@ -1,463 +0,0 @@
-require 'helper'
-require 'flipper/adapter'
-require 'flipper/adapters/memory'
-require 'flipper/instrumenters/memory'
-
-describe Flipper::Adapter do
-  let(:local_cache)  { {} }
-  let(:source)       { {} }
-  let(:adapter)      { Flipper::Adapters::Memory.new(source) }
-  let(:features_key) { described_class::FeaturesKey }
-
-  subject { described_class.new(adapter, :local_cache => local_cache) }
-
-  describe ".wrap" do
-    context "with Flipper::Adapter instance" do
-      before do
-        @result = described_class.wrap(subject)
-      end
-
-      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
-
-    context "with adapter instance" do
-      before do
-        @result = described_class.wrap(adapter)
-      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
-    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
-      subject.using_local_cache?.should be_true
-
-      subject.use_local_cache = false
-      subject.using_local_cache?.should be_false
-    end
-
-    it "clears the local cache" do
-      local_cache.should_receive(:clear)
-      subject.use_local_cache = true
-    end
-  end
-
-  describe "#using_local_cache?" do
-    it "returns true if enabled" do
-      subject.use_local_cache = true
-      subject.using_local_cache?.should be_true
-    end
-
-    it "returns false if disabled" do
-      subject.use_local_cache = false
-      subject.using_local_cache?.should be_false
-    end
-  end
-
-  context "with local cache enabled" do
-    before do
-      subject.use_local_cache = true
-    end
-
-    describe "#read" do
-      before do
-        adapter.write 'foo', 'bar'
-        @result = subject.read('foo')
-      end
-
-      it "returns result of adapter read" do
-        @result.should eq('bar')
-      end
-
-      it "memoizes adapter read value" do
-        local_cache['foo'].should eq('bar')
-        adapter.should_not_receive(:read)
-        subject.read('foo').should eq('bar')
-      end
-    end
-
-    describe "#set_members" do
-      before do
-        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'])
-      end
-
-      it "memoizes key" do
-        local_cache['foo'].should eq(Set['1', '2'])
-        adapter.should_not_receive(:set_members)
-        subject.set_members('foo').should eq(Set['1', '2'])
-      end
-    end
-
-    describe "#write" do
-      before do
-        subject.write 'foo', 'swanky'
-      end
-
-      it "performs adapter write" do
-        adapter.read('foo').should eq('swanky')
-      end
-
-      it "unmemoizes key" do
-        local_cache.key?('foo').should be_false
-      end
-    end
-
-    describe "#delete" do
-      before do
-        adapter.write 'foo', 'bar'
-        subject.delete 'foo'
-      end
-
-      it "performs adapter delete" do
-        adapter.read('foo').should be_nil
-      end
-
-      it "unmemoizes key" do
-        local_cache.key?('foo').should be_false
-      end
-    end
-
-    describe "#set_add" do
-      before do
-        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'])
-      end
-
-      it "unmemoizes key" do
-        local_cache.key?('foo').should be_false
-      end
-    end
-
-    describe "#set_delete" do
-      before do
-        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'])
-      end
-
-      it "unmemoizes key" do
-        local_cache.key?('foo').should be_false
-      end
-    end
-  end
-
-  context "with local cache disabled" do
-    before do
-      subject.use_local_cache = false
-    end
-
-    describe "#read" do
-      before do
-        adapter.write 'foo', 'bar'
-        @result = subject.read('foo')
-      end
-
-      it "returns result of adapter read" do
-        @result.should eq('bar')
-      end
-
-      it "does not memoize adapter read value" do
-        local_cache.key?('foo').should be_false
-      end
-    end
-
-    describe "#set_members" do
-      before do
-        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'])
-      end
-
-      it "does not memoize the adapter set member result" do
-        local_cache.key?('foo').should be_false
-      end
-    end
-
-    describe "#write" do
-      before do
-        adapter.write 'foo', 'bar'
-        local_cache['foo'] = 'bar'
-        subject.write 'foo', 'swanky'
-      end
-
-      it "performs adapter write" do
-        adapter.read('foo').should eq('swanky')
-      end
-
-      it "does not attempt to delete local cache key" do
-        local_cache.key?('foo').should be_true
-      end
-    end
-
-    describe "#delete" do
-      before do
-        adapter.write 'foo', 'bar'
-        local_cache['foo'] = 'bar'
-        subject.delete 'foo'
-      end
-
-      it "performs adapter delete" do
-        adapter.read('foo').should be_nil
-      end
-
-      it "does not attempt to delete local cache key" do
-        local_cache.key?('foo').should be_true
-      end
-    end
-
-    describe "#set_add" do
-      before do
-        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'])
-      end
-
-      it "does not attempt to delete local cache key" do
-        local_cache.key?('foo').should be_true
-      end
-    end
-
-    describe "#set_delete" do
-      before do
-        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'])
-      end
-
-      it "does not attempt to delete local cache key" do
-        local_cache.key?('foo').should be_true
-      end
-    end
-  end
-
-  describe "#eql?" do
-    it "returns true for same class and adapter" do
-      subject.eql?(described_class.new(adapter)).should be_true
-    end
-
-    it "returns false for different adapter" do
-      instance = described_class.new(Flipper::Adapters::Memory.new)
-      subject.eql?(instance).should be_false
-    end
-
-    it "returns false for different class" do
-      subject.eql?(Object.new).should be_false
-    end
-
-    it "is aliased to ==" do
-      (subject == described_class.new(adapter)).should be_true
-    end
-  end
-
-  describe "#features" do
-    context "with no features enabled/disabled" do
-      it "defaults to empty set" do
-        subject.features.should eq(Set.new)
-      end
-    end
-
-    context "with features enabled and disabled" do
-      before do
-        subject.set_add(features_key, 'stats')
-        subject.set_add(features_key, 'cache')
-        subject.set_add(features_key, 'search')
-      end
-
-      it "returns set of feature names" do
-        subject.features.should be_instance_of(Set)
-        subject.features.sort.should eq(['cache', 'search', 'stats'])
-      end
-    end
-  end
-
-  describe "#feature_add" do
-    context "with string name" do
-      before do
-        subject.feature_add('search')
-      end
-
-      it "adds string to set" do
-        subject.set_members(features_key).should include('search')
-      end
-    end
-
-    context "with symbol name" do
-      before do
-        subject.feature_add(:search)
-      end
-
-      it "adds string to set" do
-        subject.set_members(features_key).should include('search')
-      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