rollout 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae73aef78e5898a7936f6853788580ace070953f
-  data.tar.gz: 216f839eb30e2dbd26b33c5a5f224c285e73dc66
+SHA256:
+  metadata.gz: 37e56080ba30fb08aaa7e718e22fae3cab0745e84a91537e4e5520c2843a63a2
+  data.tar.gz: 2b2f8c5a6e7a3ddd8275d818b4a168e7573204c2e259e323ca7a2ea9996062d9
 SHA512:
-  metadata.gz: 6da7d61689d2048e82ef624ac93bc38abf9b141fc53e1787bafcd937d84eccf663ad54141040eeabaaeab5580700600fbc5b8b1bc5a319447ce53fbb1c7a12b9
-  data.tar.gz: 8c2d609455ea50da07b7229736db71e83856c4701d1b8c296472f4e6fb3583e748257a04840599a9a833114bcc9e9443f85172a0bbfdb15212beb8079aa8e629
+  metadata.gz: a31905463a16ca7413566460c9a693ab5b9063e74547c05aafe2cf40d5e8f8d83ecb9e85316dd48c3e6b5e5b63311ac222343b485228a695ff5b72f8b0d82a2c
+  data.tar.gz: 33fc542bdfe0def2b13a1b3697ba59c1e5f83e813a7c67740d94bf0a9725e17003fdc3fecfa923874883730dde589e0906b5d49ab19ff49c36943e259c28f134

data/.circleci/config.yml

@@ -0,0 +1,95 @@
+version: 2.1
+
+workflows:
+  main:
+    jobs:
+      - ruby27
+      - ruby26
+      - ruby25
+      - ruby24
+      - ruby23
+
+executors:
+  ruby27:
+    docker:
+      - image: circleci/ruby:2.7
+      - image: circleci/redis:alpine
+  ruby26:
+    docker:
+      - image: circleci/ruby:2.6
+      - image: circleci/redis:alpine
+  ruby25:
+    docker:
+      - image: circleci/ruby:2.5
+      - image: circleci/redis:alpine
+  ruby24:
+    docker:
+      - image: circleci/ruby:2.4
+      - image: circleci/redis:alpine
+  ruby23:
+    docker:
+      - image: circleci/ruby:2.3
+      - image: circleci/redis:alpine
+
+commands:
+  test:
+    steps:
+      - restore_cache:
+          keys:
+            - bundler-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Bundle Install
+          command: bundle check --path vendor/bundle || bundle install
+
+      - 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:
+  ruby27:
+    executor: ruby27
+    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
+
+  ruby26:
+    executor: ruby26
+    steps:
+      - checkout
+      - test
+
+  ruby25:
+    executor: ruby25
+    steps:
+      - checkout
+      - test
+
+  ruby24:
+    executor: ruby24
+    steps:
+      - checkout
+      - test
+
+  ruby23:
+    executor: ruby23
+    steps:
+      - checkout
+      - test

data/.gitignore

@@ -19,5 +19,6 @@ 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

@@ -4,13 +4,13 @@ sudo: false
 services:
   - redis-server
 rvm:
-  - 2.4.1
-  - 2.3.1
+  - 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:

data/Gemfile

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

data/README.md

@@ -2,10 +2,10 @@
 
 Fast feature flags based on Redis.
 
