configru 0.1.0 → 0.2.0

data/README.md

@@ -23,13 +23,13 @@ Configru.load do
 end
 ```
 
-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.
+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!
 
-This is the simplest method of loading. It just loads a file, already!
+This is the simplest method of loading. It just loads a file.
 
 ```ruby
 Configru.load do
@@ -49,9 +49,9 @@ end
 
 #### Cascading Loading
 
-This method of loading loads each file given (if it exists) and cascades
-their values. The values in the first given file have highest priority,
-and the values in the last file have lowest priority.
+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
+cascade priority)
 
 ```ruby
 Configru.load do
@@ -59,16 +59,10 @@ Configru.load do
 end
 ```
 
-This will load `/etc/foo.yml` first, then `~/foo.yml`. The values in
-`~/foo.yml` will overwrite the values in `/etc/foo.yml`. If a configuration
-option is omitted in `~/foo.yml`, it will default to the value in
-`/etc/foo.yml`.
-
 ### Accessing Options
 
-Configru aims to make accessing configuration values as simple as possible.
-All configuration options can be accessed as methods on the module
-`Configru`.
+Configuration options can be accessed as methods of the `Configru` module, or
+`Configru` can be used as a Hash.
 
 ##### foo.yml
 ```yaml
@@ -84,29 +78,28 @@ require 'configru'
 require 'socket'
 
 Configru.load do
-  first_of 'foo.yml', '~/foo.yml'
+  just 'foo.yml'
 end
 
-s = TCPSocket.new(Configru.server.address, Configru.server.port)
+s = TCPSocket.new(Configru.server.address, Configru['server']['port'])
 s.puts "Hello, I am #{Configru.nick}"
 ```
 
-Configuration options can also be accessed the old-fashioned way like a
-Hash. `Configru['server']['port']` is equivalent to `Configru.server.port`.
-
-Configuration optiosn with hyphens (ie. `foo-bar`) can be accessed either
-using the old-fashioned way (ie. `Configru['foo-bar']`), or by replacing
-the hyphens with underscores for the method way (ie. `Configru.foo_bar`).
+Configuration options with hyphens can be accessed as methods by replacing the
+hyphens with underscores.
 
 ### Defaults
 
-Configru's load DSL allows for setting configuration 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
+option, the values in `defaults` will be used.
+
 
 ```ruby
 require 'configru'
 
 Configru.load do
-  first_of 'foo.yml', '~/foo.yml'
+  just 'foo.yml'
   defaults do
     nick 'Dr. Nader'
     server do
@@ -126,8 +119,25 @@ server:
   port: 1111
 ```
 
-If no configuration files are found or if the configuration file omits an
-option, the values in `defaults` will be used.
+Defaults can also be set using a Hash instead of a block.
+
+```ruby
+Configru.load do
+  just 'foo.yml'
+  defaults 'nick' => 'Dr. Nader',
+           'server' => {'address' => 'abcd.com', 'port' => 1111}
+end
+```
+
+Defaults can also be loaded from a YAML file by passing the filename to
+`default`.
+
+```ruby
+Configru.load do
+  just 'foo.yml'
+  defaults 'foo.yml.dist'
+end
+```
 
 ## License
 

data/lib/configru/dsl.rb

@@ -23,9 +23,11 @@ module Configru
         @files_array = args
       end
       
-      def defaults(hash=nil, &block)
-        if hash
-          @defaults_hash = hash
+      def defaults(arg=nil, &block)
+        if arg.is_a? String
+          @defaults_hash = YAML.load_file(arg)
+        elsif arg
+          @defaults_hash = arg
         elsif block
           @defaults_hash = HashDSL.new(block).hash
         end

data/lib/configru/version.rb

@@ -1,3 +1,3 @@
 module Configru
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Curtis McEnroe
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-17 00:00:00 -04:00
+date: 2011-07-19 00:00:00 -04:00
 default_executable: 
 dependencies: []