configru 0.3.0 → 0.4.0

data/ChangeLog.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.4.0 (8 January 2012)
+
+ * Added `cascade 'c', ['a', 'b']` form
+
+## 0.3.0 (30 July 2011)
+
+ * Added `Configru.loaded_files`
+ * Added the `options` method to the `Configru.load` DSL
+
 ## 0.2.0 (19 July 2011)
 
  * Added loading defaults from file

data/README.md

@@ -2,16 +2,16 @@
 
 Versatile configuration file loader for Ruby
 
-## Installation
+# Installation
 
     gem install configru
 
-## Usage
+# Usage
 
 Configru loads YAML configuration files and provides a simple way to access
 configuration options.
 
-### Loading Configuration Files
+## Loading Configuration Files
 
 Configru provides a DSL for loading configuration files.
 
@@ -27,7 +27,7 @@ At the very least, the block passed to `Configru.load` must tell Configru which
 files it should load. There are two different methods of loading configuration
 files available.
 
-#### Just load a file already!
+### Just load a file already!
 
 This is the simplest method of loading. It just loads a file.
 
@@ -37,7 +37,7 @@ Configru.load do
 end
 ```
 
-#### First-of Loading
+### First-of Loading
 
 This method loads the first file that exists, ignoring all other files.
 
@@ -47,7 +47,7 @@ Configru.load do
 end
 ```
 
-#### Cascading Loading
+### Cascading Loading
 
 This method loads every file that exists in reverse order. Files listed first
 overwrite the values from files listed later. (Files are listed in high to low
@@ -59,12 +59,13 @@ Configru.load do
 end
 ```
 
-### Accessing Options
+## Accessing Options
 
 Configuration options can be accessed as methods of the `Configru` module, or
 `Configru` can be used as a Hash.
 
-##### foo.yml
+`foo.yml`
+
 ```yaml
 nick: bob
 server:
@@ -72,7 +73,8 @@ server:
   port: 6782
 ```
 
-##### foo.rb
+`foo.rb`
+
 ```ruby
 require 'configru'
 require 'socket'
@@ -88,7 +90,7 @@ s.puts "Hello, I am #{Configru.nick}"
 Configuration options with hyphens can be accessed as methods by replacing the
 hyphens with underscores.
 
-### Defaults
+## Defaults
 
 Configru's load DSL allows for setting configuration defaults using a block.
 If no configuration files are found or if the configuration file omits an
@@ -130,7 +132,7 @@ end
 ```
 
 Defaults can also be loaded from a YAML file by passing the filename to
-`default`.
+`defaults`.
 
 ```ruby
 Configru.load do
@@ -139,12 +141,53 @@ Configru.load do
 end
 ```
 
-### Verifying options
+## Verifying options
 
 Configru provides a way to verify that configuration options meet certain
 requirements. This is done using a `verify` block in `Configru.load`.
 
-## License
+```ruby
+Configru.load do
+  just 'foo.yml'
+  verify do
+    foo Fixnum
+    bar /^a+$/
+    baz ['one', 'two']
+  end
+end
+```
+
+Upon loading the configuration, Configru checks each option against this verify
+block. In most cases, the `===` operator is used to compare the values, but
+there are some special cases. If the verification value is a class, `is_a?` is
+used. If the verification value is an array, `include?` is used. This
+effectively means that with a class, the value must be an instance of that
+class, and with an array, the value must be one of the values in the array.
+
+FIXME: Talk about how Configru deals with invalid options
+
+## Doing two things at once
+
+Configru also has an `options` block in `Configru.load` which allows for
+combining the `defaults` and `verify` blocks.
+
+```ruby
+Configru.load do
+  just 'foo.yml'
+  options do
+    nick String, 'Dr. Nader'
+    server do
+      address String, 'abcd.com'
+      port (0..65535), 1111
+    end
+  end
+end
+```
+
+In the `options` block, each option takes two arguments, the first being the
+verification value, and the second being the default value.
+
+# License
 
 Copyright (c) 2011, Curtis McEnroe <programble@gmail.com>
 

data/lib/configru/confighash.rb

@@ -4,7 +4,7 @@ module Configru
       super
       merge!(hash)
     end
-    
+
     def merge!(hash)
       hash.each do |key, value|
         if value.is_a?(Hash) && self[key].is_a?(ConfigHash)
@@ -16,7 +16,7 @@ module Configru
         end
       end
     end
-    
+
     def [](key)
       key = key.to_s if key.is_a?(Symbol)
       # Allow for accessing keys with hypens using underscores
@@ -25,7 +25,7 @@ module Configru
       # doesn't exist :\
       super(key) if self.include?(key)
     end
-    
+
     def method_missing(key, *args)
       self[key]
     end

data/lib/configru/dsl.rb

@@ -2,7 +2,7 @@ module Configru
   module DSL
     class LoadDSL
       attr_reader :defaults_hash, :verify_hash, :files_array, :load_method
-      
+
       def initialize(block)
         @defaults_hash = {}
         @verify_hash = {}
@@ -11,18 +11,30 @@ module Configru
         instance_eval(&block)
       end
 
+      def files(*args)
+        if args[0].is_a?(String) && args[1].is_a?(Array)
+          @files_array = args[1].map {|x| File.join(x, args[0])}
+        else
+          @files_array = args
+        end
+      end
+
+      def method(m)
+        @load_method = m
+      end
+
       def first_of(*args)
-        @load_method = :first
-        @files_array = args
+        method(:first)
+        files(*args)
       end
 
       alias :just :first_of
-      
+
       def cascade(*args)
-        @load_method = :cascade
-        @files_array = args
+        method(:cascade)
+        files(*args)
       end
-      
+
       def defaults(arg=nil, &block)
         if arg.is_a? String
           @defaults_hash = YAML.load_file(arg)
@@ -32,7 +44,7 @@ module Configru
           @defaults_hash = HashDSL.new(block).hash
         end
       end
-      
+
       def verify(hash=nil, &block)
         if hash
           @verify_hash = hash
@@ -47,20 +59,22 @@ module Configru
         @verify_hash = hashes.hash1
       end
     end
-    
+
     class HashDSL
       attr_reader :hash
-      
+
       def initialize(block)
         @hash = {}
         instance_eval(&block)
       end
-      
+
       def method_missing(method, *args, &block)
         key = method.to_s.gsub('_', '-')
         if block
           @hash[key] = HashDSL.new(block).hash
         else
+          # Simulate method requiring 1 argument
+          raise ArgumentError, "wrong number of arguments(#{args.length} for 1)" unless args.length == 1
           @hash[key] = args[0]
         end
       end

data/lib/configru/version.rb

@@ -1,3 +1,3 @@
 module Configru
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/configru.rb

@@ -23,11 +23,11 @@ module Configru
     end
     self.reload
   end
-  
+
   def self.reload
     @config = ConfigHash.new(@defaults)
     @loaded_files = []
-    
+
     case @load_method
     when :first
       if file = @files.find {|file| File.file?(file)} # Intended
@@ -42,30 +42,28 @@ module Configru
         end
       end
     end
-    
+
     self.verify(@config, @verify)
   end
-  
+
   @verify_stack = []
   def self.verify(hash, criteria)
     hash.each do |key, value|
       next unless criteria[key]
       @verify_stack.unshift(key)
-      
+
       result = case criteria[key]
       when Hash
         self.verify(value, criteria[key])
-        true
-      when Class
-        value.is_a?(criteria[key])
+        true # If it failed, an exception will have been raised
       when Array
         criteria[key].include?(value)
       else
         criteria[key] === value
       end
-      
+
       raise ConfigurationError, "configuration option '#{@verify_stack.reverse.join('.')}' is invalid" unless result
-      
+
       @verify_stack.shift
     end
   end
@@ -73,11 +71,11 @@ module Configru
   def self.loaded_files
     @loaded_files
   end
-  
+
   def self.[](key)
     @config[key]
   end
-  
+
   def self.method_missing(key, *args)
     # Simulate NoMethodError if it looks like they really wanted a method
     raise NoMethodError, "undefined method `#{key.to_s}' for #{self.inspect}:#{self.class}" unless args.empty?

data/test/loaddsl_test.rb

@@ -0,0 +1,24 @@
+require 'teststrap'
+require 'configru/dsl'
+
+context 'LoadDSL - Files' do
+  setup do
+    block = proc do
+      cascade 'a', 'b', 'c'
+    end
+    Configru::DSL::LoadDSL.new(block).files_array
+  end
+
+  asserts_topic.equals(['a', 'b', 'c'])
+end
+
+context 'LoadDSL - File-directories' do
+  setup do
+    block = proc do
+      cascade 'a', ['b', 'c']
+    end
+    Configru::DSL::LoadDSL.new(block).files_array
+  end
+
+  asserts_topic.equals([File.join('b', 'a'), File.join('c', 'a')])
+end

metadata

@@ -1,33 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: configru
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Curtis McEnroe
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-30 00:00:00 -04:00
-default_executable: 
+date: 2012-01-08 00:00:00.000000000 Z
 dependencies: []
-
 description: Versatile configuration file loader
-email: 
+email:
 - programble@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - ChangeLog.md
 - Gemfile
@@ -40,40 +30,34 @@ files:
 - lib/configru/version.rb
 - test/confighash_test.rb
 - test/hashdsl_test.rb
+- test/loaddsl_test.rb
 - test/teststrap.rb
-has_rdoc: true
 homepage: https://github.com/programble/configru
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Versatile configuration file loader
-test_files: 
+test_files:
 - test/confighash_test.rb
 - test/hashdsl_test.rb
+- test/loaddsl_test.rb
 - test/teststrap.rb