flipper 0.17.1 → 0.21.0

data/examples/basic.rb

@@ -1,17 +1,6 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-Flipper.configure do |config|
-  config.default do
-    # pick an adapter, this uses memory, any will do
-    adapter = Flipper::Adapters::Memory.new
-
-    # pass adapter to handy DSL instance
-    Flipper.new(adapter)
-  end
-end
-
 # check if search is enabled
 if Flipper.enabled?(:search)
   puts 'Search away!'

data/examples/configuring_default.rb

@@ -1,12 +1,9 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
 # sets up default adapter so Flipper works like Flipper::DSL
 Flipper.configure do |config|
-  config.default do
-    Flipper.new Flipper::Adapters::Memory.new
-  end
+  config.adapter { Flipper::Adapters::Memory.new }
 end
 
 puts Flipper.enabled?(:search) # => false

data/examples/dsl.rb

@@ -1,20 +1,9 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-
 # create a thing with an identifier
-class Person
-  attr_reader :id
-
-  def initialize(id)
-    @id = id
-  end
-
-  # Must respond to flipper_id
-  alias_method :flipper_id, :id
+class Person < Struct.new(:id)
+  include Flipper::Identifier
 end
 
 person = Person.new(1)
@@ -22,14 +11,14 @@ person = Person.new(1)
 puts "Stats are disabled by default\n\n"
 
 # is a feature enabled
-puts "flipper.enabled? :stats: #{flipper.enabled? :stats}"
+puts "flipper.enabled? :stats: #{Flipper.enabled? :stats}"
 
 # is a feature on or off for a particular person
-puts "flipper.enabled? :stats, person: #{flipper.enabled? :stats, person}"
+puts "Flipper.enabled? :stats, person: #{Flipper.enabled? :stats, person}"
 
 # get at a feature
-puts "\nYou can also get an individual feature like this:\nstats = flipper[:stats]\n\n"
-stats = flipper[:stats]
+puts "\nYou can also get an individual feature like this:\nstats = Flipper[:stats]\n\n"
+stats = Flipper[:stats]
 
 # is that feature enabled
 puts "stats.enabled?: #{stats.enabled?}"
@@ -39,7 +28,7 @@ puts "stats.enabled? person: #{stats.enabled? person}"
 
 # enable a feature by name
 puts "\nEnabling stats\n\n"
-flipper.enable :stats
+Flipper.enable :stats
 
 # or, you can use the feature to enable
 stats.enable
@@ -49,7 +38,7 @@ puts "stats.enabled? person: #{stats.enabled? person}"
 
 # oh, no, let's turn this baby off
 puts "\nDisabling stats\n\n"
-flipper.disable :stats
+Flipper.disable :stats
 
 # or we can disable using feature obviously
 stats.disable
@@ -59,18 +48,18 @@ puts "stats.enabled? person: #{stats.enabled? person}"
 puts
 
 # get an instance of the percentage of time type set to 5
-puts flipper.time(5).inspect
+puts Flipper.time(5).inspect
 
 # get an instance of the percentage of actors type set to 15
-puts flipper.actors(15).inspect
+puts Flipper.actors(15).inspect
 
 # get an instance of an actor using an object that responds to flipper_id
 responds_to_flipper_id = Struct.new(:flipper_id).new(10)
-puts flipper.actor(responds_to_flipper_id).inspect
+puts Flipper.actor(responds_to_flipper_id).inspect
 
 # get an instance of an actor using an object
 thing = Struct.new(:flipper_id).new(22)
-puts flipper.actor(thing).inspect
+puts Flipper.actor(thing).inspect
 
 # register a top level group
 admins = Flipper.register(:admins) { |actor|

data/examples/enabled_for_actor.rb

@@ -1,5 +1,4 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
 # Some class that represents what will be trying to do something
@@ -22,21 +21,15 @@ end
 user1 = User.new(1, true)
 user2 = User.new(2, false)
 
-# pick an adapter
-adapter = Flipper::Adapters::Memory.new
-
-# get a handy dsl instance
-flipper = Flipper.new(adapter)
-
 Flipper.register :admins do |actor|
   actor.admin?
 end
 
-flipper[:search].enable
-flipper[:stats].enable_actor user1
-flipper[:pro_stats].enable_percentage_of_actors 50
-flipper[:tweets].enable_group :admins
-flipper[:posts].enable_actor user2
+Flipper.enable :search
+Flipper.enable_actor :stats, user1
+Flipper.enable_percentage_of_actors :pro_stats, 50
+Flipper.enable_group :tweets, :admins
+Flipper.enable_actor :posts, user2
 
-pp flipper.features.select { |feature| feature.enabled?(user1) }.map(&:name)
-pp flipper.features.select { |feature| feature.enabled?(user2) }.map(&:name)
+pp Flipper.features.select { |feature| feature.enabled?(user1) }.map(&:name)
+pp Flipper.features.select { |feature| feature.enabled?(user2) }.map(&:name)

data/examples/group.rb

@@ -1,10 +1,7 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-stats = flipper[:stats]
+stats = Flipper[:stats]
 
 # Register group
 Flipper.register(:admins) do |actor|
@@ -35,7 +32,7 @@ puts "Stats for admin: #{stats.enabled?(admin)}"
 puts "Stats for non_admin: #{stats.enabled?(non_admin)}"
 
 puts "\nEnabling Stats for admins...\n\n"
-stats.enable(flipper.group(:admins))
+stats.enable_group :admins
 
 puts "Stats for admin: #{stats.enabled?(admin)}"
 puts "Stats for non_admin: #{stats.enabled?(non_admin)}"

data/examples/group_dynamic_lookup.rb

@@ -1,10 +1,7 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-stats = flipper[:stats]
+stats = Flipper[:stats]
 
 # Register group
 Flipper.register(:enabled_team_member) do |actor, context|
@@ -15,19 +12,12 @@ Flipper.register(:enabled_team_member) do |actor, context|
 end
 
 # Some class that represents actor that will be trying to do something
-class User
-  attr_reader :id
-
-  def initialize(id)
-    @id = id
-  end
-
-  def flipper_id
-    "User;#{@id}"
-  end
+class User < Struct.new(:id)
+  include Flipper::Identifier
 end
 
 class Team
+  include Flipper::Identifier
   attr_reader :name
 
   def self.all
@@ -51,10 +41,6 @@ class Team
   def member?(actor)
     @members.map(&:id).include?(actor.id)
   end
-
-  def flipper_id
-    "Team:#{@name}"
-  end
 end
 
 jnunemaker = User.new("jnunemaker")

data/examples/group_with_members.rb

@@ -1,10 +1,7 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-stats = flipper[:stats]
+stats = Flipper[:stats]
 
 # Register group
 Flipper.register(:team_actor) do |actor|
@@ -12,15 +9,8 @@ Flipper.register(:team_actor) do |actor|
 end
 
 # Some class that represents actor that will be trying to do something
-class User
-  attr_reader :id
-
-  def initialize(id)
-    @id = id
-  end
-
-  # Must respond to flipper_id
-  alias_method :flipper_id, :id
+class User < Struct.new(:id)
+  include Flipper::Identifier
 end
 
 class Team

data/examples/importing.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../example_setup', __FILE__)
+require 'bundler/setup'
 require_relative 'active_record/ar_setup'
 require 'flipper'
 require 'flipper/adapters/redis'

data/examples/individual_actor.rb

@@ -1,10 +1,7 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-stats = flipper[:stats]
+stats = Flipper[:stats]
 
 # Some class that represents what will be trying to do something
 class User

data/examples/instrumentation.rb

@@ -1,5 +1,4 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'securerandom'
 require 'active_support/notifications'
 

data/examples/memoizing.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+require 'flipper'
+require 'flipper/adapters/operation_logger'
+require 'flipper/instrumentation/log_subscriber'
+
+Flipper.configure do |config|
+  config.adapter do
+    # pick an adapter, this uses memory, any will do
+    Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
+  end
+end
+
+Flipper.enable(:foo)
+Flipper.enable(:bar)
+Flipper.disable(:baz)
+Flipper.disable(:wick)
+# reset the operation logging adapter to empty for clarity
+Flipper.adapter.reset
+
+# Turn on memoization (the memoizing middleware does this per request).
+Flipper.memoize = true
+
+# Preload all the features.
+Flipper.preload_all
+
+# Do as many feature checks as your heart desires.
+%w[foo bar baz wick].each do |name|
+  Flipper.enabled?(name)
+end
+
+# See that only one operation exists, a get_all (which is the preload_all).
+pp Flipper.adapter.operations
+# [#<Flipper::Adapters::OperationLogger::Operation:0x00007fdcfe1100e8
+#   @args=[],
+#   @type=:get_all>]

data/examples/percentage_of_actors.rb

@@ -1,21 +1,11 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-stats = flipper[:stats]
+stats = Flipper[:stats]
 
 # Some class that represents what will be trying to do something
-class User
-  attr_reader :id
-
-  def initialize(id)
-    @id = id
-  end
-
-  # Must respond to flipper_id
-  alias_method :flipper_id, :id
+class User < Struct.new(:id)
+  include Flipper::Identifier
 end
 
 total = 100_000
@@ -24,10 +14,10 @@ total = 100_000
 users = (1..total).map { |n| User.new(n) }
 
 perform_test = lambda { |number|
-  flipper[:stats].enable flipper.actors(number)
+  Flipper.enable_percentage_of_actors :stats, number
 
   enabled = users.map { |user|
-    flipper[:stats].enabled?(user) ? true : nil
+    Flipper.enabled?(:stats, user) ? true : nil
   }.compact
 
   actual = (enabled.size / total.to_f * 100).round(3)

data/examples/percentage_of_actors_enabled_check.rb

@@ -1,10 +1,6 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-
 # Some class that represents what will be trying to do something
 class User
   attr_reader :id
@@ -18,15 +14,16 @@ class User
 end
 
 # checking a bunch
-gate = Flipper::Gates::PercentageOfActors.new
-feature_name = "data_migration"
-percentage_enabled = 10
 total = 20_000
 enabled = []
+percentage_enabled = 10
+
+feature = Flipper[:data_migration]
+feature.enable_percentage_of_actors 10
 
 (1..total).each do |id|
   user = User.new(id)
-  if gate.open?(user, percentage_enabled, feature_name: feature_name)
+  if feature.enabled? user
     enabled << user
   end
 end
@@ -35,4 +32,4 @@ p actual: enabled.size, expected: total * (percentage_enabled * 0.01)
 
 # checking one
 user = User.new(1)
-p user_1_enabled: Flipper::Gates::PercentageOfActors.new.open?(user, percentage_enabled, feature_name: feature_name)
+p user_1_enabled: feature.enabled?(user)

data/examples/percentage_of_actors_group.rb

@@ -3,25 +3,12 @@
 # feature for actors in a particular location or on a particular plan, but only
 # for a percentage of them. The percentage is a constant, but could easily be
 # plucked from memcached, redis, mysql or whatever.
-require File.expand_path('../example_setup', __FILE__)
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-stats = flipper[:stats]
-
 # Some class that represents what will be trying to do something
-class User
-  attr_reader :id
-
-  def initialize(id)
-    @id = id
-  end
-
-  # Must respond to flipper_id
-  def flipper_id
-    "User;#{@id}"
-  end
+class User < Struct.new(:id)
+  include Flipper::Identifier
 end
 
 PERCENTAGE = 50
@@ -34,13 +21,13 @@ Flipper.register(:experimental) do |actor|
 end
 
 # enable the experimental group
-flipper[:stats].enable_group :experimental
+Flipper.enable_group :stats, :experimental
 
 # create a bunch of fake users and see how many are enabled
 total = 10_000
 users = (1..total).map { |n| User.new(n) }
 enabled = users.map { |user|
-  flipper[:stats].enabled?(user) ? true : nil
+  Flipper.enabled?(:stats, user) ? true : nil
 }.compact
 
 # show the results

data/examples/percentage_of_time.rb

@@ -1,13 +1,10 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
-adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(adapter)
-logging = flipper[:logging]
+logging = Flipper[:logging]
 
 perform_test = lambda do |number|
-  logging.enable flipper.time(number)
+  logging.enable_percentage_of_time number
 
   total = 100_000
   enabled = []