rollout 2.1.0 → 2.4.5

data/spec/spec_helper.rb

@@ -1,11 +1,21 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'rollout'
-require 'rspec'
-require 'bourne'
-require 'redis'
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start
+
+require 'bundler/setup'
+require ENV["USE_REAL_REDIS"] == "true" ? "redis" : "fakeredis"
+require "rollout"
 
 RSpec.configure do |config|
-  config.mock_with :mocha
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
   config.before { Redis.new.flushdb }
 end

metadata

@@ -1,99 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: rollout
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.4.5
 platform: ruby
 authors:
 - James Golick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.0
-  type: :development
+        version: '4.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: bourne
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: '0.71'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: '0.71'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
 description: Feature flippers with redis.
 email:
 - jamesgolick@gmail.com
@@ -101,24 +115,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".document"
+- ".circleci/config.yml"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
+- Rakefile
 - lib/rollout.rb
-- lib/rollout/legacy.rb
 - lib/rollout/version.rb
-- misc/check_rollout.rb
 - rollout.gemspec
-- spec/legacy_spec.rb
 - spec/rollout_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
-homepage: https://github.com/jamesgolick/rollout
-licenses: []
+homepage: https://github.com/FetLife/rollout
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -128,20 +142,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rollout
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Feature flippers with redis.
 test_files:
-- spec/legacy_spec.rb
 - spec/rollout_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/README.rdoc

@@ -1,130 +0,0 @@
-= rollout
-
-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.
-
-This also has the effect of rollout no longer being dependent on redis. Just give it something that responds to <tt>set(key,value)</tt> and <tt>get(key)</tt>.
-
-If you have been using the 1.x format, you can initialize Rollout with <tt>:migrate => true</tt> and it'll do its best to automatically migrate your old features to the new format. There will be some performance impact, but it should be limited and short-lived since each feature only needs to get migrated once.
-
-== Rollout::Legacy
-
-If you'd prefer to continue to use the old layout in redis, <tt>Rollout::Legacy</tt> is a copy and paste of the old code :-).
-
-== Install it
-
-  gem install rollout
-
-== How it works
-
-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:
-
-  $rollout.active?(:chat)
-
-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.
-
-You can activate the all group for the chat feature like this:
-
-  $rollout.activate_group(:chat, :all)
-
-You might also want to define your own groups. We have one for our caretakers:
-
-  $rollout.define_group(:caretakers) do |user|
-    user.caretaker?
-  end
-
-You can activate multiple groups per feature.
-
-Deactivate groups like this:
-
-  $rollout.deactivate_group(:chat, :all)
-
-== 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:
-
-  $rollout.deactivate_user(:chat, @user)
-
-== User Percentages
-
-If you're rolling out a new feature, you might want to test the waters by slowly enabling it for a percentage of your users.
-
-  $rollout.activate_percentage(:chat, 20)
-
-The algorithm for determining which users get let in is this:
-
-  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.
-
-Deactivate all percentages like this:
-
-  $rollout.deactivate_percentage(:chat)
-
-_Note that activating a feature for 100% of users will also make it active "globally". That is when calling Rollout#active? without a user object._
-
-== Feature is broken
-
-Deactivate everybody at once:
-
-  $rollout.deactivate(:chat)
-
-For many of our features, we keep track of error rates using redis, and deactivate them automatically when a threshold is reached to prevent service failures from cascading. See http://github.com/jamesgolick/degrade for the failure detection code.
-
-== Namespacing
-
-Rollout separates its keys from other keys in the data store using the "feature" keyspace.
-
-If you're using redis, you can namespace keys further to support multiple environments by using the http://github.com/defunkt/redis-namespace gem.
-
-  $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
-
-In our infrastructure, rollout obviously allows us to progressively enable new features but we also use it to automatically disable features and services that break or fail to prevent them from causing cascading failures and wiping out our entire system.
-
-When a feature reaches "maturity" - in other words, expected to be at 100% rollout all the time - we use check_rollout.rb to setup nagios alerts on the rollouts so that we get paged if one of them gets disabled.
-
-
-== 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-InfinityAndBeyond BitLove, Inc. See LICENSE for details.

