flipper 0.7.0.beta3 → 0.7.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b952f92d9398ba28267085a3084fbc659e571f6f
-  data.tar.gz: 4e535ba61ef3e38e24f419489c305c17cbdf58e1
+  metadata.gz: 7d5dff1f360e246357e95815a52280e51470883a
+  data.tar.gz: 82e1d70468ab4dc11fc333f8af544933e6b63bf3
 SHA512:
-  metadata.gz: 5457f2328718155eef1ff0014346179f5bec08cd594a9c6f31ccd3e02977a91089477bffee66d53438bf849c04d66b9ca73dc56e06653f8a4dbb6168e69e56c8
-  data.tar.gz: 9c7da626025b191605e70beb3b6cdefd190d124c429354b54451472e7d3ea3fb48b90218356da8843fd30955529981769b320404e2c07e7ffef92da2cf787e40
+  metadata.gz: 8f06c93860e0e4a88dd523dd720f7871c407b23514db8312083a500a49cfcc20e58e7226ab3970bdcfd496a82005fa9a9e69c2e80e761d602bf8c7513b5ccbff
+  data.tar.gz: ebc6c08a8e9c3a92c8ed4b72754d0c3c9afc2caa43c80758ef40ed9c8e69b7a5af7cf05fdd1085d706dda415d0a71c3fd5c7c02273f6cfd0d0b4cc1d292cf313

data/Changelog.md

@@ -1,3 +1,31 @@
+## master (0.7)
+
+* Added Flipper.groups and Flipper.group_names
+* Changed percentage_of_random to percentage_of_time
+* Added enable/disable convenience methods for all gates (ie: enable_group, enable_actor, enable_percentage_of_actors, enable_percentage_of_time)
+* Added value convenience methods (ie: boolean_value, groups_value, actors_value, etc.)
+* Added Feature#gate_values for getting typecast adapter gate values
+* Added Feature#enabled_gates and #disabled_gates for getting the gates that are enabled/disabled for the feature
+* Remove Feature#description
+* Added Flipper::Adapters::PStore
+* Moved memoizable decorator to instance variable storage from class level thread local stuff. Now not thread safe, but we can make a thread safe version later.
+
+UI
+
+* Totally new. Works like a charm.
+
+Mongo
+
+* Updated to latest driver (~> 2.0)
+
+## 0.6.3
+
+* Minor bug fixes
+
+## 0.6.2
+
+* Added Flipper.group_exists?
+
 ## 0.6.1
 
 * Added statsd support for instrumentation.

data/Gemfile

@@ -1,16 +1,24 @@
 source 'https://rubygems.org'
-gemspec
+gemspec :name => 'flipper'
+
+Dir['flipper-*.gemspec'].each do |gemspec|
+  plugin = gemspec.scan(/flipper-(.*)\.gemspec/).flatten.first
+  gemspec(:name => "flipper-#{plugin}", :development_group => plugin)
+end
 
 gem 'rake', '~> 10.4.2'
-gem 'metriks', '~> 0.9.9', :require => false
-gem 'statsd-ruby', '~> 1.2.1', :require => false
+gem 'metriks', '~> 0.9.9'
+gem 'shotgun', '~> 0.9'
+gem 'statsd-ruby', '~> 1.2.1'
 gem 'rspec', '~> 2.14'
 gem 'rack-test', '~> 0.6.3'
-gem 'activesupport', '~> 4.2.0', :require => false
+gem 'activesupport', '~> 4.2.0'
 
 group(:guard) do
   gem 'guard', '~> 2.12.5'
   gem 'guard-rspec', '~> 4.5.0'
   gem 'guard-bundler', '~> 2.1.0'
+  gem 'guard-coffeescript', '~> 2.0.1'
+  gem 'guard-sass', '~> 1.6.0'
   gem 'rb-fsevent', '~> 0.9.4'
 end

data/README.md

@@ -1,4 +1,4 @@
-![flipper logo](https://raw.githubusercontent.com/jnunemaker/flipper-ui/master/lib/flipper/ui/public/images/logo.png)
+![flipper logo](https://raw.githubusercontent.com/jnunemaker/flipper/master/lib/flipper/ui/public/images/logo.png)
 
 <pre>
                                    __
@@ -35,7 +35,7 @@ Or install it yourself with:
 
     $ gem install flipper
 
-## Usage
+## Examples
 
 The goal of the API for flipper was to have everything revolve around features and what ways they can be enabled. Start with top level and dig into a feature, then dig in further and enable that feature for a given type of access, as opposed to thinking about how the feature will be accessed first (ie: `stats.enable` vs `activate_group(:stats, ...)`).
 
@@ -61,251 +61,17 @@ end
 
 puts 'Enabling Search...'
 search.enable
-
-# check if that feature is enabled again
-if search.enabled?
-  puts 'Search away!'
-else
-  puts 'No search for you!'
-end
-```
-
-Of course there are more [examples for you to peruse](https://github.com/jnunemaker/flipper/tree/master/examples).
-
-## Types
-
-Out of the box several types of enabling are supported. They are checked in this order:
-
-### 1. Boolean
-
-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
-```
-
-### 2. Group
-
-Turn on feature based on value of block. Super flexible way to turn on a feature for multiple things (users, people, accounts, etc.)
-
-```ruby
-Flipper.register(:admins) do |actor|
-  actor.respond_to?(:admin?) && actor.admin?
-end
-
-flipper = Flipper.new(adapter)
-
-flipper[:stats].enable flipper.group(:admins) # turn on for admins
-flipper[:stats].disable flipper.group(:admins) # turn off for admins
-
-person = Person.find(params[:id])
-flipper[:stats].enabled? person # check if enabled, returns true if person.admin? is true
-
-# you can also use shortcut methods
-flipper.enable_group :stats, :admins
-flipper.disable_group :stats, :admins
-flipper[:stats].enable_group :admins
-flipper[:stats].disable_group :admins
-```
-
-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.
-
-### 3. 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`.
-
-```ruby
-flipper = Flipper.new(adapter)
-
-flipper[:stats].enable user
-flipper[:stats].enabled? user # true
-
-flipper[:stats].disable user
-flipper[:stats].enabled? 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
-```
-
-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.
-
-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:
-
-```ruby
-class User
-  def flipper_id
-    "User:#{id}"
-  end
-end
-
-class Group
-  def flipper_id
-    "Group:#{id}"
-  end
-end
 ```
 
-### 4. 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
+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.
 
-# 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
-
-# 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
-```
+## Docs
 
-### 5. Percentage of Time
-
-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)
-
-# turn on logging for 5 percent of the time
-# 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
-
-# you can also use shortcut methods
-flipper.enable_percentage_of_time :search, 5
-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
-```
-
-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.
-
-## Adapters
-
-I plan on supporting [in-memory](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb), [Mongo](https://github.com/jnunemaker/flipper-mongo), and [Redis](https://github.com/jnunemaker/flipper-redis) as adapters for flipper. Others are welcome, so please let me know if you create one.
-
-* [memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb) – great for tests
-* [Mongo adapter](https://github.com/jnunemaker/flipper-mongo)
-* [Redis adapter](https://github.com/jnunemaker/flipper-redis)
-* [Cassanity adapter](https://github.com/jnunemaker/flipper-cassanity)
-* [Active Record 4 adapter](https://github.com/bgentry/flipper-activerecord)
-* [Active Record 3 adapter](https://github.com/jproudman/flipper-activerecord)
-
-The basic API for an adapter is this:
-
-* `features` - Get the set of known features.
-* `add(feature)` - Add a feature to the set of known features.
-* `remove(feature)` - Remove a feature from the set of known features.
-* `clear(feature)` - Clear all gate values for a feature.
-* `get(feature)` - Get all gate values for a feature.
-* `enable(feature, gate, thing)` - Enable a gate for a thing.
-* `disable(feature, gate, thing)` - Disable a gate for a thing.
-
-If you would like to make your own adapter, there are shared adapter specs that you can use to verify that you have everything working correctly.
-
-For example, here is what the in-memory adapter spec looks like:
-
-```ruby
-require 'helper'
-require 'flipper/adapters/memory'
-
-# The shared specs are included with the flipper gem so you can use them in
-# separate adapter specific gems.
-require 'flipper/spec/shared_adapter_specs'
-
-describe Flipper::Adapters::Memory do
-
-  # an instance of the new adapter you are trying to create
-  subject { described_class.new }
-
-  # include the shared specs that the subject must pass
-  it_should_behave_like 'a flipper adapter'
-end
-```
-
-A good place to start when creating your own adapter is to copy one of the adapters mentioned above and replace the client specific code with whatever client you are attempting to adapt.
-
-I would also recommend setting `fail_fast = true` in your RSpec configuration as that will just give you one failure at a time to work through. It is also handy to have the shared adapter spec file open.
-
-## Instrumentation
-
-Flipper comes with automatic instrumentation. By default these work with ActiveSupport::Notifications, but only require the pieces of ActiveSupport that are needed and only do so if you actually attempt to require the instrumentation files listed below.
-
-To use the log subscriber:
-
-```ruby
-# Gemfile
-gem "activesupport"
-
-# config/initializers/flipper.rb (or wherever you want it)
-require "flipper/instrumentation/log_subscriber"
-```
-
-To use the statsd instrumentation:
-
-```ruby
-# Gemfile
-gem "activesupport"
-gem "statsd-ruby"
-
-# config/initializers/flipper.rb (or wherever you want it)
-require "flipper/instrumentation/statsd"
-Flipper::Instrumentation::StatsdSubscriber.client = Statsd.new # or whatever your statsd instance is
-```
-
-You can also do whatever you want with the instrumented events. Check out [this example](https://github.com/jnunemaker/flipper/blob/master/examples/instrumentation.rb) for more.
-
-
-## Optimization
-
-One optimization that flipper provides is a memoizing middleware. The memoizing middleware ensures that you only make one adapter call per feature per request.
-
-This means if you check the same feature over and over, it will only make one Mongo, Redis, or whatever call per feature for the length of the request.
-
-You can use the middleware from a Rails initializer like so:
-
-```ruby
-# create flipper dsl instance, see above Usage for more details
-flipper = Flipper.new(...)
-
-require 'flipper/middleware/memoizer'
-config.middleware.use Flipper::Middleware::Memoizer, flipper
-```
-
-If you set your flipper instance up in an initializer, you can pass a block to the middleware and it will lazily load the instance the first time the middleware is invoked.
-
-```ruby
-# config/initializers/flipper.rb
-$flipper = Flipper.new(...)
-
-# config/application.rb
-config.middleware.use Flipper::Middleware::Memoizer, lambda { $flipper }
-```
-
-**Note**: Be sure that the middleware is high enough up in your stack that all feature checks are wrapped.
+* [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, Statsd and Metriks
+* [Optimization](docs/Optimization.md) - Memoization middleware
+* [Web Interface](docs/ui/README.md) - Point and click...
 
 ## Contributing
 
@@ -320,9 +86,3 @@ config.middleware.use Flipper::Middleware::Memoizer, lambda { $flipper }
 1. Update the version to be whatever it should be and commit.
 2. `script/release`
 3. Profit.
-
-[![Build Status](https://travis-ci.org/jnunemaker/flipper.svg?branch=master)](https://travis-ci.org/jnunemaker/flipper)
-
-## Coming Soon™
-
-* [Web UI](https://github.com/jnunemaker/flipper-ui) (think Resque UI for features toggling/status)

data/Rakefile

@@ -1,7 +1,38 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "flipper/version"
+
+# gem install pkg/*.gem
+# gem uninstall flipper flipper-ui flipper-redis
+desc 'Build gem into the pkg directory'
+task :build do
+  FileUtils.rm_rf('pkg')
+  Dir['*.gemspec'].each do |gemspec|
+    system "gem build #{gemspec}"
+  end
+  FileUtils.mkdir_p('pkg')
+  FileUtils.mv(Dir['*.gem'], 'pkg')
+end
+
+desc 'Tags version, pushes to remote, and pushes gem'
+task :release => :build do
+  sh 'git', 'tag', "v#{Flipper::VERSION}"
+  sh "git push origin master"
+  sh "git push origin v#{Flipper::VERSION}"
+  sh "ls pkg/*.gem | xargs -n 1 gem push"
+end
 
 require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w(--color)
+end
+
+namespace :spec do
+  desc "Run specs for UI queue"
+  RSpec::Core::RakeTask.new(:ui) do |t|
+    t.rspec_opts = %w(--color)
+    t.pattern = ["spec/flipper/ui/**/*_spec.rb", "spec/flipper/ui_spec.rb"]
+  end
+end
 
 task :default => :spec

data/docs/Adapters.md

@@ -0,0 +1,47 @@
+# Adapters
+
+I plan on supporting the adapters in the flipper repo. Other adapters are welcome, so please let me know if you create one.
+
+* [memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb) – great for tests
+* [PStore adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/pstore.rb) – great for when a local file is enough
+* [Mongo adapter](https://github.com/jnunemaker/flipper/blob/master/docs/mongo)
+* [Redis adapter](https://github.com/jnunemaker/flipper/blob/master/docs/redis)
+* [Cassanity adapter](https://github.com/jnunemaker/flipper-cassanity)
+* [Active Record 4 adapter](https://github.com/bgentry/flipper-activerecord)
+* [Active Record 3 adapter](https://github.com/jproudman/flipper-activerecord)
+
+The basic API for an adapter is this:
+
+* `features` - Get the set of known features.
+* `add(feature)` - Add a feature to the set of known features.
+* `remove(feature)` - Remove a feature from the set of known features.
+* `clear(feature)` - Clear all gate values for a feature.
+* `get(feature)` - Get all gate values for a feature.
+* `enable(feature, gate, thing)` - Enable a gate for a thing.
+* `disable(feature, gate, thing)` - Disable a gate for a thing.
+
+If you would like to make your own adapter, there are shared adapter specs that you can use to verify that you have everything working correctly.
+
+For example, here is what the in-memory adapter spec looks like:
+
+```ruby
+require 'helper'
+require 'flipper/adapters/memory'
+
+# The shared specs are included with the flipper gem so you can use them in
+# separate adapter specific gems.
+require 'flipper/spec/shared_adapter_specs'
+
+describe Flipper::Adapters::Memory do
+
+  # an instance of the new adapter you are trying to create
+  subject { described_class.new }
+
+  # include the shared specs that the subject must pass
+  it_should_behave_like 'a flipper adapter'
+end
+```
+
+A good place to start when creating your own adapter is to copy one of the adapters mentioned above and replace the client specific code with whatever client you are attempting to adapt.
+
+I would also recommend setting `fail_fast = true` in your RSpec configuration as that will just give you one failure at a time to work through. It is also handy to have the shared adapter spec file open.

data/docs/Gates.md

@@ -0,0 +1,130 @@
+# Gates
+
+Out of the box several types of enabling are supported. They are checked in this order:
+
+## 1. Boolean
+
+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
+```
+
+## 2. Group
+
+Turn on feature based on value of block. Super flexible way to turn on a feature for multiple things (users, people, accounts, etc.)
+
+```ruby
+Flipper.register(:admins) do |actor|
+  actor.respond_to?(:admin?) && actor.admin?
+end
+
+flipper = Flipper.new(adapter)
+
+flipper[:stats].enable flipper.group(:admins) # turn on for admins
+flipper[:stats].disable flipper.group(:admins) # turn off for admins
+
+person = Person.find(params[:id])
+flipper[:stats].enabled? person # check if enabled, returns true if person.admin? is true
+
+# you can also use shortcut methods
+flipper.enable_group :stats, :admins
+flipper.disable_group :stats, :admins
+flipper[:stats].enable_group :admins
+flipper[:stats].disable_group :admins
+```
+
+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.
+
+## 3. 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`.
+
+```ruby
+flipper = Flipper.new(adapter)
+
+flipper[:stats].enable user
+flipper[:stats].enabled? user # true
+
+flipper[:stats].disable user
+flipper[:stats].enabled? 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
+```
+
+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.
+
+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:
+
+```ruby
+class User
+  def flipper_id
+    "User:#{id}"
+  end
+end
+
+class Group
+  def flipper_id
+    "Group:#{id}"
+  end
+end
+```
+
+## 4. 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
+
+# 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
+
+# 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
+```
+
+## 5. Percentage of Time
+
+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)
+
+# turn on logging for 5 percent of the time
+# 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
+
+# you can also use shortcut methods
+flipper.enable_percentage_of_time :search, 5
+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
+```
+
+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.

data/docs/Instrumentation.md

@@ -0,0 +1,27 @@
+# Instrumentation
+
+Flipper comes with automatic instrumentation. By default these work with ActiveSupport::Notifications, but only require the pieces of ActiveSupport that are needed and only do so if you actually attempt to require the instrumentation files listed below.
+
+To use the log subscriber:
+
+```ruby
+# Gemfile
+gem "activesupport"
+
+# config/initializers/flipper.rb (or wherever you want it)
+require "flipper/instrumentation/log_subscriber"
+```
+
+To use the statsd instrumentation:
+
+```ruby
+# Gemfile
+gem "activesupport"
+gem "statsd-ruby"
+
+# config/initializers/flipper.rb (or wherever you want it)
+require "flipper/instrumentation/statsd"
+Flipper::Instrumentation::StatsdSubscriber.client = Statsd.new # or whatever your statsd instance is
+```
+
+You can also do whatever you want with the instrumented events. Check out [this example](https://github.com/jnunemaker/flipper/blob/master/examples/instrumentation.rb) for more.

data/docs/Optimization.md

@@ -0,0 +1,27 @@
+# Optimization
+
+One optimization that flipper provides is a memoizing middleware. The memoizing middleware ensures that you only make one adapter call per feature per request.
+
+This means if you check the same feature over and over, it will only make one Mongo, Redis, or whatever call per feature for the length of the request.
+
+You can use the middleware from a Rails initializer like so:
+
+```ruby
+# create flipper dsl instance, see above Usage for more details
+flipper = Flipper.new(...)
+
+require 'flipper/middleware/memoizer'
+config.middleware.use Flipper::Middleware::Memoizer, flipper
+```
+
+If you set your flipper instance up in an initializer, you can pass a block to the middleware and it will lazily load the instance the first time the middleware is invoked.
+
+```ruby
+# config/initializers/flipper.rb
+$flipper = Flipper.new(...)
+
+# config/application.rb
+config.middleware.use Flipper::Middleware::Memoizer, lambda { $flipper }
+```
+
+**Note**: Be sure that the middleware is high enough up in your stack that all feature checks are wrapped.

data/flipper.gemspec

@@ -1,17 +1,37 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/flipper/version', __FILE__)
 
+plugin_files = []
+plugin_test_files = []
+
+Dir['flipper-*.gemspec'].map { |gemspec|
+  spec = eval(File.read(gemspec))
+  plugin_files << spec.files
+  plugin_test_files << spec.files
+}
+
+ignored_files = plugin_files
+ignored_files << Dir['script/*']
+ignored_files << ".travis.yml"
+ignored_files << ".gitignore"
+ignored_files << "Guardfile"
+ignored_files.flatten!.uniq!
+
+ignored_test_files = plugin_test_files
+ignored_test_files.flatten!.uniq!
+
 Gem::Specification.new do |gem|
   gem.authors       = ["John Nunemaker"]
   gem.email         = ["nunemaker@gmail.com"]
-  gem.summary       = %q{Feature flipper for any adapter}
-  gem.homepage      = "http://jnunemaker.github.com/flipper"
+  gem.summary       = %q{Feature flipper for ANYTHING}
+  gem.description   = %q{Feature flipper is the act of enabling/disabling features in your application, ideally without re-deploying or changing anything in your code base. Flipper makes this extremely easy to do with any backend you would like to use.}
+  gem.homepage      = "https://github.com/jnunemaker/flipper"
+  gem.license       = "MIT"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.files         = `git ls-files`.split("\n") - ignored_files + ["lib/flipper/version.rb"]
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n") - ignored_test_files
   gem.name          = "flipper"
   gem.require_paths = ["lib"]
   gem.version       = Flipper::VERSION
-  gem.license       = "MIT"
 end

data/lib/flipper/adapters/decorator.rb

@@ -2,6 +2,8 @@ require 'flipper/decorator'
 
 module Flipper
   module Adapters
+    # Public: Adapter super class for decorating another adapter. Used internally
+    # in flipper for the instrumented, memoizable and operation logger adapters.
     class Decorator < ::Flipper::Decorator
       include Adapter
     end

data/lib/flipper/adapters/instrumented.rb

@@ -3,6 +3,8 @@ require 'flipper/instrumenters/noop'
 
 module Flipper
   module Adapters
+    # Internal: Adapter that wraps another adapter and instruments all adapter
+    # operations. Used by flipper dsl to provide instrumentatin for flipper.
     class Instrumented < Decorator
       # Private: The name of instrumentation events.
       InstrumentationName = "adapter_operation.#{InstrumentationNamespace}"

data/lib/flipper/adapters/memoizable.rb

@@ -2,28 +2,20 @@ require 'flipper/adapters/decorator'
 
 module Flipper
   module Adapters
+    # Internal: Adapter that wraps another adapter with the ability to memoize
+    # adapter calls in memory. Used by flipper dsl and the memoizer middleware
+    # to make it possible to memoize adapter calls for the duration of a request.
     class Memoizable < Decorator
       FeaturesKey = :flipper_features
 
       # Internal
-      def self.cache
-        Thread.current[:flipper_memoize_cache] ||= {}
-      end
-
-      # Internal
-      def self.memoizing?
-        !!Thread.current[:flipper_memoize]
-      end
-
-      # Internal
-      def self.memoize=(value)
-        cache.clear
-        Thread.current[:flipper_memoize] = value
-      end
+      attr_reader :cache
 
       # Public
-      def initialize(adapter)
+      def initialize(adapter, cache = nil)
         super(adapter)
+        @cache = cache || {}
+        @memoize = false
       end
 
       # Public
@@ -84,21 +76,17 @@ module Flipper
         result
       end
 
-      # Internal
-      def cache
-        self.class.cache
-      end
-
       # Internal: Turns local caching on/off.
       #
       # value - The Boolean that decides if local caching is on.
       def memoize=(value)
-        self.class.memoize = value
+        cache.clear
+        @memoize = value
       end
 
       # Internal: Returns true for using local cache, false for not.
       def memoizing?
-        self.class.memoizing?
+        !!@memoize
       end
     end
   end

data/lib/flipper/adapters/memory.rb

@@ -2,6 +2,8 @@ require 'set'
 
 module Flipper
   module Adapters
+    # Public: Adapter for storing everything in memory (ie: Hash).
+    # Useful for tests/specs.
     class Memory
       include Adapter
 
@@ -23,7 +25,7 @@ module Flipper
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
-        features.add(feature.name.to_s)
+        features.add(feature.key)
         true
       end
 

data/lib/flipper/adapters/pstore.rb

@@ -3,6 +3,8 @@ require "set"
 
 module Flipper
   module Adapters
+    # Public: Adapter based on Ruby's pstore database. Perfect for when a local
+    # file is good enough for storing features.
     class PStore
       include Adapter
 

data/lib/flipper/type.rb

@@ -6,9 +6,12 @@ module Flipper
       new(value_or_instance)
     end
 
-    def value
-      raise 'Not implemented'
+    attr_reader :value
+
+    def eql?(other)
+      self.class.eql?(other.class) && value == other.value
     end
+    alias_method :==, :eql?
   end
 end
 

data/lib/flipper/types/actor.rb

@@ -3,17 +3,9 @@ module Flipper
     class Actor < Type
       def self.wrappable?(thing)
         return false if thing.nil?
-        return true if thing.is_a?(Flipper::Types::Actor)
         thing.respond_to?(:flipper_id)
       end
 
-      def self.wrap(thing)
-        return thing if thing.is_a?(self)
-        new(thing)
-      end
-
-      attr_reader :value
-
       def initialize(thing)
         if thing.nil?
           raise ArgumentError.new("thing cannot be nil")

data/lib/flipper/types/boolean.rb

@@ -2,11 +2,7 @@ module Flipper
   module Types
     class Boolean < Type
       def initialize(value = nil)
-        @value = value.nil? ? true : value
-      end
-
-      def value
-        @value
+        @value = value.nil? ? true : Typecast.to_boolean(value)
       end
     end
   end

data/lib/flipper/types/group.rb

@@ -1,7 +1,6 @@
 module Flipper
   module Types
     class Group < Type
-
       def self.wrap(group_or_name)
         return group_or_name if group_or_name.is_a?(self)
         Flipper.group(group_or_name)
@@ -11,16 +10,13 @@ module Flipper
 
       def initialize(name, &block)
         @name = name.to_sym
+        @value = @name
         @block = block
       end
 
       def match?(*args)
         @block.call(*args) == true
       end
-
-      def value
-        @name
-      end
     end
   end
 end

data/lib/flipper/types/percentage.rb

@@ -1,14 +1,6 @@
 module Flipper
   module Types
     class Percentage < Type
-
-      def self.wrap(value)
-        return value if value.is_a?(self)
-        new(value)
-      end
-
-      attr_reader :value
-
       def initialize(value)
         value = Typecast.to_integer(value)
 
@@ -18,11 +10,6 @@ module Flipper
 
         @value = value
       end
-
-      def eql?(other)
-        self.class.eql?(other.class) && value == other.value
-      end
-      alias_method :==, :eql?
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = "0.7.0.beta3"
+  VERSION = "0.7.0.beta4"
 end

data/spec/flipper/adapters/memoizable_spec.rb

@@ -5,16 +5,11 @@ require 'flipper/spec/shared_adapter_specs'
 
 describe Flipper::Adapters::Memoizable do
   let(:features_key) { described_class::FeaturesKey }
-
   let(:adapter) { Flipper::Adapters::Memory.new }
   let(:flipper) { Flipper.new(adapter) }
-  let(:cache) { Thread.current[:flipper_memoize_cache] }
-
-  after do
-    described_class.memoize = nil
-  end
+  let(:cache)   { {} }
 
-  subject { described_class.new(adapter) }
+  subject { described_class.new(adapter, cache) }
 
   it_should_behave_like 'a flipper adapter'
 

data/spec/flipper/adapters/pstore_spec.rb

@@ -3,7 +3,10 @@ require 'flipper/adapters/pstore'
 require 'flipper/spec/shared_adapter_specs'
 
 describe Flipper::Adapters::PStore do
-  subject { described_class.new(FlipperRoot.join("tmp", "flipper.pstore")) }
+  subject {
+    dir = FlipperRoot.join("tmp").tap { |d| d.mkpath }
+    described_class.new(dir.join("flipper.pstore"))
+  }
 
   it_should_behave_like 'a flipper adapter'
 

data/spec/flipper/instrumentation/log_subscriber_spec.rb

@@ -1,3 +1,4 @@
+require 'logger'
 require 'helper'
 require 'flipper/adapters/memory'
 require 'flipper/instrumentation/log_subscriber'

data/spec/flipper/types/actor_spec.rb

@@ -28,10 +28,14 @@ describe Flipper::Types::Actor do
       described_class.wrappable?(actor).should eq(true)
     end
 
-    it "returns true if responds to id" do
+    it "returns true if responds to flipper_id" do
       thing = thing_class.new(10)
       described_class.wrappable?(thing).should eq(true)
     end
+
+    it "returns false if nil" do
+      described_class.wrappable?(nil).should be(false)
+    end
   end
 
   describe ".wrap" do

data/spec/flipper/types/boolean_spec.rb

@@ -16,4 +16,9 @@ describe Flipper::Types::Boolean do
     boolean = Flipper::Types::Boolean.new(nil)
     boolean.value.should be(true)
   end
+
+  it "typecasts value" do
+    boolean = Flipper::Types::Boolean.new(1)
+    boolean.value.should be(true)
+  end
 end

data/spec/helper.rb

@@ -1,12 +1,7 @@
 $:.unshift(File.expand_path('../../lib', __FILE__))
 
 require 'pathname'
-require 'logger'
-
 FlipperRoot = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = FlipperRoot.join('lib')
-log_path  = FlipperRoot.join('log')
-log_path.mkpath
 
 require 'rubygems'
 require 'bundler'
@@ -14,6 +9,7 @@ require 'bundler'
 Bundler.setup(:default)
 
 require 'flipper'
+require 'flipper-ui'
 
 Dir[FlipperRoot.join("spec/support/**/*.rb")].each { |f| require f }
 

data/spec/support/spec_helpers.rb

@@ -0,0 +1,31 @@
+require 'json'
+require 'flipper/adapters/memory'
+require 'rack/test'
+
+module SpecHelpers
+  def self.included(base)
+    base.let(:flipper) { build_flipper }
+    base.let(:app) { build_app(flipper) }
+  end
+
+  def build_app(flipper)
+    Flipper::UI.app(flipper, secret: "test")
+  end
+
+  def build_flipper(adapter = build_memory_adapter)
+    Flipper.new(adapter)
+  end
+
+  def build_memory_adapter
+    Flipper::Adapters::Memory.new
+  end
+
+  def json_response
+    JSON.load(last_response.body)
+  end
+end
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.include SpecHelpers
+end

metadata

@@ -1,31 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.7.0.beta3
+  version: 0.7.0.beta4
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies: []
-description: 
+description: Feature flipper is the act of enabling/disabling features in your application,
+  ideally without re-deploying or changing anything in your code base. Flipper makes
+  this extremely easy to do with any backend you would like to use.
 email:
 - nunemaker@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - Changelog.md
 - Gemfile
-- Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- docs/Adapters.md
+- docs/Gates.md
+- docs/Instrumentation.md
+- docs/Optimization.md
 - examples/basic.rb
 - examples/dsl.rb
 - examples/example_setup.rb
@@ -74,10 +76,6 @@ files:
 - lib/flipper/types/percentage_of_actors.rb
 - lib/flipper/types/percentage_of_time.rb
 - lib/flipper/version.rb
-- script/bootstrap
-- script/guard
-- script/release
-- script/test
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb
 - spec/flipper/adapters/memory_spec.rb
@@ -110,7 +108,8 @@ files:
 - spec/helper.rb
 - spec/integration_spec.rb
 - spec/support/fake_udp_socket.rb
-homepage: http://jnunemaker.github.com/flipper
+- spec/support/spec_helpers.rb
+homepage: https://github.com/jnunemaker/flipper
 licenses:
 - MIT
 metadata: {}
@@ -133,7 +132,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Feature flipper for any adapter
+summary: Feature flipper for ANYTHING
 test_files:
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb
@@ -167,3 +166,4 @@ test_files:
 - spec/helper.rb
 - spec/integration_spec.rb
 - spec/support/fake_udp_socket.rb
+- spec/support/spec_helpers.rb

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-log

data/.rspec

@@ -1 +0,0 @@
---color

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.1.0
-  - 2.2.0
-notifications:
-  email: false
-bundler_args: --without guard

data/Guardfile

@@ -1,21 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'bundler' do
-  watch('Gemfile')
-  watch(/^.+\.gemspec/)
-end
-
-rspec_options = {
-  :all_after_pass => false,
-  :all_on_start   => false,
-  :failed_mode    => :keep,
-  :cmd            => "bundle exec rspec",
-}
-
-guard 'rspec', rspec_options do
-  watch(%r{^spec/.+_spec\.rb$}) { "spec" }
-  watch(%r{^lib/(.+)\.rb$}) { "spec" }
-  watch(%r{shared_adapter_specs\.rb$}) { "spec" }
-  watch('spec/helper.rb') { "spec" }
-end

data/script/bootstrap

@@ -1,21 +0,0 @@
-#!/bin/sh
-#/ Usage: bootstrap [bundle options]
-#/
-#/ Bundle install the dependencies.
-#/
-#/ Examples:
-#/
-#/   bootstrap
-#/   bootstrap --local
-#/
-
-set -e
-cd $(dirname "$0")/..
-
-[ "$1" = "--help" -o "$1" = "-h" -o "$1" = "help" ] && {
-    grep '^#/' <"$0"| cut -c4-
-    exit 0
-}
-
-rm -rf .bundle/{binstubs,config}
-bundle install --binstubs .bundle/binstubs --path .bundle --quiet "$@"

data/script/guard

@@ -1,15 +0,0 @@
-#!/bin/sh
-#/ Usage: guard
-#/
-#/ Start running guard.
-#/
-
-set -e
-cd $(dirname "$0")/..
-
-[ "$1" = "--help" -o "$1" = "-h" -o "$1" = "help" ] && {
-    grep '^#/' <"$0"| cut -c4-
-    exit 0
-}
-
-script/bootstrap && bundle exec guard

data/script/release

@@ -1,15 +0,0 @@
-#!/bin/sh
-#/ Usage: release
-#/
-#/ Package and release the gem to rubyforge.
-#/
-
-set -e
-cd $(dirname "$0")/..
-
-[ "$1" = "--help" -o "$1" = "-h" -o "$1" = "help" ] && {
-    grep '^#/' <"$0"| cut -c4-
-    exit 0
-}
-
-script/bootstrap && bundle exec rake release

data/script/test

@@ -1,30 +0,0 @@
-#!/bin/sh
-#/ Usage: test [individual test file]
-#/
-#/ Bootstrap and run all tests or an individual test.
-#/
-#/ Examples:
-#/
-#/   # run all tests
-#/   test
-#/
-#/   # run individual test
-#/   test spec/qu_spec.rb
-#/
-
-set -e
-cd $(dirname "$0")/..
-
-[ "$1" = "--help" -o "$1" = "-h" -o "$1" = "help" ] && {
-    grep '^#/' <"$0"| cut -c4-
-    exit 0
-}
-
-specs="spec/"
-
-if [ $# -gt 0 ]
-  then
-    specs=$@
-fi
-
-script/bootstrap && bundle exec rspec $specs