configliere 0.0.4 → 0.0.5

data/README.textile

@@ -10,32 +10,40 @@ Configliere manages settings from many sources: static constants, simple config
 
 h3. Example
 
-Here's a simple example, using params from a config file and the command line. A config file, in ~/.configliere/simple_script.yaml
-
-<pre>
-    :cat:     hat
-    :spider:  tuffet
-    :sprats:
-      :jack:  lean</pre>
-
-(Note that all simple keys should be symbols, with an exception described below.) A simple script:
+Here's a simple example, using params from a config file and the command line. In the script:
 
 <pre>
     #/usr/bin/env ruby
     require 'configliere'
     Settings.use :commandline, :config_file
 
-    Settings :dish => 'spoon', :cow => 'moon'
+    Settings({
+      :dest_time => '1955-11-05',
+      :delorean => {
+        :power_source => 'plutonium',
+        :roads_needed => true,
+        },
+      :username => 'marty',
+    })
     Settings.read 'my_script.yaml'  # reads ~/.configliere/my_script.yaml
     Settings.resolve!
-
     p Settings</pre>
 
+We'll override some of the defaults with a config file, in this case ~/.configliere/simple_script.yaml
+
+<pre>
+    # Settings for return
+    :dest_time:       1985-11-05
+    :delorean:    
+      :power_source:  1.21 jiggawatts
+</pre>
+
 Output, when run with commandline parameters as shown:
 
 <pre>
-    ./simple_script.rb --sprats.wife=fat --spider=waterspout
-    {:spider=>"waterspout", :cat=>"hat", :sprats=>{:wife=>"fat", :jack=>"lean"}, :cow=>"moon"}  </pre>
+    ./time_machine.rb --username=doc_brown --delorean.roads_needed="" --delorean.power_source="Mr. Fusion"
+    {:dest_time=>"1985-11-05", :username=>"doc_brown", :delorean=>{:power_source=>"Mr. Fusion", :roads_needed=>nil}}
+</pre>
 
 For an extensive usage in production, see the "wukong gem.":http://github.com/mrflip/wukong
 
@@ -61,7 +69,7 @@ Configliere settings are just a plain old normal hash.
 You can define static defaults in your module
 
 <pre>
