ruby_flipper 0.0.3 → 0.0.5

data/.gitignore

@@ -1,4 +1,5 @@
 pkg/*
 *.gem
 .bundle
-spec/reports
+spec/reports
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+notifications:
+  email: false

data/Gemfile

@@ -1,4 +1,6 @@
 source "http://rubygems.org"
 
+gem "rake"
+
 # Specify your gem's dependencies in ruby_flipper.gemspec
 gemspec

data/{README.rdoc → README.md}

@@ -1,126 +1,172 @@
-= Ruby Flipper
+# Ruby Flipper
+![Travis-CI](https://secure.travis-ci.org/blaulabs/ruby_flipper.png)
 
 Ruby Flipper makes it easy to define features and switch them on and off. It's configuration DSL provides a very flexible but still not too verbose syntax to fulfil your flipping needs.
 
 
-== Usage
+## Usage
 
 To use ruby flipper, you have to load a feature definition file somewhere:
 
-  RubyFlipper.load(File.expand_path '../features.rb', __FILE__)
+```ruby
+RubyFlipper.load(File.expand_path '../features.rb', __FILE__)
+```
 
 This configuration can be reset by calling:
 
-  RubyFlipper.reset
+```ruby
+RubyFlipper.reset
+```
 
 
-== Feature Definitions
+## Feature Definitions
 
 The file loaded by ruby flipper is written in ruby flipper's simple DSL. The most basic feature definition is just a feature with a name. Without any further conditions, the feature is active by default.
 
-  feature :always_on_feature
+```ruby
+feature :always_on_feature
+```
 
 You can specify conditions that are used to determine whether a feature is active or not in three different ways:
 
-  feature :conditional_feature_with_parameter, false
-  feature :conditional_feature_with_condition_opt, :condition => false
-  feature :conditional_feature_with_conditions_opt, :conditions => false
+```ruby
+feature :conditional_feature_with_parameter, false
+feature :conditional_feature_with_condition_opt, :condition #> false
+feature :conditional_feature_with_conditions_opt, :conditions #> false
+```
 
 In the examples above, the features are statically disabled. You can use three different types of conditions.
 
-=== Static Conditions
+### Static Conditions
 
 A static condition is a boolean that is evaluated when the feature definitions are loaded. This can be used to statically activate/deactivate features or make features dependent on variables that don't change during runtime.
 
-  feature :development_feature, Rails.env.development?
+```ruby
+feature :development_feature, Rails.env.development?
+```ruby
 
 This defines a feature that is only active in Rails' development mode.
 
-=== Reference Conditions
+### Reference Conditions
 
 A reference condition is a symbol that references another feature. This can be used to make a feature dependent on another feature or extract complex condition definitions and reuse them for several features.
 
-  feature :dependent_feature, :development_feature
+```ruby
+feature :dependent_feature, :development_feature
+```
 
 This defines a feature that is only active when the feature :development_feature is active.
 
-=== Dynamic Conditions
+### Dynamic Conditions
 
 A dynamic condition is a proc (or anything that responds to :call) that will be evaluated each time the state of a feature is checked. This can be used to activate/deactivate features dynamically depending on variables that change during runtime.
 
-  feature :admin_feature, condition => lambda { User.current.is_admin? }
+```ruby
+feature :admin_feature, condition #> lambda { User.current.is_admin? }
+```
 
 This defines a feature that is only active when the current user is an admin (the user specific stuff must be implemented somewhere else).
 
 Dynamic conditions can also be given to the feature method as a block:
 
-  feature :admin_feature do
-    User.current.is_admin?
-  end
+```ruby
+feature :admin_feature do
+  User.current.is_admin?
+end
+```
 
 Within such a proc, you can also check whether another feature is active or not to phrase complex condition dependencies:
 
-  feature :shy_feature do
-    active?(:development_feature) && (active?(:admin_feature) || Time.now.hour < 8)
-  end
+```ruby
+feature :shy_feature do
+  active?(:development_feature) && (active?(:admin_feature) || Time.now.hour < 8)
+end
+```
 
 This defines a feature that is only active when the feature :development_feature is active and either the feature :admin_feature is active or it is between midnight and 8:00 in the morning (however that might be useful).
 
-=== Combined Conditions
+### Combined Conditions
 
 A combined condition is an array of other conditions. Any type of condition can be combined in an array. All conditions have to be met for a feature to be active.
 
-  feature :combined_feature, [:development_feature, lambda { User.current.name == 'patti' }]
+```ruby
+feature :combined_feature, [:development_feature, lambda { User.current.name ## 'patti' }]
+```
 
 This defines a feature that is only enabled when the feature :development_feature is enbled and the current user is 'patti'.
 
-=== More
+### More
 
 For more examples, see spec/fixtures/features.rb and spec/ruby_flipper_spec.rb (section 'integration specs using spec/fixtures/features.rb' which is an end-to-end integration test).
 
 
-== Condition Definitions
+## Condition Definitions
 
 If you have a lot of dependent features with shared conditions you can clean up your definition file by explicitly defining conditions that aren't used as features but just as conditions real features depend on.
 
-  condition :development, Rails.env.development?
-  condition :admin { User.current.is_admin? }
-  
-  feature :user_administration, :development, :admin
-  feature :new_feature, :development
+```ruby
+condition :development, Rails.env.development?
+condition :admin do
+  User.current.is_admin?
+end
+feature :user_administration, :development, :admin
+feature :new_feature, :development
+```
 
 Of course, you can nest this as deep as you like (features depending on conditions depending on conditions depending on features depending on conditions...), although this might lead to completely incomprehensible rulesets.
 
 The condition method is just an alias to the feature method, so internally, it makes absolutely no difference which method you use. Using both methods just helps you structuring your feature definitions and makes the feature definition file easier to understand.
 
 
-== Usage
+## Usage
 
 Finally, there are two ways to check whether a feature is active or not within your code. You can just give it a block that will only be evaluated when the feature is active:
 
-  feature_active?(:hidden_feature) do
-    # do something for that feature
-  end
+```ruby
+feature_active?(:hidden_feature) do
+  # do something for that feature
+end
+```
 
 or if you need the state of a feature as a boolean value or want to do something when a feature is not active:
 
-  if feature_active?(:hidden_feature)
-    # do something for that feature
-  else
-    # do something else
-  end
+```ruby
+if feature_active?(:hidden_feature)
+  # do something for that feature
+else
+  # do something else
+end
+```
+
+Its also possible to pass arbitary arguments to `feature_active?` like so:
+  
+```ruby
+if feature_active?(:hidden_feature, "secret_sauce")
+  ...
+end
+```
+
+Those parameters will be passed to the block defining the condition.
 
 This method is defined on Object, so it is available anywhere you might ever need it.
 
 
-== Describing Features
+## Describing Features
 
 Last and least, you can describe your features, for example when you use ticket numbers or anything other cryptic for your feature names. The description isn't used anywhere yet, but it might make your code more readable.
 
-  feature :feature_452, :development, :description => 'Feature 452: An end user can change his data on his profile page.'
+```ruby
+feature :feature_452, :development, :description #> 'Feature 452: An end user can change his data on his profile page.'
+```
 
 You could also just use comments for that, but giving this to ruby flipper in code enables you to evaluate your features and print lists containing the description.
 
-  RubyFlipper::Feature.all.each do |feature|
-    puts "#{feature.name}: #{feature.description}"
-  end
+```ruby
+RubyFlipper::Feature.all.each do |feature|
+  puts "#{feature.name}: #{feature.description}"
+end
+```
+
+## Contributors:
+
+- Thanks to [Ryan Ahearn](https://github.com/rahearn) for implementing dynamic parameters to `feature_active?`

data/lib/ruby_flipper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'ruby_flipper/object_mixin'
 
 module RubyFlipper
@@ -27,6 +28,14 @@ module RubyFlipper
     Feature.reset
   end
 
+  def self.silence_warnings
+    warn_level = $VERBOSE
+    $VERBOSE = nil
+    yield
+  ensure
+    $VERBOSE = warn_level
+  end
+
 end
 
 require 'ruby_flipper/railtie' if defined?(Rails)

data/lib/ruby_flipper/feature.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module RubyFlipper
 
   class Feature
@@ -18,11 +19,13 @@ module RubyFlipper
       all[name] || raise(NotDefinedError, "'#{name}' is not defined")
     end
 
-    def self.condition_met?(condition)
+    def self.condition_met?(condition, *args)
       if condition.is_a?(Symbol)
         find(condition).active?
       elsif condition.is_a?(Proc)
-        !!ConditionContext.new.instance_eval(&condition)
+        RubyFlipper.silence_warnings do
+          !!ConditionContext.new.instance_exec(*args, &condition)
+        end
       elsif condition.respond_to?(:call)
         !!condition.call
       else
@@ -42,8 +45,8 @@ module RubyFlipper
       @name, @conditions = name, [conditions, block].flatten.compact
     end
 
-    def active?
-      conditions.map {|condition| self.class.condition_met?(condition)}.all?
+    def active?(*args)
+      conditions.map {|condition| self.class.condition_met?(condition, *args)}.all?
     end
 
   end

data/lib/ruby_flipper/object_mixin.rb

@@ -2,8 +2,8 @@ module RubyFlipper
 
   module ObjectMixin
 
-    def feature_active?(name)
-      active = Feature.find(name).active?
+    def feature_active?(name, *args)
+      active = Feature.find(name).active?(*args)
       yield if active && block_given?
       active
     end

data/ruby_flipper.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "ruby_flipper"
-  s.version     = "0.0.3"
+  s.version     = "0.0.5"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Thomas Jachmann"]
   s.email       = ["self@thomasjachmann.com"]
@@ -13,9 +13,9 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "ruby_flipper"
 
-  s.add_development_dependency "ci_reporter", "~> 1.6.3"
-  s.add_development_dependency "rspec", "~> 2.0.1"
-  s.add_development_dependency "mocha", "~> 0.9.10"
+  s.add_development_dependency "ci_reporter", "~> 1.6.5"
+  s.add_development_dependency "rspec", "~> 2.6.0"
+  s.add_development_dependency "mocha", "~> 0.9.12"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/fixtures/features.rb

@@ -22,17 +22,22 @@ feature :disabled, :description => 'disabled feature', :condition => false
 feature :floyd, :description => 'just for floyd', :condition => :dynamic_is_floyd
 
 # feature depending on a dynamic condition (lambda)
-feature :philip, :description => 'just for philip', :condition => lambda { FLIPPER_ENV[:dynamic] == 'philip' }
+feature :philip, :description => 'just for philip', :condition => proc { FLIPPER_ENV[:dynamic] == 'philip' }
 
 # feature depending on array of a static condition, a predefined condition and a dynamic condition (lambda)
 # given in :conditions (can be both :condition/:conditions)
 feature :patti, :description => 'just for patti', :conditions => [
   FLIPPER_ENV[:changing] == 'patti',
   :dynamic_is_floyd,
-  lambda { FLIPPER_ENV[:changing] == 'gavin'}
+  proc { FLIPPER_ENV[:changing] == 'gavin'}
 ]
 
 # feature with a complex combination of dynamic and predifined conditions given as a block
 feature :sue, :description => 'just for sue' do
   (active?(:static_is_cherry) || active?(:dynamic_is_floyd)) && FLIPPER_ENV[:changing] == 'sue'
 end
+
+# feature with a block relying on a runtime argument
+feature :argument do |arg|
+  !arg.nil?
+end

data/spec/ruby_flipper/feature_spec.rb

@@ -36,7 +36,7 @@ describe RubyFlipper::Feature do
     end
 
     it 'should call add with a name, conditions and a block and store the feature' do
-      block = lambda {}
+      block = proc {}
       # cannot mock this since mocha doesn't allow to test for a proc [thomas, 2010-12-13]
       feature = RubyFlipper::Feature.add(:feature_name, :one, :two, &block)
       feature.conditions.should == [:one, :two, block]
@@ -81,7 +81,7 @@ describe RubyFlipper::Feature do
     }.each do |condition, expected|
 
       it "should call a given proc and return #{expected} when it returns #{condition}" do
-        RubyFlipper::Feature.condition_met?(lambda { condition }).should == expected
+        RubyFlipper::Feature.condition_met?(proc { condition }).should == expected
       end
 
       it "should call anything callable and return #{expected} when it returns #{condition}" do
@@ -99,8 +99,8 @@ describe RubyFlipper::Feature do
       it 'should return the met? of the combined referenced conditions' do
         RubyFlipper::Feature.add(:true, true)
         RubyFlipper::Feature.add(:false, false)
-        RubyFlipper::Feature.condition_met?(lambda { active?(:true) || active?(:false) }).should == true
-        RubyFlipper::Feature.condition_met?(lambda { active?(:true) && active?(:false) }).should == false
+        RubyFlipper::Feature.condition_met?(proc { active?(:true) || active?(:false) }).should == true
+        RubyFlipper::Feature.condition_met?(proc { active?(:true) && active?(:false) }).should == false
       end
 
     end
@@ -126,17 +126,17 @@ describe RubyFlipper::Feature do
     end
 
     it 'should work with a dynamic condition as parameter' do
-      condition = lambda { true }
+      condition = proc { true }
       RubyFlipper::Feature.new(:feature_name, condition).conditions.should == [condition]
     end
 
     it 'should work with a dynamic condition as block' do
-      condition = lambda { true }
+      condition = proc { true }
       RubyFlipper::Feature.new(:feature_name, &condition).conditions.should == [condition]
     end
 
     it 'should work with a combination of static and dynamic conditions' do
-      condition = lambda { true }
+      condition = proc { true }
       RubyFlipper::Feature.new(:feature_name, false, :live, condition).conditions.should == [false, :live, condition]
     end
 
@@ -149,7 +149,7 @@ describe RubyFlipper::Feature do
     end
 
     it 'should work with a combination of arrays, dynamic conditions and conditions given in the opts hash and eliminate nil' do
-      condition = lambda { true }
+      condition = proc { true }
       RubyFlipper::Feature.new(:feature_name, [false, nil], :condition => [nil, 'c'], :conditions => ['c1', 'c2'], &condition).conditions.should == [false, 'c', 'c1', 'c2', condition]
     end
 
@@ -162,7 +162,7 @@ describe RubyFlipper::Feature do
     end
 
     it 'should return false when not all conditions are met (with dynamic)' do
-      RubyFlipper::Feature.new(:feature_name, true, lambda { false }).active?.should == false
+      RubyFlipper::Feature.new(:feature_name, true, proc { false }).active?.should == false
     end
 
     it 'should return false when not all conditions are met (only static)' do
@@ -173,6 +173,17 @@ describe RubyFlipper::Feature do
       RubyFlipper::Feature.new(:feature_name, true, true).active?.should == true
     end
 
+    context 'with a dynamic argument' do
+      subject { RubyFlipper::Feature.new(:feature_name, proc { |arg| arg == 'active' }) }
+
+      it 'should return false when not all conditions are met' do
+        subject.active?('inactive').should == false
+      end
+
+      it 'should return true when all conditions are met' do
+        subject.active?('active').should == true
+      end
+    end
   end
 
 end

data/spec/ruby_flipper/object_mixin_spec.rb

@@ -55,6 +55,39 @@ describe RubyFlipper::ObjectMixin do
 
     end
 
+    context 'with a dynamic feature' do
+
+      before(:each) do
+        RubyFlipper::Feature.add(:dynamic, proc { |arg| arg == 'active' })
+      end
+
+      context 'that is inactive' do
+        it 'should return false when called without a block' do
+          subject.feature_active?(:dynamic, 'inactive').should == false
+        end
+
+        it 'should not execute the block and return false when called with a block' do
+          subject.feature_active?(:dynamic, 'inactive') do
+            fail 'the given block should not be called'
+          end.should == false
+        end
+      end
+
+      context 'that is active' do
+        it 'should return true when called without a block' do
+          subject.feature_active?(:dynamic, 'active').should == true
+        end
+
+        it 'should execute the block and return true when called with a block' do
+          var = 'before'
+          subject.feature_active?(:dynamic, 'active') do
+            var = 'after'
+          end.should == true
+          var.should == 'after'
+        end
+      end
+    end
+
     context 'with a missing feature' do
 
       it 'should raise an error when called without a block and the referenced feature is not defined' do

data/spec/ruby_flipper_spec.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'spec_helper'
 
 describe RubyFlipper do
@@ -282,6 +283,30 @@ describe RubyFlipper do
 
       end
 
+      context ':argument' do
+        it 'should be active when called with arg' do
+          load_features
+          RubyFlipper::Feature.find(:argument).active?(true).should be_true
+        end
+
+        it 'should not be active when called without an argument' do
+          load_features
+          RubyFlipper::Feature.find(:argument).should_not be_active
+        end
+      end
+
+    end
+
+    context "ruby 1.8" do
+      #warning: multiple values for a block parameter (0 for 1)
+      it 'should not show warnings' do
+        $VERBOSE=true
+        @verbose = true
+        RubyFlipper.silence_warnings do
+          @verbose = $VERBOSE
+        end
+        @verbose.should be_nil
+      end
     end
 
   end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ Bundler.require(:default, :development)
 
 FLIPPER_ENV = {}
 
-Rspec.configure do |config|
+RSpec.configure do |config|
   config.mock_with :mocha
   config.after(:each) do
     RubyFlipper.reset

metadata

@@ -1,86 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby_flipper
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Thomas Jachmann
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-13 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ci_reporter
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2181489240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 6
-        - 3
-        version: 1.6.3
+      - !ruby/object:Gem::Version
+        version: 1.6.5
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2181489240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2181488760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 2
-        - 0
-        - 1
-        version: 2.0.1
+      - !ruby/object:Gem::Version
+        version: 2.6.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2181488760
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2181488300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 0
-        - 9
-        - 10
-        version: 0.9.10
+      - !ruby/object:Gem::Version
+        version: 0.9.12
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *2181488300
 description: Most flexible still least verbose feature flipper for ruby projects.
-email: 
+email:
 - self@thomasjachmann.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
-- Gemfile.lock
-- README.rdoc
+- README.md
 - Rakefile
 - autotest/discover.rb
 - lib/ruby_flipper.rb
@@ -97,41 +72,31 @@ files:
 - spec/ruby_flipper/object_mixin_spec.rb
 - spec/ruby_flipper_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/blaulabs/ruby_flipper
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: ruby_flipper
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Make switching features on and off easy.
-test_files: 
+test_files:
 - spec/fixtures/features.rb
 - spec/ruby_flipper/condition_context_spec.rb
 - spec/ruby_flipper/dsl_spec.rb
@@ -139,3 +104,4 @@ test_files:
 - spec/ruby_flipper/object_mixin_spec.rb
 - spec/ruby_flipper_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/Gemfile.lock

@@ -1,34 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ruby_flipper (0.0.3)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    builder (3.0.0)
-    ci_reporter (1.6.3)
-      builder (>= 2.1.2)
-    diff-lcs (1.1.2)
-    mocha (0.9.10)
-      rake
-    rake (0.8.7)
-    rspec (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-      rspec-mocks (~> 2.0.1)
-    rspec-core (2.0.1)
-    rspec-expectations (2.0.1)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  ci_reporter (~> 1.6.3)
-  mocha (~> 0.9.10)
-  rspec (~> 2.0.1)
-  ruby_flipper!