feature 0.5.0 → 0.6.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.6.0 (2013-03-24)
+
+* add capability for easier testing of activated or deactivated features
+
 ## 0.5.0 (2012-09-29)
 
 * added erb support for yaml feature config (dscataglini)

data/Gemfile

@@ -1,4 +1,8 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem "rake"
 gem "rspec"
+
+group :test do
+  gem 'coveralls', :require => false
+end

data/README.md

@@ -1,23 +1,60 @@
 # Feature
 
-Feature is a [feature toggle](http://martinfowler.com/bliki/FeatureToggle.html) library for ruby.
+Feature is a battle-tested [feature toggle](http://martinfowler.com/bliki/FeatureToggle.html) library for ruby.
 
-The feature toggle functionality has to be configured by feature repositories. A feature repository simply provides lists of active and inctive features.
+The feature toggle functionality has to be configured by feature repositories. A feature repository simply provides lists of active features (symbols!). Unknown features are assumed deactive.
 With this approach Feature is higly configurable and not bound to a specific kind of configuration.
 
 ## CI status
 
-[![Travis-CI Build Status](https://secure.travis-ci.org/mgsnova/feature.png)](https://secure.travis-ci.org/mgsnova/feature)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mgsnova/feature)
+[![Gem Version](https://badge.fury.io/rb/feature.png)](https://rubygems.org/gems/feature)
+[![Travis-CI Build Status](https://travis-ci.org/mgsnova/feature.png)](https://travis-ci.org/mgsnova/feature)
+[![Code Climate](https://codeclimate.com/github/mgsnova/feature.png)](https://codeclimate.com/github/mgsnova/feature)
+[![Coverage Status](https://coveralls.io/repos/mgsnova/feature/badge.png)](https://coveralls.io/r/mgsnova/feature)
 
 ## Installation
 
         gem install feature
 
+## How to use
+
+* Setup Feature
+    * Create a repository (see examples below)
+    * set repository to Feature
+
+        Feature.set_repository(your_repository)
+
+* Use Feature in your production code
+
+        Feature.active(:feature_name) # => true/false
+
+        Feature.deactive?(:feature_name) # => true/false
+
+        Feature.with(:feature_name) do
+          # code
+        end
+
+        Feature.without(:feature_name) do
+          # code
+        end
+
+* Use Feature in your test code (for reliable testing of feature depending code)
+
+        require 'feature/testing'
+
+        Feature.run_with_activated(:feature_name) do
+          # your test code
+        end
+
+        Feature.run_with_deactivated(:feature_name) do
+          # your test code
+        end
+
 ## Examples
 
-### Vanilla Ruby
+### Vanilla Ruby using SimpleRepository
 
+        # setup code
         require 'feature'
 
         repo = Feature::Repository::SimpleRepository.new
@@ -25,6 +62,7 @@ With this approach Feature is higly configurable and not bound to a specific kin
 
         Feature.set_repository repo
 
+        # production code
         Feature.active?(:be_nice)
         # => true
 
@@ -32,10 +70,10 @@ With this approach Feature is higly configurable and not bound to a specific kin
           puts "you can read this"
         end
 
-### Rails
+### Rails using YamlRepository
 
         # File: Gemfile
-        gem 'feature' # Or with version specifier, e.g. '~> 0.4.0'
+        gem 'feature' # Or with version specifier, e.g. '~> 0.6.0'
 
         # File: config/feature.yml
         features:

data/lib/feature.rb

@@ -5,6 +5,20 @@
 # - to refresh the feature lists (request them from repository)
 #
 # @note all features not active will be handled has inactive
+# 
+# Example usage:
+#   repository = SimpleRepository.new
+#   repository.add_active_feature(:feature_name)
+#
+#   Feature.set_repository(repository)
+#   Feature.active?(:feature_name)
+#   # => true
+#   Feature.inactive?(:inactive_feature)
+#   # => false
+#
+#   Feature.with(:feature_name) do
+#     # code will be executed
+#   end
 #
 module Feature
   require 'feature/repository'
@@ -26,7 +40,7 @@ module Feature
     refresh!
   end
 
-  # Obtains list of active features from repository
+  # Obtains list of active features from repository (for the case they change e.g. when using db-backed repository)
   #
   def self.refresh!
     @active_features = @repository.active_features

data/lib/feature/repository/simple_repository.rb

@@ -3,6 +3,11 @@ module Feature
     # SimpleRepository for active feature list
     # Simply add features to that should be active, no config or data sources required
     #
+    # Example usage:
+    #   repository = SimpleRepository.new
+    #   repository.add_active_feature(:feature_name)
+    #   # use repository with Feature
+    #
     class SimpleRepository
       # Constructor
       #

data/lib/feature/repository/yaml_repository.rb

@@ -7,6 +7,10 @@ module Feature
     #       an_active_feature: true
     #       an_inactive_feature: false
     #
+    # Example usage:
+    #   repository = YamlRepository.new('/path/to/yaml/file')
+    #   # use repository with Feature
+    #
     class YamlRepository
       require 'erb'
       require 'yaml'

data/lib/feature/testing.rb

@@ -0,0 +1,37 @@
+require 'feature'
+
+# This file provides functionality for testing your code with features
+# activated or deactivated.
+# This file should only be required in test/spec code!
+#
+# To enable Feature testing capabilities do:
+#   require 'feature/testing'
+module Feature
+  # Execute the code block with the given feature active
+  # 
+  # Example usage:
+  #   Feature.run_with_activated(:feature) do
+  #     # your test code here
+  #   end
+  def self.run_with_activated(feature)
+    old_features = @active_features.dup
+    @active_features.push(feature).uniq!
+    yield
+  ensure
+    @active_features = old_features
+  end
+
+  # Execute the code block with the given feature deactive
+  # 
+  # Example usage:
+  #   Feature.run_with_deactivated(:feature) do
+  #     # your test code here
+  #   end
+  def self.run_with_deactivated(feature)
+    old_features = @active_features.dup
+    @active_features.delete(feature)
+    yield
+  ensure
+    @active_features = old_features
+  end
+end

data/spec/feature/testing_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'feature/testing'
+
+describe "Feature testing support" do
+  before(:each) do
+    repository = SimpleRepository.new
+    repository.add_active_feature(:active_feature)
+    Feature.set_repository(repository)
+  end
+
+  it "should execute code block with an deactivated feature" do
+    Feature.active?(:another_feature).should be_false
+
+    Feature.run_with_activated(:another_feature) do
+      Feature.active?(:another_feature).should be_true
+    end
+
+    Feature.active?(:another_feature).should be_false
+  end
+
+  it "should execute code block with an deactivated feature" do
+    Feature.active?(:active_feature).should be_true
+
+    Feature.run_with_deactivated(:active_feature) do
+      Feature.active?(:active_feature).should be_false
+    end
+
+    Feature.active?(:active_feature).should be_true
+  end
+end

data/spec/feature/yaml_repository_spec.rb

@@ -87,7 +87,7 @@ EOF
     repo = YamlRepository.new("/this/file/should/not/exist")
     lambda do
       repo.active_features
-    end.should raise_error(Errno::ENOENT, "No such file or directory - /this/file/should/not/exist")
+    end.should raise_error(Errno::ENOENT, /No such file or directory -/)
   end
 
   it "should raise exception on invalid yaml" do

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require "pathname"
 require 'pp'
+require 'coveralls'
+Coveralls.wear!
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

metadata

@@ -1,28 +1,40 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: feature
-version: !ruby/object:Gem::Version
-  version: 0.5.0
+version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: 
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
-authors:
+authors: 
 - Markus Gerdes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-29 00:00:00.000000000 Z
+
+date: 2013-03-24 00:00:00 Z
 dependencies: []
+
 description: 
 email: github@mgsnova.de
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
+- lib/feature.rb
+- lib/feature/repository.rb
 - lib/feature/repository/simple_repository.rb
 - lib/feature/repository/yaml_repository.rb
-- lib/feature/repository.rb
-- lib/feature.rb
+- lib/feature/testing.rb
 - spec/feature/feature_spec.rb
 - spec/feature/simple_repository_spec.rb
+- spec/feature/testing_spec.rb
 - spec/feature/yaml_repository_spec.rb
 - spec/spec_helper.rb
 - Rakefile
@@ -31,26 +43,37 @@ files:
 - CHANGELOG.md
 homepage: http://github.com/mgsnova/feature
 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Feature Toggle library for ruby
 test_files: []
+
+has_rdoc: