rollout 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f64f1c9012cf7fed3496317cec7542d606c1b7b7
-  data.tar.gz: af8ead4306e97cd5038a16cc88b495e4dc68c9ca
+  metadata.gz: 531e50e9914dd1ea745969469ae49b805fe583b7
+  data.tar.gz: 2c25094aa9935d7ce97263f0829072bcb728dffc
 SHA512:
-  metadata.gz: 6972dfe9065234da74ed4f260a8d73ca837828b83793fc7b12ea8327c45fc463af2ab89782ec79a0f8988a0fbcc7af7291e3c829452c8d373a27f72494ba7db7
-  data.tar.gz: e82e2f6c194edd80142e88b54419c4d466910438a3b92ee243e2edbd71ea546178b72fedc34749c9ca114851e862221f2009f23e8adedd2fa65213736fbda5b6
+  metadata.gz: 87983bb4671e964ea46e5e7c85f98b4a9e9254707c2a4775c7a24998a2480dc0faa07a67acb0f90c2cdab8a84530ffd41417fca763cfd9c4308060179f8ece78
+  data.tar.gz: fa7c1d4f2c9fc0202d0272f0750cf0ea9087a6bb375e692631bc9c4b2ea3c6e52e649a601a0c2bcef4549e38d7fcd5d683fd08711805a77db757b86d6531bab3

data/.travis.yml

@@ -4,7 +4,7 @@ sudo: false
 services:
   - redis-server
 rvm:
-  - 2.3.0
+  - 2.3.1
   - 2.2
   - 2.1
   - 2.0.0

data/README.md

@@ -10,7 +10,7 @@ Feature flippers.
 ## MAKE SURE TO READ THIS: 2.X Changes and Migration Path
 
 As of rollout-2.x, only one key is used per feature for performance reasons.
-The data format is `percentage|user_id,user_id,...|group,_group...`. This has
+The serialized format is `percentage|user_id,user_id,...|group,_group...|data_json`. This has
 the effect of making concurrent feature modifications unsafe, but in practice,
 I doubt this will actually be a problem.
 
@@ -35,6 +35,12 @@ $redis   = Redis.new
 $rollout = Rollout.new($redis)
 ```
 
+Update data specific to a feature:
+
+```ruby
+@rollout.set_feature_data(:chat, description: 'foo', release_date: 'bar', whatever: 'baz')
+```
+
 Check whether a feature is active for a particular user:
 
 ```ruby
@@ -103,7 +109,7 @@ $rollout.activate_percentage(:chat, 20)
 The algorithm for determining which users get let in is this:
 
 ```ruby
-CRC32(user.id) % 100 < percentage
+CRC32(user.id) % 100_000 < percentage * 1_000
 ```
 
 So, for 20%, users 0, 1, 10, 11, 20, 21, etc would be allowed in. Those users

data/lib/rollout.rb

@@ -1,10 +1,11 @@
 require "rollout/version"
 require "zlib"
 require "set"
+require "json"
 
 class Rollout
   class Feature
-    attr_accessor :groups, :users, :percentage
+    attr_accessor :groups, :users, :percentage, :data
     attr_reader :name, :options
 
     def initialize(name, string = nil, opts = {})
@@ -12,17 +13,18 @@ class Rollout
       @name    = name
 
       if string
-        raw_percentage,raw_users,raw_groups = string.split("|")
+        raw_percentage,raw_users,raw_groups,raw_data = string.split('|', 4)
         @percentage = raw_percentage.to_f
-        @users = (raw_users || "").split(",").map(&:to_s).to_set
-        @groups = (raw_groups || "").split(",").map(&:to_sym).to_set
+        @users = users_from_string(raw_users)
+        @groups = groups_from_string(raw_groups)
+        @data = raw_data.nil? || raw_data.strip.empty? ? {} : JSON.parse(raw_data)
       else
         clear
       end
     end
 
     def serialize
-      "#{@percentage}|#{@users.to_a.join(",")}|#{@groups.to_a.join(",")}"
+      "#{@percentage}|#{@users.to_a.join(",")}|#{@groups.to_a.join(",")}|#{serialize_data}"
     end
 
     def add_user(user)
@@ -43,9 +45,10 @@ class Rollout
     end
 
     def clear
-      @groups = Set.new
-      @users = Set.new
+      @groups = groups_from_string("")
+      @users = users_from_string("")
       @percentage = 0
+      @data = {}
     end
 
     def active?(rollout, user)
@@ -101,6 +104,30 @@ class Rollout
           rollout.active_in_group?(g, user)
         end
       end
+
+      def serialize_data
+        return "" unless @data.is_a? Hash
+
+        @data.to_json
+      end
+
+      def users_from_string(raw_users)
+        users = (raw_users || "").split(",").map(&:to_s)
+        if @options[:use_sets]
+          users.to_set
+        else
+          users
+        end
+      end
+
+      def groups_from_string(raw_groups)
+        groups = (raw_groups || "").split(",").map(&:to_sym)
+        if @options[:use_sets]
+          groups.to_set
+        else
+          groups
+        end
+      end
   end
 
   def initialize(storage, opts = {})
