flippeur 1.0.0 → 1.0.1

data/README.md

@@ -22,17 +22,17 @@ Or install it yourself as:
 
 ## Usage
 
-The basic idea is that a feature is, or isn't, available to a user of your webapp.  So the logic determining whether or not a feature is available acts on a user.
+The basic idea is that a feature is, or isn't, available to an actor (e.g. user or account) of your webapp.
 
-In the view and the controller layers, the user is obtained automatically by calling the controller's `current_person` method (currently and regrettably hardcoded).  In the model layer you need to pass an appropriate user instance explicitly.
-
-(This is suboptimal and I'm exploring alternatives.)
+In the view and the controller layers, the user is obtained automatically by sending your configured actor method to the controller.  If you don't configure an actor method, it defaults to `:current_person`.  In the model layer you need to pass an appropriate actor instance explicitly.
 
 First, setup your features.  With Rails this would go in `config/initializers/flippeur.rb`.
 
 ```ruby
 Flippeur.setup do
 
+  actor :current_user
+
   feature :something_fancy do |user|
     user.is_fancy?
   end
@@ -44,7 +44,7 @@ Flippeur.setup do
 end
 ```
 
-Give each feature a name and a block.  The block should return a truthy value if the feature is available to the user, and a falsey value otherwise.
+Give each feature a name and a block.  The block should return a truthy value if the feature is available to the actor and a falsey value otherwise.
 
 N.B. to return early from the block, use `next retvalue` instead of `return retvalue`.  For example:
 
@@ -55,7 +55,7 @@ feature :add_widget do |user|
 end
 ```
 
-Second, use the helpers to determine whether or not features are available to your current user.
+Second, use the helpers to determine whether or not features are available to your current actor.
 
 ### View
 
@@ -95,21 +95,26 @@ end
 
 ### Model
 
-Here you also need to pass a user instance to the helper.  For example:
+Here you also need to pass an actor instance to the helper.  For example:
 
 ```ruby
+Flippeur.setup do
+  actor :account
+  feature :something_fancy do |account|
+    account.id == 42
+  end
+end
+
 class Project < ActiveRecord::Base
   belongs_to :account
   def do_something_fancy
-    if feature? :something_fancy, account.users.first
+    if feature? :something_fancy, account
       # something fancy
     end
   end
 end
 ```
 
-This is suboptimal and should be revisited...
-
 
 ## See Also
 

data/lib/flippeur/feature.rb

@@ -7,8 +7,8 @@ module Flippeur
       @block = block
     end
 
-    def available?(user)
-      block.call user
+    def available?(actor)
+      block.call actor
     end
   end
 end

data/lib/flippeur/rails_helpers.rb

@@ -2,21 +2,21 @@ module Flippeur
 
   module ViewHelpers
     def feature?(name)
-      available = Flippeur.find(name).available? @controller.current_person
+      available = Flippeur.find(name).available? @controller.send(Flippeur.actor)
       block_given? ? (yield if available) : available
     end
   end
 
   module ControllerHelpers
     def feature?(name)
-      available = Flippeur.find(name).available? current_person
+      available = Flippeur.find(name).available? send(Flippeur.actor)
       block_given? ? (yield if available) : available
     end
   end
 
   module ModelHelpers
-    def feature?(name, person)
-      available = Flippeur.find(name).available? person
+    def feature?(name, actor)
+      available = Flippeur.find(name).available? actor
       block_given? ? (yield if available) : available
     end
   end

data/lib/flippeur/version.rb

@@ -1,3 +1,3 @@
 module Flippeur
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/flippeur.rb

@@ -11,6 +11,11 @@ module Flippeur
     module_eval &block
   end
 
+  def self.actor(method_name = nil)
+    @actor = method_name if method_name
+    @actor
+  end
+
   def self.feature(name, &block)
     features[name] = Feature.new(name, &block)
   end
@@ -21,12 +26,17 @@ module Flippeur
 
   private
 
+  def self.default_actor
+    :current_person
+  end
+
   def self.features
     @features ||= Hash.new { |_,k| raise UnknownFeature, "Unknown feature: #{k}" }
   end
 
   def self.reset
     @features = nil
+    @actor = default_actor
   end
-  
+
 end

data/test/actor_test.rb

@@ -0,0 +1,62 @@
+require 'minitest/autorun'
+require 'flippeur'
+require 'flippeur/rails_helpers'
+
+class ActorController
+  include Flippeur::ControllerHelpers
+
+  def current_person
+    @method = :current_person
+  end
+
+  def current_account
+    @method = :current_account
+  end
+
+  def method?
+    @method
+  end
+end
+
+
+class ActorView
+  include Flippeur::ViewHelpers
+  def initialize
+    @controller = OpenStruct.new(current_account: Object.new)
+  end
+end
+
+
+class ActorTest < MiniTest::Unit::TestCase
+
+  def setup
+    @controller = ActorController.new
+    @view = ActorView.new
+  end
+
+  def test_default_actor_controller
+    Flippeur.setup do
+      feature(:foo) { |actor| true }
+    end
+    @controller.feature?(:foo)
+    assert_equal :current_person, @controller.method?
+  end
+
+  def test_configured_actor_controller
+    Flippeur.setup do
+      actor :current_account
+      feature(:foo) { |actor| true }
+    end
+    @controller.feature?(:foo)
+    assert_equal :current_account, @controller.method?
+  end
+
+  def test_configured_actor_view
+    Flippeur.setup do
+      actor :current_account
+      feature(:foo) { |actor| true }
+    end
+    assert @view.feature?(:foo)
+  end
+
+end

data/test/controller_helpers_test.rb

@@ -26,14 +26,14 @@ class ControllerHelpersTest < MiniTest::Unit::TestCase
 
   def test_available_feature_as_boolean
     Flippeur.setup do
-      feature(:foo) { |user| true }
+      feature(:foo) { |actor| true }
     end
     assert @controller.feature?(:foo)
   end
 
   def test_available_feature_with_block
     Flippeur.setup do
-      feature(:foo) { |user| true }
+      feature(:foo) { |actor| true }
     end
     block_called = false
     @controller.feature?(:foo) do
@@ -44,14 +44,14 @@ class ControllerHelpersTest < MiniTest::Unit::TestCase
 
   def test_unavailable_feature_as_boolean
     Flippeur.setup do
-      feature(:foo) { |user| false }
+      feature(:foo) { |actor| false }
     end
     refute @controller.feature?(:foo)
   end
 
   def test_unavailable_feature_with_block
     Flippeur.setup do
-      feature(:foo) { |user| false }
+      feature(:foo) { |actor| false }
     end
     block_called = false
     @controller.feature?(:foo) do

data/test/feature_test.rb

@@ -19,14 +19,14 @@ class FeatureTest < MiniTest::Unit::TestCase
 
   def test_available_feature
     Flippeur.setup do
-      feature(:foo) { |user| user.id == 42 }
+      feature(:foo) { |actor| actor.id == 42 }
     end
     assert Flippeur.find(:foo).available?( OpenStruct.new(id: 42) )
   end
 
   def test_unavailable_feature
     Flippeur.setup do
-      feature(:foo) { |user| user.id == 42 }
+      feature(:foo) { |actor| actor.id == 42 }
     end
     refute Flippeur.find(:foo).available?( OpenStruct.new(id: 153) )
   end

data/test/model_helpers_test.rb

@@ -23,14 +23,14 @@ class ModelHelpersTest < MiniTest::Unit::TestCase
 
   def test_available_feature_as_boolean
     Flippeur.setup do
-      feature(:foo) { |user| true }
+      feature(:foo) { |actor| true }
     end
     assert @model.feature?(:foo, Object.new)
   end
 
   def test_available_feature_with_block
     Flippeur.setup do
-      feature(:foo) { |user| true }
+      feature(:foo) { |actor| true }
     end
     block_called = false
     @model.feature?(:foo, Object.new) do
@@ -41,14 +41,14 @@ class ModelHelpersTest < MiniTest::Unit::TestCase
 
   def test_unavailable_feature_as_boolean
     Flippeur.setup do
-      feature(:foo) { |user| false }
+      feature(:foo) { |actor| false }
     end
     refute @model.feature?(:foo, Object.new)
   end
 
   def test_unavailable_feature_with_block
     Flippeur.setup do
-      feature(:foo) { |user| false }
+      feature(:foo) { |actor| false }
     end
     block_called = false
     @model.feature?(:foo, Object.new) do

data/test/view_helpers_test.rb

@@ -26,14 +26,14 @@ class ViewHelpersTest < MiniTest::Unit::TestCase
 
   def test_available_feature_as_boolean
     Flippeur.setup do
-      feature(:foo) { |user| true }
+      feature(:foo) { |actor| true }
     end
     assert @view.feature?(:foo)
   end
 
   def test_available_feature_with_block
     Flippeur.setup do
-      feature(:foo) { |user| true }
+      feature(:foo) { |actor| true }
     end
     block_called = false
     @view.feature?(:foo) do
@@ -44,14 +44,14 @@ class ViewHelpersTest < MiniTest::Unit::TestCase
 
   def test_unavailable_feature_as_boolean
     Flippeur.setup do
-      feature(:foo) { |user| false }
+      feature(:foo) { |actor| false }
     end
     refute @view.feature?(:foo)
   end
 
   def test_unavailable_feature_with_block
     Flippeur.setup do
-      feature(:foo) { |user| false }
+      feature(:foo) { |actor| false }
     end
     block_called = false
     @view.feature?(:foo) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flippeur
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-27 00:00:00.000000000 Z
+date: 2013-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -45,6 +45,7 @@ files:
 - lib/flippeur/rails_helpers.rb
 - lib/flippeur/railtie.rb
 - lib/flippeur/version.rb
+- test/actor_test.rb
 - test/controller_helpers_test.rb
 - test/feature_test.rb
 - test/model_helpers_test.rb
@@ -63,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1803748012281727158
+      hash: -2788601596674215805
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -72,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1803748012281727158
+      hash: -2788601596674215805
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -80,6 +81,7 @@ signing_key:
 specification_version: 3
 summary: Simple feature flipping.
 test_files:
+- test/actor_test.rb
 - test/controller_helpers_test.rb
 - test/feature_test.rb
 - test/model_helpers_test.rb