feature_switch 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+doc
+pkg
+.yardoc
+
+## PROJECT::SPECIFIC
+feature_switch.gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Williams
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,28 @@
+= feature_switch
+
+A simple module for enabling features on your app.  If your application has a current_user object that responds to a call to 'features' with an array of symbols,  that wil be used for user specific feature control.
+
+
+Use it like so:
+
+  include FeatureSwitch
+
+  enable(:upload_photo)
+
+  feature(:upload_photo) do
+    p "This Block will be yielded if the feature is enabled"
+  end
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Dan Williams. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "feature_switch"
+    gem.summary = %Q{Selectivly enabled features in your app}
+    gem.description = %Q{Selectivly enabled features in your app on a system/per-user basis}
+    gem.email = "dan.williams@itthugs.com"
+    gem.homepage = "http://github.com/deedubs/feature_switch"
+    gem.authors = ["Dan Williams"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts  = ['--exclude', 'spec,gems']
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/feature_switch.rb

@@ -0,0 +1,51 @@
+# @author Dan Williams
+module FeatureSwitch
+  @@enabled_features = []
+  @@disabled_features = []
+  
+  # Yields a block if the feature is enabled 
+  #
+  # @param [Symbol] The feature to use as a guard-check
+  def feature(feature)    
+    yield if enabled_features.include?(feature) || (enabled_features(current_user.features).include?(feature) if respond_to?(:current_user) && current_user.respond_to?(:features))
+  end
+  
+  # Enable a feature
+  #
+  # @param [Symbol] The feature to enable
+  def enable(feature)
+    @@enabled_features << feature
+  end
+  
+  # Disable a feature
+  #
+  # @param [Symbol] The feature to disable
+  def disable(feature)
+    @@disabled_features << feature
+  end
+  
+  # Returns if the feature has been enabled
+  #
+  # @param [Symbol] The feature to check the status of
+  def enabled?(feature)
+    enabled_features.include?(feature)
+  end
+  
+  # Returns if the feature has been disabled
+  #
+  # @param [Symbol] The feature to check the status of
+  def disabled?(feature)
+    disabled_features.include?(feature)
+  end
+  
+  private
+    # Returns a list of enabled features
+    def enabled_features(user_services = [])
+      (user_services + @@enabled_features) - @@disabled_features
+    end
+    
+    # Returns a list of disabled features
+    def disabled_features
+      @@disabled_features
+    end
+end

data/spec/feature_switch_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FeatureSwitch" do
+  include FeatureSwitch
+  
+  before(:each) do
+    FeatureSwitch.reset
+  end
+  
+  it "should allow a feature to be enabled" do
+    enable(:upload_photo).should be_true
+  end
+  
+  it "should report a feature as enabled when it has been enabled" do
+    enable(:upload_photo)
+    enabled?(:upload_photo).should be_true
+  end
+  
+  it "should allow a feature to be disabled" do
+    disable(:upload_photo).should be_true
+  end
+  
+  it "should report a feature as disabled when it has been disabled" do
+    disable(:upload_photo)
+    disabled?(:upload_photo).should be_true
+  end
+  
+  it "should not report a feature as enabled if it has been enabled then disabled" do
+    enable(:upload_photo)
+    disable(:upload_photo)
+    enabled?(:upload_photo).should be_false
+  end
+  
+  it "should not render a block when the feature is not enabled" do
+    stub!(:current_user).and_return(User.new)
+    
+    feature(:upload_photo) do
+      "Feature Enabled"
+    end.should eql(nil)
+  end
+  
+  it "should render a block when the feature is enabled system-wide" do
+    stub!(:current_user).and_return(User.new)
+    
+    enable(:upload_photo)
+    
+    content = feature(:upload_photo) do
+      "Feature Enabled"
+    end.should eql("Feature Enabled")
+  end
+  
+  it "should render a block when the user has the feature enabled" do 
+    stub!(:current_user).and_return(UserWithPhotoFeature.new)
+    
+    feature(:upload_photo) do
+      "Feature Enabled"
+    end.should eql("Feature Enabled")
+  end
+  
+  it "should not render a block when the feature disabled" do
+    stub!(:current_user).and_return(User.new)
+    
+    disable(:upload_photo)
+    
+    feature(:upload_photo) do
+      "Feature Enabled"
+    end.should eql(nil)
+  end
+  
+  it "should not render a block when the feature is disabled even if the user has it enabled" do
+    stub!(:current_user).and_return(UserWithPhotoFeature.new)
+    
+    disable(:upload_photo)
+    
+    feature(:upload_photo) do
+      "Feature Enabled"
+    end.should eql(nil)
+  end
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'feature_switch'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+module FeatureSwitch
+  def self.reset
+    @@enabled_features = []
+    @@disabled_features = []
+  end
+end
+
+class User
+  def features
+    []
+  end
+end
+
+class UserWithPhotoFeature
+  def features
+    [:upload_photo]
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: feature_switch
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Dan Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Selectivly enabled features in your app on a system/per-user basis
+email: dan.williams@itthugs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/feature_switch.rb
+- spec/feature_switch_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/deedubs/feature_switch
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Selectivly enabled features in your app
+test_files: 
+- spec/feature_switch_spec.rb
+- spec/spec_helper.rb