configliere 0.0.3 → 0.0.4

data/CHANGELOG.textile

@@ -1,5 +1,9 @@
 Note that while the version # is still in the 0.0.x range, the interface may change arbitrarily while we figure out the best simplest convenientest powerfullest way to arrange things
 
+h2. Version 0.0.4 2010-01-16
+
+* Cured a variety of issues noted by "@monad":http://github.com/monad -- thanks for the feedback!
+
 h2. Version 0.0.3 2010-01-15
 
 * @Settings.param@ now only works for params that have been @#define@'d :
@@ -13,7 +17,7 @@ h2. Version 0.0.3 2010-01-15
 </pre>
 
 * Note that you *must* use symbols as keys (except for dotted notation for deep keys). See the README.
-* You must now call @#use_environment@ as @Settings.use_environment :param => 'ENV_VAR'@. (The param is used as the key everywhere else, made this consistent).
+* You must now define environment variables using @Settings.env_vars :param => 'ENV_VAR'@. The order was switched to consistently use param as the key. Also, @environment@ was renamed to @env_var@ to avoid confusion with the "development/test/production" convention from rails and friends.
 * die takes an error code as option
 * Added example scripts for encrypted and config_block scripts
 * The directory path to a config_file will now be created automatically

data/README.textile

@@ -23,19 +23,19 @@ Here's a simple example, using params from a config file and the command line. A
 <pre>
     #/usr/bin/env ruby
     require 'configliere'
-    
-    Settings.use(:commandline, :config_file, 
-      :dish => 'spoon', :cow => 'moon')
+    Settings.use :commandline, :config_file
+
+    Settings :dish => 'spoon', :cow => 'moon'
     Settings.read 'my_script.yaml'  # reads ~/.configliere/my_script.yaml
     Settings.resolve!
 
     p Settings</pre>
 
-Output:
+Output, when run with commandline parameters as shown:
 
 <pre>
-    ./simple_script.rb --sprats.wife=fat --spider=drainspout
-    {:spider=>"drainspout", :cat=>"hat", :sprats=>{:wife=>"fat", :jack=>"lean"}, :cow=>"moon"}  </pre>
+    ./simple_script.rb --sprats.wife=fat --spider=waterspout
+    {:spider=>"waterspout", :cat=>"hat", :sprats=>{:wife=>"fat", :jack=>"lean"}, :cow=>"moon"}  </pre>
 
 For an extensive usage in production, see the "wukong gem.":http://github.com/mrflip/wukong
 
@@ -48,7 +48,7 @@ h3. Design goals:
 ** Simple config files
 ** Environment variables
 ** Commandline options
-** Ruby block called when all other options are in place 
+** Ruby block called when all other options are in place
 * *Code of Silence*. Most commandline parsers force you to pre-define all your parameters in a centralized and wordy syntax. In configliere, you pre-define nothing -- commandline parameters map directly to values in the Configliere hash.
 * *Can hide your assets*. Rather than storing passwords and API keys in plain sight, configliere has a protection racket that can obscure values when stored to disk.
 
@@ -56,7 +56,7 @@ fuhgeddaboudit.
 
 h2. Settings structure
 
-Configliere settings are just a plain old normal hash. 
+Configliere settings are just a plain old normal hash.
 
 You can define static defaults in your module
 
@@ -74,11 +74,11 @@ You can define static defaults in your module
       :password => '',
     })
 </pre>
-    
+
 Retrieve them as:
 
 <pre>
-    # hash keys       
+    # hash keys
     Settings[:dest_time]                 #=> '1955-11-05'
     # deep keys
     Settings[:delorean][:power_source]   #=> 'plutonium'
@@ -89,12 +89,13 @@ Retrieve them as:
     Settings['delorean.missing']         #=> nil
     Settings['delorean.missing.fail']    #=> nil
     # method-like (no deep keys tho)
-    Settings.dest_time                 #=> '1955-11-05'
+    Settings.dest_time                   #=> '1955-11-05'
 </pre>
 
 h3. Shortcut syntax for deep keys
 
