rollout 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37e56080ba30fb08aaa7e718e22fae3cab0745e84a91537e4e5520c2843a63a2
-  data.tar.gz: 2b2f8c5a6e7a3ddd8275d818b4a168e7573204c2e259e323ca7a2ea9996062d9
+  metadata.gz: 58914b07d5596f1db7ce88d65de6e5286519e4b527377b40b7c56ad3ea799323
+  data.tar.gz: 4200f92c9784c3d3f6d275a4308714c7b55d35154c97ef01a89a04166e69c041
 SHA512:
-  metadata.gz: a31905463a16ca7413566460c9a693ab5b9063e74547c05aafe2cf40d5e8f8d83ecb9e85316dd48c3e6b5e5b63311ac222343b485228a695ff5b72f8b0d82a2c
-  data.tar.gz: 33fc542bdfe0def2b13a1b3697ba59c1e5f83e813a7c67740d94bf0a9725e17003fdc3fecfa923874883730dde589e0906b5d49ab19ff49c36943e259c28f134
+  metadata.gz: 4e3fcddc89ff58fe0d652eed810767eba1a03a4a23312f9bceb174e63348b07fd47592a1504316c3e42169610f24fc78580b846b5649200159dcef6c6ffdbdb7
+  data.tar.gz: 02cc8771d302d5e0b33fb370d6a9ed063f5b7d05406f4ec57689f2196921e5ec4e1382b1a1fd175d7804e316f98538d0e2809e6ad7fe25847e06466dd12cafbc

data/.circleci/config.yml

@@ -3,58 +3,64 @@ version: 2.1
 workflows:
   main:
     jobs:
+      - ruby33
+      - ruby31
+      - ruby32
+      - ruby30
       - ruby27
       - ruby26
       - ruby25
       - ruby24
-      - ruby23
 
 executors:
+  ruby33:
+    docker:
+      - image: cimg/ruby:3.3
+      - image: cimg/redis:7.2
+  ruby32:
+    docker:
+      - image: cimg/ruby:3.2
+      - image: cimg/redis:7.2
+  ruby31:
+    docker:
+      - image: cimg/ruby:3.1
+      - image: cimg/redis:7.2
+  ruby30:
+    docker:
+      - image: cimg/ruby:3.0
+      - image: cimg/redis:7.2
   ruby27:
     docker:
-      - image: circleci/ruby:2.7
-      - image: circleci/redis:alpine
+      - image: cimg/ruby:2.7
+      - image: cimg/redis:7.2
   ruby26:
     docker:
-      - image: circleci/ruby:2.6
-      - image: circleci/redis:alpine
+      - image: cimg/ruby:2.7
+      - image: cimg/redis:7.2
   ruby25:
     docker:
-      - image: circleci/ruby:2.5
-      - image: circleci/redis:alpine
+      - image: cimg/ruby:2.7
+      - image: cimg/redis:7.2
   ruby24:
     docker:
-      - image: circleci/ruby:2.4
-      - image: circleci/redis:alpine
-  ruby23:
-    docker:
-      - image: circleci/ruby:2.3
-      - image: circleci/redis:alpine
+      - image: cimg/ruby:2.4
+      - image: cimg/redis:7.2
 
 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
+  ruby33:
+    executor: ruby33
     steps:
       - checkout
       - test
@@ -70,26 +76,44 @@ jobs:
       - store_test_results:
           path: test_results
 
-  ruby26:
-    executor: ruby26
+  ruby32:
+    executor: ruby30
     steps:
       - checkout
       - test
 
-  ruby25:
-    executor: ruby25
+  ruby31:
+    executor: ruby30
     steps:
       - checkout
       - test
 
-  ruby24:
-    executor: ruby24
+  ruby30:
+    executor: ruby30
     steps:
       - checkout
       - test
 
-  ruby23:
-    executor: ruby23
+  ruby27:
+    executor: ruby27
+    steps:
+      - checkout
+      - test
+
+  ruby26:
+    executor: ruby27
+    steps:
+      - checkout
+      - test
+
+  ruby25:
+    executor: ruby27
+    steps:
+      - checkout
+      - test
+
+  ruby24:
+    executor: ruby24
     steps:
       - checkout
       - test

data/README.md

@@ -28,7 +28,7 @@ or even simpler
 
 ```ruby
 require 'redis'
-$rollout = Rollout.new(Redis.current) # Will use REDIS_URL env var or default redis url
+$rollout = Rollout.new($redis) # Will use REDIS_URL env var or default redis url
 ```
 
 
@@ -161,6 +161,15 @@ 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.
 
+## Check Rollout Feature
+
+You can inspect the state of your feature using:
+
+```ruby
+>> $rollout.get(:chat)
+=> #<Rollout::Feature:0x00007f99fa4ec528 @data={}, @groups=[:caretakers], @name=:chat, @options={}, @percentage=0.05, @users=["1"]>
+```
+
 ## Namespacing
 
 Rollout separates its keys from other keys in the data store using the
@@ -180,6 +189,7 @@ This example would use the "development:feature:chat:groups" key.
 
 ## Frontend / UI
 
+* [rollout-ui](https://github.com/fetlife/rollout-ui)
 * [Rollout-Dashboard](https://github.com/fiverr/rollout_dashboard/)
 
 ## Implementations in other languages
@@ -188,6 +198,7 @@ This example would use the "development:feature:chat:groups" key.
 *   PHP: https://github.com/opensoft/rollout
 *   Clojure: https://github.com/yeller/shoutout
 *   Perl: https://metacpan.org/pod/Toggle
+*   Golang: https://github.com/SalesLoft/gorollout
 
 
 ## Contributors

data/lib/rollout/feature.rb

@@ -5,12 +5,13 @@ class Rollout
     attr_accessor :groups, :users, :percentage, :data
     attr_reader :name, :options
 
-    def initialize(name, string = nil, opts = {})
-      @options = opts
-      @name    = name
+    def initialize(name, rollout:, state: nil, options: {})
+      @name = name
+      @rollout = rollout
+      @options = options
 
-      if string
-        raw_percentage, raw_users, raw_groups, raw_data = string.split('|', 4)
+      if state
+        raw_percentage, raw_users, raw_groups, raw_data = state.split('|', 4)
         @percentage = raw_percentage.to_f
         @users = users_from_string(raw_users)
         @groups = groups_from_string(raw_groups)
@@ -48,12 +49,12 @@ class Rollout
       @data = {}
     end
 
-    def active?(rollout, user)
+    def active?(user)
       if user
         id = user_id(user)
         user_in_percentage?(id) ||
           user_in_active_users?(id) ||
-          user_in_active_group?(user, rollout)
+          user_in_active_group?(user)
       else
         @percentage == 100
       end
@@ -72,6 +73,14 @@ class Rollout
       }
     end
 
+    def deep_clone
+      c = self.clone
+      c.instance_variable_set('@rollout', nil)
+      c = Marshal.load(Marshal.dump(c))
+      c.instance_variable_set('@rollot', @rollout)
+      c
+    end
+
     private
 
     def user_id(user)
@@ -98,9 +107,9 @@ class Rollout
       end
     end
 
-    def user_in_active_group?(user, rollout)
+    def user_in_active_group?(user)
       @groups.any? do |g|
-        rollout.active_in_group?(g, user)
+        @rollout.active_in_group?(g, user)
       end
     end
 

data/lib/rollout/logging.rb

@@ -40,6 +40,7 @@ class Rollout
           name: @name,
           data: @data,
           context: @context,
+          created_at: @created_at,
         )
       end
 

data/lib/rollout/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Rollout
-  VERSION = '2.5.0'
+  VERSION = '2.6.0'
 end

data/lib/rollout.rb

@@ -107,7 +107,7 @@ class Rollout
 
   def active?(feature, user = nil)
     feature = get(feature)
-    feature.active?(self, user)
+    feature.active?(user)
   end
 
   def user_in_active_users?(feature, user = nil)
@@ -138,7 +138,7 @@ class Rollout
 
   def get(feature)
     string = @storage.get(key(feature))
-    Feature.new(feature, string, @options)
+    Feature.new(feature, state: string, rollout: self, options: @options)
   end
 
   def set_feature_data(feature, data)
@@ -157,7 +157,13 @@ class Rollout
     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) }
+
+    @storage
+      .mget(*feature_keys)
+      .map
+      .with_index do |string, index|
+        Feature.new(features[index], state: string, rollout: self, options: @options)
+      end
   end
 
   def features
@@ -166,13 +172,13 @@ class Rollout
 
   def feature_states(user = nil)
     multi_get(*features).each_with_object({}) do |f, hash|
-      hash[f.name] = f.active?(self, user)
+      hash[f.name] = f.active?(user)
     end
   end
 
   def active_features(user = nil)
     multi_get(*features).select do |f|
-      f.active?(self, user)
+      f.active?(user)
     end.map(&:name)
   end
 
@@ -199,7 +205,7 @@ class Rollout
     f = get(feature)
 
     if count_observers > 0
-      before = Marshal.load(Marshal.dump(f))
+      before = f.deep_clone
       yield(f)
       save(f)
       changed

data/rollout.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_dependency 'redis', '~> 4.0'
+  spec.add_dependency 'redis', '>= 4.0', '< 6'
 
   spec.add_development_dependency 'bundler', '>= 1.17'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec', '~> 3.13'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
   spec.add_development_dependency 'rubocop', '~> 0.71'
   spec.add_development_dependency 'simplecov', '0.17'

data/spec/rollout/feature_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe "Rollout::Feature" do
+  let(:rollout) { Rollout.new($redis) }
+
+  describe "#add_user" do
+    it "ids a user using id_user_by" do
+      user    = double("User", email: "test@test.com")
+      feature = Rollout::Feature.new(:chat, state: nil, rollout: rollout, options: { 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, rollout: rollout)
+        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, state: nil, rollout: rollout)
+        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, state: "", rollout: rollout)
+        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, state: "0||", rollout: rollout)
+          expect(feature.data).to eq({})
+        end
+
+        it 'sets @data to empty hash' do
+          feature = Rollout::Feature.new(:chat, state: "|||   ", rollout: rollout)
+          expect(feature.data).to eq({})
+        end
+      end
+    end
+  end
+end

data/spec/rollout/logging_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe 'Rollout::Logging' do
-  let(:rollout) { Rollout.new(Redis.current, logging: logging) }
+  let(:rollout) { Rollout.new($redis, logging: logging) }
   let(:logging) { true }
   let(:feature) { :foo }