configru 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fe2eb4ab4567132c798bceaa960d6952f24f64f
-  data.tar.gz: 610aab18e8619ece1f85c3c5a6e2b4119375e7b9
+  metadata.gz: 411032b2676edb0558982ceeeba01327afa061ea
+  data.tar.gz: e4cdc8a16b7d93d38fea32109f4f63c5470a2137
 SHA512:
-  metadata.gz: 1b5684f556040ba711ebeae9b71012cb775ebc62209b8e067de935e1146ea130b7841d755512686983171b8487b9e0bcf04c22c30a9d6dabe67a6de48f1844b1
-  data.tar.gz: 3927b8495c5402df1723a2ed18e96f23a74dafc587ee02c8253a247ee084a9834d60fae8c33632da984f60d58728885d9e18d7a06458fe4463bbcde4a827fa35
+  metadata.gz: c97c37b22cf0bf4e28bd076970b82d6a325cdb85a68d7312c821fcd747c943ac007fbb0650e0138c7ba33fd77c568b48e3010f85900bd540804b54db719533bb
+  data.tar.gz: 424fcc556bd4f9f42694db51fed76673153c0dc0ce4cf8ee9f6f4a095ebd27b819b58945f4751640be76980ceb39cebceac09418fd3afea37cb940c351955f0c

data/ChangeLog.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 3.5.0 (9 October 2013)
+
+ * Treat `nil` as being the correct type
+
 ## 3.4.0 (8 October 2013)
 
  * Added `Configru::Config` class

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    configru (3.4.0)
+    configru (3.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -7,7 +7,7 @@ YAML configuration file loader
 Install the gem or add it to your `Gemfile`:
 
 ```ruby
-gem 'configru', '~> 3.4.0'
+gem 'configru', '~> 3.5.0'
 ```
 
 Next, require it and load a configuration:
@@ -33,7 +33,10 @@ end
 ```
 
 `option` takes 4 arguments: the configuration key, the type of value,
-the default value, and an optional validation check.
+the default value, and a validation check. The type defaults to
+`Object`, the default value defaults to `nil` and the validation check
+defaults to nothing. Note that a value of `nil` will be treated as the
+correct type regardless of the specified type.
 
 The configuration option above can then be accessed in two ways:
 

data/lib/configru/config.rb

@@ -24,6 +24,7 @@ module Configru
       # Load all defaults if no files were loaded
       # TODO: Some way to not special case this
       @option_path = Array.new
+      @file = '(none)'
       load_group(@options, self, {}) if loaded_files.empty?
     end
 
@@ -31,6 +32,7 @@ module Configru
 
     def load_file(file)
       @option_path = Array.new
+      @file = file
       load_group(@options, self, YAML.load_file(file) || {})
     end
 
@@ -41,7 +43,7 @@ module Configru
         # option is a group
         if option.is_a? Hash
           if input.has_key?(key) && !input[key].is_a?(Hash)
-            raise OptionTypeError.new(@option_path, Hash, input[key].class)
+            raise OptionTypeError.new(@file, @option_path, Hash, input[key].class)
           end
           group_output = output[key] || StructHash.new
           load_group(option, group_output, input[key] || {})
@@ -56,17 +58,17 @@ module Configru
           @option_path.pop
           next
         elsif option.is_a? RequiredOption
-          raise OptionRequiredError.new(@option_path)
+          raise OptionRequiredError.new(@file, @option_path)
         else # option has not been set
           value = option.default
         end
 
         unless option.type?(value)
-          raise OptionTypeError.new(@option_path, option.type, value.class)
+          raise OptionTypeError.new(@file, @option_path, option.type, value.class)
         end
 
         unless option.valid?(value)
-          raise OptionValidationError.new(@option_path, option.validation)
+          raise OptionValidationError.new(@file, @option_path, option.validation)
         end
 
         output[key] = option.transform(value)

data/lib/configru/exceptions.rb

@@ -1,28 +1,28 @@
 module Configru
   class OptionError < RuntimeError
-    def initialize(path, message)
-      super("#{path.join('.')}: #{message}")
+    def initialize(file, path, message)
+      super("in #{file} at #{path.join('.')}: #{message}")
     end
   end
 
   class OptionRequiredError < OptionError
-    def initialize(path)
-      super(path, 'option required')
+    def initialize(file, path)
+      super(file, path, 'option required')
     end
   end
 
   class OptionTypeError < OptionError
-    def initialize(path, expected, got)
-      super(path, "expected #{expected}, got #{got}")
+    def initialize(file, path, expected, got)
+      super(file, path, "expected #{expected}, got #{got}")
     end
   end
 
   class OptionValidationError < OptionError
-    def initialize(path, validation = nil)
+    def initialize(file, path, validation)
       if validation.is_a?(Proc)
-        super(path, "failed validation")
+        super(file, path, 'failed validation')
       else
-        super(path, "failed validation `#{validation.inspect}`")
+        super(file, path, "failed validation `#{validation.inspect}`")
       end
     end
   end

data/lib/configru/option.rb

@@ -1,7 +1,7 @@
 module Configru
   module OptionMethods
     def type?(value)
-      value.is_a?(self.type)
+      value.nil? || value.is_a?(self.type)
     end
 
     def valid?(value)

data/lib/configru/version.rb

@@ -1,3 +1,3 @@
 module Configru
-  VERSION = "3.4.0"
+  VERSION = "3.5.0"
 end

data/spec/config_spec.rb

@@ -96,6 +96,14 @@ describe Configru::Config do
     end.to raise_error(Configru::OptionTypeError)
   end
 
+  it 'treats nil as if it were the right type' do
+    c = described_class.new do
+      option :string, String
+    end
+
+    c.string.should == nil
+  end
+
   it 'validates options against values' do
     expect do
       c = described_class.new(example_file :d) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configru
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Curtis McEnroe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies: []
 description: YAML configuration file loader
 email: