configliere 0.2.3 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/configliere.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configliere}
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mrflip"]
-  s.date = %q{2011-04-02}
+  s.date = %q{2011-03-01}
   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.
 
@@ -39,6 +39,7 @@ Configliere manage settings from many sources: static constants, simple config f
     "examples/simple_script.yaml",
     "lib/configliere.rb",
     "lib/configliere/commandline.rb",
+    "lib/configliere/commands.rb",
     "lib/configliere/config_block.rb",
     "lib/configliere/config_file.rb",
     "lib/configliere/core_ext.rb",
@@ -49,9 +50,9 @@ Configliere manage settings from many sources: static constants, simple config f
     "lib/configliere/define.rb",
     "lib/configliere/encrypted.rb",
     "lib/configliere/env_var.rb",
-    "lib/configliere/git_style_binaries.rb",
     "lib/configliere/param.rb",
     "spec/configliere/commandline_spec.rb",
+    "spec/configliere/commands_spec.rb",
     "spec/configliere/config_block_spec.rb",
     "spec/configliere/config_file_spec.rb",
     "spec/configliere/core_ext/hash_spec.rb",
@@ -75,6 +76,7 @@ Configliere manage settings from many sources: static constants, simple config f
     "examples/env_var_script.rb",
     "examples/simple_script.rb",
     "spec/configliere/commandline_spec.rb",
+    "spec/configliere/commands_spec.rb",
     "spec/configliere/config_block_spec.rb",
     "spec/configliere/config_file_spec.rb",
     "spec/configliere/core_ext/hash_spec.rb",

data/lib/configliere.rb

@@ -10,11 +10,16 @@ module Configliere
     Configliere::Param.new(*args, &block)
   end
 
-  ALL_MIXINS = [:define, :config_file, :commandline, :encrypted, :env_var, :config_block, :git_style_binaries]
+  ALL_MIXINS = [:define, :config_file, :commandline, :encrypted, :env_var, :config_block, :commands]
   def self.use *mixins
     mixins = ALL_MIXINS if mixins.include?(:all) || mixins.empty?
     mixins.each do |mixin|
-      require "configliere/#{mixin}"
+      # backwards compatibility
+      if mixin.to_sym == :git_style_binaries
+        require "configliere/commands"
+      else
+        require "configliere/#{mixin}"
+      end
     end
   end
 

data/lib/configliere/commandline.rb

@@ -6,6 +6,7 @@ module Configliere
   #
   module Commandline
     attr_accessor :rest
+    alias_method :argv, :rest
 
     # Processing to reconcile all options
     #
@@ -37,27 +38,40 @@ module Configliere
       until args.empty? do
         arg = args.shift
         case
+        # end of options parsing
         when arg == '--'
           self.rest += args
           break
+        # --param=val
         when arg =~ /\A--([\w\-\.]+)(?:=(.*))?\z/
           param, val = [$1, $2]
           param.gsub!(/\-/, '.')                        # translate --scoped-flag to --scoped.flag
           param = param.to_sym unless (param =~ /\./)   # symbolize non-scoped keys
-          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
+          self[param] = parse_value(val)
+        # -abc
         when arg =~ /\A-(\w+)\z/
           $1.each_char do |flag|
             param = param_with_flag(flag)
             self[param] = true if param
           end
+        # -a=val
+        # when arg =~ /\A-(\w)=(.*)\z/
+        #   param, val = param_with_flag($1), $2
+        #   self[param] = parse_value(val) if param
         else
           self.rest << arg
         end
       end
     end
 
+    def parse_value val
+      case
+      when val == nil then true            # --flag    option on its own means 'set that option'
+      when val == '' then nil             # --flag='' the explicit empty string means nil      
+      else val                             # else just return the value
+      end
+    end
+
     # Configliere internal params
     def define_special_params
       Settings.define :encrypt_pass, :description => "Passphrase to extract encrypted config params.", :internal => true
@@ -123,33 +137,48 @@ module Configliere
       @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 ]
-      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
+    # Return the params for which a line should be printed giving
+    # their usage.
+    def params_with_command_line_help
+      descriptions.reject{ |param, desc| param_definitions[param][:no_command_line_help] }.sort_by{ |param, desc| param.to_s }
+    end
+
+    # Help on the flags used.
+    def flags_help
+      help = ["\nParams"]
+      help += params_with_command_line_help.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
-        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
+
+    # Return the params for which a line should be printing giving
+    # their dependence on environment variables.
+    def params_with_env_help
+      definitions_for(:env_var).reject { |param, desc| param_definitions[param][:no_help] || param_definitions[param][:no_env_help] }
+    end
+
+    # Help on environment variables.
+    def env_var_help
+      [ "\nEnvironment Variables can be used to set:"] + params_with_env_help.map{ |param, env| "  %-27s %s"%[env.to_s, param]}
     end
 
     # Output the help message to $stderr, along with an optional extra message appended.
-    def dump_help extra_msg=nil
-      $stderr.puts help
+    def dump_basic_help extra_msg=nil
+      $stderr.puts [:flags_help, :env_var_help].map { |help| send(help) }.flatten.compact.join("\n") if respond_to?(:descriptions)
       $stderr.puts "\n\n"+extra_msg unless extra_msg.blank?
       $stderr.puts ''
     end
 
+    def dump_help str=nil
+      dump_basic_help
+      dump_command_help if respond_to?(:dump_command_help)
+      puts str if str
+    end
+      
     def raw_script_name
       File.basename($0)
     end
@@ -164,6 +193,7 @@ module Configliere
     # Ouput the help string if requested
     def dump_help_if_requested
       return unless self[:help]
+      $stderr.puts usage
       dump_help
       exit
     end

data/lib/configliere/commands.rb