-    Settings.defaults({
+    Settings({
       :dest_time => '1955-11-05',
       :fluxcapacitor => {
         :speed => 88,
@@ -75,7 +83,7 @@ You can define static defaults in your module
     })
 </pre>
 
-Retrieve them as:
+(Note that all simple keys should be symbols, with an exception you're about to see.) Retrieve the settings as:
 
 <pre>
     # hash keys
@@ -88,7 +96,7 @@ Retrieve them as:
     Settings['delorean.power_source']    #=> 'plutonium'
     Settings['delorean.missing']         #=> nil
     Settings['delorean.missing.fail']    #=> nil
-    # method-like (no deep keys tho)
+    # method-like (no deep keys tho, and you have to @#define@ the param; see below)
     Settings.dest_time                   #=> '1955-11-05'
 </pre>
 
@@ -193,9 +201,10 @@ h2. Command-line parameters
 
 <pre>
     # Head back
-    time_machine --delorean-power_source='1.21 gigawatt lightning strike' --dest_time=1985-11-05
+    time_machine --delorean.power_source='1.21 gigawatt lightning strike' --dest_time=1985-11-05
     # (in the time_machine script:)
     Settings.use :commandline
+    Settings.resolve!
 </pre>
 
 Interpretation of command-line parameters:
@@ -224,7 +233,7 @@ You don't have to pre-define parameters, but you can:
 
 <pre>
     Settings.use :define
-    Settings.define :dest_time, :type => Date, :description => 'Arrival time'
+    Settings.define :dest_time, :type => DateTime, :description => 'Arrival time'
     Settings.define 'delorean.power_source', :env_var => 'POWER_SOURCE', :description => 'Delorean subsytem supplying power to the Flux Capacitor.'
     Settings.define :password, :required => true, :encrypted => true
 </pre>
@@ -235,7 +244,7 @@ You don't have to pre-define parameters, but you can:
 * *:encrypted*: marks params to be obscured when saved to disk. See [#Encrypted Parameters] below for caveats.
 * *:env_var*: take param from given environment variable if set.
 
-Defined parameters are demonstrated in most of the  "example scripts":http://github.com/mrflip/configliere/tree/master/examples
+Defined parameters are demonstrated in most of the "example scripts":http://github.com/mrflip/configliere/tree/master/examples
 
 h3. Type Conversion
 
@@ -302,15 +311,17 @@ h2. Independent Settings
 All of the above examples use the global variable @Settings@, defined in configliere.rb.  You're free to define your own settings universe though:
 
 <pre>
-    module MyProject
+    class Wolfman
       cattr_accessor :config
       self.config = Configliere.new({
-        :helicity => 'homotopic',
-        :froebenius_matrix => 'unitary',
+        :moon    => 'full',
+        :nards   => true,
         })
     end
-    pr = proj.new
-    pr.config   #=> {:helicity => 'homotopic', :froebenius_matrix => 'unitary' }
+    teen_wolf = proj.new
+    teen_wolf.config.defaults(:give_me => 'keg of beer')
+    teen_wolf.config #=> {:moon=>"full", :nards=>true, :give_me=>"keg of beer" }
+    Settings         #=> {}
 </pre>
 
 Values in here don't overlap with the Settings object or any other settings universe. However, every one that pulls in commandline params gets a full copy of the commandline params.

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/configliere.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configliere}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mrflip"]
-  s.date = %q{2010-01-18}
+  s.date = %q{2010-01-20}
   s.default_executable = %q{configliere}
   s.description = %q{ You've got a script. It's got some settings. Some settings are for this module, some are for that module. Most of them don't change. Except on your laptop, where the paths are different.  Or when you're in production mode. Or when you're testing from the command line.
 

data/examples/simple_script.rb

@@ -3,21 +3,28 @@ $: << File.dirname(__FILE__)+'/../lib'
 require 'configliere'
 
 puts "This is a demo of Configliere in a simple script."
-Settings.use :commandline, :config_file
+Settings.use :commandline, :config_file, :define
 
 puts "You can set default values:"
-Settings.defaults :cat => 'bag', :cow => 'moon'
+Settings({
+  :dest_time => '1955-11-05',
+  :delorean => {
+    :power_source => 'plutonium',
+    :roads_needed => true,
+    },
+})
 puts "  #{Settings.inspect}"
 
 config_filename = File.dirname(__FILE__)+'/simple_script.yaml'
 puts "\nYou can load values from a file -- in this case, #{config_filename} -- which overrides the defaults:"
 Settings.read config_filename
+Settings.resolve!
 puts "  #{Settings.inspect}"
 
 puts %Q{\nTry running the script with commandline parameters, for example
-  #{$0} --sprats.wife=fat --spider=waterspout
+  #{$0} --dest_time=2015-11-05 --delorean.roads_needed="" --delorean.power_source="Mr. Fusion"
 In this case, you used
-  #{$0} #{ARGV.join(" ")}
+  #{$0} #{ARGV.map{|argv| "'#{argv}'"}.join(" ")}
 and so the final parameter values are}
 Settings.resolve!
 puts "  #{Settings.inspect}"

data/examples/simple_script.yaml

@@ -1,5 +1,5 @@
 --- 
-:cat:     hat
-:spider:  tuffet
-:sprats:
-  :jack:  lean
+# Settings for return
+:dest_time:       1985-11-05
+:delorean:    
+  :power_source:  1.21 jiggawatts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: configliere
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - mrflip
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-18 00:00:00 -06:00
+date: 2010-01-20 00:00:00 -06:00
 default_executable: configliere
 dependencies: 
 - !ruby/object:Gem::Dependency