feature 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f9b9580a7aa39fe081df357dce3bcfaf4611ba9
-  data.tar.gz: 5ec1b69eb13c4c20689fd227194796e26969b4ef
+  metadata.gz: 83131f6c0bc8a7fe056a4c621130a968fcb1ec5a
+  data.tar.gz: 9772c00ec3dd58a84a259162591fe3f3983019f6
 SHA512:
-  metadata.gz: 5d12f49a521091b2d2ad0787f33bfa4352f5db57ea3801a86088e03ea2c61ddf116e5c9cae9f6f2fb83cb560b196f47a1916455e78e293cba4f1b3b4705bd794
-  data.tar.gz: d84ff821a0bd30c0534ce68e971b671640881c829a46384d9f2165ea5945f1594e1db0d1264d38b1ad80caa766e8b31a775879c36faecd22f14157992ce9984d
+  metadata.gz: fcfa2c4877b32898c8f08dff2531eb22089b6bd38d63caa95bc6752ff396034d6aef6fba1c038f6a0b509471da8126a45a5b884ac2d267fa49a23668c2753317
+  data.tar.gz: 7c5cc34fbbe4007030e5708d2db9c50105a6cda84445492f5a881bb567f15db2cabef41b971fdabcc57a4fd45c0a917adc2b719935b1aa81647058ab4641475e

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.2.0 (2014-10-28)
+
+* add Support for auto-refresh of feature data (javidjamae)
+* read list of features at first usage instead of initialization (lazy-load)
+* add RedisRepository (javidjamae)
+* remove explicit Rails 3 Support of ActiveRecordRepository
+
 ## 1.1.0 (2014-09-30)
 
 * generator compatible with Rails 3/4 (mumoshu)

data/Gemfile

@@ -1,9 +1,13 @@
 source 'https://rubygems.org'
 
-gem "rake"
+gem 'rake'
 
 group :test do
-  gem "rspec"
-  gem "rspec-mocks"
+  gem 'rspec'
+  gem 'rspec-mocks'
   gem 'coveralls', require: false
+  gem 'rubocop', require: false
+  gem 'fakeredis'
+  gem 'mutant'
+  gem 'mutant-rspec'
 end

data/README.md