@@ -0,0 +1,111 @@
+Configliere.use :commandline
+module Configliere
+
+  #
+  # Command line tool to manage param info
+  #
+  # To include, specify
+  #
+  #   Configliere.use :commands
+  #
+  module Commands
+
+    # The name of the command.
+    attr_accessor :command_name
+
+    # Add a command, along with a description of its predicates and the command itself.
+    def define_command cmd, options={}, &block
+      command_configuration = Configliere.new
+      yield command_configuration if block_given?
+      commands[cmd] = options.merge(:config => command_configuration)
+    end
+
+    # Define a help command.
+    def define_help_command!
+      define_command :help, :description => "Print detailed help on each command"
+    end
+
+    # Are there any commands that have been defined?
+    def commands?
+      (! commands.empty?)
+    end
+    
+    # Is +cmd+ the name of a known command?
+    def command? cmd
+      return false if cmd.blank?
+      commands.include?(cmd) || commands.include?(cmd.to_s)
+    end
+
+    def commands
+      @commands ||= Sash.new
+    end
+
+    def command
+      command_name && commands[command_name]
+    end
+
+    # The Param object for the command
+    def command_settings
+      command && command[:config]
+    end
+
+    def resolve!
+      super()
+      commands.each_value do |command|
+        command[:config].resolve!
+      end
+    end
+
+    #
+    # Parse the command-line args into the params hash.
+    #
+    # '--happy_flag'   produces :happy_flag => true in the params hash
+    # '--foo=foo_val'  produces :foo => 'foo_val' in the params hash.
+    # '--'             Stop parsing; all remaining args are piled into :rest
+    #
+    # self.rest        contains all arguments that don't start with a '--'
+    #                  and all args following the '--' sentinel if any.
+    #
+    def process_argv!
+      super()
+      if raw_script_name =~ /(\w+)-([\w\-]+)/
+        self.command_name = $2
+      else
+        self.command_name = rest.shift if command?(rest.first)
+      end
+    end
+
+    # The script name without command appendix if any: For $0 equal to any of
+    # 'git', 'git-reset', or 'git-cherry-pick', base_script_name is 'git'
+    #
+    def base_script_name
+      raw_script_name.gsub(/-.*/, '')
+    end
+
+    # Usage line
+    def usage
+      %Q{usage: #{base_script_name} command [...--param=val...]}
+    end
+
+    # Return help on commands.
+    def dump_command_help
+      help = ["Available commands"]
+      help += commands.keys.map(&:to_s).sort.map do |key|
+        "  %-27s %s" % [key.to_s, commands[key][:description]] unless commands[key][:no_help]
+      end
+      help += ["\nRun `#{base_script_name} help COMMAND' for more help on COMMAND"] if command?(:help)
+      $stderr.puts help.join("\n")
+    end
+    
+  end
+
+  Param.class_eval do
+    # include command syntax methods in chain.  Since commandline is required
+    # first at the top of this file, Commands methods sit below
+    # Commandline methods in the superclass chain.
+    include Commands
+  end
+end
+
+
+puts "Loaded #{__FILE__}"

data/lib/configliere/config_file.rb

@@ -13,16 +13,7 @@ module Configliere
     # Load params from disk.
     # * file is in YAML format, as a hash of handle => param_hash pairs
     # * filename defaults to Configliere::DEFAULT_CONFIG_FILE (~/.configliere, probably)
-    #
-    # @option [String] :env
-    #   If an :env option is given, only the indicated subhash is merged. This
-    #   lets you for example specify production / environment / test settings
-    #
-    # @example
-    #     # Read from config/apey_eye.yaml and use settings appropriate for development/staging/production
-    #     Settings.read(root_path('config/apey_eye.yaml'), :env => (ENV['RACK_ENV'] || 'production'))
-    #
-    def read handle, options={}
+    def read handle
       filename = filename_for_handle(handle)
       begin
         params = YAML.load(File.open(filename)) || {}
@@ -31,10 +22,6 @@ module Configliere
         params = {}
       end
       params = params[handle] if handle.is_a?(Symbol)
-      # Extract the :env (production/development/etc)
-      if options[:env]
-        params = params[options[:env]]
-      end
       deep_merge! params
     end
 

data/lib/configliere/core_ext/sash.rb

@@ -150,6 +150,7 @@ protected
       value
     end
   end
+
 end
 
 

data/lib/configliere/define.rb

@@ -55,7 +55,7 @@ module Configliere
 
     # All described params with their descriptions
     def descriptions
-      definitions_for(:description) # .reject{|param, desc| param_definitions[param][:hide_help] }
+      definitions_for(:description).reject{ |param, desc| param_definitions[param][:no_help] }
     end
 
     # List of params that have descriptions
@@ -106,8 +106,9 @@ module Configliere
         when (type == Symbol)    then val = val.to_s.to_sym     rescue nil
         when ((val.to_s == 'now') && (type == Date))     then val = Date.today
         when ((val.to_s == 'now') && (type == DateTime)) then val = DateTime.now
-        when (type == Date)      then val = Date.parse(val)     rescue nil
-        when (type == DateTime)  then val = DateTime.parse(val) rescue nil
+        when (type == Date)     then val = Date.parse(val)     rescue nil
+        when (type == DateTime) then val = DateTime.parse(val) rescue nil
+        when (type == Regexp)   then val = Regexp.new(val)     rescue nil
         else # nothing
         end
         self[param] = val
@@ -135,7 +136,7 @@ module Configliere
       required_params.each do |param|
         missing << param if self[param].nil?
       end
-      raise "Missing values for:\n #{missing.map{|s| "  --" + s.to_s + " (" + description_for(s) + ") " }.sort.join("\n")}" if (! missing.empty?)
+      raise "Missing values for:\n #{missing.map{|s| "  --" + s.to_s + (description_for(s) ? (" (" + description_for(s).to_s + ") ") : '') }.sort.join("\n")}" if (! missing.empty?)
     end
 
     # all params with a value for the definable aspect

data/lib/configliere/env_var.rb

@@ -18,11 +18,7 @@ module Configliere
         end
       end
     end
-
-    def params_from_env_vars
-      definitions_for(:env_var)
-    end
-
+    
   protected
     def adopt_env_var! param, env
       env   = env.to_s

data/spec/configliere/commandline_spec.rb

@@ -1,5 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'configliere/commandline'
+Configliere.use :commandline
 
 describe "Configliere::Commandline" do
 
@@ -83,6 +83,13 @@ describe "Configliere::Commandline" do
       @config.should == { :param_1 => true, :cat => true, :foo => nil}
     end
 
+    # it 'should parse a single-letter flag with a value' do
+    #   ::ARGV.replace ['-p=new_val', '-c']
+    #   @config.resolve!
+    #   @config.rest.should == []
+    #   @config.should == { :param_1 => 'new_val', :cat => true, :foo => nil }
+    # end
+
     it 'should not complain about bad single-letter flags by default' do
       ::ARGV.replace ['-pcz']
       @config.resolve!

data/spec/configliere/commands_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+Configliere.use :commands
+
+describe "Configliere::Commands" do
+
+  after do
+    ::ARGV.replace []
+  end
+
+  describe "when no commands are defined" do
+    before do
+      @config = Configliere::Param.new
+    end
+
+    it "should know that no commands are defined" do
+      @config.commands?.should be_false
+    end
+
+    it "should not shift the ARGV when resolving" do
+      ::ARGV.replace ['not_command_but_arg', 'another_arg']
+      @config.resolve!
+      @config.rest.should == ['not_command_but_arg', 'another_arg']
+      @config.command.should be_nil
+    end
+
+    it "should still recognize a git-style binary command" do
+      ::ARGV.replace ['not_command_but_arg', 'another_arg']
+      File.should_receive(:basename).and_return('prog-subcommand')
+      @config.resolve!
+      @config.rest.should == ['not_command_but_arg', 'another_arg']
+      @config.command_name.should == 'subcommand'
+      @config.command.should be_nil
+    end
+  end
+  
+  describe "a simple command" do
+    before do
+      @config = Configliere::Param.new :param => 'val 1' 
+      @config.define_command "the_command", :description => "foobar"
+    end
+
+    it "should continue to parse flags when the command is given" do
+      ::ARGV.replace ['the_command', '--param=wuzz', 'an_arg']
+      @config.resolve!
+      @config.should == { :param => 'wuzz' }
+    end
+
+    it "should continue to set args when the command is given" do
+      ::ARGV.replace ['the_command', '--param=wuzz', 'an_arg']
+      @config.resolve!
+      @config.rest.should == ['an_arg']
+    end
+    
+    it "should recognize the command when given" do
+      ::ARGV.replace ['the_command', '--param=wuzz', 'an_arg']
+      @config.resolve!
+      @config.command_name.should == 'the_command'
+    end
+
+    it "should recognize when the command is not given" do
+      ::ARGV.replace ['bogus_command', '--param=wuzz', 'an_arg']
+      @config.resolve!
+      @config.rest.should == ['bogus_command', 'an_arg']
+      @config.command_name.should be_nil
+    end
+  end
+
+  describe "a complex command" do
+    before do
+      @config = Configliere::Param.new :outer_param => 'val 1' 
+      @config.define_command "the_command", :description => "the command" do |command|
+        command.define :inner_param, :description => "inside"
+      end
+    end
+
+    it "should still recognize the outer param and the args" do
+      ::ARGV.replace ['the_command', '--outer_param=wuzz', 'an_arg', '--inner_param=buzz']
+      @config.resolve!
+      @config.rest.should == ['an_arg']
+      @config.command_name.should == 'the_command'
+      @config[:outer_param].should == 'wuzz'
+    end
+
+    it "should recognize the inner param" do
+      ::ARGV.replace ['the_command', '--outer_param=wuzz', 'an_arg', '--inner_param=buzz']
+      @config.resolve!
+      @config[:inner_param].should == 'buzz'
+      @config.command[:config][:inner_param].should == 'buzz'
+    end
+    
+  end
+end
+

data/spec/configliere/config_block_spec.rb

@@ -9,7 +9,8 @@ describe "Configliere::ConfigBlock" do
   describe 'resolving' do
     it 'runs blocks' do
       @block_watcher = 'watcher'
-      @block_watcher.should_receive(:fnord).with(@config)
+      # @block_watcher.should_receive(:fnord).with(@config)
+      @block_watcher.should_receive(:fnord)
       @config.finally{|arg| @block_watcher.fnord(arg) }
       @config.resolve!
     end

data/spec/configliere/core_ext/sash_spec.rb

@@ -5,11 +5,10 @@ end
 
 describe Sash do
   before(:each) do
-    @hash = { "str_key" => "strk_val", :sym_key => "symk_val" }
+    @hash = { "str_key" => "strk_val", :sym_key => "symk_val"}
     @sub  = AwesomeHash.new("str_key" => "strk_val", :sym_key => "symk_val")
   end
 
-
   describe "#deep_merge!" do
     before do
       @sash = Sash.new :hsh1 => { :hsh2 => { :key3 => "val3" }, :key2 => "val2" }
@@ -59,7 +58,7 @@ describe Sash do
       sash[:sym_key][:sym_key].should == "symk_val"
     end
 
-    it 'doesn not convert Hash subclass values into Sashes' do
+    it 'does not convert Hash subclass values into Sashes' do
       sash = Sash.new :sub => @sub
       sash[:sub].should be_an_instance_of(AwesomeHash)
     end

data/spec/configliere/define_spec.rb

@@ -92,14 +92,14 @@ describe "Configliere::Define" do
     end
     it 'counts nil-but-set values as missing' do
       @config.defaults :param_1 => true, :param_2 => nil
-      lambda{ @config.validate! }.should raise_error("Missing values for param_2")
+      lambda{ @config.validate! }.should raise_error(RuntimeError)
     end
     it 'counts never-set values as missing' do
-      lambda{ @config.validate! }.should raise_error("Missing values for param_1, param_2")
+      lambda{ @config.validate! }.should raise_error(RuntimeError)
     end
     it 'lists all missing values when it raises' do
       Configliere.use :define
-      lambda{ @config.validate! }.should raise_error("Missing values for param_1, param_2")
+      lambda{ @config.validate! }.should raise_error(RuntimeError)
     end
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: configliere
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - mrflip
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-02 00:00:00 -05:00
+date: 2011-03-01 00:00:00 -06:00
 default_executable: configliere
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -71,6 +74,7 @@ files:
 - examples/simple_script.yaml
 - lib/configliere.rb
 - lib/configliere/commandline.rb
+- lib/configliere/commands.rb
 - lib/configliere/config_block.rb
 - lib/configliere/config_file.rb
 - lib/configliere/core_ext.rb
@@ -81,9 +85,9 @@ files:
 - lib/configliere/define.rb
 - lib/configliere/encrypted.rb
 - lib/configliere/env_var.rb
-- lib/configliere/git_style_binaries.rb
 - lib/configliere/param.rb
 - spec/configliere/commandline_spec.rb
+- spec/configliere/commands_spec.rb
 - spec/configliere/config_block_spec.rb
 - spec/configliere/config_file_spec.rb
 - spec/configliere/core_ext/hash_spec.rb
@@ -110,6 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -118,6 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -134,6 +140,7 @@ test_files:
 - examples/env_var_script.rb
 - examples/simple_script.rb
 - spec/configliere/commandline_spec.rb
+- spec/configliere/commands_spec.rb
 - spec/configliere/config_block_spec.rb
 - spec/configliere/config_file_spec.rb
 - spec/configliere/core_ext/hash_spec.rb

data/lib/configliere/git_style_binaries.rb

@@ -1,74 +0,0 @@
-require 'configliere/commandline'
-module Configliere
-
-  # If your script uses the 'script_name verb [...params...]'
-  # pattern, list the commands here:
-  Configliere::COMMANDS = []
-
-  # Add a command, along with a description of its predicates and the command itself.
-  def self.define_command cmd, preds_desc=nil, desc=nil
-    Configliere::COMMANDS << [cmd, preds_desc, (desc || "#{cmd} command")]
-  end
-
-  #
-  # Command line tool to manage param info
-  #
-  # To include, specify
-  #
-  #   Configliere.use :git_style_binaries
-  #
-  module GitStyleBinaries
-    attr_accessor :command
-
-    #
-    # Parse the command-line args into the params hash.
-    #
-    # '--happy_flag'   produces :happy_flag => true in the params hash
-    # '--foo=foo_val'  produces :foo => 'foo_val' in the params hash.
-    # '--'             Stop parsing; all remaining args are piled into :rest
-    #
-    # self.rest        contains all arguments that don't start with a '--'
-    #                  and all args following the '--' sentinel if any.
-    #
-    def process_argv!
-      super
-      if raw_script_name =~ /(\w+)-([\w\-]+)/
-        self.command = $2
-      else
-        self.command = rest.shift
-      end
-    end
-
-    # The script name without command appendix if any: For $0 equal to any of
-    # 'git', 'git-reset', or 'git-cherry-pick', base_script_name is 'git'
-    #
-    def base_script_name
-      raw_script_name.gsub(/-.*/, '')
-    end
-
-    # The contents of the help message.  Dumps the standard commandline help
-    # message, and then lists the commands with their description.
-    def help
-      help_str = super()
-      help_str << "\n\nCommands:\n"
-      COMMANDS.map do |cmd, cmd_params, desc|
-        cmd_template = "  %-49s" % [base_script_name, cmd, cmd_params].join(" ")
-        cmd_template += " :: " + desc if desc
-        help_str << cmd_template+"\n"
-      end
-      help_str
-    end
-
-    # Usage line
-    def usage
-      %Q{usage: #{base_script_name} command [...--param=val...]}
-    end
-  end
-
-  Param.class_eval do
-    # include command syntax methods in chain.  Since commandline is required
-    # first at the top of this file, GitStyleBinaries methods sit below
-    # Commandline methods in the superclass chain.
-    include GitStyleBinaries
-  end
-end