@@ -122,8 +149,8 @@ class Rollout
   end
 
   def delete(feature)
-    features = (@storage.get(features_key) || "").split(",").map(&:to_sym)
-    features.delete(feature)
+    features = (@storage.get(features_key) || "").split(",")
+    features.delete(feature.to_s)
     @storage.set(features_key, features.join(","))
     @storage.del(key(feature))
   end
@@ -214,6 +241,23 @@ class Rollout
     Feature.new(feature, string, @options)
   end
 
+  def set_feature_data(feature, data)
+    with_feature(feature) do |f|
+      f.data.merge!(data) if data.is_a? Hash
+    end
+  end
+
+  def clear_feature_data(feature)
+    with_feature(feature) do |f|
+      f.data = {}
+    end
+  end
+
+  def multi_get(*features)
+    feature_keys = features.map{ |feature| key(feature) }
+    @storage.mget(*feature_keys).map.with_index { |string, index| Feature.new(features[index], string, @options) }
+  end
+
   def features
     (@storage.get(features_key) || "").split(",").map(&:to_sym)
   end

data/lib/rollout/version.rb

@@ -1,3 +1,3 @@
 class Rollout
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/spec/rollout_spec.rb

@@ -51,6 +51,12 @@ RSpec.describe "Rollout" do
     end
 
     it "leaves the other groups active" do
+      expect(@rollout.get(:chat).groups).to eq [:fivesonly]
+    end
+
+    it "leaves the other groups active using sets" do
+      @options = @rollout.instance_variable_get("@options")
+      @options[:use_sets] = true
       expect(@rollout.get(:chat).groups).to eq [:fivesonly].to_set
     end
   end
@@ -169,6 +175,15 @@ RSpec.describe "Rollout" do
     end
 
     it "remains active for other active users" do
+      @options = @rollout.instance_variable_get("@options")
+      @options[:use_sets] = false
+      expect(@rollout.get(:chat).users).to eq %w(24)
+    end
+
+    it "remains active for other active users using sets" do
+      @options = @rollout.instance_variable_get("@options")
+      @options[:use_sets] = true
+
       expect(@rollout.get(:chat).users).to eq %w(24).to_set
     end
   end
@@ -219,6 +234,10 @@ RSpec.describe "Rollout" do
     it "activates the feature" do
       expect(@rollout).to be_active(:chat)
     end
+
+    it "sets @data to empty hash" do
+      expect(@rollout.get(:chat).data).to eq({})
+    end
   end
 
   describe "activating a feature for a percentage of users" do
@@ -344,6 +363,14 @@ RSpec.describe "Rollout" do
       @rollout.set(:chat, true)
     end
 
+    context "when feature was passed as string" do
+      it "should be removed from features list" do
+        expect(@rollout.features.size).to eq 1
+        @rollout.delete('chat')
+        expect(@rollout.features.size).to eq 0
+      end
+    end
+
     it "should be removed from features list" do
       expect(@rollout.features.size).to eq 1
       @rollout.delete(:chat)
@@ -386,6 +413,26 @@ RSpec.describe "Rollout" do
     end
 
     it "returns the feature object" do
+      feature = @rollout.get(:chat)
+      expect(feature.groups).to eq [:caretakers, :greeters]
+      expect(feature.percentage).to eq 10
+      expect(feature.users).to eq %w(42)
+      expect(feature.to_hash).to eq(
+        groups: [:caretakers, :greeters],
+        percentage: 10,
+        users: %w(42)
+      )
+
+      feature = @rollout.get(:signup)
+      expect(feature.groups).to be_empty
+      expect(feature.users).to be_empty
+      expect(feature.percentage).to eq(100)
+    end
+
+    it "returns the feature objects using sets" do
+      @options = @rollout.instance_variable_get("@options")
+      @options[:use_sets] = true
+
       feature = @rollout.get(:chat)
       expect(feature.groups).to eq [:caretakers, :greeters].to_set
       expect(feature.percentage).to eq 10
@@ -413,6 +460,18 @@ RSpec.describe "Rollout" do
     end
 
     it "each feature is cleared" do
+      features.each do |feature|
+        expect(@rollout.get(feature).to_hash).to eq(
+          percentage: 0,
+          users: [],
+          groups: []
+        )
+      end
+    end
+
+    it "each feature is cleared with sets" do
+      @options = @rollout.instance_variable_get("@options")
+      @options[:use_sets] = true
       features.each do |feature|
         expect(@rollout.get(feature).to_hash).to eq(
           percentage: 0,
@@ -515,18 +574,127 @@ RSpec.describe "Rollout" do
       expect(@rollout.user_in_active_users?(:chat, "5")).to eq(false)
     end
   end
-end
 
-describe "Rollout::Feature" do
-  before do
-    @user    = double("User", email: "test@test.com")
-    @feature = Rollout::Feature.new(:chat, nil, id_user_by: :email)
+  describe "#multi_get" do
+    before do
+      @rollout.activate_percentage(:chat, 10)
+      @rollout.activate_group(:chat, :caretakers)
+      @rollout.activate_group(:videos, :greeters)
+      @rollout.activate(:signup)
+      @rollout.activate_user(:photos, double(id: 42))
+    end
+
+    it "returns an array of features" do
+      features = @rollout.multi_get(:chat, :videos, :signup)
+      expect(features[0].name).to eq :chat
+      expect(features[0].groups).to eq [:caretakers]
+      expect(features[0].percentage).to eq 10
+      expect(features[1].name).to eq :videos
+      expect(features[1].groups).to eq [:greeters]
+      expect(features[2].name).to eq :signup
+      expect(features[2].percentage).to eq 100
+      expect(features.size).to eq 3
+    end
+  end
+
+  describe "#set_feature_data" do
+    before do
+      @rollout.set_feature_data(:chat, description: 'foo', release_date: 'bar')
+    end
+
+    it 'sets the data attribute on feature' do
+      expect(@rollout.get(:chat).data).to include('description' => 'foo', 'release_date' => 'bar')
+    end
+
+    it 'updates a data attribute' do
+      @rollout.set_feature_data(:chat, description: 'baz')
+      expect(@rollout.get(:chat).data).to include('description' => 'baz', 'release_date' => 'bar')
+    end
+
+    it 'only sets data on specified feature' do
+      @rollout.set_feature_data(:talk, image_url: 'kittens.png')
+      expect(@rollout.get(:chat).data).not_to include('image_url' => 'kittens.png')
+      expect(@rollout.get(:chat).data).to include('description' => 'foo', 'release_date' => 'bar')
+    end
+
+    it 'does not modify @data if param is nil' do
+      expect(@rollout.get(:chat).data).to include('description' => 'foo', 'release_date' => 'bar')
+      @rollout.set_feature_data(:chat, nil)
+      expect(@rollout.get(:chat).data).to include('description' => 'foo', 'release_date' => 'bar')
+    end
+
+    it 'does not modify @data if param is empty string' do
+      expect(@rollout.get(:chat).data).to include('description' => 'foo', 'release_date' => 'bar')
+      @rollout.set_feature_data(:chat, "   ")
+      expect(@rollout.get(:chat).data).to include('description' => 'foo', 'release_date' => 'bar')
+    end
+
+    it 'properly parses data when it contains a |' do
+      user = double("User", id: 8)
+      @rollout.activate_user(:chat, user)
+      @rollout.set_feature_data(:chat, "|call||text|" => "a|bunch|of|stuff")
+      expect(@rollout.get(:chat).data).to include("|call||text|" => "a|bunch|of|stuff")
+      expect(@rollout.active?(:chat, user)).to be true
+    end
+  end
+
+  describe "#clear_feature_data" do
+    it 'resets data to empty string' do
+      @rollout.set_feature_data(:chat, description: 'foo')
+      expect(@rollout.get(:chat).data).to include('description' => 'foo')
+      @rollout.clear_feature_data(:chat)
+      expect(@rollout.get(:chat).data).to eq({})
+    end
   end
+end
 
+describe "Rollout::Feature" do
   describe "#add_user" do
     it "ids a user using id_user_by" do
-      @feature.add_user(@user)
-      expect(@user).to have_received :email
+      user    = double("User", email: "test@test.com")
+      feature = Rollout::Feature.new(:chat, nil, id_user_by: :email)
+      feature.add_user(user)
+      expect(user).to have_received :email
+    end
+  end
+
+  describe "#initialize" do
+    describe "when string does not exist" do
+      it 'clears feature attributes when string is not given' do
+        feature = Rollout::Feature.new(:chat)
+        expect(feature.groups).to be_empty
+        expect(feature.users).to be_empty
+        expect(feature.percentage).to eq 0
+        expect(feature.data).to eq({})
+      end
+
+      it 'clears feature attributes when string is nil' do
+        feature = Rollout::Feature.new(:chat, nil)
+        expect(feature.groups).to be_empty
+        expect(feature.users).to be_empty
+        expect(feature.percentage).to eq 0
+        expect(feature.data).to eq({})
+      end
+
+      it 'clears feature attributes when string is empty string' do
+        feature = Rollout::Feature.new(:chat, "")
+        expect(feature.groups).to be_empty
+        expect(feature.users).to be_empty
+        expect(feature.percentage).to eq 0
+        expect(feature.data).to eq({})
+      end
+
+      describe "when there is no data" do
+        it 'sets @data to empty hash' do
+          feature = Rollout::Feature.new(:chat, "0||")
+          expect(feature.data).to eq({})
+        end
+
+        it 'sets @data to empty hash' do
+          feature = Rollout::Feature.new(:chat, "|||   ")
+          expect(feature.data).to eq({})
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollout
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - James Golick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -126,4 +126,3 @@ summary: Feature flippers with redis.
 test_files:
 - spec/rollout_spec.rb
 - spec/spec_helper.rb
-has_rdoc: