flipflop 2.1.0 → 2.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWY3YjRjMGU0YmZlNDljMWM5YTNjYTllZmQ3MDljZTU2NDE0NTVkZA==
+    MDk3OGYyZmJlYmFlNWMwM2EzOGE5YjY4MmI2ZGVhNTQ3N2JiM2E0Nw==
   data.tar.gz: !binary |-
-    MjUzZTE3MjY4MDFmY2MxZjE0YWIwZmViYTk4NjNkZjUwMTlkYTE3NA==
+    Y2ZjNmQ0MGQ0NjllZTFiNjE3ZGQwYjZhNmUzMGYxNzg1NDU5ZWE4Yg==
 SHA512:
   metadata.gz: !binary |-
-    ZTE1ZWM5ODgzZDM5NTA1MTllZGEyYTg3OWViYzAzOGE4YmZhMjFmYzg1NTZh
-    ZTkwOWQ0ODhhMzE3ZTI0YzIxMWQyYjI1MmFhN2ZjZWZmYjZhYmVhZGE5N2Mx
-    YWQzYWVkMzRkMTkxNTg1ODVhZDJmZGIzMWI3ODc0YmFjNjU2NTE=
+    ZWE3NTY1ZTk2YWQ5MmY5ZTMyMjE5YWM0ODg1NjYyYTU2ZjQ5M2JiMTI0ZWU5
+    Mzk4ZjBmZWY3YmU0YTQ5ZjQyMjI1ZWQ4NTA1NmE0M2U5ODkyZDQyMDFjNGFk
+    NjJmN2NiMjg4MTA1Y2M3MmNiYWUyZjI2MWRiZjY5Y2UyNTcxNDc=
   data.tar.gz: !binary |-
-    ZWI4YTJhZTg5ZWQ4NWI0ZDRmNWU4MDVmYTc2MzYyN2NmZjA3Mjg5YjVmNGE0
-    Nzg3YWJiMDY0MjBmMjljNjIyZDAzYzhlZmQwY2E2NTAxZDVlODJmNTMwZTY1
-    MGJlNzVlYTE3ZmE1ZDc3MjhkY2E0ZGQ1YjgyNWRjY2MzMjgzOWI=
+    Mjk0MTBmYzVlNmQ2NWY5ZGM2MWY3ODkwOTYwYzMxMDIxN2FkMGRlOTQ0Nzg0
+    NzE3MjM3MzhlMmNiZmE4M2Y1MzA2ZTBhZWMyMTQ3MjI5YjI5YmMyNzdjZWNl
+    ZjczYWQ5ZGNlNTMwODY1N2M0ZmU3NjkwNzQ5ODk0NGFhOGI0ZGQ=

data/lib/flipflop/feature_set.rb

@@ -56,12 +56,18 @@ module Flipflop
 
     def add(feature)
       @@lock.synchronize do
+        if @features.has_key?(feature.key)
+          raise FeatureError.new(feature.key, "already defined")
+        end
         @features[feature.key] = feature.freeze
       end
     end
 
     def use(strategy)
       @@lock.synchronize do
+        if @strategies.has_key?(strategy.key)
+          raise StrategyError.new(strategy.name, "(#{strategy.class}) already defined with identical options")
+        end
         @strategies[strategy.key] = strategy.freeze
       end
     end

data/lib/flipflop/strategies/abstract_strategy.rb

@@ -35,12 +35,17 @@ module Flipflop
         end
       end
 
-      attr_reader :name, :description
+      attr_reader :key, :name, :description
 
       def initialize(**options)
+        # Generate key before setting instance that should be excluded from
+        # unique key generation.
+        @key = OptionsHasher.new(self).generate
+
         @name = (options.delete(:name) || self.class.default_name).freeze
         @description = (options.delete(:description) || self.class.default_description).freeze
         @hidden = !!options.delete(:hidden) || false
+
         if options.any?
           raise StrategyError.new(name, "did not understand option #{options.keys.map(&:inspect) * ', '}")
         end
@@ -50,12 +55,6 @@ module Flipflop
         @hidden
       end
 
-      def key
-        # TODO: Object ID changes if the feature definitions are reloaded. Maybe
-        # we can use the index instead?
-        object_id.to_s
-      end
-
       # Return true iff this strategy is able to switch features on/off.
       # Return false otherwise.
       def switchable?

data/lib/flipflop/strategies/options_hasher.rb

@@ -0,0 +1,21 @@
+require "digest/md5"
+
+module Flipflop
+  module Strategies
+    class OptionsHasher
+      def initialize(value)
+        @hasher = Digest::MD5.new
+        @value = value
+      end
+
+      def generate
+        @hasher << begin
+          Marshal.dump(@value)
+        rescue TypeError
+          @value.object_id.to_s
+        end
+        @hasher.hexdigest
+      end
+    end
+  end
+end

data/lib/flipflop/version.rb

@@ -1,3 +1,3 @@
 module Flipflop
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/lib/flipflop.rb

@@ -11,6 +11,8 @@ require "flipflop/feature_definition"
 require "flipflop/feature_set"
 
 require "flipflop/strategies/abstract_strategy"
+require "flipflop/strategies/options_hasher"
+
 require "flipflop/strategies/active_record_strategy"
 require "flipflop/strategies/cookie_strategy"
 require "flipflop/strategies/default_strategy"

data/test/unit/feature_set_test.rb

@@ -104,6 +104,20 @@ describe Flipflop::FeatureSet do
       subject.add(feature = Flipflop::FeatureDefinition.new(:feature))
       assert subject.feature(feature.key).frozen?
     end
+
+    it "should raise if feature with same key is added" do
+      subject.add(Flipflop::FeatureDefinition.new(:feature))
+      assert_raises Flipflop::FeatureError do
+        subject.add(Flipflop::FeatureDefinition.new(:feature))
+      end
+    end
+
+    it "should raise with message if feature with same key is added" do
+      subject.add(Flipflop::FeatureDefinition.new(:feature))
+      assert_raises Flipflop::FeatureError do
+        subject.add(Flipflop::FeatureDefinition.new(:feature))
+      end
+    end
   end
 
   describe "use" do
@@ -116,6 +130,20 @@ describe Flipflop::FeatureSet do
       subject.use(strategy = NullStrategy.new)
       assert subject.strategy(strategy.key).frozen?
     end
+
+    it "should raise if strategy with same key is added" do
+      subject.use(NullStrategy.new)
+      assert_raises Flipflop::StrategyError do
+        subject.use(NullStrategy.new)
+      end
+    end
+
+    it "should raise with message if strategy with same key is added" do
+      subject.use(NullStrategy.new)
+      assert_raises Flipflop::StrategyError do
+        subject.use(NullStrategy.new)
+      end
+    end
   end
 
   describe "feature" do

data/test/unit/strategies/abstract_strategy_test.rb

@@ -27,7 +27,7 @@ describe Flipflop::Strategies::AbstractStrategy do
     end
 
     it "should have unique key" do
-      assert_match /^\d+$/, subject.key
+      assert_match /^\w+$/, subject.key
     end
 
     describe "request" do

data/test/unit/strategies/active_record_strategy_test.rb

@@ -56,7 +56,7 @@ describe Flipflop::Strategies::ActiveRecordStrategy do
     end
 
     it "should have unique key" do
-      assert_match /^\d+$/, subject.key
+      assert_match /^\w+$/, subject.key
     end
 
     describe "with enabled feature" do

data/test/unit/strategies/cookie_strategy_test.rb

@@ -28,7 +28,7 @@ describe Flipflop::Strategies::CookieStrategy do
     end
 
     it "should have unique key" do
-      assert_match /^\d+$/, subject.key
+      assert_match /^\w+$/, subject.key
     end
 
     describe "with enabled feature" do

data/test/unit/strategies/default_strategy_test.rb

@@ -26,7 +26,7 @@ describe Flipflop::Strategies::DefaultStrategy do
     end
 
     it "should have unique key" do
-      assert_match /^\d+$/, subject.key
+      assert_match /^\w+$/, subject.key
     end
 
     describe "with explicitly defaulted feature" do

data/test/unit/strategies/lambda_strategy_test.rb

@@ -20,7 +20,7 @@ describe Flipflop::Strategies::LambdaStrategy do
     end
 
     it "should have unique key" do
-      assert_match /^\d+$/, subject.key
+      assert_match /^\w+$/, subject.key
     end
   end
 

data/test/unit/strategies/options_hasher_test.rb

@@ -0,0 +1,85 @@
+require File.expand_path("../../../test_helper", __FILE__)
+
+class Test
+  def initialize(value)
+    @value = value
+  end
+end
+
+class Test2
+  def initialize(value)
+    @value = value
+  end
+end
+
+describe Flipflop::Strategies::OptionsHasher do
+  subject do
+    Flipflop::Strategies::OptionsHasher
+  end
+
+  def hash(value)
+    subject.new(value).generate
+  end
+
+  describe "with nil" do
+    it "should generate stable hash" do
+      assert_equal hash(nil), hash(nil)
+    end
+  end
+
+  describe "with boolean" do
+    it "should generate unique hash" do
+      refute_equal hash(true), hash(false)
+    end
+
+    it "should generate stable hash" do
+      assert_equal hash(false), hash(false)
+    end
+  end
+
+  describe "with fixnum" do
+    it "should generate unique hash" do
+      refute_equal hash(1), hash(2)
+    end
+
+    it "should generate stable hash" do
+      assert_equal hash(2), hash(2)
+    end
+  end
+
+  describe "with hash" do
+    it "should generate unique hash" do
+      refute_equal hash(foo: 3), hash(bar: 3)
+    end
+
+    it "should generate stable hash" do
+      assert_equal hash(foo: 3), hash(foo: 3)
+    end
+  end
+
+  describe "with array" do
+    it "should generate unique hash" do
+      refute_equal hash([1, 2]), hash([1, 2, 3])
+    end
+
+    it "should generate stable hash" do
+      assert_equal hash([1, 2, 3]), hash([1, 2, 3])
+    end
+  end
+
+  describe "with object" do
+    it "should generate unique hash" do
+      refute_equal hash(Test.new([1, 2])), hash(Test.new([1, 2, 3]))
+    end
+
+    it "should generate stable hash" do
+      assert_equal hash(Test.new([1, 2, 3])), hash(Test.new([1, 2, 3]))
+    end
+  end
+
+  describe "with similar object of different class" do
+    it "should generate unique hash" do
+      refute_equal hash(Test.new([1, 2, 3])), hash(Test2.new([1, 2, 3]))
+    end
+  end
+end

data/test/unit/strategies/query_string_strategy_test.rb

@@ -28,7 +28,7 @@ describe Flipflop::Strategies::QueryStringStrategy do
     end
 
     it "should have unique key" do
-      assert_match /^\d+$/, subject.key
+      assert_match /^\w+$/, subject.key
     end
 
     describe "with enabled feature" do

data/test/unit/strategies/session_strategy_test.rb

@@ -28,7 +28,7 @@ describe Flipflop::Strategies::SessionStrategy do
     end
 
     it "should have unique key" do
-      assert_match /^\d+$/, subject.key
+      assert_match /^\w+$/, subject.key
     end
 
     describe "with enabled feature" do

data/test/unit/strategies/test_strategy_test.rb

@@ -19,7 +19,7 @@ describe Flipflop::Strategies::TestStrategy do
     end
 
     it "should have unique key" do
-      assert_match /^\d+$/, subject.key
+      assert_match /^\w+$/, subject.key
     end
 
     describe "with enabled feature" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flipflop
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Paul Annesley
@@ -63,6 +63,7 @@ files:
 - lib/flipflop/strategies/cookie_strategy.rb
 - lib/flipflop/strategies/default_strategy.rb
 - lib/flipflop/strategies/lambda_strategy.rb
+- lib/flipflop/strategies/options_hasher.rb
 - lib/flipflop/strategies/query_string_strategy.rb
 - lib/flipflop/strategies/session_strategy.rb
 - lib/flipflop/strategies/test_strategy.rb
@@ -90,6 +91,7 @@ files:
 - test/unit/strategies/cookie_strategy_test.rb
 - test/unit/strategies/default_strategy_test.rb
 - test/unit/strategies/lambda_strategy_test.rb
+- test/unit/strategies/options_hasher_test.rb
 - test/unit/strategies/query_string_strategy_test.rb
 - test/unit/strategies/session_strategy_test.rb
 - test/unit/strategies/test_strategy_test.rb