rollout 2.0.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc88ca14f2eb1ae5156873fce8e5f569e8e551d5
+  data.tar.gz: 37e6306414e96c1dad888d68f4241bb339af5dd0
+SHA512:
+  metadata.gz: 43b4ba29fd8bc735ec1646aa3386ebf409d7d19c3d459fdd649670cf773bcef5ed28583b653ad824b15dcb022ed0e49d55b256a1c477044d93fbd292451df88f
+  data.tar.gz: 36031f802e6b61f2d4e8d5205da8bcc8103cc837ddf6fcff1b51db3c4f71e6a2deeb18286e691fdc5f2daa9ab82ee7717118739cd22d7b6bcd5f72de4075e0e4

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+services:
+  - redis-server
+rvm:
+  - 2.1
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+script:
+  - bundle exec rspec

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    rollout (2.0.0a)
-      redis
+    rollout (2.0.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     bourne (1.0)
       mocha (= 0.9.8)
@@ -18,7 +17,7 @@ GEM
     mocha (0.9.8)
       rake
     rake (0.9.2.2)
-    redis (3.0.2)
+    redis (3.0.7)
     rspec (2.10.0)
       rspec-core (~> 2.10.0)
       rspec-expectations (~> 2.10.0)
@@ -36,5 +35,6 @@ DEPENDENCIES
   bundler (>= 1.0.0)
   jeweler (~> 1.6.4)
   mocha (= 0.9.8)
+  redis
   rollout!
   rspec (~> 2.10.0)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 James Golick
+Copyright (c) 2010-InfinityAndBeyond BitLove, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -2,6 +2,8 @@
 
 Feature flippers.
 
+{<img src="https://travis-ci.org/FetLife/rollout.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/FetLife/rollout]
+
 == MAKE SURE TO READ THIS: 2.0 Changes and Migration Path
 
 As of rollout-2.x, only one key is used per feature for performance reasons. The data format is <tt>percentage|user_id,user_id,...|group,_group...</tt>. This has the effect of making concurrent feature modifications unsafe, but in practice, I doubt this will actually be a problem.
@@ -22,11 +24,13 @@ If you'd prefer to continue to use the old layout in redis, <tt>Rollout::Legacy<
 
 Initialize a rollout object. I assign it to a global var.
 
+  require 'redis'
+
   $redis   = Redis.new
   $rollout = Rollout.new($redis)
 
 Check whether a feature is active for a particular user:
-  
+
   $rollout.active?(:chat, User.first) # => true/false
 
 Check whether a feature is active globally:
@@ -37,7 +41,7 @@ You can activate features using a number of different mechanisms.
 
 == Groups
 
-Rollout ships with one group by default: "all", which does exactly what it sounds like. 
+Rollout ships with one group by default: "all", which does exactly what it sounds like.
 
 You can activate the all group for the chat feature like this:
 
@@ -58,7 +62,7 @@ Deactivate groups like this:
 == Specific Users
 
 You might want to let a specific user into a beta test or something. If that user isn't part of an existing group, you can let them in specifically:
-  
+
   $rollout.activate_user(:chat, @user)
 
 Deactivate them like this:
@@ -73,7 +77,7 @@ If you're rolling out a new feature, you might want to test the waters by slowly
 
 The algorithm for determining which users get let in is this:
 
-  user.id % 10 < percentage / 10
+  CRC32(user.id) % 100 < percentage
 
 So, for 20%, users 0, 1, 10, 11, 20, 21, etc would be allowed in. Those users would remain in as the percentage increases.
 
@@ -100,7 +104,7 @@ If you're using redis, you can namespace keys further to support multiple enviro
   $ns = Redis::Namespace.new(Rails.env, :redis => $redis)
   $rollout = Rollout.new($ns)
   $rollout.activate_group(:chat, :all)
-  
+
 This example would use the "development:feature:chat:groups" key.
 
 == misc/check_rollout.rb
@@ -113,7 +117,14 @@ When a feature reaches "maturity" - in other words, expected to be at 100% rollo
 == Implementations in other languages
 
 * Python: http://github.com/asenchi/proclaim
+* PHP: https://github.com/opensoft/rollout
+* Clojure: https://github.com/tcrayford/shoutout
+
+== Contributors
+
+* James Golick - Creator - https://github.com/jamesgolick
+* Eric Rafaloff - Maintainer - https://github.com/EricR
 
 == Copyright
 
-Copyright (c) 2010 James Golick, BitLove, Inc. See LICENSE for details.
+Copyright (c) 2010-InfinityAndBeyond BitLove, Inc. See LICENSE for details.

data/lib/rollout.rb

@@ -1,13 +1,16 @@
+require "rollout/version"
 require "rollout/legacy"
 require "zlib"
 
 class Rollout
   class Feature
-    attr_reader :name, :groups, :users, :percentage
-    attr_writer :percentage, :groups, :users
+    attr_accessor :groups, :users, :percentage
+    attr_reader :name, :options
+
+    def initialize(name, string = nil, opts = {})
+      @options = opts
+      @name    = name
 
-    def initialize(name, string = nil)
-      @name = name
       if string
         raw_percentage,raw_users,raw_groups = string.split("|")
         @percentage = raw_percentage.to_i
@@ -23,11 +26,12 @@ class Rollout
     end
 
     def add_user(user)
-      @users << user.id.to_s unless @users.include?(user.id.to_s)
+      id = user_id(user)
+      @users << id unless @users.include?(id)
     end
 
     def remove_user(user)
-      @users.delete(user.id.to_s)
+      @users.delete(user_id(user))
     end
 
     def add_group(group)
@@ -48,8 +52,9 @@ class Rollout
       if user.nil?
         @percentage == 100
       else
-        user_in_percentage?(user) ||
-          user_in_active_users?(user) ||
+        id = user_id(user)
+        user_in_percentage?(id) ||
+          user_in_active_users?(id) ||
             user_in_active_group?(user, rollout)
       end
     end
@@ -61,12 +66,25 @@ class Rollout
     end
 
     private
+      def user_id(user)
+        if user.is_a?(Fixnum) ||
+             user.is_a?(String)
+          user.to_s
+        else
+          user.send(id_user_by).to_s
+        end
+      end
+
+      def id_user_by
+        @options[:id_user_by] || :id
+      end
+
       def user_in_percentage?(user)
-        Zlib.crc32(user.id.to_s) % 100 < @percentage
+        Zlib.crc32(user_id(user)) % 100 < @percentage
       end
 
       def user_in_active_users?(user)
-        @users.include?(user.id.to_s)
+        @users.include?(user_id(user))
       end
 
       def user_in_active_group?(user, rollout)
@@ -77,9 +95,10 @@ class Rollout
   end
 
   def initialize(storage, opts = {})
-    @storage  = storage
-    @groups = {:all => lambda { |user| true }}
-    @legacy = Legacy.new(opts[:legacy_storage] || @storage) if opts[:migrate]
+    @storage = storage
+    @options = opts
+    @groups  = {:all => lambda { |user| true }}
+    @legacy  = Legacy.new(opts[:legacy_storage] || @storage) if opts[:migrate]
   end
 
   def activate(feature)
@@ -94,6 +113,16 @@ class Rollout
     end
   end
 
+  def set(feature, desired_state)
+    with_feature(feature) do |f|
+      if desired_state
+        f.percentage = 100
+      else
+        f.clear
+      end
+    end
+  end
+
   def activate_group(feature, group)
     with_feature(feature) do |f|
       f.add_group(group)
@@ -147,11 +176,12 @@ class Rollout
   def get(feature)
     string = @storage.get(key(feature))
     if string || !migrate?
-      Feature.new(feature, string)
+      Feature.new(feature, string, @options)
     else
       info = @legacy.info(feature)
       f = Feature.new(feature)
       f.percentage = info[:percentage]
+      f.percentage = 100 if info[:global].include? feature
       f.groups = info[:groups].map { |g| g.to_sym }
       f.users = info[:users].map { |u| u.to_s }
       save(f)
@@ -163,6 +193,15 @@ class Rollout
     (@storage.get(features_key) || "").split(",").map(&:to_sym)
   end
 
+  def clear!
+    features.each do |feature|
+      with_feature(feature) { |f| f.clear }
+      @storage.del(key(feature))
+    end
+
+    @storage.del(features_key)
+  end
+
   private
     def key(name)
       "feature:#{name}"
@@ -180,7 +219,7 @@ class Rollout
 
     def save(feature)
       @storage.set(key(feature.name), feature.serialize)
-      @storage.set(features_key, (features | [feature.name]).join(","))
+      @storage.set(features_key, (features | [feature.name.to_sym]).join(","))
     end
 
     def migrate?

data/lib/rollout/version.rb

@@ -1,3 +1,3 @@
 class Rollout
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/rollout.gemspec

@@ -11,8 +11,6 @@ Gem::Specification.new do |s|
   s.summary = "Feature flippers with redis."
   s.homepage = "https://github.com/jamesgolick/rollout"
 
-  s.require_paths = ["lib"]
-
   s.rubyforge_project = "rollout"
 
   s.files         = `git ls-files`.split("\n")
@@ -20,12 +18,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
   s.add_development_dependency "rspec", "~> 2.10.0"
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "jeweler", "~> 1.6.4"
   s.add_development_dependency "bourne", "1.0"
   s.add_development_dependency "mocha", "0.9.8"
-
-  s.add_runtime_dependency "redis"
+  s.add_development_dependency "redis"
 end

data/spec/legacy_spec.rb

@@ -185,7 +185,7 @@ describe "Rollout::Legacy" do
       end
 
       it "returns all global features" do
-        @rollout.info.should eq({ :global => features.reverse })
+        @rollout.info[:global].should include(*features)
       end
     end
 
@@ -199,12 +199,11 @@ describe "Rollout::Legacy" do
       end
 
       it "returns info about all the activations" do
-        @rollout.info(:chat).should == {
-          :percentage => 10,
-          :groups     => [:greeters, :caretakers],
-          :users      => [42],
-          :global     => [:signup]
-        }
+        info = @rollout.info(:chat)
+        info[:percentage].should == 10
+        info[:groups].should include(:caretakers, :greeters)
+        info[:users].should include(42)
+        info[:global].should include(:signup)
       end
     end
 

data/spec/rollout_spec.rb

@@ -97,6 +97,20 @@ describe "Rollout" do
     end
   end
 
+  describe "activating a specific user by ID" do
+    before do
+      @rollout.activate_user(:chat, 42)
+    end
+
+    it "is active for that user" do
+      @rollout.should be_active(:chat, stub(:id => 42))
+    end
+
+    it "remains inactive for other users" do
+      @rollout.should_not be_active(:chat, stub(:id => 24))
+    end
+  end
+
   describe "activating a specific user with a string id" do
     before do
       @rollout.activate_user(:chat, stub(:id => 'user-72'))
@@ -206,6 +220,26 @@ describe "Rollout" do
     end
   end
 
+  describe "setting a feature on" do
+    before do
+      @rollout.set(:chat, true)
+    end
+
+    it "becomes activated" do
+      @rollout.should be_active(:chat)
+    end
+  end
+
+  describe "setting a feature off" do
+    before do
+      @rollout.set(:chat, false)
+    end
+
+    it "becomes activated" do
+      @rollout.should_not be_active(:chat)
+    end
+  end
+
   describe "keeps a list of features" do
     it "saves the feature" do
       @rollout.activate(:chat)
@@ -217,6 +251,12 @@ describe "Rollout" do
       @rollout.activate(:chat)
       @rollout.features.size.should == 1
     end
+
+    it "does not contain doubles when using string" do
+      @rollout.activate(:chat)
+      @rollout.activate("chat")
+      @rollout.features.size.should == 1
+    end
   end
 
   describe "#get" do
@@ -246,6 +286,30 @@ describe "Rollout" do
     end
   end
 
+  describe "#clear" do
+    let(:features) { %w(signup beta alpha gm) }
+
+    before do
+      features.each { |f| @rollout.activate(f) }
+
+      @rollout.clear!
+    end
+
+    it "each feature is cleared" do
+      features.each do |feature|
+        @rollout.get(feature).to_hash.should == {
+          :percentage => 0,
+          :users => [],
+          :groups => []
+        }
+      end
+    end
+
+    it "removes all features" do
+      @rollout.features.should be_empty
+    end
+  end
+
   describe "migration mode" do
     before do
       @legacy = Rollout::Legacy.new(@redis)
@@ -270,5 +334,24 @@ describe "Rollout" do
       }
       @redis.get("feature:chat").should_not be_nil
     end
+
+    it "imports settings that were globally activated" do
+      @legacy.activate_globally(:video_chat)
+      @rollout.get(:video_chat).to_hash[:percentage].should == 100
+    end
+  end
+end
+
+describe "Rollout::Feature" do
+  before do
+    @user    = stub("User", :email => "test@test.com")
+    @feature = Rollout::Feature.new(:chat, nil, :id_user_by => :email)
+  end
+
+  describe "#add_user" do
+    it "ids a user using id_user_by" do
+      @feature.add_user(@user)
+      @user.should have_received :email
+    end
   end
 end

metadata

@@ -1,68 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: rollout
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
 - James Golick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.4
 - !ruby/object:Gem::Dependency
   name: bourne
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -94,17 +83,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Feature flippers with redis.
@@ -114,13 +101,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
+- ".document"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.rdoc
-- VERSION
 - lib/rollout.rb
 - lib/rollout/legacy.rb
 - lib/rollout/version.rb
@@ -132,27 +119,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/jamesgolick/rollout
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: rollout
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Feature flippers with redis.
 test_files:
 - spec/legacy_spec.rb

data/VERSION

@@ -1 +0,0 @@
-1.1.0