feature 0.2.1 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.0 (2011-11-23)
+
+* assume all features as inactive that are not active, also unknown ones
+* make yaml parsing in yaml repository more strict
+
 ## 0.2.1 (2011-11-22)
 
 * refactored gemspec

data/README.md

@@ -5,6 +5,10 @@ Feature is a [feature toggle](http://martinfowler.com/bliki/FeatureToggle.html)
 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.
 
+## CI status
+
+[![Travis-CI Build Status](https://secure.travis-ci.org/mgsnova/feature.png)](https://secure.travis-ci.org/mgsnova/feature)
+
 ## Installation
 
         gem install feature

data/lib/feature/repository/abstract_repository.rb

@@ -1,12 +1,9 @@
 module Feature
   module Repository
-    ##
     # Abstract class for subclassing and building repository classes which
-    # provide lists of active and inactive features
+    # provide lists of active features
     #
     class AbstractRepository
-
-      ##
       # Constructor
       #
       # Should be overridden in derived class to initialize repository with all data needed
@@ -15,23 +12,13 @@ module Feature
         raise "abstract class #{self.class.name}!"
       end
 
-      ##
       # Returns list of active features
       #
-      #   @return   Array<Symbol>
+      # @return [Array<Symbol>] list of active features
       #
       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

@@ -1,86 +1,55 @@
 module Feature
   module Repository
-    ##
-    # SimpleRepository for active and inactive feature list
-    # Simply add features to both lists, not config or data sources required
+    # SimpleRepository for active feature list
+    # Simply add features to that should be active, no config or data sources required
     #
     class SimpleRepository < AbstractRepository
-      ##
       # Constructor
       #
       def initialize
         @active_features = []
-        @inactive_features = []
       end
 
-      ##
       # Returns list of active features
       #
-      #   @return   Array<Symbol>
+      # @return [Array<Symbol>] list of active features
       #
       def active_features
         @active_features.dup
       end
 
-      ##
-      # Returns list of inactive features
+      # Add an active feature to repository
       #
-      #   @return   Array<Symbol>
-      #
-      def inactive_features
-        @inactive_features.dup
-      end
-
-      ##
-      # Add an active feature
-      #
-      #   @param    Sybmol, feature
+      # @param [Symbol] feature the feature to be added
       #
       def add_active_feature(feature)
-        check_feature_is_symbol(feature)
-        check_feature_already_in_lists(feature)
+        check_feature_is_not_symbol(feature)
+        check_feature_already_in_list(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
+      # Checks if the given feature is a not symbol and raises an exception if so
       #
-      #   @param    Sybmol, feature
+      # @param [Sybmol] feature the feature to be checked
       #
-      def check_feature_is_symbol(feature)
+      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_symbol
+      private :check_feature_is_not_symbol
 
-      ##
-      # Checks if given feature is already added to list of active or inactive features
+      # Checks if given feature is already added to list of active features
       # and raises an exception if so
       #
-      #   @param    Symbol, feature
+      # @param [Symbol] feature the feature to be checked
       #
-      def check_feature_already_in_lists(feature)
+      def check_feature_already_in_list(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
+      private :check_feature_already_in_list
     end
   end
 end

data/lib/feature/repository/yaml_repository.rb

@@ -1,78 +1,50 @@
 module Feature
   module Repository
-    ##
-    # YamlRepository for active and inactive feature list
+    # YamlRepository for active and inactive features
     # The yaml config file should look like this:
     #
-    #     features:
-    #         an_active_feature: true
-    #         an_inactive_feature: false
+    #   features:
+    #       an_active_feature: true
+    #       an_inactive_feature: false
     #
     class YamlRepository < AbstractRepository
       require 'yaml'
 
-      ##
       # Constructor
       #
-      #   @param    String, yaml_file_name
+      # @param [String] yaml_file_name the yaml config filename
       #
       def initialize(yaml_file_name)
         @yaml_file_name = yaml_file_name
       end
 
-      ##
       # Returns list of active features
       #
-      #   @return   Array<Symbol>
+      # @return [Array<Symbol>] list of active features
       #
       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)
+      # @return [Hash] Hash containing :feature => true/false entries for representing active/inactive features
       #
       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
+
+        invalid_value = data['features'].values.detect { |value| ![true, false].include?(value) }
+        if invalid_value
+          raise ArgumentError, "#{invalid_value} is not allowed value in config, use true/false"
+        end
+
         data['features']
       end
       private :read_and_parse_file_data

data/lib/feature/repository.rb

@@ -1,4 +1,5 @@
 module Feature
+  # Module for holding feature repositories
   module Repository
     require 'feature/repository/abstract_repository'
     require 'feature/repository/simple_repository'

data/lib/feature.rb

@@ -1,21 +1,20 @@
-##
 # 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)
+# - to set a feature repository
+# - to check if a feature (represented by a symbol) is active or inactive
+# - for conditional block execution with or without a feature
+# - to refresh the feature lists (request them from repository)
+#
+# @note all features not active will be handled has inactive
 #
 module Feature
   require 'feature/repository'
 
   @repository = nil
   @active_features = nil
-  @inactive_features = nil
 
-  ##
   # Set the feature repository
   #
-  #   @param    Feature::Repository::AbstractRepository, repository
+  # @param [Feature::Repository::AbstractRepository] repository the repository to get the features from
   #
   def self.set_repository(repository)
     if !repository.is_a?(Feature::Repository::AbstractRepository)
@@ -26,19 +25,17 @@ module Feature
     refresh!
   end
 
-  ##
-  # Obtains list of active and inactive features from repository
+  # Obtains list of active 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
+  # @param [Symbol] feature
+  # @return [Boolean]
   #
   def self.active?(feature)
     if !@repository
@@ -48,23 +45,19 @@ module Feature
     @active_features.include?(feature)
   end
 
-  ##
-  # Requests if feature is inactive
+  # Requests if feature is inactive (or unknown)
   #
-  #   @param    Symbol, feature
-  #   @return   Boolean
+  # @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)
+    !self.active?(feature)
   end
 
-  ##
   # Execute the given block if feature is active
   #
+  # @param [Symbol] feature
+  #
   def self.with(feature)
     if !block_given?
       raise ArgumentError, "no block given to #{__method__}"
@@ -75,9 +68,10 @@ module Feature
     end
   end
 
-  ##
   # Execute the given block if feature is inactive
   #
+  # @param [Symbol] feature
+  #
   def self.without(feature)
     if !block_given?
       raise ArgumentError, "no block given to #{__method__}"

data/spec/feature/feature_spec.rb

@@ -55,11 +55,6 @@ describe Feature 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
@@ -73,19 +68,12 @@ describe Feature do
       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
 

data/spec/feature/simple_repository_spec.rb

@@ -11,10 +11,6 @@ describe Feature::Repository::SimpleRepository 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]
@@ -32,36 +28,4 @@ describe Feature::Repository::SimpleRepository 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

@@ -28,10 +28,6 @@ EOF
       @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')
@@ -46,10 +42,6 @@ EOF
       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
 
@@ -71,4 +63,19 @@ EOF
       repo.active_features
     end.should raise_error(ArgumentError, "content of #{@filename} does not contain proper config")
   end
+
+  it "should raise exception on not true/false value in config" do
+    @filename = Tempfile.new(['feature_config', '.yaml']).path
+    fp = File.new(@filename, 'w')
+    fp.write <<"EOF";
+features:
+    invalid_feature: neither_true_or_false
+EOF
+    fp.close
+
+    repo = YamlRepository.new(@filename)
+    lambda do
+      repo.active_features
+    end.should raise_error(ArgumentError, "neither_true_or_false is not allowed value in config, use true/false")
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: feature
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Markus Gerdes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-22 00:00:00 +01:00
+date: 2011-11-23 00:00:00 +01:00
 default_executable: 
 dependencies: []