optparse-defaults 0.1.0

data/README.rdoc

@@ -0,0 +1,17 @@
+= OptionParser::Defaults
+
+Adds support for default options to the stdlib's OptionParser.
+
+Default options are parsed before any given command-line options, and they're
+also added to the bottom of the help message.
+
+== Usage
+
+  parser = OptionParser.with_defaults do |opts|
+             opts.defaults = %w(--foo --no-bar --baz=42)
+             # ... and so on ...
+           end
+
+  parser.order(ARGV)
+
+

data/lib/optparse/defaults.rb

@@ -0,0 +1,43 @@
+require 'optparse'
+
+class OptionParser
+  module Defaults
+    VERSION = '0.1.0'
+
+    def defaults=(defaults)
+      @defaults = defaults.extend(Arguments)
+    end
+
+    # Note that it's important to use #order rather than #permute, to ensure
+    # that the given options have a chance to override the defaults. (These are
+    # <tt>POSIX</tt>-ly correct semantics.)
+    def order(*args, &block)
+      super(*@defaults.followed_by(*args), &block)
+    rescue ParseError
+      abort($!)
+    end
+
+    def help
+      @defaults.help(super, summary_indent)
+    end
+
+    private
+
+    module Arguments #:nodoc:
+      def followed_by(*args)
+        dup.concat(args.flatten)
+      end
+
+      def help(before, indent)
+        "#{before}\nDefaults:\n#{indent}#{join ' '}"
+      end
+    end
+  end
+
+  def self.with_defaults(*args)
+    new(*args) do |instance|
+      instance.extend(Defaults)
+      yield instance if block_given?
+    end
+  end
+end

data/man/optparse-defaults.3

@@ -0,0 +1,38 @@
+.\" generated with Ronn/v0.5
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "OPTPARSE\-DEFAULTS" "3" "June 2010" "Matthew Todd" "RubyGems Manual"
+.
+.SH "NAME"
+\fBoptparse\-defaults\fR \-\- default options for Ruby's OptionParser
+.
+.SH "SYNOPSIS"
+require 'optparse/defaults'
+.
+.P
+options = OptionParser.with_defaults do |opts|
+  opts.defaults = %w(\-\-foo \-\-no\-bar)
+.
+.br
+end
+.
+.P
+options.order(ARGV)
+.
+.SH "DESCRIPTION"
+\fBOptionParser.with_defaults()\fR extends Ruby's OptionParser with the ability to
+handle default options.
+.
+.P
+These options are applied before any given command\-line options, and they're
+also displayed at the bottom of the help text.
+.
+.SH "AUTHOR"
+Matthew Todd, \fImatthewtodd\fR on GitHub.
+.
+.SH "BUGS"
+For POSIX\-correctness, it's important that you call \fBOptionParser#order\fR
+instead of \fBOptionParser#permute\fR.
+.
+.SH "SEE ALSO"
+ruby(1)

data/man/optparse-defaults.3.ronn

@@ -0,0 +1,33 @@
+optparse-defaults(3) -- default options for Ruby's OptionParser
+===============================================================
+
+## SYNOPSIS
+
+require 'optparse/defaults'  
+
+options = OptionParser.with_defaults do |opts|
+  opts.defaults = %w(--foo --no-bar)  
+end
+
+options.order(ARGV)
+
+## DESCRIPTION
+
+`OptionParser.with_defaults()` extends Ruby's OptionParser with the ability to
+handle default options.
+
+These options are applied before any given command-line options, and they're
+also displayed at the bottom of the help text.
+
+## AUTHOR
+
+Matthew Todd, [matthewtodd](http://github.com/matthewtodd) on GitHub.
+
+## BUGS
+
+For POSIX-correctness, it's important that you call `OptionParser#order`
+instead of `OptionParser#permute`.
+
+## SEE ALSO
+
+ruby(1)

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: optparse-defaults
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Todd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-18 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  name: ronn
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  name: shoe
+  prerelease: false
+  type: :development
+description: |
+  Default options for the stdlib's OptionParser
+
+email: matthew.todd@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- lib/optparse/defaults.rb
+- man/optparse-defaults.3
+- man/optparse-defaults.3.ronn
+has_rdoc: true
+homepage: http://github.com/matthewtodd/optparse-defaults
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- optparse-defaults-0.1.0
+- --inline-source
+- --webcvs
+- http://github.com/matthewtodd/optparse-defaults/blob/v0.1.0/
+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.7
+signing_key: 
+specification_version: 3
+summary: Default options for the stdlib's OptionParser
+test_files: []
+