flipper-rollout 0.12.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3c3cd714e01fa05692efe3b02c27a55d0dfe9f7
-  data.tar.gz: 5eb7aa9aaed42a42804c5497d1ef38fde67c001b
+  metadata.gz: 2b1f4a58ee4db5bf368bc0798d572ba2e4bbedac
+  data.tar.gz: 36e940c9d386b504837a9cb7a53bca4f856f1219
 SHA512:
-  metadata.gz: a0090b377f1b44b68c94fad9ae4b0b22e38525a25bcd2127cad5d1e8b6bb2dcec39f94e8d3774633a918dbf97b6179c0e1defa38eac68a122d8d3915dfbb7f87
-  data.tar.gz: bfb725e0ad8d034fde23cbe3e5d6eb9deb727e44ceb0a28a9d807a7402efb5068fab86e6049bc4a727fd72acdcb1def5d53767260a532c90ca66d6143cb62560
+  metadata.gz: d4999b9d3c43560c15a72632b9fa5ebc86a50c91448e5f12d804debf1aeed3cedaf3291d483205cfaa2f3c2144257534bb6051da4e01ddc79137d488427b9ce4
+  data.tar.gz: c2907694644a3b06cc5bb83d873d0470c5464adaecbdb07407eeb26ced32988e4dfdbccad48c61130df2826e6bb5d0bfd9fc8c096a8ba3c96777366369e0a595

data/docs/rollout/README.md

@@ -23,18 +23,25 @@ Or install it yourself with:
 
 ## Usage
 
-Assuming you've configured a [default Flipper instance](https://github.com/jnunemaker/flipper#user-content-examples)
-
 ```ruby
 require 'redis'
+require 'rollout'
+require 'flipper'
+require 'flipper/adapters/redis'
 require 'flipper/adapters/rollout'
 
+# setup redis, rollout and rollout flipper
 redis = Redis.new
 rollout = Rollout.new(redis)
-
 rollout_adapter = Flipper::Adapters::Rollout.new(rollout)
 rollout_flipper = Flipper.new(rollout_adapter)
 
+# setup flipper default instance
+Flipper.configure do |config|
+  config.default { Flipper.new(Flipper::Adapters::Redis.new(redis)) }
+end
+
+# import rollout into redis flipper
 Flipper.import(rollout_flipper)
 ```
 

data/examples/rollout/basic.rb

@@ -0,0 +1,32 @@
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'redis'
+require 'rollout'
+require 'flipper'
+require 'flipper/adapters/rollout'
+
+redis = Redis.new
+rollout = Rollout.new(redis)
+rollout.activate(:stats)
+
+adapter = Flipper::Adapters::Rollout.new(rollout)
+flipper = Flipper.new(adapter)
+
+if flipper[:stats].enabled?
+  puts "Enabled!"
+else
+  puts "Disabled!"
+end
+
+rollout.deactivate(:stats)
+
+if flipper[:stats].enabled?
+  puts "Enabled!"
+else
+  puts "Disabled!"
+end

data/examples/rollout/import.rb

@@ -0,0 +1,41 @@
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'redis'
+require 'rollout'
+require 'flipper'
+require 'flipper/adapters/redis'
+require 'flipper/adapters/rollout'
+
+# setup redis, rollout and rollout flipper
+redis = Redis.new
+rollout = Rollout.new(redis)
+rollout_adapter = Flipper::Adapters::Rollout.new(rollout)
+rollout_flipper = Flipper.new(rollout_adapter)
+
+# setup flipper default instance
+Flipper.configure do |config|
+  config.default do
+    Flipper.new(Flipper::Adapters::Redis.new(redis))
+  end
+end
+
+# flush redis so we have clean state for script
+redis.flushdb
+
+# activate some rollout stuff to show that importing works
+rollout.activate(:stats)
+rollout.activate_user(:search, Struct.new(:id).new(1))
+rollout.activate_group(:admin, :admins)
+
+# import rollout into redis flipper
+Flipper.import(rollout_flipper)
+
+# demonstrate that the rollout enablements made it into flipper
+p Flipper[:stats].boolean_value # true
+p Flipper[:search].actors_value # #<Set: {"1"}>
+p Flipper[:admin].groups_value # #<Set: {"admins"}>

