flipper 0.20.4 → 0.21.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3728bb1232be334741c8b8540533f6ce19c2cb40875272227f767c7355e0c9ee
-  data.tar.gz: fb7d7d027142157814d11df17b457bb939a850a52d9d9b3f2c42e38697ce55cf
+  metadata.gz: 04567e721e7189ed3a5a28c91833caa438e89c8dc412708c1d5487ebcf43e09e
+  data.tar.gz: c31948ae275a36a986352ae8d53e858d63e67590a1cae3831013530446008608
 SHA512:
-  metadata.gz: f3ee425699a25053e3b27bc8f7e3c33dc14d7a31c9d1906b3ac026ca2bf7131b7d2c1192744cc296578fd519eefa15556266ba21e8642301f4d2a394ad6b8f5a
-  data.tar.gz: '06382d14225fe2bae3f67a890b82c0742247ca4404ef521ce3c5faeb9d8085004ac92811554ce742b9a99a12a9ab62036000bcb9787b9daea842d4f0cf5b3651'
+  metadata.gz: 30e3b27356e2a24948cb4136c59be5a7a0d0b21631102999affa01c3e969dc037e6ff524df3da4ffc0c39ecd8ffbbb1798bda4593fca21f33aeebefb0236caff
+  data.tar.gz: 7cb046ca418ff31219b9d786cd22c0f81de6c37c9efc38a718e9ddcf2c97027de0d1a351ddeeae1a24adf1db081dcb364e0751f4d2881ef126e2a98ff0212b63

data/.github/workflows/ci.yml

@@ -1,5 +1,8 @@
 name: CI
-on: [push, pull_request]
+on:
+  push:
+    branches: [master]
+  pull_request:
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -19,6 +22,7 @@ jobs:
       RAILS_VERSION: 6.0.0
       SQLITE3_VERSION: 1.4.1
       REDIS_URL: redis://localhost:6379/0
+      CI: true
     steps:
       - name: Setup memcached
         uses: KeisukeYamashita/memcached-actions@v1
@@ -47,3 +51,7 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run Rake
         run: bundle exec rake
+      - name: Run Examples
+        env:
+          FLIPPER_CLOUD_TOKEN: ${{ secrets.FLIPPER_CLOUD_TOKEN }}
+        run: script/examples

data/Changelog.md

