flipper 0.6.3 → 0.7.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e34faac8f845079716a91656c21c42152e6fca2f
-  data.tar.gz: 6520f47773e83622cc34a6c1fa00f7a5909626e8
+  metadata.gz: 94132c1c49e833a166069931d26beee25f9f5a1e
+  data.tar.gz: 8575c2db458321be6d371f04b842e04f6a99daeb
 SHA512:
-  metadata.gz: e7b87ac273822f26046f712bb745869677e9a92039a14f17fc3457743c963e4359b8439c0196654f6ab2f26be2ae78a062e62e80f1f92661a24b875e90ec9a1c
-  data.tar.gz: f79a13fd623d67a12f17a90da97143df4152bbf87ff76c5556439d02f0a62d6c8993dbd6d1850f4267c37a1b29708a204343840b43d5904e1f5b1b06cabe08db
+  metadata.gz: 51df2910a358380d4b1eace919c8f6277210cf4b007b1ab34c10376070041dc3ab843ab551d1d3524ac42599a1e3556bab53c3aaf890c2e81a24f40f7980ab26
+  data.tar.gz: bcce3fe6e79483dbc1eeae59b32743bdfef65cb711f532b9f4aa33752d74b5e31fef5ed39a76c6fb7be9fd3796ea4be23561cf1e1f5264d2f99c6da07779b444

data/.travis.yml

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

data/Gemfile

@@ -1,16 +1,16 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'rake'
-gem 'metriks', :require => false
-gem 'statsd-ruby', :require => false
-gem 'rspec'
-gem 'rack-test'
-gem 'activesupport', :require => false
+gem 'rake', '~> 10.4.2'
+gem 'metriks', '~> 0.9.9', :require => false
+gem 'statsd-ruby', '~> 1.2.1', :require => false
+gem 'rspec', '~> 2.14'
+gem 'rack-test', '~> 0.6.3'
+gem 'activesupport', '~> 4.2.0', :require => false
 
 group(:guard) do
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'guard-bundler'
-  gem 'rb-fsevent'
+  gem 'guard', '~> 2.12.5'
+  gem 'guard-rspec', '~> 4.5.0'
+  gem 'guard-bundler', '~> 2.1.0'
+  gem 'rb-fsevent', '~> 0.9.4'
 end

data/Guardfile

@@ -9,7 +9,8 @@ end
 rspec_options = {
   :all_after_pass => false,
   :all_on_start   => false,
-  :keep_failed    => false,
+  :failed_mode    => :keep,
+  :cmd            => "bundle exec rspec",
 }
 
 guard 'rspec', rspec_options do

data/README.md

@@ -1,7 +1,7 @@
-![flipper logo](https://raw.github.com/jnunemaker/flipper-ui/master/lib/flipper/ui/public/images/logo.png)
+![flipper logo](https://raw.githubusercontent.com/jnunemaker/flipper-ui/master/lib/flipper/ui/public/images/logo.png)
 
 <pre>
-__
+                                   __
                                _.-~  )
                     _..--~~~~,'   ,-/     _
                  .-'. . . .'   ,-','    ,' )
@@ -37,7 +37,7 @@ Or install it yourself with:
 
 ## Usage
 
-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, ...)).
+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, ...)`).
 
 ```ruby
 require 'flipper'
@@ -74,11 +74,11 @@ Of course there are more [examples for you to peruse](https://github.com/jnunema
 
 ## Types
 
-Out of the box several types of enabling are supported. They are checked in this order.
+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.
+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)
@@ -97,13 +97,21 @@ Flipper.register(:admins) do |actor|
 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.
+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
 
@@ -121,11 +129,17 @@ 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 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 uuid's. 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 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
@@ -158,36 +172,47 @@ flipper[:stats].enable percentage
 # 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 Random
+### 5. Percentage of Time
 
-Turn this on for a random percentage of time. Think load testing new features behind the scenes and such.
+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 random instance set to 5
-percentage = flipper.random(5)
+# get percentage of time instance set to 5
+percentage = flipper.time(5)
 
-# turn on logging for 5 percent of the time randomly
+# 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
 ```
 
-Randomness 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 random to be very useful.
+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)
-* [activerecord 4 adapter](https://github.com/bgentry/flipper-activerecord)
-* [activerecord 3 adapter](https://github.com/jproudman/flipper-activerecord)
+* [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:
 
@@ -229,7 +254,7 @@ I would also recommend setting `fail_fast = true` in your RSpec configuration as
 
 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.
+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:
 
@@ -251,7 +276,7 @@ $flipper = Flipper.new(...)
 config.middleware.use Flipper::Middleware::Memoizer, lambda { $flipper }
 ```
 
