confiture 0.1.0 → 0.1.1

data/README.md

@@ -1,7 +1,7 @@
 ## Infos
 
 ![Status](http://stillmaintained.com/phoet/confiture.png "Status")
-![Build](http://travis-ci.org/phoet/confiture.png "Build")
+![Build](https://travis-ci.org/phoet/confiture.png "Build")
 
 ## Installation
 

data/lib/confiture/configuration.rb

@@ -7,14 +7,29 @@ module Confiture
     end
 
     module ClassExtension
+
+      # Set a hash of defaults.
+      # Defaults will be used while configuring the options, but may be overridden.
+      #
       def confiture_defaults(defaults)
         @defaults = defaults
       end
 
+      # Set a list of allowed configuration options.
+      # If set, trying to access an option that is not configured will result in an ArgumentError.
+      #
       def confiture_allowed_keys(*allowed_keys)
         @allowed_keys = allowed_keys
       end
 
+      # Set a list of mandatory configuration options.
+      # If set, trying to access an option that is not configured properly will result in an ArgumentError.
+      # The validation can be triggered manually by calling +validate!+
+      #
+      def confiture_mandatory_keys(*mandatory_keys)
+        @mandatory_keys = mandatory_keys
+      end
+
       # Rails initializer configuration:
       #
       #   Confiture::Configuration.configure do |config|
@@ -59,6 +74,8 @@ module Confiture
         self
       end
 
+      # Run a block of code with temporary configuration.
+      #
       def with_config(options={})
         current_data = data
         configure(options, true)
@@ -72,8 +89,41 @@ module Confiture
         init_config(true)
       end
 
+      # Raises an ArgumentError if the configuration is not valid.
+      #
+      def validate!
+        unless valid?
+          raise ArgumentError.new("you are missing mandatory configuration options. please set #{@mandatory_keys}")
+        end
+      end
+
+      # Validates the configuration. All mandatory keys have to be not blank.
+      #
+      def valid?
+        @mandatory_keys.nil? || @mandatory_keys.none? { |key| blank?(key) }
+      end
+
+      # Raises an ArgumentError if the given key is not allowed as a configuration option.
+      #
+      def validate_key!(key)
+        unless valid_key?(key)
+          raise ArgumentError.new("#{key} is not allowed, use one of #{@allowed_keys}")
+        end
+      end
+
+      # Validates if a given key is valid for configuration.
+      #
+      def valid_key?(key)
+        @allowed_keys.nil? || @allowed_keys.include?(key)
+      end
+
       private
 
+      def blank?(key)
+        val = self.send key
+        val.nil? || val.empty?
+      end
+
       def data
         Thread.current[:confiture]
       end
@@ -92,20 +142,16 @@ module Confiture
         meth = "#{meth}"
         if meth =~ /.+=/ && args.size == 1
           key = meth[0..-2].to_sym
-          check_key!(key)
+          validate_key!(key)
           data.options[key] = args.last
         elsif args.size == 0
           key = meth.to_sym
-          check_key!(key)
+          validate_key!(key)
           data.options[key]
         else
           super
         end
       end
-
-      def check_key!(key)
-        raise ArgumentError.new("#{key} is not allowed, use one of #{@allowed_keys}") if @allowed_keys && !@allowed_keys.include?(key)
-      end
     end
   end
 end

data/lib/confiture/version.rb

@@ -1,3 +1,3 @@
 module Confiture
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/configuration_spec.rb

@@ -5,6 +5,11 @@ module Confiture
     include Confiture::Configuration
   end
 
+  class Valid
+    include Confiture::Configuration
+    confiture_mandatory_keys(:key)
+  end
+
   class Allowed
     include Confiture::Configuration
     confiture_allowed_keys(:key)
@@ -16,6 +21,22 @@ module Confiture
   end
 
   describe Confiture do
+    context "reset" do
+      it "should reset the configuration" do
+        Config.configure(:key => "value").tap do |config|
+          config.key.should eql("value")
+          config.reset!
+          config.key.should be_nil
+        end
+      end
+    end
+
+    context "validate" do
+      it "should validate the configuration" do
+        expect { Valid.configure.validate! }.should raise_error(ArgumentError, "you are missing mandatory configuration options. please set [:key]")
+      end
+    end
+
     context "defaults" do
       it "should have default settings" do
         Default.configure.key.should eql('value')
@@ -28,6 +49,7 @@ module Confiture
         Default.configure.key.should eql('value')
       end
     end
+
     context "allowed_keys" do
       it "should have access to allowed fields" do
         Allowed.configure do |config|
@@ -58,9 +80,10 @@ module Confiture
       end
 
       it "should read configuration from yml" do
-        config = Config.configure :yaml => 'spec/config.yml'
-        config.secret.should eql('secret_yml')
-        config.key.should eql('key_yml')
+        Config.configure(:yaml => 'spec/config.yml').tap do |config|
+          config.secret.should eql('secret_yml')
+          config.key.should eql('key_yml')
+        end
       end
 
       it "should read configuration from yml with block" do
@@ -75,9 +98,10 @@ module Confiture
 
     context "with_config" do
       it "should have a config on a per block basis" do
-        config = Config.configure(:key => "value")
-        config.with_config(:key => "bla") do
-          Config.key.should eql("bla")
+        Config.configure(:key => "value").tap do |config|
+          config.with_config(:key => "bla") do
+            Config.key.should eql("bla")
+          end
         end
         Config.key.should eql("value")
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confiture
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70276619699480 !ruby/object:Gem::Requirement
+  requirement: &70354285626600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70276619699480
+  version_requirements: *70354285626600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70276619698980 !ruby/object:Gem::Requirement
+  requirement: &70354285626100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70276619698980
+  version_requirements: *70354285626100
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70276619698520 !ruby/object:Gem::Requirement
+  requirement: &70354285625640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 0.9.9
   type: :development
   prerelease: false
-  version_requirements: *70276619698520
+  version_requirements: *70354285625640
 description: Confiture helps with configuring your gem.
 email:
 - phoetmail@googlemail.com