-You can use a 'dotted key' like 'delorean.power_source' as simple notation for a deep key: Settings['delorean.power_source'] is equivalent to Settings[:delorean][:power_source].  You can use a dotted key in any simple reference:
+You can use a 'dotted key' like 'delorean.power_source' as simple notation for a deep key: @Settings['delorean.power_source']@ is equivalent to @Settings[:delorean][:power_source]@.  You can use a dotted key in any simple reference:
+
 <pre>
   Settings['delorean.power_source'] = "Mr. Fusion"
   Settings[:delorean][:power_source]
@@ -102,10 +103,11 @@ You can use a 'dotted key' like 'delorean.power_source' as simple notation for a
   Settings.delete('delorean.power_source')
   #=> "Mr. Fusion"
   Settings
-  #=> { :delorean => {} }  
+  #=> { :delorean => {} }
 </pre>
 
 Intermediate keys "auto-vivify" (automatically create any intervening hashes):
+
 <pre>
   Settings['one.two.three'] = "To tha Fo'"
   # Settings is { :one => { :two => { :three => "To tha Fo'" } }, :delorean => { :power_source => "Mr. Fusion" }
@@ -125,7 +127,7 @@ h3. Only basic functionality loaded by default
 Configliere doesn't load any other functionality by default -- you may not want to load config files, or environment variable handling, and so forth.  You can require each file directly, or call @Configliere.use@ with a list of mixins (:all to load all functionality).
 
 <pre>
-    Configliere.use :config_file, :define # Load config files and pre-define 
+    Configliere.use :config_file, :define # Load config files and pre-define
     Configliere.use :all                  # all of them
 </pre>
 
@@ -151,7 +153,7 @@ You can instead supply a path to a config file.  If a bare filename (no '/') is
 </pre>
 
 When you read directly from a file you should leave off the top-level settings group:
-    
+
 <pre>
     # Settings for version II.
     :dest_time:         2015-11-05
@@ -167,32 +169,41 @@ Save defaults by inserting a line like:
     Settings.save('/etc/time_machine.yaml') # overwrites /etc/time_machine.yaml
     Settings.save('time_machine.yaml')      # overwrites ~/.configliere/time_machine.yaml
 </pre>
-    
+
+You're free to use as many config files as you like. Loading a config file sets values immediately, so later-loaded files win out over earlier-loaded ones:
+
+<pre>
+    Settings.read('time_machine_global.yaml')
+    Settings.read('time_machine_site.yaml')
+</pre>
+
 h2. Environment Variables
 
 <pre>
-    Settings.use_environment 'DEST_TIME', :password => 'TM_PASS', 'delorean.power_source' => 'POWER_SOURCE'
+    Settings.env_vars 'DEST_TIME', :password => 'TM_PASS', 'delorean.power_source' => 'POWER_SOURCE'
 </pre>
 
-As usual, dotted keys set the corresponeding nested key (@'delorean.power_source'@ sets @Settings[:delorean][:power_source]@). You can alternatively set up environment variables with @define 'delorean.power_source', :environment => 'POWER_SOURCE'@ - see below.
+As usual, dotted keys set the corresponeding nested key (@'delorean.power_source'@ sets @Settings[:delorean][:power_source]@). As shown below, you may also use #define to set up environment variables: @define 'delorean.power_source', :environment => 'POWER_SOURCE'@.
 
-**NOTE**: The interface to #use_environment has changed since v0.2. You must now call it as @Settings.use_environment :param => 'ENV_VAR'@, (since everywhere else the param is used as the key).
+Environment variables are demonstrated in "examples/simple_script.rb":http://github.com/mrflip/configliere/tree/master/examples/simple_script.rb and "examples/env_var_script.rb":http://github.com/mrflip/configliere/tree/master/examples/env_var_script.rb
+
+**NOTE**: The interface to #env_vars has changed since v0.2, see "CHANGELOG.textile":CHANGELOG.textile
 
 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
 </pre>
 
 Interpretation of command-line parameters:
 * *name-val params*: @--param=val@ sets @Configliere[:param]@ to val.
-* *boolean params*: @--param@ sets @Configliere[:param]@ to be true. @--param=""@ sets @Configliere[:param]@ to be nil. 
+* *boolean params*: @--param@ sets @Configliere[:param]@ to be true. @--param=""@ sets @Configliere[:param]@ to be nil.
 * *scoped params*: @--group-sub_group-param=val@ sets @Configliere[:group][:subgroup][:param]@ to val (and similarly for boolean parameters).
 ** A dash or dot within a parameter name scopes that parameter: @--group.sub_group.param=val@ and @--group-sub_group-param=val@ do the same thing. A _ within a parameter name is left as part of the segment.
