feature 0.6.0 → 0.7.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.0 (2013-12-07)
+
+* add ActiveRecordRepository and a Rails::Generator (bigzed)
+
 ## 0.6.0 (2013-03-24)
 
 * add capability for easier testing of activated or deactivated features

data/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gem "rake"
 gem "rspec"
+gem "rspec-mocks"
 
 group :test do
   gem 'coveralls', :require => false

data/README.md

@@ -73,7 +73,7 @@ With this approach Feature is higly configurable and not bound to a specific kin
 ### Rails using YamlRepository
 
         # File: Gemfile
-        gem 'feature' # Or with version specifier, e.g. '~> 0.6.0'
+        gem 'feature' # Or with version specifier, e.g. '~> 0.7.0'
 
         # File: config/feature.yml
         features:
@@ -88,3 +88,27 @@ With this approach Feature is higly configurable and not bound to a specific kin
         <% if Feature.active?(:an_active_feature) %>
           <%# Feature implementation goes here %>
         <% end %>
+
+
+### Rails using ActiveRecordRepository
+
+        # File: Gemfile
+        gem 'feature' # Or with version specifier, e.g. '~> 0.7.0'
+
+        # Run generator and migrations
+        $ rails g feature:install
+        $ rake db:migrate
+
+        # Add Features to table FeaturesToggle for example in
+        # File: db/schema.rb
+        FeatureToggle.new(name: "ActiveFeature", active: true)
+        FeatureToggle.new(name: "InActiveFeature", active: false)
+
+        # or in initializer
+        # File: config/initializers/feature.rb
+        repo.add_active_feature(:active_feature)
+
+        # File: app/views/example/index.html.erb
+        <% if Feature.active?(:an_active_feature) %>
+          <%# Feature implementation goes here %>
+        <% end %>

data/lib/feature.rb

@@ -22,6 +22,8 @@
 #
 module Feature
   require 'feature/repository'
+  # Only load the generator if Rails is defined
+  require 'feature/generators/install_generator' if defined?(Rails)
 
   @repository = nil
   @active_features = nil

data/lib/feature/generators/install_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module Feature
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+
+    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 'feature_toggle.rb', 'app/models/feature_toggle.rb'
+      migration_template 'create_feature_toggles.rb', 'db/migrate/create_feature_toggles.rb'
+    end
+  end
+end

data/lib/feature/generators/templates/create_feature_toggles.rb

@@ -0,0 +1,10 @@
+class CreateFeatureToggles < ActiveRecord::Migration
+  def change
+    create_table :feature_toggles do |t|
+      t.string :name
+      t.boolean :active
+
+      t.timestamps
+    end
+  end
+end

data/lib/feature/generators/templates/feature.rb

@@ -0,0 +1,5 @@
+# Set repository to ActiveRecord
+if FeatureToggle.table_exists?
+  repo = Feature::Repository::ActiveRecordRepository.new(FeatureToggle)
+  Feature.set_repository(repo)
+end

data/lib/feature/generators/templates/feature_toggle.rb

@@ -0,0 +1,6 @@
+class FeatureToggle < ActiveRecord::Base
+  attr_accessible :name, :active
+
+  # Feature name should be present and unique
+  validates :name, :presence => true, :uniqueness => true
+end

data/lib/feature/repository.rb

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

data/lib/feature/repository/active_record_repository.rb

@@ -0,0 +1,61 @@
+module Feature
+  module Repository
+    # 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)
+    #   # use repository with Feature
+    #
+    class ActiveRecordRepository
+      # Constructor
+      #
+      def initialize(model)
+        @model = model
+      end
+
+      # Returns list of active features
+      #
+      # @return [Array<Symbol>] list of active features
+      #
+      def active_features
+        @model.where(:active => true).map { |f| f.name.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)
+        @model.new(:name => feature.to_s, :active => true).save
+      end
+
+      # Checks if the given feature is a not symbol and raises an exception if so
+      #
+      # @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
+      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)
+        if @model.exists?(feature.to_s)
+          raise ArgumentError, "feature :#{feature} already added to list of active features"
+        end
+      end
+      private :check_feature_already_in_list
+    end
+  end
+end

data/spec/feature/active_record_repository_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+include Feature::Repository
+
+describe Feature::Repository::ActiveRecordRepository do
+  before(:each) do
+    # Mock the model
+    @features = double("FeatureToggle")
+    @repository = ActiveRecordRepository.new(@features)
+  end
+
+  it "should have no active features after initialization" do
+    @features.stub(:where) { Hash.new }
+
+    @repository.active_features.should == []
+  end
+
+  it "should add an active feature" do
+    @features.should_receive(:exists?).with("feature_a").and_return(false)
+    @features.should_receive(:new).with(:name => "feature_a",:active => true).and_return(stub(:save => true))
+
+    @repository.add_active_feature :feature_a
+  end
+
+  it "should raise an exception when adding not a symbol as active feature" do
+    expect {
+      @repository.add_active_feature 'feature_a'
+    }.to raise_error(ArgumentError, "given feature feature_a is not a symbol")
+  end
+
+  it "should raise an exception when adding a active feature already added as active" do
+    @features.should_receive(:new).with(:name => "feature_a",:active => true).and_return(stub(:save => true))
+    @features.stub(:exists?).and_return(false,true)
+
+    @repository.add_active_feature :feature_a
+    expect {
+      @repository.add_active_feature :feature_a
+    }.to raise_error(ArgumentError, "feature :feature_a already added to list of active features")
+  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 -/)
+    end.should raise_error(Errno::ENOENT, /No such file or directory/)
   end
 
   it "should raise exception on invalid yaml" do

metadata

@@ -1,37 +1,33 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: feature
-version: !ruby/object:Gem::Version 
-  hash: 7
+version: !ruby/object:Gem::Version
+  version: 0.7.0
   prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 0
-  version: 0.6.0
 platform: ruby
-authors: 
+authors:
 - Markus Gerdes
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-24 00:00:00 Z
+date: 2013-12-07 00:00:00.000000000 Z
 dependencies: []
-
 description: 
 email: github@mgsnova.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/feature.rb
+- lib/feature/generators/install_generator.rb
+- lib/feature/generators/templates/create_feature_toggles.rb
+- lib/feature/generators/templates/feature.rb
+- lib/feature/generators/templates/feature_toggle.rb
 - lib/feature/repository.rb
+- lib/feature/repository/active_record_repository.rb
 - lib/feature/repository/simple_repository.rb
 - lib/feature/repository/yaml_repository.rb
 - lib/feature/testing.rb
+- spec/feature/active_record_repository_spec.rb
 - spec/feature/feature_spec.rb
 - spec/feature/simple_repository_spec.rb
 - spec/feature/testing_spec.rb
@@ -43,37 +39,26 @@ 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 
-      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: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Feature Toggle library for ruby
 test_files: []
-
-has_rdoc: