flipper 0.16.0 → 1.4.0

data/examples/expressions.rb

@@ -0,0 +1,237 @@
+require 'bundler/setup'
+require 'flipper'
+
+def assert(value)
+  if value
+    p value
+  else
+    puts "Expected true but was #{value}. Please correct."
+    exit 1
+  end
+end
+
+def refute(value)
+  if value
+    puts "Expected false but was #{value}. Please correct."
+    exit 1
+  else
+    p value
+  end
+end
+
+def reset
+  Flipper.disable_expression :something
+end
+
+class User < Struct.new(:id, :flipper_properties)
+  include Flipper::Identifier
+end
+
+class Org < Struct.new(:id, :flipper_properties)
+  include Flipper::Identifier
+end
+
+org = Org.new(1, {
+  "type" => "Org",
+  "id" => 1,
+})
+
+user = User.new(1, {
+  "type" => "User",
+  "id" => 1,
+  "plan" => "basic",
+  "age" => 39,
+  "team_user" => true,
+})
+
+admin_user = User.new(2, {
+  "type" => "User",
+  "id" => 2,
+  "admin" => true,
+  "team_user" => true,
+})
+
+other_user = User.new(3, {
+  "type" => "User",
+  "id" => 3,
+  "plan" => "plus",
+  "age" => 18,
+  "org_admin" => true,
+})
+
+age_expression = Flipper.property(:age).gte(21)
+plan_expression = Flipper.property(:plan).eq("basic")
+admin_expression = Flipper.property(:admin).eq(true)
+
+puts "Single Expression"
+refute Flipper.enabled?(:something, user)
+
+puts "Enabling single expression"
+Flipper.enable :something, plan_expression
+assert Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Disabling single expression"
+reset
+refute Flipper.enabled?(:something, user)
+
+puts "\n\nAny Expression"
+any_expression = Flipper.any(plan_expression, age_expression)
+refute Flipper.enabled?(:something, user)
+
+puts "Enabling any expression"
+Flipper.enable :something, any_expression
+assert Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Disabling any expression"
+reset
+refute Flipper.enabled?(:something, user)
+
+puts "\n\nAll Expression"
+all_expression = Flipper.all(plan_expression, age_expression)
+refute Flipper.enabled?(:something, user)
+
+puts "Enabling all expression"
+Flipper.enable :something, all_expression
+assert Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Disabling all expression"
+reset
+refute Flipper.enabled?(:something, user)
+
+puts "\n\nNested Expression"
+nested_expression = Flipper.any(admin_expression, all_expression)
+refute Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Enabling nested expression"
+Flipper.enable :something, nested_expression
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Disabling nested expression"
+reset
+refute Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "\n\nBoolean Expression"
+boolean_expression = Flipper.boolean(true)
+Flipper.enable :something, boolean_expression
+assert Flipper.enabled?(:something)
+assert Flipper.enabled?(:something, user)
+reset
+
+puts "\n\nSet of Actors Expression"
+set_of_actors_expression = Flipper.any(
+  Flipper.property(:flipper_id).eq("User;1"),
+  Flipper.property(:flipper_id).eq("User;3"),
+)
+Flipper.enable :something, set_of_actors_expression
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, other_user)
+refute Flipper.enabled?(:something, admin_user)
+reset
+
+puts "\n\n% of Actors Expression"
+percentage_of_actors = Flipper.property(:flipper_id).percentage_of_actors(30)
+Flipper.enable :something, percentage_of_actors
+refute Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, other_user)
+assert Flipper.enabled?(:something, admin_user)
+reset
+
+puts "\n\n% of Actors Per Type Expression"
+percentage_of_actors_per_type = Flipper.any(
+  Flipper.all(
+    Flipper.property(:type).eq("User"),
+    Flipper.property(:flipper_id).percentage_of_actors(40),
+  ),
+  Flipper.all(
+    Flipper.property(:type).eq("Org"),
+    Flipper.property(:flipper_id).percentage_of_actors(10),
+  )
+)
+Flipper.enable :something, percentage_of_actors_per_type
+refute Flipper.enabled?(:something, user) # not in the 40% enabled for Users
+assert Flipper.enabled?(:something, other_user)
+assert Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, org) # not in the 10% of enabled for Orgs
+reset
+
+puts "\n\nPercentage of Time Expression"
+percentage_of_time_expression = Flipper.random(100).lt(50)
+Flipper.enable :something, percentage_of_time_expression
+results = (1..10000).map { |n| Flipper.enabled?(:something, user) }
+enabled, disabled = results.partition { |r| r }
+p enabled: enabled.size
+p disabled: disabled.size
+assert (4_700..5_200).include?(enabled.size)
+assert (4_700..5_200).include?(disabled.size)
+reset
+
+puts "\n\nChanging single expression to all expression"
+Flipper.enable :something, plan_expression
+Flipper.enable :something, Flipper.expression(:something).all.add(age_expression)
+assert Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "\n\nChanging single expression to any expression"
+Flipper.enable :something, plan_expression
+Flipper.enable :something, Flipper.expression(:something).any.add(age_expression, admin_expression)
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "\n\nChanging single expression to any expression by adding to condition"
+Flipper.enable :something, plan_expression
+Flipper.enable :something, Flipper.expression(:something).add(admin_expression)
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "\n\nEnabling based on time (epoch)"
+scheduled_epoch = Flipper.now.gte(Flipper.time(Time.now.to_i - 86_400))
+Flipper.enable :something, scheduled_epoch
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+assert Flipper.enabled?(:something, other_user)
+reset
+
+puts "\n\nEnabling based on time (datetime)"
+past_time = (Time.now.utc - 86_400).iso8601
+scheduled_datetime = Flipper.now.gte(Flipper.time(past_time))
+Flipper.enable :something, scheduled_datetime
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+assert Flipper.enabled?(:something, other_user)
+reset
+
+puts "\n\nDisabling after a time (expiring feature)"
+future_time = (Time.now.utc + 86_400).iso8601
+expiring_expression = Flipper.now.lt(Flipper.time(future_time))
+Flipper.enable :something, expiring_expression
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+assert Flipper.enabled?(:something, other_user)
+reset
+
+puts "\n\nEnabling within a time window"
+start_time = (Time.now.utc - 86_400).iso8601
+end_time = (Time.now.utc + 86_400).iso8601
+time_window = Flipper.all(
+  Flipper.now.gte(Flipper.time(start_time)),
+  Flipper.now.lt(Flipper.time(end_time))
+)
+Flipper.enable :something, time_window
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+assert Flipper.enabled?(:something, other_user)

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,6 +1,6 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'securerandom'
+require 'active_support/isolated_execution_state'
 require 'active_support/notifications'
 
 class FlipperSubscriber

data/examples/instrumentation_last_accessed_at.rb

@@ -0,0 +1,38 @@
+# Quick example of how to keep track of when a feature was last checked.
+require 'bundler/setup'
+require 'securerandom'
+require 'active_support/isolated_execution_state'
+require 'active_support/notifications'
+require 'flipper'
+
+class FlipperSubscriber
+  def self.stats
+    @stats ||= {}
+  end
+
+  def call(name, start, finish, id, payload)
+    if payload[:operation] == :enabled?
+      feature_name = payload.fetch(:feature_name)
+      self.class.stats[feature_name] = Time.now
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe(/feature_operation.flipper/, new)
+end
+
+Flipper.configure do |config|
+  config.default {
+    Flipper.new(config.adapter, instrumenter: ActiveSupport::Notifications)
+  }
+end
+
+Flipper.enabled?(:search)
+Flipper.enabled?(:booyeah)
+Flipper.enabled?(:hooray)
+sleep 1
+Flipper.enabled?(:booyeah)
+Flipper.enabled?(:hooray)
+sleep 1
+Flipper.enabled?(:hooray)
+
+pp FlipperSubscriber.stats

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/mirroring.rb

@@ -0,0 +1,59 @@
+require 'bundler/setup'
+require_relative 'active_record/ar_setup'
+require 'flipper'
+require 'flipper/adapters/redis'
+require 'flipper/adapters/active_record'
+
+# Say you have production...
+production_adapter = Flipper::Adapters::Memory.new
+production = Flipper.new(production_adapter)
+
+# And production has some stuff enabled...
+production.enable(:search)
+production.enable_percentage_of_time(:verbose_logging, 5)
+production.enable_percentage_of_actors(:new_feature, 5)
+production.enable_actor(:issues, Flipper::Actor.new('1'))
+production.enable_actor(:issues, Flipper::Actor.new('2'))
+production.enable_group(:request_tracing, :staff)
+
+# And you would like to mirror production to staging...
+staging_adapter = Flipper::Adapters::Memory.new
+staging = Flipper.new(staging_adapter)
+staging_export = staging.export
+
+puts "Here is the state of the world for staging and production..."
+puts "Staging"
+staging.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+puts "Production"
+production.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+
+# NOTE: This wipes active record clean and copies features/gates from redis into active record.
+puts "Mirroring production to staging..."
+staging.import(production.export)
+puts "Staging is now identical to Production."
+
+puts "Staging"
+staging.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+puts "Production"
+production.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+
+puts "Restoring staging to original state..."
+staging.import(staging_export)
+puts "Staging restored."
+
+puts "Staging"
+staging.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+puts "Production"
+production.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end

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 = []

data/examples/strict.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'flipper'
+
+adapter = Flipper::Adapters::Strict.new(Flipper::Adapters::Memory.new)
+flipper = Flipper.new(adapter)
+
+begin
+  puts "Checking :unknown_feature, which should raise an error."
+  flipper.enabled?(:unknown_feature)
+  warn "An error was not raised, but should have been"
+  exit 1
+rescue Flipper::Adapters::Strict::NotFound => exception
+  puts "Ok, the exepcted error was raised: #{exception.message}"
+end
+
+puts "Flipper.add(:new_feature)"
+flipper.add(:new_feature)
+puts "Flipper.enabled?(:new_feature) => #{flipper.enabled?(:new_feature)}"

data/exe/flipper

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "flipper/cli"
+
+Flipper::CLI.run(ARGV)

data/flipper-cloud.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flipper/version', __FILE__)
+require File.expand_path('../lib/flipper/metadata', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['John Nunemaker']
+  gem.email         = 'support@flippercloud.io'
+  gem.summary       = '[DEPRECATED] This gem has been merged into the `flipper` gem'
+  gem.license       = 'MIT'
+  gem.homepage      = 'https://www.flippercloud.io'
+
+  gem.files         = [ 'lib/flipper-cloud.rb', 'lib/flipper/version.rb' ]
+  gem.name          = 'flipper-cloud'
+  gem.require_paths = ['lib']
+  gem.version       = Flipper::VERSION
+  gem.metadata      = Flipper::METADATA
+
+  gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
+end