-[![Build Status](https://travis-ci.org/fetlife/rollout.svg?branch=master)](https://travis-ci.org/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)
-[![Dependency Status](https://gemnasium.com/FetLife/rollout.svg)](https://gemnasium.com/fetlife/rollout)
+[![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
 
@@ -20,10 +20,18 @@ Initialize a rollout object. I assign it to a global var.
 ```ruby
 require 'redis'
 
-$redis   = Redis.new
+$redis = Redis.new
 $rollout = Rollout.new($redis)
 ```
 
+or even simpler
+
+```ruby
+require 'redis'
+$rollout = Rollout.new(Redis.current) # Will use REDIS_URL env var or default redis url
+```
+
+
 Update data specific to a feature:
 
 ```ruby
@@ -71,6 +79,9 @@ Deactivate groups like this:
 $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
@@ -98,7 +109,7 @@ $rollout.activate_percentage(:chat, 20)
 The algorithm for determining which users get let in is this:
 
 ```ruby
-CRC32(user.id) % 100_000 < percentage * 1_000
+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
@@ -176,6 +187,7 @@ This example would use the "development:feature:chat:groups" key.
 *   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

data/Rakefile

@@ -1,9 +1,7 @@
-begin
-  require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-  RSpec::Core::RakeTask.new(:spec)
+require 'rspec/core/rake_task'
 
-  task default: :spec
-rescue LoadError
-  # no rspec available
-end
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rollout.rb

@@ -1,141 +1,30 @@
-require "rollout/version"
-require "zlib"
-require "set"
-require "json"
+# frozen_string_literal: true
 
-class Rollout
-  RAND_BASE = (2**32 - 1) / 100.0
-  
-  class Feature
-    attr_accessor :groups, :users, :percentage, :data
-    attr_reader :name, :options
-
-    def initialize(name, string = nil, opts = {})
-      @options = opts
-      @name    = name
-
-      if string
-        raw_percentage,raw_users,raw_groups,raw_data = string.split('|', 4)
-        @percentage = raw_percentage.to_f
-        @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(",")}|#{serialize_data}"
-    end
-
-    def add_user(user)
-      id = user_id(user)
-      @users << id unless @users.include?(id)
-    end
-
-    def remove_user(user)
-      @users.delete(user_id(user))
-    end
-
-    def add_group(group)
-      @groups << group.to_sym unless @groups.include?(group.to_sym)
-    end
-
-    def remove_group(group)
-      @groups.delete(group.to_sym)
-    end
-
-    def clear
-      @groups = groups_from_string("")
-      @users = users_from_string("")
-      @percentage = 0
-      @data = {}
-    end
-
-    def active?(rollout, user)
-      if user
-        id = user_id(user)
-        user_in_percentage?(id) ||
-          user_in_active_users?(id) ||
-            user_in_active_group?(user, rollout)
-      else
-        @percentage == 100
-      end
-    end
-
-    def user_in_active_users?(user)
-      @users.include?(user_id(user))
-    end
-
-    def to_hash
-      {
-        percentage: @percentage,
-        groups: @groups,
-        users: @users
-      }
-    end
-
-    private
-      def user_id(user)
-        if user.is_a?(Integer) || 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_for_percentage(user)) < RAND_BASE * @percentage
-      end
-
-      def user_id_for_percentage(user)
-        if @options[:randomize_percentage]
-          user_id(user).to_s + @name.to_s
-        else
-          user_id(user)
-        end
-      end
+require 'rollout/feature'
+require 'rollout/logging'
+require 'rollout/version'
+require 'zlib'
+require 'set'
+require 'json'
+require 'observer'
 
-      def user_in_active_group?(user, rollout)
-        @groups.any? do |g|
-          rollout.active_in_group?(g, user)
-        end
-      end
-
-      def serialize_data
-        return "" unless @data.is_a? Hash
-
-        @data.to_json
-      end
+class Rollout
+  include Observable
 
-      def users_from_string(raw_users)
-        users = (raw_users || "").split(",").map(&:to_s)
-        if @options[:use_sets]
-          users.to_set
-        else
-          users
-        end
-      end
+  RAND_BASE = (2**32 - 1) / 100.0
 
-      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
+  attr_reader :options, :storage
 
   def initialize(storage, opts = {})
     @storage = storage
     @options = opts
-    @groups  = { all: lambda { |user| true } }
+    @groups  = { all: ->(_user) { true } }
+
+    extend(Logging) if opts[:logging]
+  end
+
+  def groups
+    @groups.keys
   end
 
   def activate(feature)
@@ -145,16 +34,18 @@ class Rollout
   end
 
   def deactivate(feature)
-    with_feature(feature) do |f|
-      f.clear
-    end
+    with_feature(feature, &:clear)
   end
 
   def delete(feature)
-    features = (@storage.get(features_key) || "").split(",")
+    features = (@storage.get(features_key) || '').split(',')
     features.delete(feature.to_s)
-    @storage.set(features_key, features.join(","))
+    @storage.set(features_key, features.join(','))
     @storage.del(key(feature))
+
+    if respond_to?(:logging)
+      logging.delete(feature)
+    end
   end
 
   def set(feature, desired_state)
@@ -193,13 +84,20 @@ class Rollout
 
   def activate_users(feature, users)
     with_feature(feature) do |f|
-      users.each{|user| f.add_user(user)}
+      users.each { |user| f.add_user(user) }
     end
   end
 
   def deactivate_users(feature, users)
     with_feature(feature) do |f|
-      users.each{|user| f.remove_user(user)}
+      users.each { |user| f.remove_user(user) }
+    end
+  end
+
+  def set_users(feature, users)
+    with_feature(feature) do |f|
+      f.users = []
+      users.each { |user| f.add_user(user) }
     end
   end
 
@@ -235,7 +133,7 @@ class Rollout
 
   def active_in_group?(group, user)
     f = @groups[group.to_sym]
-    f && f.call(user)
+    f&.call(user)
   end
 
   def get(feature)
@@ -256,29 +154,31 @@ class Rollout
   end
 
   def multi_get(*features)
-    feature_keys = features.map{ |feature| key(feature) }
+    return [] if features.empty?
+
+    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)
+    (@storage.get(features_key) || '').split(',').map(&:to_sym)
   end
 
   def feature_states(user = nil)
-    features.each_with_object({}) do |f, hash|
-      hash[f] = active?(f, user)
+    multi_get(*features).each_with_object({}) do |f, hash|
+      hash[f.name] = f.active?(self, user)
     end
   end
 
   def active_features(user = nil)
-    features.select do |f|
-      active?(f, user)
-    end
+    multi_get(*features).select do |f|
+      f.active?(self, user)
+    end.map(&:name)
   end
 
   def clear!
     features.each do |feature|
-      with_feature(feature) { |f| f.clear }
+      with_feature(feature, &:clear)
       @storage.del(key(feature))
     end
 
@@ -286,7 +186,28 @@ class Rollout
   end
 
   def exists?(feature)
-    @storage.exists(key(feature))
+    # since redis-rb v4.2, `#exists?` replaces `#exists` which now returns integer value instead of boolean
+    # https://github.com/redis/redis-rb/pull/918
+    if @storage.respond_to?(:exists?)
+      @storage.exists?(key(feature))
+    else
+      @storage.exists(key(feature))
+    end
+  end
+
+  def with_feature(feature)
+    f = get(feature)
+
+    if count_observers > 0
+      before = Marshal.load(Marshal.dump(f))
+      yield(f)
+      save(f)
+      changed
+      notify_observers(:update, before, f)
+    else
+      yield(f)
+      save(f)
+    end
   end
 
   private
@@ -296,17 +217,11 @@ class Rollout
   end
 
   def features_key
-    "feature:__features__"
-  end
-
-  def with_feature(feature)
-    f = get(feature)
-    yield(f)
-    save(f)
+    'feature:__features__'
   end
 
   def save(feature)
     @storage.set(key(feature.name), feature.serialize)
-    @storage.set(features_key, (features | [feature.name.to_sym]).join(","))
+    @storage.set(features_key, (features | [feature.name.to_sym]).join(','))
   end
 end