optparse-subcommand 1.0.0.pre

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Bodaniel Jeanes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# optparse-subcommand
+
+This gem extends Ruby's standard library `OptionParser` class to allow popular
+subcommand-style tools (e.g. git).
+
+## Usage
+
+A new method `subcommand` is added to the `OptionParser` instance allowing you
+to define an action to occur when that subcommand is detected as an argument.
+
+The `subcommand` method takes a block which yields a new `OptionParser` instance.
+Simply define your option parsing recursively for all subcommands.
+
+Example:
+
+``` Ruby
+require 'optparse/subcommand' # Also requires 'optparse'
+require 'ostruct'
+
+options                = OpenStruct.new
+options.verbose        = false
+options.action         = nil
+options.action_options = OpenStruct.new
+
+parser = OptionParser.new do |opts|
+  opts.on '-v', '--[no-]verbose' do |verbose|
+    options.verbose = verbose
+  end
+
+  opts.subcommand 'foo' do |foo|
+    options.action = :foo
+
+    foo.on '-x' do
+      options.action_options.x = true
+    end
+  end
+end
+
+parser.parse(%w[-v foo -x]) # or ARGV, whatever...
+
+options # => #<OpenStruct verbose=true, action=:foo, action_options=#<OpenStruct x=true>>
+```
+
+## License
+
+See `LICENSE` file in this directory.

data/lib/optparse/subcommand.rb

@@ -0,0 +1,35 @@
+require 'optparse'
+
+class OptionParser
+  module Subcommand
+    def subcommand(key, &block)
+      subcommand = lambda { OptionParser.new(&block) }
+      subcommands[key.to_s] = subcommand
+    end
+
+    private
+
+    def self.included(klass)
+      klass.instance_eval do
+        alias_method :parse_without_subcommand!, :parse!
+        alias_method :parse!, :parse_with_subcommand!
+      end
+    end
+
+    def parse_with_subcommand!(argv = default_argv)
+      subcommand = catch(:subcommand) do
+        return order!(argv) { |sub| throw :subcommand, sub }
+      end
+
+      sub_parser = subcommands[subcommand.to_s]
+      sub_parser.call.send(:parse!, argv) if sub_parser
+    end
+
+    def subcommands
+      @subcommands ||= {}
+    end
+  end
+
+  include Subcommand
+end
+

data/spec/optparse/subcommand_spec.rb

@@ -0,0 +1,41 @@
+require 'optparse/subcommand'
+
+describe OptionParser do
+  def run(args)
+    options.parse(args.split(/\s+/))
+    hits
+  end
+
+  let(:hits) { [] }
+  let(:options) do
+    OptionParser.new do |opt|
+      opt.on '-t' do
+        hits << :t
+      end
+
+      opt.subcommand 'foo' do |foo|
+        hits << :foo
+
+        foo.on '-q' do
+          hits << :foo_q
+        end
+      end
+
+      opt.subcommand 'bar' do |bar|
+        hits << :bar
+
+        bar.on '-s' do
+          hits << :bar_s
+        end
+      end
+    end
+  end
+
+  specify { run("-t").should == [:t] }
+  specify { run("foo").should == [:foo] }
+  specify { run("foo -q").should == [:foo, :foo_q] }
+  specify { run("foo bar").should == [:foo] }
+  specify { run("-t foo").should == [:t, :foo] }
+
+  specify { lambda { run("foo -t") }.should raise_error(OptionParser::InvalidOption )}
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: optparse-subcommand
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Bodaniel Jeanes
+autorequire: optparse/subcommand
+bindir: bin
+cert_chain: []
+date: 2012-04-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70145307916660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70145307916660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70145307915240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70145307915240
+description: Add subcommand parsing to Ruby's OptionParser class
+email: me@bjeanes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/optparse/subcommand.rb
+- spec/optparse/subcommand_spec.rb
+homepage: http://github.com/bjeanes/optparse-subcommand
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Add subcommand parsing to Ruby's OptionParser class
+test_files:
+- spec/optparse/subcommand_spec.rb