feature 0.2.1

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.2.1 (2011-11-22)
+
+* refactored gemspec
+
+## 0.2.0 (2011-11-22)
+
+* add yaml config file repository
+
+## 0.1.0 (2011-11-18)
+
+* first version with basic functionality and simple feature repository

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem "rake"
+gem "rspec"

data/README.md

@@ -0,0 +1,26 @@
+# Feature
+
+Feature is a [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.
+With this approach Feature is higly configurable and not bound to a specific kind of configuration.
+
+## Installation
+
+        gem install feature
+
+## Example usage
+
+        require 'feature'
+
+        repo = Feature::Repository::SimpleRepository.new
+        repo.add_active_feature :be_nice
+
+        Feature.set_repository repo
+
+        Feature.active?(:be_nice)
+        # => true
+
+        Feature.with(:be_nice) do
+          puts "you can read this"
+        end

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--colour', '-f documentation', '--backtrace']
+end
+
+task :default => [:spec] do
+end

data/lib/feature.rb

@@ -0,0 +1,90 @@
+##
+# Feature module provides all methods
+#  - to set a feature repository
+#  - to check if a feature (represented by a symbol) is acitve or inactive
+#  - for conditional block execution with or without a feature
+#  - to refresh the feature lists (request them from repository)
+#
+module Feature
+  require 'feature/repository'
+
+  @repository = nil
+  @active_features = nil
+  @inactive_features = nil
+
+  ##
+  # Set the feature repository
+  #
+  #   @param    Feature::Repository::AbstractRepository, repository
+  #
+  def self.set_repository(repository)
+    if !repository.is_a?(Feature::Repository::AbstractRepository)
+      raise ArgumentError, "given argument is not a repository"
+    end
+
+    @repository = repository
+    refresh!
+  end
+
+  ##
+  # Obtains list of active and inactive features from repository
+  #
+  def self.refresh!
+    @active_features = @repository.active_features
+    @inactive_features = @repository.inactive_features
+  end
+
+  ##
+  # Requests if feature is active
+  #
+  #   @param    Symbol, feature
+  #   @return   Boolean
+  #
+  def self.active?(feature)
+    if !@repository
+      raise "Feature is missing Repository for obtaining feature lists"
+    end
+
+    @active_features.include?(feature)
+  end
+
+  ##
+  # Requests if feature is inactive
+  #
+  #   @param    Symbol, feature
+  #   @return   Boolean
+  #
+  def self.inactive?(feature)
+    if !@repository
+      raise "Feature is missing Repository for obtaining feature lists"
+    end
+
+    @inactive_features.include?(feature)
+  end
+
+  ##
+  # Execute the given block if feature is active
+  #
+  def self.with(feature)
+    if !block_given?
+      raise ArgumentError, "no block given to #{__method__}"
+    end
+
+    if active?(feature)
+      yield
+    end
+  end
+
+  ##
+  # Execute the given block if feature is inactive
+  #
+  def self.without(feature)
+    if !block_given?
+      raise ArgumentError, "no block given to #{__method__}"
+    end
+
+    if inactive?(feature)
+      yield
+    end
+  end
+end

data/lib/feature/repository.rb

@@ -0,0 +1,7 @@
+module Feature
+  module Repository
+    require 'feature/repository/abstract_repository'
+    require 'feature/repository/simple_repository'
+    require 'feature/repository/yaml_repository'
+  end
+end

data/lib/feature/repository/abstract_repository.rb

@@ -0,0 +1,37 @@
+module Feature
+  module Repository
+    ##
+    # Abstract class for subclassing and building repository classes which
+    # provide lists of active and inactive features
+    #
+    class AbstractRepository
+
+      ##
+      # Constructor
+      #
+      # Should be overridden in derived class to initialize repository with all data needed
+      #
+      def initialize
+        raise "abstract class #{self.class.name}!"
+      end
+
+      ##
+      # Returns list of active features
+      #
+      #   @return   Array<Symbol>
+      #
+      def active_features
+        raise "#{__method__} has to be overridden in derived class"
+      end
+
+      ##
+      # Returns list of inactive features
+      #
+      #   @return   Array<Symbol>
+      #
+      def inactive_features
+        raise "#{__method__} has to be overridden in derived class"
+      end
+    end
+  end
+end

data/lib/feature/repository/simple_repository.rb

@@ -0,0 +1,86 @@
+module Feature
+  module Repository
+    ##
+    # SimpleRepository for active and inactive feature list
+    # Simply add features to both lists, not config or data sources required
+    #
+    class SimpleRepository < AbstractRepository
+      ##
+      # Constructor
+      #
+      def initialize
+        @active_features = []
+        @inactive_features = []
+      end
+
+      ##
+      # Returns list of active features
+      #
+      #   @return   Array<Symbol>
+      #
+      def active_features
+        @active_features.dup
+      end
+
+      ##
+      # Returns list of inactive features
+      #
+      #   @return   Array<Symbol>
+      #
+      def inactive_features
+        @inactive_features.dup
+      end
+
+      ##
+      # Add an active feature
+      #
+      #   @param    Sybmol, feature
+      #
+      def add_active_feature(feature)
+        check_feature_is_symbol(feature)
+        check_feature_already_in_lists(feature)
+        @active_features << feature
+      end
+
+      ##
+      # Add an inactive feature
+      #
+      #   @param    Sybmol, feature
+      #
+      def add_inactive_feature(feature)
+        check_feature_is_symbol(feature)
+        check_feature_already_in_lists(feature)
+        @inactive_features << feature
+      end
+
+      ##
+      # Checks if the given feature is a symbol and raises and raises an exception if so
+      #
+      #   @param    Sybmol, feature
+      #
+      def check_feature_is_symbol(feature)
+        if !feature.is_a?(Symbol)
+          raise ArgumentError, "given feature #{feature} is not a symbol"
+        end
+      end
+      private :check_feature_is_symbol
+
+      ##
+      # Checks if given feature is already added to list of active or inactive features
+      # and raises an exception if so
+      #
+      #   @param    Symbol, feature
+      #
+      def check_feature_already_in_lists(feature)
+        if @active_features.include?(feature)
+          raise ArgumentError, "feature :#{feature} already added to list of active features"
+        end
+
+        if @inactive_features.include?(feature)
+          raise ArgumentError, "feature :#{feature} already added to list of inactive features"
+        end
+      end
+      private :check_feature_already_in_lists
+    end
+  end
+end

data/lib/feature/repository/yaml_repository.rb

@@ -0,0 +1,81 @@
+module Feature
+  module Repository
+    ##
+    # YamlRepository for active and inactive feature list
+    # The yaml config file should look like this:
+    #
+    #     features:
+    #         an_active_feature: true
+    #         an_inactive_feature: false
+    #
+    class YamlRepository < AbstractRepository
+      require 'yaml'
+
+      ##
+      # Constructor
+      #
+      #   @param    String, yaml_file_name
+      #
+      def initialize(yaml_file_name)
+        @yaml_file_name = yaml_file_name
+      end
+
+      ##
+      # Returns list of active features
+      #
+      #   @return   Array<Symbol>
+      #
+      def active_features
+        get_active_features_from_file
+      end
+
+      ##
+      # Return a list of active features read from the config file
+      #
+      #   @return   Array<Symbol>
+      #
+      def get_active_features_from_file
+        features_hash = read_and_parse_file_data
+        features = features_hash.keys.select { |feature_key| features_hash[feature_key] }
+        features.sort.map(&:to_sym)
+      end
+      private :get_active_features_from_file
+
+      ##
+      # Returns list of inactive features
+      #
+      #   @return   Array<Symbol>
+      #
+      def inactive_features
+        get_inactive_features_from_file
+      end
+
+      ##
+      # Return a list of inactive features read from the config file
+      #
+      #   @return   Array<Symbol>
+      #
+      def get_inactive_features_from_file
+        features_hash = read_and_parse_file_data
+        features = features_hash.keys.select { |feature_key| !features_hash[feature_key] }
+        features.sort.map(&:to_sym)
+      end
+      private :get_inactive_features_from_file
+
+      ##
+      # Read and parses the feature config file
+      #
+      #   @return   Hash (with :feature => true/false meaning active/inactive)
+      #
+      def read_and_parse_file_data
+        raw_data = File.read(@yaml_file_name)
+        data = YAML.load(raw_data)
+        if !data.is_a?(Hash) or !data.has_key?('features')
+          raise ArgumentError, "content of #{@yaml_file_name} does not contain proper config"
+        end
+        data['features']
+      end
+      private :read_and_parse_file_data
+    end
+  end
+end

data/spec/feature/abstract_repository_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Feature::Repository::AbstractRepository do
+  it "should raise error on creating a new instance" do
+    lambda do
+      Feature::Repository::AbstractRepository.new
+    end.should raise_error("abstract class Feature::Repository::AbstractRepository!")
+  end
+end

data/spec/feature/feature_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+describe Feature do
+  context "without FeatureRepository" do
+    it "should raise an exception when calling active?" do
+      lambda do
+        Feature.active?(:feature_a)
+      end.should raise_error("Feature is missing Repository for obtaining feature lists")
+    end
+
+    it "should raise an exception when calling inactive?" do
+      lambda do
+        Feature.inactive?(:feature_a)
+      end.should raise_error("Feature is missing Repository for obtaining feature lists")
+    end
+
+    it "should raise an exception when calling with" do
+      lambda do
+        Feature.with(:feature_a) do
+        end
+      end.should raise_error("Feature is missing Repository for obtaining feature lists")
+    end
+
+    it "should raise an exception when calling without" do
+      lambda do
+        Feature.without(:feature_a) do
+        end
+      end.should raise_error("Feature is missing Repository for obtaining feature lists")
+    end
+  end
+
+  context "setting Repository" do
+    before(:each) do
+      @repository = Feature::Repository::SimpleRepository.new
+      Feature.set_repository @repository
+    end
+
+    it "should raise an exception when add repository with wrong class" do
+      lambda do
+        Feature.set_repository("not a repository")
+      end.should raise_error(ArgumentError, "given argument is not a repository")
+    end
+
+    it "should set a feature repository" do
+      lambda do
+        Feature.active?(:feature_a)
+      end.should_not raise_error
+
+      lambda do
+        Feature.inactive?(:feature_a)
+      end.should_not raise_error
+    end
+
+    it "should get active features from repository once" do
+      @repository.add_active_feature(:feature_a)
+      Feature.active?(:feature_a).should be_false
+    end
+
+    it "should get inactive features from repository once" do
+      @repository.add_inactive_feature(:feature_a)
+      Feature.inactive?(:feature_a).should be_false
+    end
+  end
+
+  context "refresh features" do
+    before(:each) do
+      @repository = Feature::Repository::SimpleRepository.new
+      Feature.set_repository @repository
+    end
+
+    it "should refresh active feature lists from repository" do
+      @repository.add_active_feature(:feature_a)
+      Feature.refresh!
+      Feature.active?(:feature_a).should be_true
+    end
+
+    it "should refresh inactive feature lists from repository" do
+      @repository.add_inactive_feature(:feature_a)
+      Feature.refresh!
+      Feature.inactive?(:feature_a).should be_true
+    end
+  end
+
+  context "request features" do
+    before(:each) do
+      repository = Feature::Repository::SimpleRepository.new
+      repository.add_active_feature :feature_active
+      repository.add_inactive_feature :feature_inactive
+      Feature.set_repository repository
+    end
+
+    it "should affirm active feature is active" do
+      Feature.active?(:feature_active).should be_true
+    end
+
+    it "should not affirm active feature is inactive" do
+      Feature.inactive?(:feature_active).should be_false
+    end
+
+    it "should affirm inactive feature is inactive" do
+      Feature.inactive?(:feature_inactive).should be_true
+    end
+
+    it "should not affirm inactive feature is active" do
+      Feature.active?(:feature_inactive).should be_false
+    end
+
+    it "should call block with active feature in active list" do
+      reached = false
+
+      Feature.with(:feature_active) do
+        reached = true
+      end
+
+      reached.should be_true
+    end
+
+    it "should not call block with active feature not in active list" do
+      reached = false
+
+      Feature.with(:feature_inactive) do
+        reached = true
+      end
+
+      reached.should be_false
+    end
+
+    it "should raise exception when no block given to with" do
+      lambda do
+        Feature.with(:feature_active)
+      end.should raise_error(ArgumentError, "no block given to with")
+    end
+
+    it "should call block without inactive feature in inactive list" do
+      reached = false
+
+      Feature.without(:feature_inactive) do
+        reached = true
+      end
+
+      reached.should be_true
+    end
+
+    it "should not call block without inactive feature in inactive list" do
+      reached = false
+
+      Feature.without(:feature_active) do
+        reached = true
+      end
+
+      reached.should be_false
+    end
+
+    it "should raise exception when no block given to without" do
+      lambda do
+        Feature.without(:feature_inactive)
+      end.should raise_error(ArgumentError, "no block given to without")
+    end
+
+  end
+end

data/spec/feature/simple_repository_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+include Feature::Repository
+
+describe Feature::Repository::SimpleRepository do
+  before(:each) do
+    @repository = SimpleRepository.new
+  end
+
+  it "should have no active features after initialization" do
+    @repository.active_features.should == []
+  end
+
+  it "should have no inactive features after initialization" do
+    @repository.inactive_features.should == []
+  end
+
+  it "should add an active feature" do
+    @repository.add_active_feature :feature_a
+    @repository.active_features.should == [:feature_a]
+  end
+
+  it "should raise an exception when adding not a symbol as active feature" do
+    lambda do
+      @repository.add_active_feature 'feature_a'
+    end.should 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
+    @repository.add_active_feature :feature_a
+    lambda do
+      @repository.add_active_feature :feature_a
+    end.should raise_error(ArgumentError, "feature :feature_a already added to list of active features")
+  end
+
+  it "should raise an exception when adding a active feature already added as inactive" do
+    @repository.add_inactive_feature :feature_a
+    lambda do
+      @repository.add_active_feature :feature_a
+    end.should raise_error(ArgumentError, "feature :feature_a already added to list of inactive features")
+  end
+
+  it "should add an inactive feature" do
+    @repository.add_inactive_feature :feature_a
+    @repository.inactive_features.should == [:feature_a]
+  end
+
+  it "should raise an exception when adding not a symbol as inactive feature" do
+    lambda do
+      @repository.add_inactive_feature 'feature_a'
+    end.should raise_error(ArgumentError, "given feature feature_a is not a symbol")
+  end
+
+  it "should raise an exception when adding a inactive feature already added as inactive" do
+    @repository.add_inactive_feature :feature_a
+    lambda do
+      @repository.add_inactive_feature :feature_a
+    end.should raise_error(ArgumentError, "feature :feature_a already added to list of inactive features")
+  end
+
+  it "should raise an exception when adding a inactive feature already added as active" do
+    @repository.add_active_feature :feature_a
+    lambda do
+      @repository.add_inactive_feature :feature_a
+    end.should raise_error(ArgumentError, "feature :feature_a already added to list of active features")
+  end
+end

data/spec/feature/yaml_repository_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'tempfile'
+
+include Feature::Repository
+
+describe Feature::Repository::YamlRepository do
+  context "proper config file" do
+    before(:each) do
+      @filename = Tempfile.new(['feature_config', '.yaml']).path
+      fp = File.new(@filename, 'w')
+      fp.write <<"EOF";
+features:
+    feature_a_active: true
+    feature_b_active: true
+    feature_c_inactive: false
+    feature_d_inactive: false
+EOF
+      fp.close
+
+      @repo = YamlRepository.new(@filename)
+    end
+
+    after(:each) do
+      File.delete(@filename)
+    end
+
+    it "should read active features from a config file" do
+      @repo.active_features.should == [:feature_a_active, :feature_b_active]
+    end
+
+    it "should read inactive features from a config file" do
+      @repo.inactive_features.should == [:feature_c_inactive, :feature_d_inactive]
+    end
+
+    context "re-read config file" do
+      before(:each) do
+        fp = File.new(@filename, 'w')
+        fp.write <<"EOF";
+features:
+    feature_a_active: true
+    feature_c_inactive: false
+EOF
+        fp.close
+      end
+
+      it "should read active features new on each request" do
+        @repo.active_features.should == [:feature_a_active]
+      end
+
+      it "should read inactive features new on each request" do
+        @repo.inactive_features.should == [:feature_c_inactive]
+      end
+    end
+  end
+
+  it "should raise exception on no file found" do
+    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
+
+  it "should raise exception on invalid yaml" do
+    @filename = Tempfile.new(['feature_config', '.yaml']).path
+    fp = File.new(@filename, 'w')
+    fp.write "this is not valid feature config"
+    fp.close
+
+    repo = YamlRepository.new(@filename)
+    lambda do
+      repo.active_features
+    end.should raise_error(ArgumentError, "content of #{@filename} does not contain proper config")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "pathname"
+require 'pp'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+SPEC_ROOT = Pathname(__FILE__).dirname.expand_path
+
+require SPEC_ROOT.parent + 'lib/feature'

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: feature
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Markus Gerdes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-22 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: github@mgsnova.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/feature.rb
+- lib/feature/repository/simple_repository.rb
+- lib/feature/repository/abstract_repository.rb
+- lib/feature/repository/yaml_repository.rb
+- lib/feature/repository.rb
+- spec/feature/simple_repository_spec.rb
+- spec/feature/yaml_repository_spec.rb
+- spec/feature/abstract_repository_spec.rb
+- spec/feature/feature_spec.rb
+- spec/spec_helper.rb
+- Rakefile
+- Gemfile
+- README.md
+- CHANGELOG.md
+has_rdoc: true
+homepage: http://github.com/mgsnova/feature
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Feature Toggle library for ruby
+test_files: []
+