@@ -1,4 +1,14 @@
-## unreleased
+## 0.21.0
+
+### Additions/Changes
+
+* Default to using memory adapter (https://github.com/jnunemaker/flipper/pull/501)
+* Adapters now configured on require when possible (https://github.com/jnunemaker/flipper/pull/502)
+* Added cloud recommendation to flipper-ui. Can be disabled with `Flipper::UI.configure { |config| config.cloud_recommendation = false }`. Just want to raise awareness that more is available if people want it (https://github.com/jnunemaker/flipper/pull/504)
+* Added default `flipper_id` implementation via `Flipper::Identifier` and automatically included it in ActiveRecord and Sequel models (https://github.com/jnunemaker/flipper/pull/505)
+* Deprecate superflous sync_method setting (https://github.com/jnunemaker/flipper/pull/511)
+
+## 0.20.4
 
 ### Additions/Changes
 

data/Gemfile

@@ -18,6 +18,7 @@ gem 'minitest', '~> 5.8'
 gem 'minitest-documentation'
 gem 'webmock', '~> 3.0'
 gem 'climate_control'
+gem 'redis-namespace'
 
 group(:guard) do
   gem 'guard', '~> 2.15'

data/README.md

@@ -2,7 +2,14 @@
 
 # Flipper
 
-Beautiful, performant feature flags for Ruby.
+> Beautiful, performant feature flags for Ruby.
+
+Flipper gives you control over who has access to features in your app.
+
+* Enable or disable features for everyone, specific actors, groups of actors, a percentage of actors, or a percentage of time.
+* Configure your feature flags from the console or a web UI.
+* Regardless of what data store you are using, Flipper can performantly store your feature flags.
+* Use [Flipper Cloud](#flipper-cloud) to cascade features from multiple environments, share settings with your team, control permissions, keep an audit history, and rollback.
 
 Control your software — don't let it control you.
 
@@ -12,6 +19,10 @@ Add this line to your application's Gemfile:
 
     gem 'flipper'
 
+You'll also want to pick a storage [adapter](#adapters), for example:
+
+    gem 'flipper-active_record'`
+
 And then execute:
 
     $ bundle
@@ -22,9 +33,62 @@ Or install it yourself with:
 
 ## Getting Started
 
+Use `Flipper#enabled?` in your app to check if a feature is enabled.
+
+```ruby
+# check if search is enabled
+if Flipper.enabled? :search, current_user
+  puts 'Search away!'
+else
+  puts 'No search for you!'
+end
+```
+
+All features are disabled by default, so you'll need to explicitly enable them.
+
+#### Enable a feature for everyone
+
+```ruby
+Flipper.enable :search
+```
+
+#### Enable a feature for a specific actor
+
+```ruby
+Flipper.enable_actor :search, current_user
+```
+
+#### Enable a feature for a group of actors
+
+First tell Flipper about your groups:
+
+```ruby
+# config/initializers/flipper.rb
+Flipper.register(:admin) do |actor|
+  actor.respond_to?(:admin?) && actor.admin?
+end
+```
+
+Then enable the feature for that group:
+
+```ruby
+Flipper.enable_group :search, :admin
+```
+
+#### Enable a feature for a percentage of actors
+
+```ruby
+Flipper.enable_percentage_of_actors :search, 2
+```
+
+
+Read more about enabling and disabling features with [Gates](docs/Gates.md). Check out the [examples directory](examples/) for more, and take a peek at the [DSL](lib/flipper/dsl.rb) and [Feature](lib/flipper/feature.rb) classes for code/docs.
+
+## Adapters
+
 Flipper is built on adapters for maximum flexibility. Regardless of what data store you are using, Flipper can performantly store data in it.
 
-To get started, pick one of our [supported adapters](docs/Adapters.md#officially-supported) and follow the instructions:
+Pick one of our [supported adapters](docs/Adapters.md#officially-supported) and follow the installation instructions:
 
 * [Active Record](docs/active_record/README.md)
 * [Sequel](docs/sequel/README.md)
@@ -35,7 +99,7 @@ To get started, pick one of our [supported adapters](docs/Adapters.md#officially
 
 Or [roll your own](docs/Adapters.md#roll-your-own). We even provide automatic (rspec and minitest) tests for you, so you know you've built your custom adapter correctly.
 
-Once you've selected an adapter and followed the installation instructions, you should be good to go.
+Read more about [Adapters](docs/Adapters.md).
 
 ## Flipper UI
 
@@ -63,50 +127,12 @@ Or, (even better than OSS + UI) use [Flipper Cloud](https://www.flippercloud.io)
 
 Cloud is super simple to integrate with Rails ([demo app](https://github.com/fewerandfaster/flipper-rails-demo)), Sinatra or any other framework.
 
-## Examples
-
-Want to get a quick feel for what it looks like to work with Flipper? Check out the following example or the [examples directory](examples/). You might also want to peek at the [DSL](lib/flipper/dsl.rb) and [Feature](lib/flipper/feature.rb) classes for code/docs.
-
-```ruby
-require 'flipper'
-
-Flipper.configure do |config|
-  config.default do
-    # pick an adapter, this uses memory, any will do, see docs above
-    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!'
-else
-  puts 'No search for you!'
-end
-
-puts 'Enabling Search...'
-Flipper.enable(:search)
-
-# check if search is enabled
-if Flipper.enabled?(:search)
-  puts 'Search away!'
-else
-  puts 'No search for you!'
-end
-```
-
-## Docs
+## Advanced
 
 A few miscellaneous docs with more info for the hungry.
 
-* [Gates](docs/Gates.md) - Boolean, Groups, Actors, % of Actors, and % of Time
-* [Adapters](docs/Adapters.md) - Mongo, Redis, Cassandra, Active Record...
 * [Instrumentation](docs/Instrumentation.md) - ActiveSupport::Notifications and Statsd
 * [Optimization](docs/Optimization.md) - Memoization middleware and Cache adapters
-* [Web Interface](docs/ui/README.md) - Point and click...
 * [API](docs/api/README.md) - HTTP API interface
 * [Caveats](docs/Caveats.md) - Flipper beware! (see what I did there)
 * [Docker-Compose](docs/DockerCompose.md) - Using docker-compose in contributing

data/docs/Adapters.md

@@ -14,6 +14,7 @@ I plan on supporting the adapters in the flipper repo. Other adapters are welcom
 * [PStore adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/pstore.rb) – great for when a local file is enough
 * [read-only adapter](https://github.com/jnunemaker/flipper/blob/master/docs/read-only)
 * [Redis adapter](https://github.com/jnunemaker/flipper/blob/master/docs/redis)
+* [Rollout adapter](rollout/README.md)
 * [Sequel adapter](https://github.com/jnunemaker/flipper/blob/master/docs/sequel)
 
 ## Community Supported

data/docs/Gates.md

@@ -7,76 +7,82 @@ Out of the box several types of enabling are supported. They are checked in this
 All on or all off. Think top level things like `:stats`, `:search`, `:logging`, etc. Also, an easy way to release a new feature as once a feature is boolean enabled it is on for every situation.
 
 ```ruby
-flipper = Flipper.new(adapter)
-flipper[:stats].enable # turn on
-flipper[:stats].disable # turn off
-flipper[:stats].enabled? # check
+Flipper.enable :stats # turn on
+Flipper.disable :stats # turn off
+Flipper.enabled? :stats # check
 ```
 
 ## 2. Individual Actor
 
-Turn feature on for individual thing. Think enable feature for someone to test or for a buddy. The only requirement for an individual actor is that it must respond to `flipper_id`.
+Turn feature on for individual thing. Think enable feature for someone to test or for a buddy.
 
 ```ruby
-flipper = Flipper.new(adapter)
+Flipper.enable_actor :stats, user
+Flipper.enabled? :stats, user # true
 
-flipper[:stats].enable user
-flipper[:stats].enabled? user # true
-
-flipper[:stats].disable user
-flipper[:stats].enabled? user # false
+Flipper.disable_actor :stats, user
+Flipper.enabled? :stats, user # false
 
 # you can enable anything, does not need to be user or person
-flipper[:search].enable group
-flipper[:search].enabled? group
-
-# you can also use shortcut methods
-flipper.enable_actor :search, user
-flipper.disable_actor :search, user
-flipper[:search].enable_actor user
-flipper[:search].disable_actor user
-```
+Flipper.enable_actor :search, organization
+Flipper.enabled? :search, organization
 
-The key is to make sure you do not enable two different types of objects for the same feature. Imagine that user has a `flipper_id` of 6 and group has a `flipper_id` of 6. Enabling search for user would automatically enable it for group, as they both have a `flipper_id` of 6.
+# you can also save a reference to a specific feature
+feature = Flipper[:search]
+
+feature.enable_actor user
+feature.enabled? user # true
+feature.disable_actor user
+```
 
-The one exception to this rule is if you have globally unique `flipper_ids`, such as UUIDs. If your `flipper_ids` are unique globally in your entire system, enabling two different types should be safe. Another way around this is to prefix the `flipper_id` with the class name like this:
+The only requirement for an individual actor is that it must have a unique `flipper_id`. Include the `Flipper::Identifier` module for a default implementation which combines the class name and `id` (e.g. `User;6`).
 
 ```ruby
-class User
-  def flipper_id
-    "User;#{id}"
-  end
+class User < Struct.new(:id)
+  include Flipper::Identifier
 end
 
-class Group
+User.new(5).flipper_id # => "User;5"
+```
+
+You can also define your own implementation:
+
+```
+class Organization < Struct.new(:uuid)
   def flipper_id
-    "Group;#{id}"
+    uuid
   end
 end
+
+Organization.new("DEB3D850-39FB-444B-A1E9-404A990FDBE0").flipper_id
+# => "DEB3D850-39FB-444B-A1E9-404A990FDBE0"
 ```
 
+Just make sure each type of object has a unique `flipper_id`.
+
 ## 3. Percentage of Actors
 
 Turn this on for a percentage of actors (think user, member, account, group, whatever). Consistently on or off for this user as long as percentage increases. Think slow rollout of a new feature to a percentage of things.
 
 ```ruby
-flipper = Flipper.new(adapter)
-
-# returns a percentage of actors instance set to 10
-percentage = flipper.actors(10)
-
 # turn stats on for 10 percent of users in the system
-flipper[:stats].enable percentage
+Flipper.enable :stats, Flipper.actors(10)
+# or
+Flipper.enable_percentage_of_actors :stats, 10
 
 # checks if actor's flipper_id is in the enabled percentage by hashing
 # user.flipper_id.to_s to ensure enabled distribution is smooth
-flipper[:stats].enabled? user
+Flipper.enabled? :stats, user
 
-# you can also use shortcut methods
-flipper.enable_percentage_of_actors :search, 10
-flipper.disable_percentage_of_actors :search # sets to 0
-flipper[:search].enable_percentage_of_actors 10
-flipper[:search].disable_percentage_of_actors # sets to 0
+Flipper.disable_percentage_of_actors :search # sets to 0
+# or
+Flipper.disable :stats, Flipper.actors(0)
+
+# you can also save a reference to a specific feature
+feature = Flipper[:search]
+feature.enable_percentage_of_actors 10
+feature.enabled? user
+feature.disable_percentage_of_actors # sets to 0
 ```
 
 ## 4. Percentage of Time
@@ -84,22 +90,20 @@ flipper[:search].disable_percentage_of_actors # sets to 0
 Turn this on for a percentage of time. Think load testing new features behind the scenes and such.
 
 ```ruby
-flipper = Flipper.new(adapter)
-
-# get percentage of time instance set to 5
-percentage = flipper.time(5)
-
 # Register a feature called logging and turn it on for 5 percent of the time.
 # This could be on during one request and off the next
 # could even be on first time in request and off second time
-flipper[:logging].enable percentage
-flipper[:logging].enabled? # this will return true 5% of the time.
-
-# you can also use shortcut methods
-flipper.enable_percentage_of_time :search, 5 # registers a feature called "search" and enables it 5% of the time
-flipper.disable_percentage_of_time :search # sets to 0
-flipper[:search].enable_percentage_of_time 5
-flipper[:search].disable_percentage_of_time # sets to 0
+Flipper.enable_percentage_of_time :logging, 5
+
+Flipper.enabled? :logging # this will return true 5% of the time.
+
+Flipper.disable_percentage_of_time :logging # sets to 0
+
+# you can also save a reference to a specific feature
+feature = Flipper[:search]
+feature.enable_percentage_of_time, 5
+feature.enabled?
+feature.disable_percentage_of_time
 ```
 
 Timeness is not a good idea for enabling new features in the UI. Most of the time you want a feature on or off for a user, but there are definitely times when I have found percentage of time to be very useful.
@@ -114,52 +118,48 @@ Flipper.register(:admins) do |actor|
   actor.respond_to?(:admin?) && actor.admin?
 end
 
-flipper = Flipper.new(adapter)
-
-flipper[:stats].enable flipper.group(:admins) # This registers a stats feature and turns it on for admins (which is anything that returns true from the registered block).
-flipper[:stats].disable flipper.group(:admins) # turn off the stats feature for admins
+Flipper.enable_group :stats, :admins # This registers a stats feature and turns it on for admins (which is anything that returns true from the registered block).
+Flipper.disable_group :stats, :admins # turn off the stats feature for admins
 
 person = Person.find(params[:id])
-flipper[:stats].enabled? person # check if enabled, returns true if person.admin? is true
+Flipper.enabled? :stats, person # check if enabled, returns true if person.admin? is true
 
-# you can also use shortcut methods. This also registers a stats feature and turns it on for admins.
-flipper.enable_group :stats, :admins
-person = Person.find(params[:id])
-flipper[:stats].enabled? person # same as above. check if enabled, returns true if person.admin? is true
 
-flipper.disable_group :stats, :admins
-flipper[:stats].enable_group :admins
-flipper[:stats].disable_group :admins
+# you can also use shortcut methods. This also registers a stats feature and turns it on for admins.
+feature = Flipper[:search]
+feature.enable_group :admins
+feature.enabled? person
+feature.disable_group :admins
 ```
 
 Here's a quick explanation of the above code block:
 
-```
+```ruby
 Flipper.register(:admins) do |actor|
   actor.respond_to?(:admin?) && actor.admin?
 end
 ```
-- The above first registers a group called `admins` which essentially saves a [Proc](http://www.eriktrautman.com/posts/ruby-explained-blocks-procs-and-lambdas-aka-closures) to be called later. The `actor` is an instance of the `Flipper::Types::Actor` that wraps the thing being checked against and `actor.thing` is the original object being checked. 
+- The above first registers a group called `admins` which essentially saves a [Proc](http://www.eriktrautman.com/posts/ruby-explained-blocks-procs-and-lambdas-aka-closures) to be called later. The `actor` is an instance of the `Flipper::Types::Actor` that wraps the thing being checked against and `actor.thing` is the original object being checked.
 
-```
-flipper[:stats].enable flipper.group(:admins)
+```ruby
+Flipper.enable_group :stats, :admins
 ```
 
 - The above enables the stats feature to any object that returns true from the `:admins` proc.
 
-```
+```ruby
 person = Person.find(params[:id])
-flipper[:stats].enabled? person # check if person is enabled, returns true if person.admin? is true
+Flipper.enabled? :stats, person # check if person is enabled, returns true if person.admin? is true
 ```
 
-When the `person` object is passed to the `enabled?` method, it is then passed into the proc. If the proc returns true, the entire statement returns true and so `flipper[:stats].enabled? person` returns true. Whatever logic follows this conditional check is then executed.
+When the `person` object is passed to the `enabled?` method, it is then passed into the proc. If the proc returns true, the entire statement returns true and so `Flipper[:stats].enabled? person` returns true. Whatever logic follows this conditional check is then executed.
 
 There is no requirement that the thing yielded to the block be a user model or whatever. It can be anything you want, therefore it is a good idea to check that the thing passed into the group block actually responds to what you are trying to do in the `register` proc.
 
 In your application code, you can do something like this now:
 
-```
-if flipper[:stats].enabled?(some_admin)
+```ruby
+if Flipper.enabled? :stats, some_admin
   # do thing...
 else
   # do not do thing

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,5 +1,4 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 
 # sets up default adapter so Flipper works like Flipper::DSL

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

@@ -1,5 +1,4 @@
-require File.expand_path('../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper'
 require 'flipper/adapters/operation_logger'
 require 'flipper/instrumentation/log_subscriber'

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/lib/flipper.rb

@@ -152,6 +152,7 @@ require 'flipper/feature'
 require 'flipper/gate'
 require 'flipper/instrumenters/memory'
 require 'flipper/instrumenters/noop'
+require 'flipper/identifier'
 require 'flipper/middleware/memoizer'
 require 'flipper/middleware/setup_env'
 require 'flipper/registry'

data/lib/flipper/configuration.rb

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

data/lib/flipper/errors.rb

@@ -16,9 +16,8 @@ module Flipper
   # 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)
+      warn "Flipper::DefaultNotSet is deprecated and will be removed in 1.0"
+      super
     end
   end
 

data/lib/flipper/identifier.rb

@@ -0,0 +1,17 @@
+module Flipper
+  # A default implementation of `#flipper_id` for actors.
+  #
+  #   class User < Struct.new(:id)
+  #     include Flipper::Identifier
+  #   end
+  #
+  #   user = User.new(99)
+  #   Flipper.enable :thing, user
+  #   Flipper.enabled? :thing, user #=> true
+  #
+  module Identifier
+    def flipper_id
+      "#{self.class.name};#{id}"
+    end
+  end
+end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.4'.freeze
+  VERSION = '0.21.0.rc1'.freeze
 end

data/spec/flipper/configuration_spec.rb

@@ -3,12 +3,15 @@ require 'flipper/configuration'
 
 RSpec.describe Flipper::Configuration do
   describe '#default' do
-    it 'raises if default not configured' do
-      expect { subject.default }.to raise_error(Flipper::DefaultNotSet)
+    it 'returns instance using Memory adapter' do
+      expect(subject.default).to be_a(Flipper::DSL)
+      # All adapter are wrapped in Memoizable
+      expect(subject.default.adapter.adapter).to be_a(Flipper::Adapters::Memory)
     end
 
     it 'can be set default' do
       instance = Flipper.new(Flipper::Adapters::Memory.new)
+      expect(subject.default).not_to be(instance)
       subject.default { instance }
       expect(subject.default).to be(instance)
     end

data/spec/flipper/identifier_spec.rb

@@ -0,0 +1,14 @@
+require 'helper'
+require 'flipper/identifier'
+
+RSpec.describe Flipper::Identifier do
+  describe '#flipper_id' do
+    class User < Struct.new(:id)
+      include Flipper::Identifier
+    end
+
+    it 'uses class name and id' do
+      expect(User.new(5).flipper_id).to eq('User;5')
+    end
+  end
+end

data/spec/flipper/middleware/memoizer_spec.rb

@@ -342,7 +342,7 @@ RSpec.describe Flipper::Middleware::Memoizer do
     it 'eagerly caches known features for duration of request' do
       memory = Flipper::Adapters::Memory.new
       logged_memory = Flipper::Adapters::OperationLogger.new(memory)
-      cache = ActiveSupport::Cache::DalliStore.new(ENV['MEMCACHED_URL'])
+      cache = ActiveSupport::Cache::MemoryStore.new
       cache.clear
       cached = Flipper::Adapters::ActiveSupportCacheStore.new(logged_memory, cache, expires_in: 10)
       logged_cached = Flipper::Adapters::OperationLogger.new(cached)

data/spec/flipper/middleware/setup_env_spec.rb

@@ -93,20 +93,4 @@ RSpec.describe Flipper::Middleware::SetupEnv do
       expect(last_response.body).to eq(Flipper.object_id.to_s)
     end
   end
-
-  context 'when flipper instance or block are nil and default Flipper is NOT configured' do
-    let(:app) do
-      app = lambda do |env|
-        [200, { 'Content-Type' => 'text/html' }, [env['flipper'].enabled?(:search)]]
-      end
-      builder = Rack::Builder.new
-      builder.use described_class
-      builder.run app
-      builder
-    end
-
-    it 'can use env flipper' do
-      expect { get '/' }.to raise_error(Flipper::DefaultNotSet)
-    end
-  end
 end

data/spec/flipper_spec.rb

@@ -232,7 +232,6 @@ RSpec.describe Flipper do
       cloud_configuration = Flipper::Cloud::Configuration.new({
         token: "asdf",
         sync_secret: "tasty",
-        sync_method: :webhook,
       })
 
       described_class.configure do |config|

data/spec/support/spec_helpers.rb

@@ -64,6 +64,9 @@ module SpecHelpers
 end
 
 RSpec.configure do |config|
+  config.order = :random
+  Kernel.srand config.seed
+
   config.include Rack::Test::Methods
   config.include SpecHelpers
 end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+require 'bundler/setup'
 require 'flipper'
 require 'minitest/autorun'
 require 'minitest/unit'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.20.4
+  version: 0.21.0.rc1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2021-05-01 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -41,7 +41,6 @@ files:
 - examples/configuring_default.rb
 - examples/dsl.rb
 - examples/enabled_for_actor.rb
-- examples/example_setup.rb
 - examples/group.rb
 - examples/group_dynamic_lookup.rb
 - examples/group_with_members.rb
@@ -83,6 +82,7 @@ files:
 - lib/flipper/gates/group.rb
 - lib/flipper/gates/percentage_of_actors.rb
 - lib/flipper/gates/percentage_of_time.rb
+- lib/flipper/identifier.rb
 - lib/flipper/instrumentation/log_subscriber.rb
 - lib/flipper/instrumentation/statsd.rb
 - lib/flipper/instrumentation/statsd_subscriber.rb
@@ -130,6 +130,7 @@ files:
 - spec/flipper/gates/group_spec.rb
 - spec/flipper/gates/percentage_of_actors_spec.rb
 - spec/flipper/gates/percentage_of_time_spec.rb
+- spec/flipper/identifier_spec.rb
 - spec/flipper/instrumentation/log_subscriber_spec.rb
 - spec/flipper/instrumentation/statsd_subscriber_spec.rb
 - spec/flipper/instrumenters/memory_spec.rb
@@ -170,9 +171,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -205,6 +206,7 @@ test_files:
 - spec/flipper/gates/group_spec.rb
 - spec/flipper/gates/percentage_of_actors_spec.rb
 - spec/flipper/gates/percentage_of_time_spec.rb
+- spec/flipper/identifier_spec.rb
 - spec/flipper/instrumentation/log_subscriber_spec.rb
 - spec/flipper/instrumentation/statsd_subscriber_spec.rb
 - spec/flipper/instrumenters/memory_spec.rb

data/examples/example_setup.rb

@@ -1,8 +0,0 @@
-# Nothing to see here... move along.
-# Sets up load path for examples and requires some stuff
-require 'pp'
-require 'pathname'
-
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)