rollout 2.1.0 → 2.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bc88ca14f2eb1ae5156873fce8e5f569e8e551d5
-  data.tar.gz: 37e6306414e96c1dad888d68f4241bb339af5dd0
+SHA256:
+  metadata.gz: acf240ab59dcfdebec335aee19df882f8936e7de5b7a0c347a3c28cfa8b3fc6d
+  data.tar.gz: 2ca7c2d7c761c6e539790421547b5e8eb82bbe8b56dca246975f6adc0773866d
 SHA512:
-  metadata.gz: 43b4ba29fd8bc735ec1646aa3386ebf409d7d19c3d459fdd649670cf773bcef5ed28583b653ad824b15dcb022ed0e49d55b256a1c477044d93fbd292451df88f
-  data.tar.gz: 36031f802e6b61f2d4e8d5205da8bcc8103cc837ddf6fcff1b51db3c4f71e6a2deeb18286e691fdc5f2daa9ab82ee7717118739cd22d7b6bcd5f72de4075e0e4
+  metadata.gz: dc61fd463b60a94e85b5b141ad5fb7431f37249d9b899739b52524bd0fc28106135e039cbfe0130a0c35d0934b50339e426e38255516381636ec1ff226068e49
+  data.tar.gz: 5babd80ccaab8b4f7b4efeac63e5941709913014e5d5d37f71c5f8b04ae62d09a38e50f7f6236df8d09ce359384cb0d877452209a1b63b69284fd649bb49033c

data/.circleci/config.yml

@@ -0,0 +1,80 @@
+version: 2.1
+
+workflows:
+  main:
+    jobs:
+      - ruby26
+      - ruby25
+      - ruby24
+      - ruby23
+
+executors:
+  ruby26:
+    docker:
+      - image: circleci/ruby:2.6
+  ruby25:
+    docker:
+      - image: circleci/ruby:2.5
+  ruby24:
+    docker:
+      - image: circleci/ruby:2.4
+  ruby23:
+    docker:
+      - image: circleci/ruby:2.3
+
+commands:
+  test:
+    steps:
+      - restore_cache:
+          keys:
+            - bundler-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Bundle Install
+          command: bundle check --path vendor/bundle || bundle install --deployment
+
+      - save_cache:
+          key: bundler-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: |
+            bundle exec rspec --format documentation --format RspecJunitFormatter --out test_results/rspec.xml
+
+jobs:
+  ruby26:
+    executor: ruby26
+    steps:
+      - checkout
+      - test
+
+      - run:
+          name: Report Test Coverage
+          command: |
+            wget https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 -O cc-test-reporter
+            chmod +x cc-test-reporter
+            ./cc-test-reporter format-coverage -t simplecov -o coverage/codeclimate.json coverage/.resultset.json
+            ./cc-test-reporter upload-coverage -i coverage/codeclimate.json
+
+      - store_test_results:
+          path: test_results
+
+  ruby25:
+    executor: ruby25
+    steps:
+      - checkout
+      - test
+
+  ruby24:
+    executor: ruby24
+    steps:
+      - checkout
+      - test
+
+  ruby23:
+    executor: ruby23
+    steps:
+      - checkout
+      - test

data/.gitignore

@@ -18,5 +18,7 @@ coverage
 rdoc
 pkg
 *.gem
+gemfiles/*.lock
+.rspec_status
 
 ## PROJECT::SPECIFIC

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 20
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -1,10 +1,20 @@
 language: ruby
+cache: bundler
+sudo: false
 services:
   - redis-server
 rvm:
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3
+  - 2.2
   - 2.1
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
+  - 2.0
+env:
+  - USE_REAL_REDIS=true
+gemfile:
+  - gemfiles/redis_3.gemfile
+  - gemfiles/redis_4.gemfile
 script:
   - bundle exec rspec

data/Gemfile

@@ -1,3 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,40 +1,65 @@
 PATH
   remote: .
   specs:
-    rollout (2.0.0)
+    rollout (2.4.5)
+      redis (~> 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bourne (1.0)
-      mocha (= 0.9.8)
-    diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.6.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    mocha (0.9.8)
-      rake
-    rake (0.9.2.2)
-    redis (3.0.7)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
+    ast (2.4.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    fakeredis (0.7.0)
+      redis (>= 3.2, < 5.0)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    redis (4.1.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bourne (= 1.0)
-  bundler (>= 1.0.0)
-  jeweler (~> 1.6.4)
-  mocha (= 0.9.8)
-  redis
+  bundler (~> 1.17)
+  fakeredis
   rollout!
-  rspec (~> 2.10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4)
+  rubocop (~> 0.71)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,193 @@
+# rollout
+
+Fast feature flags based on Redis.
+
+[![Gem Version](https://badge.fury.io/rb/rollout.svg)](https://badge.fury.io/rb/rollout)
+[![CircleCI](https://circleci.com/gh/fetlife/rollout.svg?style=svg)](https://circleci.com/gh/fetlife/rollout)
+[![Code Climate](https://codeclimate.com/github/FetLife/rollout/badges/gpa.svg)](https://codeclimate.com/github/FetLife/rollout)
+[![Test Coverage](https://codeclimate.com/github/FetLife/rollout/badges/coverage.svg)](https://codeclimate.com/github/FetLife/rollout/coverage)
+
+## Install it
+
+```bash
+gem install rollout
+```
+
+## How it works
+
+Initialize a rollout object. I assign it to a global var.
+
+```ruby
+require 'redis'
+
+$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
+$rollout.active?(:chat, User.first) # => true/false
+```
+
+Check whether a feature is active globally:
+
+```ruby
+$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:
+
+```ruby
+$rollout.activate_group(:chat, :all)
+```
+
+You might also want to define your own groups. We have one for our caretakers:
+
+```ruby
+$rollout.define_group(:caretakers) do |user|
+  user.caretaker?
+end
+```
+
+You can activate multiple groups per feature.
+
+Deactivate groups like this:
+
+```ruby
+$rollout.deactivate_group(:chat, :all)
+```
+
+Groups need to be defined every time your app starts. The logic is not persisted
+anywhere.
+
+## 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:
+
+```ruby
+$rollout.activate_user(:chat, @user)
+```
+
+Deactivate them like this:
+
+```ruby
+$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.
+
+```ruby
+$rollout.activate_percentage(:chat, 20)
+```
+
+The algorithm for determining which users get let in is this:
+
+```ruby
+CRC32(user.id) < (2**32 - 1) / 100.0 * 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:
+
+```ruby
+$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._
+
+In some cases you might want to have a feature activated for a random set of
+users. It can come specially handy when using Rollout for split tests.
+
+```ruby
+$rollout = Rollout.new($redis, randomize_percentage: true)
+```
+
+When on `randomize_percentage` will make sure that 50% of users for feature A
+are selected independently from users for feature B.
+
+## Global actions
+
+While groups can come in handy, the actual global setter for a feature does not require a group to be passed.
+
+```ruby
+$rollout.activate(:chat)
+```
+
+In that case you can check the global availability of a feature using the following
+
+```ruby
+$rollout.active?(:chat)
+```
+
+And if something is wrong you can set a feature off for everybody using
+
+Deactivate everybody at once:
+
+```ruby
+$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 https://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
+[redis-namespace](https://github.com/resque/redis-namespace) gem.
+
+```ruby
+$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.
+
+## Frontend / UI
+
+* [Rollout-Dashboard](https://github.com/fiverr/rollout_dashboard/)
+
+## Implementations in other languages
+
+*   Python: https://github.com/asenchi/proclaim
+*   PHP: https://github.com/opensoft/rollout
+*   Clojure: https://github.com/yeller/shoutout
+*   Perl: https://metacpan.org/pod/Toggle
+
+
+## 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/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rollout/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Rollout
-  VERSION = "2.1.0"
+  VERSION = '2.4.5'
 end