configliere 0.0.9 → 0.1.0

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.1.0

data/configliere.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configliere}
-  s.version = "0.0.9"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mrflip"]
-  s.date = %q{2010-05-10}
+  s.date = %q{2010-08-10}
   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.
 
@@ -69,7 +69,7 @@ Configliere manage settings from many sources: static constants, simple config f
   s.homepage = %q{http://github.com/mrflip/configliere}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Wise, discreet configuration management}
   s.test_files = [
     "spec/configliere/commandline_spec.rb",
@@ -94,7 +94,7 @@ Configliere manage settings from many sources: static constants, simple config f
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else

data/lib/configliere.rb

@@ -17,6 +17,10 @@ module Configliere
       require "configliere/#{mixin}"
     end
   end
+
+  # Base class for Configliere errors.
+  Error = Class.new(StandardError)
+  
 end
 
 # Defines a global config object

data/lib/configliere/commandline.rb

@@ -47,6 +47,11 @@ module Configliere
           if    val == nil then val = true              # --flag    option on its own means 'set that option'
           elsif val == ''  then val = nil end           # --flag='' the explicit empty string means nil
           self[param] = val
+        when arg =~ /\A-(\w+)\z/
+          $1.each_char do |flag|
+            param = param_with_flag(flag)
+            self[param] = true if param
+          end
         else
           self.rest << arg
         end
@@ -79,11 +84,56 @@ module Configliere
       self[attr] = ask("#{attr}"+(hint ? " for #{hint}?" : '?'))
     end
 
+    # Retreive the first param defined with the given flag.
+    def param_with_flag flag
+      params_with(:flag).each do |param|
+        return param if param_definitions[param][:flag].to_s == flag.to_s
+      end
+      raise Configliere::Error.new("Unknown option: -#{flag}") if complain_about_bad_flags?
+    end
+
+    # Returns a flag in dashed form, suitable for recycling into the commandline
+    # of an external program.
+    # Can specify a specific flag name, otherwise the given setting key is used
+    #
+    # @example
+    #   Settings.dashed_flag_for(:flux_capacitance)
+    #   #=> --flux-capacitance=0.7
+    #   Settings.dashed_flag_for(:screw_you, :hello_friend)
+    #   #=> --hello-friend=true
+    #
+    def dashed_flag_for setting_name, flag_name=nil
+      flag_name ||= setting_name
+      "--#{flag_name.to_s.gsub(/_/,"-")}=#{Settings[setting_name]}"
+    end
+
+    # Complain about bad flags?
+    def complain_about_bad_flags?
+      @complain_about_bad_flags
+    end
+
+    # Force this params object to complain about bad (single-letter)
+    # flags on the command-line.
+    def complain_about_bad_flags!
+      @complain_about_bad_flags = true
+    end
+
     # The contents of the help message.
     # Lists the usage as well as any defined parameters and environment variables
     def help
       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)
+      if respond_to?(:descriptions)
+        help_str += ["\nParams"]
+        ordered_params_and_descs = descriptions.sort_by{|p,d| p.to_s }
+        param_help_strings       = ordered_params_and_descs.map do |param, desc|
+          if flag = param_definitions[param][:flag]
+            "  -%s, --%-21s %s" % [flag.to_s.first, param.to_s + ':', desc]
+          else
+            "  --%-25s %s" % [param.to_s + ':', desc]
+          end
+        end
+        help_str += param_help_strings
+      end
       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/define.rb

@@ -11,12 +11,15 @@ module Configliere
     #   Settings.define 'delorean.power_source', :description => 'Delorean subsytem supplying power to the Flux Capacitor.'
     #   Settings.define :password, :required => true, :obscure => true
     #
-    def define param, definitions={}
+    def define param, definitions={}, &block
       self.param_definitions[param].merge! definitions
-      self.use(:env_var)   if definitions.include?(:env_var)
-      self.use(:encrypted) if definitions.include?(:encrypted)
+      self.use(:env_var)      if definitions.include?(:env_var)
+      self.use(:encrypted)    if definitions.include?(:encrypted)
+      self.use(:config_block) if definitions.include?(:finally)
       self[param] = definitions[:default] if definitions.include?(:default)
       self.env_vars param => definitions[:env_var] if definitions.include?(:env_var)
+      self.finally(&definitions[:finally]) if definitions.include?(:finally)
+      self.finally(&block) if block
     end
 
     def param_definitions

data/spec/configliere/commandline_spec.rb

@@ -2,61 +2,101 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 require 'configliere/commandline'
 
 describe "Configliere::Commandline" do
-  before do
-    @config = Configliere::Param.new :param_1 => 'val 1', :cat => :hat
-  end
 
-  it 'handles --param=val pairs' do
-    ::ARGV.replace ['--my_param=my_val']
-    @config.resolve!
-    @config.should == { :my_param => 'my_val', :param_1 => 'val 1', :cat => :hat}
-  end
-  it 'handles --dotted.param.name=val pairs' do
-    ::ARGV.replace ['--dotted.param.name=my_val']
-    @config.resolve!
-    @config.rest.should be_empty
-    @config.should == { :dotted => { :param => { :name => 'my_val' }}, :param_1 => 'val 1', :cat => :hat}
-  end
-  it 'handles --dashed-param-name=val pairs' do
-    ::ARGV.replace ['--dashed-param-name=my_val']
-    @config.resolve!
-    @config.rest.should be_empty
-    @config.should == { :dashed => { :param => { :name => 'my_val' }}, :param_1 => 'val 1', :cat => :hat}
-  end
-  it 'uses the last-seen of the commandline values' do
-    ::ARGV.replace ['--param_1=A', '--param_1=B']
-    @config.resolve!
-    @config.rest.should be_empty
-    @config.should == { :param_1 => 'B', :cat => :hat}
-  end
-  it 'sets a bare parameter (no "=") to true' do
-    ::ARGV.replace ['--param_1', '--deep.param']
-    @config.resolve!
-    @config.rest.should be_empty
-    @config.should == { :param_1 => true, :deep => { :param => true }, :cat => :hat}
-  end
-  it 'sets an explicit blank to nil' do
-    ::ARGV.replace ['--param_1=', '--deep.param=']
-    @config.resolve!
-    @config.should == { :param_1 => nil, :deep => { :param => nil }, :cat => :hat}
+  after do
+    ::ARGV.replace []
   end
+  
+  describe "processing long-format flags" do
+    before do
+      @config = Configliere::Param.new :param_1 => 'val 1', :cat => :hat
+    end
 
-  it 'saves non --param args into rest' do
-    ::ARGV.replace ['--param_1', 'file1', 'file2']
-    @config.resolve!
-    @config.should == { :param_1 => true, :cat => :hat}
-    @config.rest.should == ['file1', 'file2']
-  end
+    it 'should handle --param=val pairs' do
+      ::ARGV.replace ['--my_param=my_val']
+      @config.resolve!
+      @config.should == { :my_param => 'my_val', :param_1 => 'val 1', :cat => :hat}
+    end
+    it 'should handle --dotted.param.name=val pairs' do
+      ::ARGV.replace ['--dotted.param.name=my_val']
+      @config.resolve!
+      @config.rest.should be_empty
+      @config.should == { :dotted => { :param => { :name => 'my_val' }}, :param_1 => 'val 1', :cat => :hat}
+    end
+    it 'should handle --dashed-param-name=val pairs' do
+      ::ARGV.replace ['--dashed-param-name=my_val']
+      @config.resolve!
+      @config.rest.should be_empty
+      @config.should == { :dashed => { :param => { :name => 'my_val' }}, :param_1 => 'val 1', :cat => :hat}
+    end
+    it 'should handle the last-seen of the commandline values' do
+      ::ARGV.replace ['--param_1=A', '--param_1=B']
+      @config.resolve!
+      @config.rest.should be_empty
+      @config.should == { :param_1 => 'B', :cat => :hat}
+    end
+    it 'should set a bare parameter (no "=") to true' do
+      ::ARGV.replace ['--param_1', '--deep.param']
+      @config.resolve!
+      @config.rest.should be_empty
+      @config.should == { :param_1 => true, :deep => { :param => true }, :cat => :hat}
+    end
+    it 'should set an explicit blank to nil' do
+      ::ARGV.replace ['--param_1=', '--deep.param=']
+      @config.resolve!
+      @config.should == { :param_1 => nil, :deep => { :param => nil }, :cat => :hat}
+    end
 
-  it 'stops processing on "--"' do
-    ::ARGV.replace ['--param_1=A', '--', '--param_1=B']
-    @config.resolve!
-    @config.rest.should == ['--param_1=B']
-    @config.should == { :param_1 => 'A', :cat => :hat}
+    it 'should save non --param args into rest' do
+      ::ARGV.replace ['--param_1', 'file1', 'file2']
+      @config.resolve!
+      @config.should == { :param_1 => true, :cat => :hat}
+      @config.rest.should == ['file1', 'file2']
+    end
+
+    it 'should stop processing on "--"' do
+      ::ARGV.replace ['--param_1=A', '--', '--param_1=B']
+      @config.resolve!
+      @config.rest.should == ['--param_1=B']
+      @config.should == { :param_1 => 'A', :cat => :hat}
+    end
   end
 
-  after do
-    ::ARGV.replace []
+  describe "processing single-letter flags" do
+
+    before do
+      @config = Configliere::Param.new :param_1 => 'val 1', :cat => nil, :foo => nil
+      @config.param_definitions = { :param_1 => { :flag => :p }, :cat =>  { :flag => 'c' } }
+    end
+
+    it 'should parse flags given separately' do
+      ::ARGV.replace ['-p', '-c']
+      @config.resolve!
+      @config.rest.should == []
+      @config.should == { :param_1 => true, :cat => true, :foo => nil}
+    end
+
+    it 'should parse flags given together' do
+      ::ARGV.replace ['-pc']
+      @config.resolve!
+      @config.rest.should == []
+      @config.should == { :param_1 => true, :cat => true, :foo => nil}
+    end
+
+    it 'should not complain about bad single-letter flags by default' do
+      ::ARGV.replace ['-pcz']
+      @config.resolve!
+      @config.rest.should == []
+      @config.should == { :param_1 => true, :cat => true, :foo => nil}
+    end
+
+    it 'should raise an error about bad single-letter flags if asked' do
+      ::ARGV.replace ['-pcz']
+      @config.complain_about_bad_flags!
+      lambda { @config.resolve! }.should raise_error(Configliere::Error)
+    end
+    
   end
+  
 end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: configliere
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - mrflip
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-10 00:00:00 -05:00
+date: 2010-08-10 00:00:00 -05:00
 default_executable: configliere
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -35,9 +38,11 @@ dependencies:
   name: yard
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -105,23 +110,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Wise, discreet configuration management