-**Note**: Be sure that the middlware is high enough up in your stack that all feature checks are wrapped.
+**Note**: Be sure that the middleware is high enough up in your stack that all feature checks are wrapped.
 
 ## Contributing
 
@@ -261,6 +286,12 @@ config.middleware.use Flipper::Middleware::Memoizer, lambda { $flipper }
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Releasing
+
+1. Update the version to be whatever it should be and commit.
+2. `script/release`
+3. Profit.
+
 ## Coming Soon™
 
-* [Web UI](https://github.com/jnunemaker/flipper-ui) (think resque UI for features toggling/status)
+* [Web UI](https://github.com/jnunemaker/flipper-ui) (think Resque UI for features toggling/status)

data/Rakefile

@@ -1,7 +1,7 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
 
 task :default => :spec

data/examples/dsl.rb

@@ -59,8 +59,8 @@ puts "stats.enabled?: #{stats.enabled?}"
 puts "stats.enabled? person: #{stats.enabled? person}"
 puts
 
-# get an instance of the percentage of random type set to 5
-puts flipper.random(5).inspect
+# get an instance of the percentage of time type set to 5
+puts flipper.time(5).inspect
 
 # get an instance of the percentage of actors type set to 15
 puts flipper.actors(15).inspect

data/examples/{percentage_of_random.rb → percentage_of_time.rb}

@@ -8,7 +8,7 @@ flipper = Flipper.new(adapter)
 logging = flipper[:logging]
 
 perform_test = lambda do |number|
-  logging.enable flipper.random(number)
+  logging.enable flipper.time(number)
 
   total = 1_000
   enabled = []

data/lib/flipper.rb

@@ -24,27 +24,39 @@ module Flipper
   # Raises Flipper::DuplicateGroup if the group is already registered.
   def self.register(name, &block)
     group = Types::Group.new(name, &block)
-    groups.add(group.name, group)
+    groups_registry.add(group.name, group)
     group
   rescue Registry::DuplicateKey
-    raise DuplicateGroup, %Q{Group #{name.inspect} has already been registered}
+    raise DuplicateGroup, "Group #{name.inspect} has already been registered"
+  end
+
+  # Public: Returns a Set of registered Types::Group instances.
+  def self.groups
+    groups_registry.values.to_set
+  end
+
+  # Public: Returns a Set of symbols where each symbol is a registered
+  # group name. If you just want the names, this is more efficient than doing
+  # `Flipper.groups.map(&:name)`.
+  def self.group_names
+    groups_registry.keys.to_set
   end
 
   # Public: Clears the group registry.
   #
   # Returns nothing.
   def self.unregister_groups
-    groups.clear
+    groups_registry.clear
   end
 
   # Public: Check if a group exists
   #
   # Returns boolean
   def self.group_exists?(name)
-    self.groups.key?(name)
+    groups_registry.key?(name)
   end
 
-  # Internal: Fetches a group by name.
+  # Public: Fetches a group by name.
   #
   # name - The Symbol name of the group.
   #
@@ -55,19 +67,19 @@ module Flipper
   # Returns the Flipper::Group if group registered.
   # Raises Flipper::GroupNotRegistered if group is not registered.
   def self.group(name)
-    groups.get(name)
+    groups_registry.get(name)
   rescue Flipper::Registry::KeyNotFound => e
     raise GroupNotRegistered, "Group #{e.key.inspect} has not been registered"
   end
 
-  # Internal: Registry of all groups.
-  def self.groups
-    @groups ||= Registry.new
+  # Internal: Registry of all groups_registry.
+  def self.groups_registry
+    @groups_registry ||= Registry.new
   end
 
-  # Internal: Change the groups registry.
-  def self.groups=(registry)
-    @groups = registry
+  # Internal: Change the groups_registry registry.
+  def self.groups_registry=(registry)
+    @groups_registry = registry
   end
 end
 
@@ -78,3 +90,4 @@ require 'flipper/feature'
 require 'flipper/gate'
 require 'flipper/registry'
 require 'flipper/type'
+require 'flipper/typecast'

data/lib/flipper/dsl.rb

@@ -47,6 +47,50 @@ module Flipper
       feature(name).enable(*args)
     end
 
+    # Public: Enable a feature for an actor.
+    #
+    # name - The String or Symbol name of the feature.
+    # actor - a Flipper::Types::Actor instance or an object that responds
+    #         to flipper_id.
+    #
+    # Returns result of Feature#enable.
+    def enable_actor(name, actor)
+      feature(name).enable_actor(actor)
+    end
+
+    # Public: Enable a feature for a group.
+    #
+    # name - The String or Symbol name of the feature.
+    # group - a Flipper::Types::Group instance or a String or Symbol name of a
+    #         registered group.
+    #
+    # Returns result of Feature#enable.
+    def enable_group(name, group)
+      feature(name).enable_group(group)
+    end
+
+    # Public: Enable a feature a percentage of time.
+    #
+    # name - The String or Symbol name of the feature.
+    # percentage - a Flipper::Types::PercentageOfTime instance or an object
+    #              that responds to to_i.
+    #
+    # Returns result of Feature#enable.
+    def enable_percentage_of_time(name, percentage)
+      feature(name).enable_percentage_of_time(percentage)
+    end
+
+    # Public: Enable a feature for a percentage of actors.
+    #
+    # name - The String or Symbol name of the feature.
+    # percentage - a Flipper::Types::PercentageOfActors instance or an object
+    #              that responds to to_i.
+    #
+    # Returns result of Feature#enable.
+    def enable_percentage_of_actors(name, percentage)
+      feature(name).enable_percentage_of_actors(percentage)
+    end
+
     # Public: Disable a feature.
     #
     # name - The String or Symbol name of the feature.
@@ -57,6 +101,50 @@ module Flipper
       feature(name).disable(*args)
     end
 
+    # Public: Disable a feature for an actor.
+    #
+    # name - The String or Symbol name of the feature.
+    # actor - a Flipper::Types::Actor instance or an object that responds
+    #         to flipper_id.
+    #
+    # Returns result of disable.
+    def disable_actor(name, actor)
+      feature(name).disable_actor(actor)
+    end
+
+    # Public: Disable a feature for a group.
+    #
+    # name - The String or Symbol name of the feature.
+    # group - a Flipper::Types::Group instance or a String or Symbol name of a
+    #         registered group.
+    #
+    # Returns result of disable.
+    def disable_group(name, group)
+      feature(name).disable_group(group)
+    end
+
+    # Public: Disable a feature a percentage of time.
+    #
+    # name - The String or Symbol name of the feature.
+    # percentage - a Flipper::Types::PercentageOfTime instance or an object
+    #              that responds to to_i.
+    #
+    # Returns result of disable.
+    def disable_percentage_of_time(name)
+      feature(name).disable_percentage_of_time
+    end
+
+    # Public: Disable a feature for a percentage of actors.
+    #
+    # name - The String or Symbol name of the feature.
+    # percentage - a Flipper::Types::PercentageOfActors instance or an object
+    #              that responds to to_i.
+    #
+    # Returns result of disable.
+    def disable_percentage_of_actors(name)
+      feature(name).disable_percentage_of_actors
+    end
+
     # Public: Access a feature instance by name.
     #
     # name - The String or Symbol name of the feature.
@@ -110,20 +198,20 @@ module Flipper
     # thing - The object that you would like to wrap.
     #
     # Returns an instance of Flipper::Types::Actor.
-    # Raises ArgumentError if thing not wrappable.
+    # Raises ArgumentError if thing does not respond to `flipper_id`.
     def actor(thing)
       Types::Actor.new(thing)
     end
 
-    # Public: Shortcut for getting a percentage of random instance.
+    # Public: Shortcut for getting a percentage of time instance.
     #
-    # number - The percentage of random that should be enabled.
+    # number - The percentage of time that should be enabled.
     #
-    # Returns Flipper::Types::PercentageOfRandom.
-    def random(number)
-      Types::PercentageOfRandom.new(number)
+    # Returns Flipper::Types::PercentageOfTime.
+    def time(number)
+      Types::PercentageOfTime.new(number)
     end
-    alias_method :percentage_of_random, :random
+    alias_method :percentage_of_time, :time
 
     # Public: Shortcut for getting a percentage of actors instance.
     #
@@ -135,7 +223,7 @@ module Flipper
     end
     alias_method :percentage_of_actors, :actors
 
-    # Internal: Returns a Set of the known features for this adapter.
+    # Public: Returns a Set of the known features for this adapter.
     #
     # Returns Set of Flipper::Feature instances.
     def features