configru 2.0.1 → 3.0.0

data/ChangeLog.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 3.0.0 (22 September 2012)
+
+ * Added option arrays
+ * Accessing a key that is not declared in `Configru.load` now raises
+   `NoMethodError`, rather than returning `nil`.
+
 ## 2.0.1 (14 September 2012)
 
  * Fix: Cascade options in loaded files

data/Gemfile

@@ -2,7 +2,7 @@ source :rubygems
 
 group :development do
   gem "rake", "~> 0.9.0"
-  gem "rspec", "~> 2.10.0"
+  gem "rspec", "~> 2.11.0"
   gem "simplecov", "~> 0.6.0"
 end
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    configru (2.0.1)
+    configru (3.0.0)
 
 GEM
   remote: http://rubygems.org/
@@ -9,14 +9,14 @@ GEM
     diff-lcs (1.1.3)
     multi_json (1.3.6)
     rake (0.9.2.2)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
+    rspec-mocks (2.11.2)
     simplecov (0.6.4)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
@@ -28,5 +28,5 @@ PLATFORMS
 DEPENDENCIES
   configru!
   rake (~> 0.9.0)
-  rspec (~> 2.10.0)
+  rspec (~> 2.11.0)
   simplecov (~> 0.6.0)

data/lib/configru/dsl.rb

@@ -10,8 +10,14 @@ module Configru
         instance_eval(&block)
       end
 
-      def option(name, type = Object, default = nil, validate = nil, &block)
-        option = Configru::Option.new(type, default, validate, nil)
+      def option(name, type = Object, default = nil, validation = nil, &block)
+        option = Configru::Option.new(type, default, validation, nil)
+        Option.new(option, &block) if block
+        @options[name.to_s] = option
+      end
+
+      def option_array(name, type = Object, default = [], validation = nil, &block)
+        option = Configru::OptionArray.new(type, default, validation, nil)
         Option.new(option, &block) if block
         @options[name.to_s] = option
       end
@@ -36,11 +42,11 @@ module Configru
       end
 
       def validate(v = nil, &block)
-        @option.validate = v || block
+        @option.validation = v || block
       end
 
       def transform(&block)
-        @option.transform = block
+        @option.transformation = block
       end
     end
   end

data/lib/configru/option.rb

@@ -1,3 +1,38 @@
 module Configru
-  Option = Struct.new(:type, :default, :validate, :transform)
+  class Option < Struct.new(:type, :default, :validation, :transformation)
+    def type?(value)
+      value.is_a?(self.type)
+    end
+
+    def valid?(value)
+      return true unless self.validation
+      self.validation === value
+    end
+
+    def transform(value)
+      return value unless self.transformation
+      self.transformation[value]
+    end
+  end
+
+  class OptionArray < Option
+    def type?(values)
+      return false unless values.is_a?(Array)
+      values.all? {|x| x.is_a?(self.type) }
+    end
+
+    def valid?(values)
+      return true unless self.validation
+      values.all? do |x|
+        # Use === instead of passing validation as the block to #all? so that
+        # non-block validations (Regexp, Range) work
+        self.validation === x
+      end
+    end
+
+    def transform(values)
+      return values unless self.transformation
+      values.map(&self.transformation)
+    end
+  end
 end

data/lib/configru/structhash.rb

@@ -1,6 +1,8 @@
 module Configru
   class StructHash < Hash
-    def method_missing(key)
+    def method_missing(key, *args)
+      # Raise NoMethodError if the key does not exist
+      super(key, *args) unless args.empty? && self.include?(key.to_s)
       self[key.to_s]
     end
   end

data/lib/configru/version.rb

@@ -1,3 +1,3 @@
 module Configru
-  VERSION = "2.0.1"
+  VERSION = "3.0.0"
 end

data/lib/configru.rb

@@ -19,10 +19,10 @@ module Configru
 
   class OptionValidationError < OptionError
     def initialize(path, validation = nil)
-      if validation
-        super(path, "failed validation `#{validation.inspect}`")
-      else
+      if validation.is_a?(Proc)
         super(path, "failed validation")
+      else
+        super(path, "failed validation `#{validation.inspect}`")
       end
     end
   end
@@ -80,21 +80,15 @@ module Configru
         value = option.default
       end
 
-      unless value.is_a? option.type
+      unless option.type?(value)
         raise OptionTypeError.new(@option_path, option.type, value.class)
       end
 
-      if option.validate.is_a? Proc
-        unless option.validate[value]
-          raise OptionValidationError.new(@option_path)
-        end
-      elsif option.validate
-        unless option.validate === value
-          raise OptionValidationError.new(@option_path, option.validate)
-        end
+      unless option.valid?(value)
+        raise OptionValidationError.new(@option_path, option.validation)
       end
 
-      output[key] = option.transform ? option.transform[value] : value
+      output[key] = option.transform(value)
 
       @option_path.pop
     end
@@ -105,9 +99,6 @@ module Configru
   end
 
   def self.method_missing(method, *args)
-    # Let super raise the appropriate exception if it looks like the caller
-    # wants a real method
-    super(method, *args) unless args.empty?
-    @root.send(method)
+    @root.send(method, *args)
   end
 end

data/spec/configru_spec.rb

@@ -11,12 +11,14 @@ describe Configru do
     Configru.example.should == 'example'
   end
 
-  it 'behaves like a hash' do
+  it 'behaves like a StructHash' do
     Configru.load do
       option :example, String, 'example'
     end
 
     Configru['example'].should == 'example'
+    Configru.example.should == 'example'
+    expect { Configru.example2 }.to raise_error(NoMethodError)
   end
 
   it 'loads defaults if no files exist' do
@@ -123,4 +125,48 @@ describe Configru do
 
     Configru.example.should == 'example_dt'
   end
+
+  it 'checks that array option values are arrays' do
+    expect do
+      Configru.load(example_file :a) do
+        option_array :example
+      end
+    end.to raise_error(Configru::OptionTypeError)
+  end
+
+  it 'checks array option types' do
+    expect do
+      Configru.load(example_file :i) do
+        option_array :hetero, String
+      end
+    end.to raise_error(Configru::OptionTypeError)
+  end
+
+  it 'validates option arrays against values' do
+    expect do
+      Configru.load(example_file :i) do
+        option_array :example, Fixnum, [], 1..6
+      end
+    end.to raise_error(Configru::OptionValidationError)
+  end
+
+  it 'validates option arrays against blocks' do
+    expect do
+      Configru.load(example_file :i) do
+        option_array :example, Fixnum, [] do
+          validate {|x| x.even? }
+        end
+      end
+    end.to raise_error(Configru::OptionValidationError)
+  end
+
+  it 'applies transformations to option arrays' do
+    Configru.load(example_file :i) do
+      option_array :example, Fixnum, [] do
+        transform {|x| x + 1 }
+      end
+    end
+
+    Configru.example.should == [3, 5, 7, 8]
+  end
 end

data/spec/dsl_spec.rb

@@ -1,6 +1,6 @@
 describe Configru::DSL::Option do
   before do
-    @option = Configru::Option.new(:type, :default, :validate, :transform)
+    @option = Configru::Option.new(:type, :default, :validation, :transformation)
   end
 
   it 'sets option type' do
@@ -24,7 +24,7 @@ describe Configru::DSL::Option do
       validate /example/
     end
 
-    @option.validate.should == /example/
+    @option.validation.should == /example/
   end
 
   it 'sets option validate block' do
@@ -34,19 +34,19 @@ describe Configru::DSL::Option do
       end
     end
 
-    @option.validate.should be_a(Proc)
-    @option.validate.call.should == :example
+    @option.validation.should be_a(Proc)
+    @option.validation.call.should == :example
   end
 
-  it 'sets option transofmr block' do
+  it 'sets option transform block' do
     described_class.new(@option) do
       transform do
         :example
       end
     end
 
-    @option.transform.should be_a(Proc)
-    @option.transform.call.should == :example
+    @option.transformation.should be_a(Proc)
+    @option.transformation.call.should == :example
   end
 end
 
@@ -58,6 +58,10 @@ describe Configru::DSL::OptionGroup do
 
     group.options.should have_key('example')
     group.options['example'].should be_a(Configru::Option)
+    group.options['example'].type.should == Object
+    group.options['example'].default.should be_nil
+    group.options['example'].validation.should be_nil
+    group.options['example'].transformation.should be_nil
   end
 
   it 'converts option names to strings' do
@@ -68,15 +72,25 @@ describe Configru::DSL::OptionGroup do
     group.options.should have_key('example')
   end
 
-  it 'creates a default option' do
+  it 'creates an option array' do
     group = described_class.new do
-      option 'example'
+      option_array 'example'
     end
 
+    group.options.should have_key('example')
+    group.options['example'].should be_a(Configru::OptionArray)
     group.options['example'].type.should == Object
-    group.options['example'].default.should be_nil
-    group.options['example'].validate.should be_nil
-    group.options['example'].transform.should be_nil
+    group.options['example'].default.should == []
+    group.options['example'].validation.should be_nil
+    group.options['example'].transformation.should be_nil
+  end
+
+  it 'converts option array names to strings' do
+    group = described_class.new do
+      option_array :example
+    end
+
+    group.options.should have_key('example')
   end
 
   it 'runs the Option DSL' do
@@ -84,9 +98,13 @@ describe Configru::DSL::OptionGroup do
       option 'example' do
         type String
       end
+      option_array 'example_array' do
+        type String
+      end
     end
 
     group.options['example'].type.should == String
+    group.options['example_array'].type.should == String
   end
 
   it 'creates a group' do

data/spec/example_files/example_i.yml

@@ -0,0 +1,2 @@
+hetero: ["string", 2]
+example: [2, 4, 6, 7]

data/spec/structhash_spec.rb

@@ -7,8 +7,13 @@ describe Configru::StructHash do
     @hash.should be_a_kind_of(Hash)
   end
 
-  it 'returns nil for missing method key' do
-    @hash.example.should be_nil
+  it 'raises NoMethodError for missing method key' do
+    expect { @hash.example }.to raise_error(NoMethodError)
+  end
+
+  it 'raises NoMethodError if method key exists but is called with arguments' do
+    @hash['example'] = :example
+    expect { @hash.example(:foo) }.to raise_error(NoMethodError)
   end
 
   it 'returns value for method key' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configru
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies: []
 description: YAML configuration file loader
 email:
@@ -42,6 +42,7 @@ files:
 - spec/example_files/example_f.yml
 - spec/example_files/example_g.yml
 - spec/example_files/example_h.yml
+- spec/example_files/example_i.yml
 - spec/spec_helper.rb
 - spec/structhash_spec.rb
 homepage: https://github.com/programble/configru
@@ -58,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 872203077689334122
+      hash: 2949675092247533978
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -67,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 872203077689334122
+      hash: 2949675092247533978
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -85,5 +86,6 @@ test_files:
 - spec/example_files/example_f.yml
 - spec/example_files/example_g.yml
 - spec/example_files/example_h.yml
+- spec/example_files/example_i.yml
 - spec/spec_helper.rb
 - spec/structhash_spec.rb