flipper 0.11.0.beta6 → 0.11.0.beta7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc657f1ced7ca41760051223843e487c3c820277
-  data.tar.gz: '0520502010855501979601516821cac277ce3891'
+  metadata.gz: 258c0cfa4877a2bea9e7927f5d39ed1339c3f698
+  data.tar.gz: 4402f1aa545f09f2bf0dd97937d6e7564ec6d008
 SHA512:
-  metadata.gz: b9afe59c11ad41ec976ed8cb804929985afdb9e737146d9639510c75298ee88f1fb1573d92580f3504840a453e3cf84ed1a4b9d9c61ad5975fc1471d8096d34f
-  data.tar.gz: a1c682c40e47feb582e74069aad67f261b9a2cb14b3cd0978a175a305e6fd31a062804514608c60dffe743a635d4037b7aba55a6410b12a68eaef8a9343506a1
+  metadata.gz: 7596ed84b459acc7b052a11e7a86e5be07d4bc52b083e31dcd14749b56e026f7a6ee0a6b3aac50fdc61950afcc764bdf64834bcecd4668baadc62e06a60d248b
+  data.tar.gz: 18a608871470cd7ae57db9b4dccf661e9ea8fe68e55efced9fea8cec26b9374a9c528b324516da9f263cad8cd4da28d697501f321d8f9a2b0280a351e1ed057c

data/Changelog.md