-** Only @[\w\.\-]+@ are accepted in parameter names. 
+** Only @[\w\.\-]+@ are accepted in parameter names.
 * *Settings.rest*: anything else is stored, in order, in @Settings.rest@.
 * *stop marker*: a @--@ alone stops parameter processing and tosses all remaining params (not including the @--@) into Settings.rest.
 
@@ -204,6 +215,9 @@ Here are some things you don't get:
 
 If you want more, you might like the Trollop gem.  If you enjoy wordy nightmares, use "getoptlog":http://linuxdevcenter.com/pub/a/linux/2003/09/18/ruby_csv.html?page=2 from the ruby standard library.
 
+Commandline parameters are demonstrated in "examples/simple_script.rb":http://github.com/mrflip/configliere/tree/master/examples/simple_script.rb and
+"examples/env_var_script.rb":http://github.com/mrflip/configliere/tree/master/examples/env_var_script.rb
+
 h2. Fancy Parameters
 
 You don't have to pre-define parameters, but you can:
@@ -211,15 +225,17 @@ 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 'delorean.power_source', :environment => 'POWER_SOURCE', :description => 'Delorean subsytem supplying power to the Flux Capacitor.'
+    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>
 
-* *:type*: converts params to a desired form. 
+* *:type*: converts params to a desired form.
 * *:description*: documents a param.
-* *:required*: marks params required. 
+* *:required*: marks params required.
 * *:encrypted*: marks params to be obscured when saved to disk. See [#Encrypted Parameters] below for caveats.
-* *:environment*: take param from given environment variable if set.
+* *: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
 
 h3. Type Conversion
 
@@ -261,6 +277,8 @@ bq.  There are two kinds of cryptography in this world: cryptography that will s
 
 Configliere provides the latter.  Anyone with access to the script, its config files and the config file passphrase can recover the plaintext password. Still, there's a difference between immediate access and having to find a paperclip and jimmy open your annoying older brother's stupid journal.
 
+Encrypted parameters are demonstrated in "examples/encrypted_script.rb":http://github.com/mrflip/configliere/tree/master/examples/encrypted_script.rb
+
 h2. Ruby Block
 
 <pre>
@@ -277,6 +295,8 @@ h2. Ruby Block
 
 Configliere 'finally' blocks are invoked when you call @#resolve!@.  They're guaranteed to be called at the end of the resolve chain, and before the validate chain.
 
+Config blocks are demonstrated in "examples/config_block.rb":http://github.com/mrflip/configliere/tree/master/examples/config_block.rb
+
 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:
@@ -298,7 +318,7 @@ Values in here don't overlap with the Settings object or any other settings univ
 h2. Project info
 
 h3. Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/configliere.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configliere}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mrflip"]
-  s.date = %q{2010-01-15}
+  s.date = %q{2010-01-18}
   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.
 
@@ -33,11 +33,9 @@ Configliere manage settings from many sources: static constants, simple config f
      "VERSION",
      "bin/configliere",
      "configliere.gemspec",
-     "examples/commandline_script.rb",
-     "examples/commandline_script.yaml",
-     "examples/config_block.rb",
+     "examples/config_block_script.rb",
      "examples/encrypted_script.rb",
-     "examples/foo.yaml",
+     "examples/env_var_script.rb",
      "examples/simple_script.rb",
      "examples/simple_script.yaml",
      "lib/configliere.rb",
@@ -51,7 +49,7 @@ Configliere manage settings from many sources: static constants, simple config f
      "lib/configliere/crypter.rb",
      "lib/configliere/define.rb",
      "lib/configliere/encrypted.rb",
-     "lib/configliere/environment.rb",
+     "lib/configliere/env_var.rb",
      "lib/configliere/param.rb",
      "spec/configliere/commandline_spec.rb",
      "spec/configliere/config_block_spec.rb",
@@ -61,7 +59,7 @@ Configliere manage settings from many sources: static constants, simple config f
      "spec/configliere/crypter_spec.rb",
      "spec/configliere/define_spec.rb",
      "spec/configliere/encrypted_spec.rb",