data/lib/rollout/legacy.rb

@@ -1,134 +0,0 @@
-class Rollout
-  class Legacy
-    def initialize(redis)
-      @redis  = redis
-      @groups = {"all" => lambda { |user| true }}
-    end
-
-    def activate_globally(feature)
-      @redis.sadd(global_key, feature)
-    end
-
-    def deactivate_globally(feature)
-      @redis.srem(global_key, feature)
-    end
-
-    def activate_group(feature, group)
-      @redis.sadd(group_key(feature), group)
-    end
-
-    def deactivate_group(feature, group)
-      @redis.srem(group_key(feature), group)
-    end
-
-    def deactivate_all(feature)
-      @redis.del(group_key(feature))
-      @redis.del(user_key(feature))
-      @redis.del(percentage_key(feature))
-      deactivate_globally(feature)
-    end
-
-    def activate_user(feature, user)
-      @redis.sadd(user_key(feature), user.id)
-    end
-
-    def deactivate_user(feature, user)
-      @redis.srem(user_key(feature), user.id)
-    end
-
-    def define_group(group, &block)
-      @groups[group.to_s] = block
-    end
-
-    def active?(feature, user = nil)
-      if user
-        active_globally?(feature) ||
-          user_in_active_group?(feature, user) ||
-            user_active?(feature, user) ||
-              user_within_active_percentage?(feature, user)
-      else
-        active_globally?(feature)
-      end
-    end
-
-    def activate_percentage(feature, percentage)
-      @redis.set(percentage_key(feature), percentage)
-    end
-
-    def deactivate_percentage(feature)
-      @redis.del(percentage_key(feature))
-    end
-
-    def info(feature = nil)
-      if feature
-        {
-          :percentage => (active_percentage(feature) || 0).to_i,
-          :groups     => active_groups(feature).map { |g| g.to_sym },
-          :users      => active_user_ids(feature),
-          :global     => active_global_features
-        }
-      else
-        {
-          :global     => active_global_features
-        }
-      end
-    end
-
-    private
-      def key(name)
-        "feature:#{name}"
-      end
-
-      def group_key(name)
-        "#{key(name)}:groups"
-      end
-
-      def user_key(name)
-        "#{key(name)}:users"
-      end
-
-      def percentage_key(name)
-        "#{key(name)}:percentage"
-      end
-
-      def global_key
-        "feature:__global__"
-      end
-
-      def active_groups(feature)
-        @redis.smembers(group_key(feature)) || []
-      end
-
-      def active_user_ids(feature)
-        @redis.smembers(user_key(feature)).map { |id| id.to_i }
-      end
-
-      def active_global_features
-        (@redis.smembers(global_key) || []).map(&:to_sym)
-      end
-
-      def active_percentage(feature)
-        @redis.get(percentage_key(feature))
-      end
-
-      def active_globally?(feature)
-        @redis.sismember(global_key, feature)
-      end
-
-      def user_in_active_group?(feature, user)
-        active_groups(feature).any? do |group|
-          @groups.key?(group) && @groups[group].call(user)
-        end
-      end
-
-      def user_active?(feature, user)
-        @redis.sismember(user_key(feature), user.id)
-      end
-
-      def user_within_active_percentage?(feature, user)
-        percentage = active_percentage(feature)
-        return false if percentage.nil?
-        user.id % 100 < percentage.to_i
-      end
-  end
-end

data/misc/check_rollout.rb

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-
-require "rubygems"
-require "yajl"
-require "open-uri"
-
-output = Yajl::Parser.parse(open(ARGV[0]))
-percentage = output["percentage"].to_i
-
-puts Yajl::Encoder.encode(output)
-
-if percentage == 100
-  exit(0)
-else
-  exit(2)
-end