@@ -23,6 +23,8 @@
 * Allow setting debug output of http adapter (https://github.com/jnunemaker/flipper/pull/256 and https://github.com/jnunemaker/flipper/pull/258).
 * Allow setting env key for middleware (https://github.com/jnunemaker/flipper/pull/259).
 * Added ActiveSupport cache store adapter for use with Rails.cache (https://github.com/jnunemaker/flipper/pull/265).
+* Added support for up to 3 decimal places in percentage based rollouts (https://github.com/jnunemaker/flipper/pull/274).
+* Removed Flipper::GroupNotRegistered error as it is now unused (https://github.com/jnunemaker/flipper/pull/270).
 
 ## 0.10.2
 

data/README.md

@@ -41,26 +41,34 @@ The goal of the API for flipper was to have everything revolve around features a
 
 ```ruby
 require 'flipper'
-
-# pick an adapter
 require 'flipper/adapters/memory'
-adapter = Flipper::Adapters::Memory.new
 
-# get a handy dsl instance
-flipper = Flipper.new(adapter)
+Flipper.configure do |config|
+  config.default do
+    # pick an adapter, this uses memory, any will do
+    adapter = Flipper::Adapters::Memory.new
 
-# grab a feature
-search = flipper[:search]
+    # pass adapter to handy DSL instance
+    Flipper.new(adapter)
+  end
+end
 
-# check if that feature is enabled
-if search.enabled?
+# check if search is enabled
+if Flipper.enabled?(:search)
   puts 'Search away!'
 else
   puts 'No search for you!'
 end
 
 puts 'Enabling Search...'
-search.enable
+Flipper.enable(:search)
+
+# check if search is enabled
+if Flipper.enabled?(:search)
+  puts 'Search away!'
+else
+  puts 'No search for you!'
+end
 ```
 
 Of course there are more [examples for you to peruse](examples/). You could also check out the [DSL](lib/flipper/dsl.rb) and [Feature](lib/flipper/feature.rb) classes for code/docs.

data/docs/Adapters.md

@@ -5,6 +5,7 @@ I plan on supporting the adapters in the flipper repo. Other adapters are welcom
 ## Officially Supported
 
 * [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 3, 4, and 5.
+* [CacheStore adapter](https://github.com/jnunemaker/flipper/blob/master/docs/cache_store) - ActiveSupport::Cache::Store
 * [Cassanity adapter](https://github.com/jnunemaker/flipper-cassanity)
 * [Http adapter](https://github.com/jnunemaker/flipper/blob/master/docs/http)
 * [memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb) – great for tests

data/docs/Optimization.md

@@ -95,3 +95,34 @@ Example using the RedisCache adapter with the Memory adapter and a TTL of 4800 s
   adapter = Flipper::Adapters::RedisCache.new(memory_adapter, redis, 4800)
   flipper = Flipper.new(adapter)
 ```
+
+### CacheStore
+
+Rails applications can cache Flipper calls in any [ActiveSupport::Cache::Store](http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html) implementation.
+
+Add this line to your application's Gemfile:
+
+    gem 'flipper-cache-store'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install flipper-cache-store
+
+Example using the CacheStore adapter with ActiveSupport's [MemoryStore](http://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html), Flipper's [Memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb), and a TTL of 5 minutes.
+
+```ruby
+require 'active_support/cache'
+require 'flipper/adapters/memory'
+require 'flipper/adapters/cache_store'
+
+memory_adapter = Flipper::Adapters::Memory.new
+cache = ActiveSupport::Cache::MemoryStore.new
+adapter = Flipper::Adapters::CacheStore.new(memory_adapter, cache, expires_in: 5.minutes)
+flipper = Flipper.new(adapter)
+```
+
+Setting `expires_in` is optional and will set an expiration time on Flipper cache keys.  If specified, all flipper keys will use this `expires_in` over the `expires_in` passed to your ActiveSupport cache constructor.

data/examples/basic.rb

@@ -3,25 +3,29 @@ require File.expand_path('../example_setup', __FILE__)
 require 'flipper'
 require 'flipper/adapters/memory'
 
-# pick an adapter
-adapter = Flipper::Adapters::Memory.new
+Flipper.configure do |config|
+  config.default do
+    # pick an adapter, this uses memory, any will do
+    adapter = Flipper::Adapters::Memory.new
 
-# get a handy dsl instance
-flipper = Flipper.new(adapter)
-
-# grab a feature
-search = flipper[:search]
-
-perform = lambda do
-  # check if that feature is enabled
-  if search.enabled?
-    puts 'Search away!'
-  else
-    puts 'No search for you!'
+    # pass adapter to handy DSL instance
+    Flipper.new(adapter)
   end
 end
 
-perform.call
+# check if search is enabled
+if Flipper.enabled?(:search)
+  puts 'Search away!'
+else
+  puts 'No search for you!'
+end
+
 puts 'Enabling Search...'
-search.enable
-perform.call
+Flipper.enable(:search)
+
+# check if search is enabled
+if Flipper.enabled?(:search)
+  puts 'Search away!'
+else
+  puts 'No search for you!'
+end

data/examples/configuring_default.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../example_setup', __FILE__)
+
+require 'flipper'
+require 'flipper/adapters/memory'
+
+# sets up default adapter so Flipper works like Flipper::DSL
+Flipper.configure do |config|
+  config.default do
+    Flipper.new Flipper::Adapters::Memory.new
+  end
+end
+
+puts Flipper.enabled?(:search) # => false
+Flipper.enable(:search)
+puts Flipper.enabled?(:search) # => true
+Flipper.disable(:search)
+
+enabled_actor = Flipper::Actor.new("1")
+disabled_actor = Flipper::Actor.new("2")
+Flipper.enable_actor(:search, enabled_actor)
+
+puts Flipper.enabled?(:search, enabled_actor)
+puts Flipper.enabled?(:search, disabled_actor)

data/examples/percentage_of_actors.rb

@@ -19,7 +19,7 @@ class User
   alias_method :flipper_id, :id
 end
 
-total = 10_000
+total = 100_000
 
 # create array of fake users
 users = (1..total).map { |n| User.new(n) }
@@ -31,13 +31,12 @@ perform_test = lambda { |number|
     flipper[:stats].enabled?(user) ? true : nil
   }.compact
 
-  actual = (enabled.size / total.to_f * 100).round(2)
+  actual = (enabled.size / total.to_f * 100).round(3)
 
   puts "percentage: #{actual.to_s.rjust(6, ' ')} vs #{number.to_s.rjust(3, ' ')}"
 }
 
 puts "percentage: Actual vs Hoped For"
-
-[1, 5, 10, 20, 30, 40, 50, 60, 70, 80, 90, 95, 99, 100].each do |number|
+[0.001, 0.01, 0.1, 1, 5, 10, 20, 30, 40, 50, 60, 70, 80, 90, 95, 99, 100].each do |number|
   perform_test.call number
 end

data/examples/percentage_of_time.rb

@@ -10,7 +10,7 @@ logging = flipper[:logging]
 perform_test = lambda do |number|
   logging.enable flipper.time(number)
 
-  total = 1_000
+  total = 100_000
   enabled = []
   disabled = []
 
@@ -18,7 +18,7 @@ perform_test = lambda do |number|
     logging.enabled? ? true : nil
   }.compact
 
-  actual = (enabled.size / total.to_f * 100).round(2)
+  actual = (enabled.size / total.to_f * 100).round(3)
 
   # puts "#{enabled.size} / #{total}"
   puts "percentage: #{actual.to_s.rjust(6, ' ')} vs #{number.to_s.rjust(3, ' ')}"
@@ -26,6 +26,6 @@ end
 
 puts "percentage: Actual vs Hoped For"
 
-[1, 5, 10, 20, 30, 40, 50, 60, 70, 80, 90, 95, 99, 100].each do |number|
+[0.001, 0.01, 0.1, 1, 5, 10, 20, 30, 40, 50, 60, 70, 80, 90, 95, 99, 100].each do |number|
   perform_test.call number
 end

data/flipper-cache-store.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flipper/version', __FILE__)
+
+flipper_cache_store_files = lambda do |file|
+  file =~ /cache_store/
+end
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['John Nunemaker']
+  gem.email         = ['nunemaker@gmail.com']
+  gem.summary       = 'ActiveSupport::Cache::Store adapter for Flipper'
+  gem.description   = 'ActiveSupport::Cache::Store adapter for Flipper'
+  gem.license       = 'MIT'
+  gem.homepage      = 'https://github.com/jnunemaker/flipper'
+
+  gem.files         = `git ls-files`.split("\n").select(&flipper_cache_store_files) + ['lib/flipper/version.rb']
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_cache_store_files)
+  gem.name          = 'flipper-cache-store'
+  gem.require_paths = ['lib']
+  gem.version       = Flipper::VERSION
+
+  gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
+  gem.add_dependency 'activesupport', '>= 3.2', '< 6'
+end

data/lib/flipper.rb

@@ -1,13 +1,62 @@
+require "forwardable"
+
 module Flipper
+  extend self # rubocop:disable Style/ModuleFunction
+  extend Forwardable
+
   # Private: The namespace for all instrumented events.
   InstrumentationNamespace = :flipper
 
   # Public: Start here. Given an adapter returns a handy DSL to all the flipper
   # goodness. To see supported options, check out dsl.rb.
-  def self.new(adapter, options = {})
+  def new(adapter, options = {})
     DSL.new(adapter, options)
   end
 
+  # Public: Configure flipper.
+  #
+  #   Flipper.configure do |config|
+  #     config.default { ... }
+  #   end
+  #
+  # Yields Flipper::Configuration instance.
+  def configure
+    yield configuration if block_given?
+  end
+
+  # Public: Returns Flipper::Configuration instance.
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Public: Sets Flipper::Configuration instance.
+  def configuration=(configuration)
+    @configuration = configuration
+  end
+
+  # Public: Default per thread flipper instance if configured. You should not
+  # need to use this directly as most of the Flipper::DSL methods are delegated
+  # from Flipper module itself. Instead of doing Flipper.instance.enabled?(:search),
+  # you can use Flipper.enabled?(:search) for the same result.
+  #
+  # Returns Flipper::DSL instance.
+  def instance
+    Thread.current[:flipper_instance] ||= configuration.default
+  end
+
+  # Public: All the methods delegated to instance. These should match the
+  # interface of Flipper::DSL.
+  def_delegators :instance,
+                 :enabled?, :enable, :disable, :bool, :boolean,
+                 :enable_actor, :disable_actor, :actor,
+                 :enable_group, :disable_group,
+                 :enable_percentage_of_actors, :disable_percentage_of_actors,
+                 :actors, :percentage_of_actors,
+                 :enable_percentage_of_time, :disable_percentage_of_time,
+                 :time, :percentage_of_time,
+                 :features, :feature, :[], :preload, :preload_all,
+                 :add, :remove, :import
+
   # Public: Use this to register a group by name.
   #
   # name - The Symbol name of the group.
@@ -22,7 +71,7 @@ module Flipper
   #
   # Returns a Flipper::Group.
   # Raises Flipper::DuplicateGroup if the group is already registered.
-  def self.register(name, &block)
+  def register(name, &block)
     group = Types::Group.new(name, &block)
     groups_registry.add(group.name, group)
     group
@@ -31,28 +80,28 @@ module Flipper
   end
 
   # Public: Returns a Set of registered Types::Group instances.
-  def self.groups
+  def groups
     groups_registry.values.to_set
   end
 
   # Public: Returns a Set of symbols where each symbol is a registered
   # group name. If you just want the names, this is more efficient than doing
   # `Flipper.groups.map(&:name)`.
-  def self.group_names
+  def group_names
     groups_registry.keys.to_set
   end
 
   # Public: Clears the group registry.
   #
   # Returns nothing.
-  def self.unregister_groups
+  def unregister_groups
     groups_registry.clear
   end
 
   # Public: Check if a group exists
   #
   # Returns boolean
-  def self.group_exists?(name)
+  def group_exists?(name)
     groups_registry.key?(name)
   end
 
@@ -65,22 +114,23 @@ module Flipper
   #   Flipper.group(:admins)
   #
   # Returns Flipper::Group.
-  def self.group(name)
+  def group(name)
     groups_registry.get(name) || Types::Group.new(name)
   end
 
   # Internal: Registry of all groups_registry.
-  def self.groups_registry
+  def groups_registry
     @groups_registry ||= Registry.new
   end
 
   # Internal: Change the groups_registry registry.
-  def self.groups_registry=(registry)
+  def groups_registry=(registry)
     @groups_registry = registry
   end
 end
 
 require 'flipper/actor'
+require 'flipper/configuration'
 require 'flipper/adapter'
 require 'flipper/dsl'
 require 'flipper/errors'

data/lib/flipper/configuration.rb

@@ -0,0 +1,32 @@
+module Flipper
+  class Configuration
+    def initialize
+      @default = -> { raise DefaultNotSet }
+    end
+
+    # Controls the default instance for flipper. When used with a block it
+    # assigns a new default block to use to generate an instance. When used
+    # without a block, it performs a block invocation and returns the result.
+    #
+    #   configuration = Flipper::Configuration.new
+    #   configuration.default # => raises DefaultNotSet error.
+    #
+    #   # sets the default block to generate a new instance using Memory adapter
+    #   configuration.default do
+    #     require "flipper/adapters/memory"
+    #     Flipper.new(Flipper::Adapters::Memory.new)
+    #   end
+    #
+    #   configuration.default # => Flipper::DSL instance using Memory adapter
+    #
+    # Returns result of default block invocation if called without block. If
+    # called with block, assigns the default block.
+    def default(&block)
+      if block_given?
+        @default = block
+      else
+        @default.call
+      end
+    end
+  end
+end

data/lib/flipper/dsl.rb

@@ -217,7 +217,6 @@ module Flipper
     # name - The String or Symbol name of the feature.
     #
     # Returns an instance of Flipper::Group.
-    # Raises Flipper::GroupNotRegistered if group has not been registered.
     def group(name)
       Flipper.group(name)
     end

data/lib/flipper/errors.rb

@@ -12,6 +12,13 @@ module Flipper
   # Raised when attempting to declare a group name that has already been used.
   class DuplicateGroup < Error; end
 
-  # Raised when attempting to access a group that is not registered.
-  class GroupNotRegistered < Error; end
+  # Raised when default instance not configured but there is an attempt to
+  # use it.
+  class DefaultNotSet < Flipper::Error
+    def initialize(message = nil)
+      default = "Default flipper instance not configured. See " \
+                "Flipper.configure for how to configure the default instance."
+      super(message || default)
+    end
+  end
 end