-     "spec/configliere/environment_spec.rb",
+     "spec/configliere/env_var_spec.rb",
      "spec/configliere/param_spec.rb",
      "spec/configliere_spec.rb",
      "spec/spec.opts",
@@ -81,13 +79,13 @@ Configliere manage settings from many sources: static constants, simple config f
      "spec/configliere/crypter_spec.rb",
      "spec/configliere/define_spec.rb",
      "spec/configliere/encrypted_spec.rb",
-     "spec/configliere/environment_spec.rb",
+     "spec/configliere/env_var_spec.rb",
      "spec/configliere/param_spec.rb",
      "spec/configliere_spec.rb",
      "spec/spec_helper.rb",
-     "examples/commandline_script.rb",
-     "examples/config_block.rb",
+     "examples/config_block_script.rb",
      "examples/encrypted_script.rb",
+     "examples/env_var_script.rb",
      "examples/simple_script.rb"
   ]
 

data/examples/config_block_script.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+$: << File.dirname(__FILE__)+'/../lib'
+require 'configliere'
+Settings.use :config_block
+
+Settings.define :passenger
+Settings.define :dest_time, :type => DateTime
+Settings :passenger => 'einstein', :dest_time => '1955-11-05'
+
+Settings.finally do |c|
+  p [self, 'finally', c[:passenger], c.passenger]
+  # Einstein the dog should only be sent one minute into the future.
+  c.dest_time = (Time.now + 60) if c.passenger == 'einstein'
+end
+Settings.resolve!
+p Settings

data/examples/encrypted_script.rb

@@ -1,17 +1,52 @@
 #!/usr/bin/env ruby
+require 'rubygems'
 require 'configliere'
-
 DUMP_FILENAME = '/tmp/encrypted_script.yml'
-Settings.use :config_file, :define, :encrypt_pass => 'password1'
-Settings.define :password, :encrypted => true
 
-Settings :password => 'plaintext'
+#
+# Example usage:
+#   export ENCRYPT_PASS=password1
+#   ./examples/encrypted_script.rb
+#
+
+puts %Q{Many times, scripts need to save values you\'d rather not leave as
+plaintext: API keys, database passwords, etc. Instead of leaving them in plain
+sight, you may wish to obscure their value on disk and use a secondary password
+to unlock it.
+
+View source for this script to see commands you might use (from the irb console
+or in a standalone script) to store the obscured values for later decryption.}
+
+Settings.use :config_file, :define, :encrypted, :encrypt_pass => 'password1'
+Settings.define :password, :encrypted => true, :default => 'plaintext'
 Settings.resolve!
-p ["saved version will have encrypted password (see #{DUMP_FILENAME}).", Settings.send(:export)]
-p ['live version still has password in plaintext', Settings]
+
+puts "\nIn-memory version still has password in plaintext..."
+puts "  #{Settings.inspect}"
+puts "But the saved version will have encrypted password (see #{DUMP_FILENAME}):"
+puts "  #{Settings.send(:export).inspect}"
 Settings.save!(DUMP_FILENAME)
 
-Settings[:password] = 'before read'
+puts "If we now load the saved file, the parameter's value is decrypted on resolve:"
+Settings[:password] = 'nothing up my sleeve'
 Settings.read('/tmp/encrypted_script.yml')
 Settings.resolve!
-p ["value is decrypted on resolve.", Settings]
+puts "  #{Settings.inspect}"
+
+# unset encrypt_pass
+Settings.encrypt_pass = nil
+
+puts %Q{\nOf course, in your script you\'ll have to supply the decryption
+password.  The best thing is to use an environment variable -- a user can spy on
+your commandline parameters using "ps" or "top".  The following will fail unless
+you supply the correct password ("password1") in the ENCRYPT_PASS environment
+variable:\n\n}
+
+Settings.define :encrypt_pass, :env_var => 'ENCRYPT_PASS'
+Settings.read('/tmp/encrypted_script.yml')
+begin
+  Settings.resolve!
+  puts "  #{Settings.inspect}"
+rescue RuntimeError => e
+  warn "  #{e}"
+end