data/lib/flipper/adapters/rollout.rb

@@ -1,6 +1,10 @@
+require "flipper/errors"
+
 module Flipper
   module Adapters
     class Rollout
+      include Adapter
+
       class AdapterMethodNotSupportedError < Error
         def initialize(message = 'unsupported method called for import adapter')
           super(message)
@@ -24,13 +28,30 @@ module Flipper
       #
       # Returns a Hash of Flipper::Gate#key => value.
       def get(feature)
-        feature = @rollout.get(feature.key)
-        percentage = feature.percentage.zero? ? nil : feature.percentage
+        rollout_feature = @rollout.get(feature.key)
+        return default_config if rollout_feature.nil?
+
+        boolean = nil
+        groups = Set.new(rollout_feature.groups)
+        actors = Set.new(rollout_feature.users)
+
+        percentage_of_actors = case rollout_feature.percentage
+                               when 100
+                                 boolean = true
+                                 groups = Set.new
+                                 actors = Set.new
+                                 nil
+                               when 0
+                                 nil
+                               else
+                                 rollout_feature.percentage
+                               end
+
         {
-          boolean: nil,
-          groups: Set.new(feature.groups),
-          actors: Set.new(feature.users),
-          percentage_of_actors: percentage,
+          boolean: boolean,
+          groups: groups,
+          actors: actors,
+          percentage_of_actors: percentage_of_actors,
           percentage_of_time: nil,
         }
       end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.12.1'.freeze
+  VERSION = '0.12.2'.freeze
 end

data/spec/flipper/adapters/rollout_spec.rb

@@ -29,16 +29,49 @@ RSpec.describe Flipper::Adapters::Rollout do
       rollout.activate_user(:chat, Struct.new(:id).new(1))
       rollout.activate_percentage(:chat, 20)
       rollout.activate_group(:chat, :admins)
-      feature = Struct.new(:key).new(:chat)
+      feature = source_flipper[:chat]
       expected = {
-        actors: Set.new(["1"]),
         boolean: nil,
         groups: Set.new([:admins]),
+        actors: Set.new(["1"]),
         percentage_of_actors: 20.0,
         percentage_of_time: nil,
       }
       expect(source_adapter.get(feature)).to eq(expected)
     end
+
+    it 'returns fully flipper enabled for fully rollout activated' do
+      rollout.activate(:chat)
+      feature = source_flipper[:chat]
+      expected = {
+        boolean: true,
+        groups: Set.new,
+        actors: Set.new,
+        percentage_of_actors: nil,
+        percentage_of_time: nil,
+      }
+      expect(source_adapter.get(feature)).to eq(expected)
+    end
+
+    it 'returns fully flipper enabled for fully rollout activated with user/group' do
+      rollout.activate_user(:chat, Struct.new(:id).new(1))
+      rollout.activate_group(:chat, :admins)
+      rollout.activate(:chat)
+      feature = source_flipper[:chat]
+      expected = {
+        boolean: true,
+        groups: Set.new,
+        actors: Set.new,
+        percentage_of_actors: nil,
+        percentage_of_time: nil,
+      }
+      expect(source_adapter.get(feature)).to eq(expected)
+    end
+
+    it 'returns default hash of gate data for feature not existing in rollout' do
+      feature = source_flipper[:chat]
+      expect(source_adapter.get(feature)).to eq(source_adapter.default_config)
+    end
   end
 
   describe '#features' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-rollout
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - docs/rollout/README.md
+- examples/rollout/basic.rb
+- examples/rollout/import.rb
 - flipper-rollout.gemspec
 - lib/flipper/adapters/rollout.rb
 - lib/flipper/version.rb