@@ -1,18 +1,21 @@
+[![Gem Version](https://badge.fury.io/rb/feature.svg)](https://rubygems.org/gems/feature)
+[![Travis-CI Build Status](https://travis-ci.org/mgsnova/feature.svg)](https://travis-ci.org/mgsnova/feature)
+[![Coverage Status](http://img.shields.io/coveralls/mgsnova/feature/master.svg)](https://coveralls.io/r/mgsnova/feature)
+[![Code Climate](https://codeclimate.com/github/mgsnova/feature.svg)](https://codeclimate.com/github/mgsnova/feature)
+[![Inline docs](http://inch-ci.org/github/mgsnova/feature.svg)](http://inch-ci.org/github/mgsnova/feature)
+[![Dependency Status](https://gemnasium.com/mgsnova/feature.svg)](https://gemnasium.com/mgsnova/feature)
+
 # Feature
 
 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 features (symbols!). Unknown features are assumed inactive.
+
 With this approach Feature is higly configurable and not bound to a specific kind of configuration.
 
 **NOTE:** Ruby 1.8 is only supported until version 0.7.0. Later Versions require at least Ruby 1.9.
 
-## CI status
-
-[![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?branch=master)](https://coveralls.io/r/mgsnova/feature)
+**NOTE:** Using feature with ActiveRecord and Rails 3 MAY work. Use version 1.1.0 if you need support for Rails 3.
 
 ## Installation
 
@@ -22,7 +25,7 @@ With this approach Feature is higly configurable and not bound to a specific kin
 
 * Setup Feature
     * Create a repository (see examples below)
-    * set repository to Feature
+    * Set repository to Feature
 
             Feature.set_repository(your_repository)
 
@@ -57,6 +60,25 @@ With this approach Feature is higly configurable and not bound to a specific kin
           # your test code
         end
 
+* Feature-toggle caching
+
+    * By default, Feature will lazy-load the active features from the
+      underlying repository the first time you try to check whether a
+      feature is set or not. 
+
+    * Subsequent toggle-status checks will access the cached, in-memory
+      representation of the toggle status, so changes to toggles in the 
+      underlying repository would not be reflected in the application
+      until you restart the application or manally call 
+
+            Feature.refresh!
+
+    * You can optionally pass in true as a second argument on
+      set_repository, to force Feature to auto-refresh the feature list
+      on every feature-toggle check you make.
+
+            Feature.set_repository(your_repository, true) 
+
 ## Examples
 
 ### Vanilla Ruby using SimpleRepository
@@ -77,6 +99,35 @@ With this approach Feature is higly configurable and not bound to a specific kin
           puts "you can read this"
         end
 
+### Ruby or Rails using RedisRepository
+
+        # See here to learn how to configure redis: https://github.com/redis/redis-rb
+
+        # File: Gemfile
+        gem 'feature'
+        gem 'redis'
+
+        # setup code (or Rails initializer: config/initializers/feature.rb)
+        require 'feature'
+
+        repo = Feature::Repository::RedisRepository.new("feature_toggles")
+        Feature.set_repository repo
+
+        # production code
+        Feature.active?(:be_nice)
+        # => true
+
+        Feature.with(:be_nice) do
+          puts "you can read this"
+        end
+
+        # see all features in Redis
+        Redis.current.hgetall("feature_toggles")
+
+        # add/toggle features in Redis
+        Redis.current.hset("feature_toggles", "ActiveFeature", true)
+        Redis.current.hset("feature_toggles", "InActiveFeature", false)
+
 ### Rails using YamlRepository
 
         # File: Gemfile

data/Rakefile

@@ -1,10 +1,18 @@
 require 'rake/testtask'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'mutant'
+
+RuboCop::RakeTask.new
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rspec_opts = ['--colour', '-f documentation', '--backtrace']
 end
 
-task default: [:spec] do
+task :mutant do
+  result = Mutant::CLI.run(%w(--include lib --require feature --use rspec Feature*))
+  fail unless result == Mutant::CLI::EXIT_SUCCESS
 end
+
+task default: [:spec, :rubocop, :mutant]

data/lib/feature.rb

@@ -22,8 +22,7 @@
 #
 module Feature
   require 'feature/repository'
-  # Only load the generator if Rails is defined and Version is greater than 3
-  require 'feature/generators/install_generator' if defined?(Rails) and Rails::VERSION::STRING > "3"
+  require 'feature/generators/install_generator'
 
   @repository = nil
   @active_features = nil
@@ -32,20 +31,24 @@ module Feature
   # The given repository has to respond to method 'active_features' with an array of symbols
   #
   # @param [Object] repository the repository to get the features from
+  # @param [Boolean] auto_refresh optional (default: false) - refresh feature toggles on every check if set true
   #
-  def self.set_repository(repository)
-    if !repository.respond_to?(:active_features)
-      raise ArgumentError, "given repository does not respond to active_features"
+  def self.set_repository(repository, auto_refresh = false)
+    unless repository.respond_to?(:active_features)
+      fail ArgumentError, 'given repository does not respond to active_features'
     end
 
+    @auto_refresh = auto_refresh
+    @perform_initial_refresh = true
     @repository = repository
-    refresh!
   end
 
-  # Obtains list of active features from repository (for the case they change e.g. when using db-backed repository)
+  # Refreshes list of active features from repository.
+  # Useful when using an repository with external source.
   #
   def self.refresh!
     @active_features = @repository.active_features
+    @perform_initial_refresh = false
   end
 
   ##
@@ -55,9 +58,9 @@ module Feature
   # @return [Boolean]
   #
   def self.active?(feature)
-    if !@repository
-      raise "Feature is missing Repository for obtaining feature lists"
-    end
+    fail 'missing Repository for obtaining feature lists' unless @repository
+
+    refresh! if @auto_refresh || @perform_initial_refresh
 
     @active_features.include?(feature)
   end
@@ -68,7 +71,7 @@ module Feature
   # @return [Boolean]
   #
   def self.inactive?(feature)
-    !self.active?(feature)
+    !active?(feature)
   end
 
   # Execute the given block if feature is active
@@ -76,9 +79,7 @@ module Feature
   # @param [Symbol] feature
   #
   def self.with(feature)
-    if !block_given?
-      raise ArgumentError, "no block given to #{__method__}"
-    end
+    fail ArgumentError, "no block given to #{__method__}" unless block_given?
 
     yield if active?(feature)
   end
@@ -88,9 +89,7 @@ module Feature
   # @param [Symbol] feature
   #
   def self.without(feature)
-    if !block_given?
-      raise ArgumentError, "no block given to #{__method__}"
-    end
+    fail ArgumentError, "no block given to #{__method__}" unless block_given?
 
     yield if inactive?(feature)
   end
@@ -98,14 +97,14 @@ module Feature
   # Return value or execute Proc/lambda depending on Feature status.
   #
   # @param [Symbol] feature
-  # @param [Object] value to be returned / lambda to be evaluated if feature is active
-  # @param [Object] value to be returned / lambda to be evaluated if feature is inactive
+  # @param [Object] value / lambda to use if feature is active
+  # @param [Object] value / lambda to use if feature is inactive
   #
   def self.switch(feature, l1, l2)
     if active?(feature)
-      l1.is_a?(Proc) ? l1.call : l1
+      l1.instance_of?(Proc) ? l1.call : l1
     else
-      l2.is_a?(Proc) ? l2.call : l2
+      l2.instance_of?(Proc) ? l2.call : l2
     end
   end
 end

data/lib/feature/generators/install_generator.rb

@@ -1,33 +1,24 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-require 'rails/generators/active_record'
+if defined?(Rails) && Rails::VERSION::STRING > '3'
+  require 'rails/generators'
 
-module Feature
-  class InstallGenerator < Rails::Generators::Base
-    include Rails::Generators::Migration
-    extend Rails::Generators::Migration
+  module Feature
+    # Rails generator for generating feature ActiveRecord model
+    # and migration step for creating the table
+    class InstallGenerator < Rails::Generators::Base
+      desc 'This generator creates a migration and a model for FeatureToggles.'
+      source_root File.expand_path('../templates', __FILE__)
 
-    desc 'This generator creates a migration and a model for FeatureToggles.'
-    source_root File.expand_path('../templates', __FILE__)
-
-    def create_model_file
-      template 'feature.rb', 'config/initializers/feature.rb'
-      template appropriate_feature_toggle_rb, 'app/models/feature_toggle.rb'
-      migration_template 'create_feature_toggles.rb', 'db/migrate/create_feature_toggles.rb'
-    end
-
-    def self.next_migration_number(path)
-      ActiveRecord::Generators::Base.next_migration_number(path)
-    end
-
-    private
+      def generate_model
+        generate :model, 'feature_toggle name:string active:boolean'
+        inject_into_class 'app/models/feature_toggle.rb', 'FeatureToggle' do
+          "  attr_accessible :name, :active if ActiveRecord::Base.respond_to? :attr_accessible\n"\
+          "  # Feature name should be present and unique\n"\
+          "  validates :name, presence: true, uniqueness: true\n"
+        end
+      end
 
-    def appropriate_feature_toggle_rb
-      # For Rails 4 + protected_attributes or Rails 3, we prefer the model with `attr_accessible` pre-populated
-      if ActiveRecord::Base.respond_to? :attr_accessible
-        'feature_toggle.rb'
-      else
-        'feature_toggle_without_attr_accessible.rb'
+      def generate_initializer
+        template 'feature.rb', 'config/initializers/feature.rb'
       end
     end
   end

data/lib/feature/repository.rb

@@ -4,5 +4,6 @@ module Feature
     require 'feature/repository/simple_repository'
     require 'feature/repository/yaml_repository'
     require 'feature/repository/active_record_repository'
+    require 'feature/repository/redis_repository'
   end
 end

data/lib/feature/repository/active_record_repository.rb

@@ -3,7 +3,7 @@ module Feature
     # AcitveRecordRepository for active feature list
     # Right now we assume you have at least name:string and active:boolean
     # defined in your table.
-    # 
+    #
     # Example usage:
     #   repository = ActiveRecordRepository.new(FeatureToggle)
     #   repository.add_active_feature(:feature_name)
@@ -31,7 +31,7 @@ module Feature
       def add_active_feature(feature)
         check_feature_is_not_symbol(feature)
         check_feature_already_in_list(feature)
-        @model.new(name: feature.to_s, active: true).save
+        @model.create!(name: feature.to_s, active: true)
       end
 
       # Checks if the given feature is a not symbol and raises an exception if so
@@ -39,9 +39,7 @@ module Feature
       # @param [Sybmol] feature the feature to be checked
       #
       def check_feature_is_not_symbol(feature)
-        if !feature.is_a?(Symbol)
-          raise ArgumentError, "given feature #{feature} is not a symbol"
-        end
+        fail ArgumentError, "#{feature} is not a symbol" unless feature.instance_of?(Symbol)
       end
       private :check_feature_is_not_symbol
 
@@ -51,9 +49,7 @@ module Feature
       # @param [Symbol] feature the feature to be checked
       #
       def check_feature_already_in_list(feature)
-        if @model.exists?(feature.to_s)
-          raise ArgumentError, "feature :#{feature} already added to list of active features"
-        end
+        fail ArgumentError, "feature :#{feature} already added" if @model.exists?(feature.to_s)
       end
       private :check_feature_already_in_list
     end

data/lib/feature/repository/redis_repository.rb

@@ -0,0 +1,59 @@
+module Feature
+  module Repository
+    # RedisRepository for active feature list
+    #
+    # Example usage:
+    #   repository = RedisRepository.new("feature_toggles")
+    #   repository.add_active_feature(:feature_name)
+    #
+    # 'feature_toggles' can be whatever name you want to use for
+    # the Redis hash that will store all of your feature toggles.
+    #
+    class RedisRepository
+      # Constructor
+      #
+      # @param redis_key the key of the redis hash where all the toggles will be stored
+      #
+      def initialize(redis_key)
+        @redis_key = redis_key
+      end
+
+      # Returns list of active features
+      #
+      # @return [Array<Symbol>] list of active features
+      #
+      def active_features
+        Redis.current.hgetall(@redis_key).select { |_k, v| v.to_s == 'true' }.map { |k, _v| k.to_sym }
+      end
+
+      # Add an active feature to repository
+      #
+      # @param [Symbol] feature the feature to be added
+      #
+      def add_active_feature(feature)
+        check_feature_is_not_symbol(feature)
+        check_feature_already_in_list(feature)
+        Redis.current.hset(@redis_key, feature, true)
+      end
+
+      # Checks that given feature is a symbol, raises exception otherwise
+      #
+      # @param [Sybmol] feature the feature to be checked
+      #
+      def check_feature_is_not_symbol(feature)
+        fail ArgumentError, "#{feature} is not a symbol" unless feature.instance_of?(Symbol)
+      end
+      private :check_feature_is_not_symbol
+
+      # Checks if given feature is already added to list of active features
+      # and raises an exception if so
+      #
+      # @param [Symbol] feature the feature to be checked
+      #
+      def check_feature_already_in_list(feature)
+        fail ArgumentError, "feature :#{feature} already added" if Redis.current.hexists(@redis_key, feature)
+      end
+      private :check_feature_already_in_list
+    end
+  end
+end

data/lib/feature/repository/simple_repository.rb

@@ -1,7 +1,8 @@
 module Feature
   module Repository
     # SimpleRepository for active feature list
-    # Simply add features to that should be active, no config or data sources required
+    # Simply add features to that should be active,
+    # no config or data sources required.
     #
     # Example usage:
     #   repository = SimpleRepository.new
@@ -33,14 +34,12 @@ module Feature
         @active_features << feature
       end
 
-      # Checks if the given feature is a not symbol and raises an exception if so
+      # Checks that given feature is a symbol, raises exception otherwise
       #
       # @param [Sybmol] feature the feature to be checked
       #
       def check_feature_is_not_symbol(feature)
-        if !feature.is_a?(Symbol)
-          raise ArgumentError, "given feature #{feature} is not a symbol"
-        end
+        fail ArgumentError, "#{feature} is not a symbol" unless feature.instance_of?(Symbol)
       end
       private :check_feature_is_not_symbol
 
@@ -50,9 +49,7 @@ module Feature
       # @param [Symbol] feature the feature to be checked
       #
       def check_feature_already_in_list(feature)
-        if @active_features.include?(feature)
-          raise ArgumentError, "feature :#{feature} already added to list of active features"
-        end
+        fail ArgumentError, "feature :#{feature} already added" if @active_features.include?(feature)
       end
       private :check_feature_already_in_list
     end