data/examples/env_var_script.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+$: << File.dirname(__FILE__)+'/../lib'
+require 'configliere'
+
+Settings.use :define, :env_var, :commandline
+Settings.define :underpants, :env_var => 'UNDERPANTS', :default => "boxers"
+Settings.resolve!
+
+puts %Q{
+Configliere can take parameter values from its defaults, from the commandline, or from the environment.
+Compare:
+
+./env_var_script.rb                                           # value from default
+./env_var_script.rb --underpants=briefs                       # value from commandline
+UNDERPANTS="commando" ./env_var_script.rb                     # value from environment variable
+UNDERPANTS="commando" ./env_var_script.rb --underpants=briefs # commandline wins
+
+}
+
+puts %Q{Using
+* the default setting of:   #{Settings.param_definitions[:underpants][:default].inspect}
+* the environment variable: #{ENV['UNDERPANTS'].inspect}
+* the commandline setting:  #{ARGV.grep(/^--underpants/).inspect}
+your configliere advises that
+  #{Settings.inspect}
+}

data/examples/simple_script.rb

@@ -2,20 +2,26 @@
 $: << File.dirname(__FILE__)+'/../lib'
 require 'configliere'
 
-# Intro text
-puts %Q{
-This is a demo of the Configliere interface. It takse settings
-Try running it as
-  ./examples/simple_script.rb --sprats.wife=fat --spider=drainspout
-with those args, we
-  expect: {:spider=>"drainspout", :cat=>"hat", :sprats=>{:wife=>"fat", :jack=>"lean"}, :cow=>"moon"}
-}
+puts "This is a demo of Configliere in a simple script."
+Settings.use :commandline, :config_file
 
-Settings.use(:commandline, :config_file,
-      :cat => 'bag', :cow => 'moon')
-Settings.read File.dirname(__FILE__)+'/simple_script.yaml'
+puts "You can set default values:"
+Settings.defaults :cat => 'bag', :cow => 'moon'
+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
+puts "  #{Settings.inspect}"
+
+puts %Q{\nTry running the script with commandline parameters, for example
+  #{$0} --sprats.wife=fat --spider=waterspout
+In this case, you used
+  #{$0} #{ARGV.join(" ")}
+and so the final parameter values are}
 Settings.resolve!
+puts "  #{Settings.inspect}"
 
-# Print results
-print '  actual: '
-p Settings
+saved_filename = '/tmp/simple_script_saved.yaml'
+puts %Q{\nYou can save the defaults out to a config file.  These settings have been written to #{saved_filename}}
+Settings.save!(saved_filename)

data/lib/configliere.rb

@@ -14,7 +14,7 @@ module Configliere
     Configliere::Param.new *args, &block
   end
 
-  ALL_MIXINS = [:define, :encrypted, :environment, :config_file, :commandline, :config_block]
+  ALL_MIXINS = [:define, :encrypted, :env_var, :config_file, :commandline, :config_block]
   def self.use *mixins
     mixins = ALL_MIXINS if mixins.include?(:all)
     mixins.each do |mixin|

data/lib/configliere/commandline.rb

@@ -18,7 +18,7 @@ module Configliere
     def resolve!
       process_argv!
       dump_help_if_requested
-      begin ; super() ; rescue NoMethodError ; nil ; end
+      super()
     end
 
     #
@@ -88,7 +88,7 @@ module Configliere
       help_str  = [ usage ]
       help_str += [ "\nParams:", descriptions.sort_by{|p,d| p.to_s }.map{|param, desc| "  --%-25s %s"%[param.to_s+':', desc]}.join("\n"), ] if respond_to?(:descriptions)
       # help_str += ["\nCommands", commands.map{|cmd, desc| "  %-20s %s"%[cmd.to_s+':', desc]}.join("\n")] if respond_to?(:commands)
-      help_str += [ "\nEnvironment Variables can be used to set:", params_from_environment.map{|param, env| "  %-27s %s"%[env.to_s+':', param]}.join("\n"), ] if respond_to?(:params_from_environment)
+      help_str += [ "\nEnvironment Variables can be used to set:", params_from_env_vars.map{|param, env| "  %-27s %s"%[env.to_s+':', param]}.join("\n"), ] if respond_to?(:params_from_env_vars)
       help_str.join("\n")
     end
 

data/lib/configliere/config_block.rb

@@ -32,7 +32,7 @@ module Configliere
     # The resolve! for config_block is made to run last of all in the +resolve!+
     # chain, and runs each +finally+ block in the order it was defined.
     def resolve!
-      begin ; super() ; rescue NoMethodError ; nil ; end
+      super
       resolve_finally_blocks!
       self
     end

data/lib/configliere/define.rb

@@ -13,10 +13,10 @@ module Configliere
     #
     def define param, definitions={}
       self.param_definitions[param].merge! definitions
-      self.use(:environment) if definitions.include?(:encrypted)
-      self.use(:encrypted)   if definitions.include?(:encrypted)
+      self.use(:env_var)   if definitions.include?(:env_var)
+      self.use(:encrypted) if definitions.include?(:encrypted)
       self[param] = definitions[:default] if definitions.include?(:default)
-      self.environment_variables definitions[:environment], param if definitions.include?(:environment)
+      self.env_vars definitions[:env_var], param if definitions.include?(:env_var)
     end
 
     def param_definitions
@@ -27,13 +27,13 @@ module Configliere
     # performs type coercion
     def resolve!
       resolve_types!
-      begin ; super() ; rescue NoMethodError ; nil ; end
+      super()
       self
     end
 
     def validate!
       validate_requireds!
-      begin ; super() ; rescue NoMethodError ; nil ; end
+      super()
       true
     end
 
@@ -163,17 +163,17 @@ module Configliere
     #   Settings.foo = 4
     #   Settings.foo      #=> 4
     def method_missing meth, *args
-      meth.to_s =~ /^(\w+)(=)?$/
-      name, setter = [$1, $2]
-      super unless name && param_definitions.include?(name)
+      meth.to_s =~ /^(\w+)(=)?$/ or return super
+      name, setter = [$1.to_sym, $2]
+      return(super) unless param_definitions.include?(name)
       if setter && (args.size == 1)
-        self[$1] = args.first
+        self[name] = args.first
       elsif (!setter) && args.empty?
-        self[meth]
+        self[name]
       else super ; end
     end
-  end
 
+  end
   Param.class_eval do
     include Configliere::Define
   end

data/lib/configliere/encrypted.rb

@@ -9,7 +9,7 @@ module Configliere
     # then calls the next step in the resolve! chain.
     def resolve!
       resolve_encrypted!
-      begin ; super() ; rescue NoMethodError ; nil ; end
+      super()
       self
     end
 

data/lib/configliere/{environment.rb → env_var.rb}

@@ -2,31 +2,31 @@ require 'yaml'
 Configliere.use :define
 module Configliere
   #
-  # Environment -- load configuration from environment variables
+  # EnvVar -- load configuration from environment variables
   #
-  module Environment
-    def environment_variables *envs
+  module EnvVar
+    def env_vars *envs
       envs.each do |env|
         case env
         when Hash
           env.each do |param, env|
-            adopt_environment_variable! param, env
+            adopt_env_var! param, env
           end
         else
           param = env.to_s.downcase.to_sym
-          adopt_environment_variable! param, env
+          adopt_env_var! param, env
         end
       end
     end
 
-    def params_from_environment
-      definitions_for(:environment)
+    def params_from_env_vars
+      definitions_for(:env_var)
     end
 
   protected
-    def adopt_environment_variable! param, env
+    def adopt_env_var! param, env
       env   = env.to_s
-      param_definitions[param][:environment] ||= env
+      param_definitions[param][:env_var] ||= env
       val = ENV[env]
       self[param] = val if val
     end
@@ -34,7 +34,7 @@ module Configliere
 
   Param.class_eval do
     # include read / save operations
-    include Environment
+    include EnvVar
   end
 end
 

data/lib/configliere/param.rb

@@ -1,9 +1,6 @@
 require 'configliere/core_ext/sash.rb'
 module Configliere
   class ParamParent < ::Hash
-    def finally *args, &block
-      nil #no-op
-    end
     # default export method: self
     def export
       to_hash
@@ -11,9 +8,8 @@ module Configliere
     # terminate resolution chain
     def resolve!
     end
-
+    # terminate validation chain
     def validate!
-      true
     end
   end
 
@@ -63,12 +59,12 @@ module Configliere
 
     # Finalize and validate params
     def resolve!
-      begin ; super() ; rescue NoMethodError ; nil ; end
+      super()
       validate!
     end
     # Check that all defined params are valid
     def validate!
-      begin ; super() ; rescue NoMethodError ; nil ; end
+      super()
     end
 
     def []= param, val
@@ -101,11 +97,6 @@ module Configliere
       self.deep_merge!(hsh) unless hsh.nil?
     end
 
-    # see Configliere::ConfigBlock#finally
-    def finally *args, &block
-      use :config_block
-      super
-    end
   protected
     # @param key<Object> The key to convert.
     #

data/spec/configliere/{environment_spec.rb → env_var_spec.rb}

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-Configliere.use :environment
+Configliere.use :env_var
 
-describe "Configliere::Environment" do
+describe "Configliere::EnvVar" do
   before do
     @config = Configliere::Param.new
   end
@@ -9,13 +9,13 @@ describe "Configliere::Environment" do
   describe 'loads environment variables' do
     it 'loads a simple value into the corresponding symbolic key' do
       ENV.should_receive(:[]).with('HOME').and_return('/fake/path')
-      @config.environment_variables 'HOME'
+      @config.env_vars 'HOME'
       @config[:home].should == '/fake/path'
     end
     it 'loads a hash into the individual params' do
       ENV.should_receive(:[]).with('HOME').and_return('/fake/path')
       ENV.should_receive(:[]).with('POWER_SUPPLY').and_return('1.21 jigawatts')
-      @config.environment_variables :home => 'HOME', 'delorean.power_supply' => 'POWER_SUPPLY'
+      @config.env_vars :home => 'HOME', 'delorean.power_supply' => 'POWER_SUPPLY'
       @config[:home].should == '/fake/path'
       @config[:delorean][:power_supply].should == '1.21 jigawatts'
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: configliere
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - mrflip
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-15 00:00:00 -06:00
+date: 2010-01-18 00:00:00 -06:00
 default_executable: configliere
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,11 +52,9 @@ files:
 - VERSION
 - bin/configliere
 - configliere.gemspec
-- examples/commandline_script.rb
-- examples/commandline_script.yaml
-- examples/config_block.rb
+- examples/config_block_script.rb
 - examples/encrypted_script.rb
-- examples/foo.yaml
+- examples/env_var_script.rb
 - examples/simple_script.rb
 - examples/simple_script.yaml
 - lib/configliere.rb
@@ -70,7 +68,7 @@ files:
 - lib/configliere/crypter.rb
 - lib/configliere/define.rb
 - lib/configliere/encrypted.rb
-- lib/configliere/environment.rb
+- lib/configliere/env_var.rb
 - lib/configliere/param.rb
 - spec/configliere/commandline_spec.rb
 - spec/configliere/config_block_spec.rb
@@ -80,7 +78,7 @@ files:
 - spec/configliere/crypter_spec.rb
 - spec/configliere/define_spec.rb
 - spec/configliere/encrypted_spec.rb
-- spec/configliere/environment_spec.rb
+- spec/configliere/env_var_spec.rb
 - spec/configliere/param_spec.rb
 - spec/configliere_spec.rb
 - spec/spec.opts
@@ -122,11 +120,11 @@ test_files:
 - spec/configliere/crypter_spec.rb
 - spec/configliere/define_spec.rb
 - spec/configliere/encrypted_spec.rb
-- spec/configliere/environment_spec.rb
+- spec/configliere/env_var_spec.rb
 - spec/configliere/param_spec.rb
 - spec/configliere_spec.rb
 - spec/spec_helper.rb
-- examples/commandline_script.rb
-- examples/config_block.rb
+- examples/config_block_script.rb
 - examples/encrypted_script.rb
+- examples/env_var_script.rb
 - examples/simple_script.rb

data/examples/commandline_script.rb

@@ -1,74 +0,0 @@
-#!/usr/bin/env ruby
-require 'rubygems' ; $: << File.dirname(__FILE__)+'/../lib'
-require 'pp'
-# module Configliere ; DEFAULT_CONFIG_FILENAME = File.dirname(__FILE__)+'/commandline_script.yaml' end
-require 'configliere'
-
-Settings.use :all
-
-puts %Q{
-This is a demo of the Configliere interface. It parses all command line options to load keys, global options, etc.
-
-Try running it as
-
-   PLACES='go' NOISES='who' ./examples/simple_script.rb --cat=hat
-
-which should create
-
-  expect: {:password=>"zike_bike", :horton=>{:hears_a=>"who"}, :key=>"asdf", :cat=>"hat", :things=>["thing_1", "thing_2"], :rate_per_hour=>10, :places=>"go", :wocket=>"pocket"}
-}
-
-# describe and define params
-Settings.define :cat,    :description => 'The type of feline haberdashery to include in the story', :required => true, :type => Symbol
-Settings.define :wocket, :description => 'where the wocket is residing'
-Settings.define :password, :encrypted => true
-
-# static settings
-Settings :wocket => 'pocket', :key => 'asdf'
-# from environment
-Settings.environment_variables 'PLACES', 'NOISES' => 'horton.hears_a'
-
-# from config file
-Settings.read(File.dirname(__FILE__)+'/commandline_script.yaml')
-
-# from finally block
-Settings.finally do |c|
-  c.lorax = 'tree'
-end
-
-# bookkeeping
-Settings.resolve!
-# Get the value for param[:key] from the keyboard if missing
-Settings.param_or_ask :key
-
-# Print results
-print '  actual: '
-p Settings
-
-
-fiddle = Configliere.new; fiddle.encrypt_pass = 'pass'
-fiddle.define 'amazon.api.key', :encrypted => true
-fiddle['amazon.api.encrypted_key'] = "{bo\335\256nt2Rc\016\244\216c\030\2627g\233%\300\035l\225\325\305z\207LR\333\035"
-fiddle.resolve!
-puts  'expect: [nil, "bite_me"]'
-print "actual: "; p [fiddle['amazon.api.encrypted_key'], fiddle['amazon.api.key'], fiddle.send(:export)]
-#
-fiddle = Configliere.new; fiddle.encrypt_pass = 'pass'
-fiddle.define 'amazon.api.key', :encrypted => true
-fiddle['amazon.api.key'] = 'bite_me'
-fiddle.resolve!
-puts  'expect: [nil, "bite_me"]'
-print "actual: "; p [fiddle['amazon.api.encrypted_key'], fiddle['amazon.api.key'], fiddle.send(:export)]
-#
-fiddle = Configliere.new; fiddle.encrypt_pass = 'pass'
-fiddle.define 'amazon.api.key', :encrypted => true
-fiddle['amazon.api.encrypted_key'] = "{bo\335\256nt2Rc\016\244\216c\030\2627g\233%\300\035l\225\325\305z\207LR\333\035"
-# fiddle.resolve!
-puts  'expect: ["{bo\335\256nt2Rc\016\244\216c\030\2627g\233%\300\035l\225\325\305z\207LR\333\035", nil]'
-print "actual: "; p [fiddle['amazon.api.encrypted_key'], fiddle['amazon.api.key'], fiddle.send(:export)]
-
-
-
-# save to disk
-# you can check that :password and :api_key have been properly encrypted.
-Settings.save! File.dirname(__FILE__)+'/foo.yaml'

data/examples/commandline_script.yaml

@@ -1,8 +0,0 @@
---- 
-:encrypted_password: !binary |
-  el58XhZZYLJ+IZZ1/Q1ab/JSyI7KuYyj8+dgf2vW9Fw=
-
-:things: 
-- thing_1
-- thing_2
-:rate_per_hour: 10

data/examples/config_block.rb

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-require 'configliere'
-
-Settings :passenger => 'einstein', :dest_time => '1955-11-05', 'delorean.power_source' => :plutonium
-Settings.finally do |c|
-  p [self, 'finally', c[:passenger], c.passenger]
-  # Einstein the dog should only be sent one minute into the future.
-  dest_time = (Time.now + 60) if c.passenger == 'einstein'
-end
-Settings.resolve!
-p Settings

data/examples/foo.yaml

@@ -1,15 +0,0 @@
---- 
-:horton: 
-  :hears_a: who
-:wocket: pocket
-:encrypted_password: !binary |
-  BdwUvxy0xWh2oB5yWKm/BZ099E6pi+6Al+k09PoPik4=
-
-:things: 
-- thing_1
-- thing_2
-:lorax: tree
-:rate_per_hour: 10
-:cat: :hat
-:key: asdf
-:places: go