configliere 0.0.7 → 0.0.8

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/configliere.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configliere}
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mrflip"]
-  s.date = %q{2010-04-08}
+  s.date = %q{2010-05-02}
   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.
 
@@ -50,6 +50,7 @@ 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/config_block_spec.rb",

data/lib/configliere.rb

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

data/lib/configliere/commandline.rb

@@ -53,10 +53,6 @@ module Configliere
       end
     end
 
-    # If your script uses the 'script_name verb [...params...]'
-    # pattern, list the commands here:
-    COMMANDS= {}
-
     # Configliere internal params
     def define_special_params
       Settings.define :encrypt_pass, :description => "Passphrase to extract encrypted config params.", :internal => true
@@ -72,8 +68,7 @@ module Configliere
     # @param str [String] the string to dump out before exiting
     # @param exit_code [Integer] UNIX exit code to set, default -1
     def die str, exit_code=-1
-      puts help
-      warn "\n****\n#{str}\n****"
+      dump_help "****\n#{str}\n****"
       exit exit_code
     end
 
@@ -84,22 +79,29 @@ module Configliere
       self[attr] = ask("#{attr}"+(hint ? " for #{hint}?" : '?'))
     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)
-      # 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_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
 
+    # Output the help message to $stderr, along with an optional extra message appended.
     def dump_help extra_msg=nil
       $stderr.puts help
       $stderr.puts "\n\n"+extra_msg unless extra_msg.blank?
+      $stderr.puts ''
+    end
+
+    def raw_script_name
+      File.basename($0)
     end
 
     # Usage line
     def usage
-      %Q{usage: #{File.basename($0)} [...--param=val...]}
+      %Q{usage: #{raw_script_name} [...--param=val...]}
     end
 
   protected

data/lib/configliere/define.rb

@@ -52,7 +52,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][:hide_help] }
     end
 
     # List of params that have descriptions

data/lib/configliere/git_style_binaries.rb

@@ -0,0 +1,74 @@
+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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - mrflip
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 -05:00
+date: 2010-05-02 00:00:00 -05:00
 default_executable: configliere
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,6 +80,7 @@ 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/config_block_spec.rb