ejt_command_line 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDQzM2QzNDU0NGE4MzhiOWZhMDc1ZGE0YjA3MDQzZTNkMDQ3Y2MzZA==
+  data.tar.gz: !binary |-
+    NmIxZDE2MTE0ZjZiNzQ5OWI4MjFhZTU0MGQwZTU2M2IyMDYxZTBlNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDQ2MDc2ZmEzZjY2ODZjNTAyNTQwNzNlMjM3YThjYWFiM2IwNjc0ZmQwNGQ4
+    MDdhODFjYjM4YTk5N2M1ZWM3ODRjNGEzZGM2YmRiMzU1MTNiYjRlNjEwN2U2
+    YTQ2MGRmOGMyM2FhMDI4ZTU4NjkyMjBmZGM0NTJiYjQ4OTkwMzg=
+  data.tar.gz: !binary |-
+    NTdlNzU2NTYwMmNiY2RmZDIxM2I5ZjNiYmZiOWJkZDY3ODc2ZTA0OGZhYTJh
+    MWY5MDllZDNkNWVlZjVjYzZlNjE5Y2NjN2UzMDU4YTM2NDBkNGI0ODZkNzAz
+    YWU2OTJlYWI4ZGYzMTViMjIxNzcwYWQzMWQ3MjU1YTdmMzc2NTU=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ejt_command_line.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joe Thornber
+
+MIT License
+
+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,29 @@
+# EjtCommandLine
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ejt_command_line'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ejt_command_line
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')

data/ejt_command_line.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ejt_command_line/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ejt_command_line"
+  spec.version       = EjtCommandLine::VERSION
+  spec.authors       = ["Joe Thornber"]
+  spec.email         = ["ejt@redhat.com"]
+  spec.description   = %q{Yet another command line parser.  Allows you define argument types}
+  spec.summary       = %q{Command line parser}
+  spec.homepage      = ""
+  spec.license       = "GPL"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/ejt_command_line/version.rb

@@ -0,0 +1,3 @@
+module EjtCommandLine
+  VERSION = "0.0.1"
+end

data/lib/ejt_command_line.rb

@@ -0,0 +1,268 @@
+require "ejt_command_line/version"
+require 'set'
+
+#----------------------------------------------------------------
+
+module CommandLine
+  # from prelude
+  def bracket_(release)
+    r = nil
+    begin
+      r = yield
+    ensure
+      release.call
+    end
+    r
+  end
+
+  #----------------------------------------------------------------
+
+  class CommandLineError < StandardError
+  end
+
+  class ParseError < CommandLineError
+  end
+
+  class ConfigureError < CommandLineError
+  end
+
+  #----------------------------------------------------------------
+  
+  def simple_switch_parser(*aliases)
+    ArrayParser::choice(*aliases)
+  end
+
+  def value_switch_parser(*aliases, &block)
+    p = sequence(choice(*aliases), value(&block))
+  end
+
+  #----------------------------------------------------------------
+
+  class Switch
+    attr_reader :flags, :parser
+
+    def initialize(flags, parser = nil)
+      @flags = flags
+      @parser = parser
+    end
+
+    def has_flag?(flag)
+      @flags.member?(flag)
+    end
+  end
+
+  class Command
+    attr_reader :switches
+
+    def initialize
+      @switches = []
+      @mutually_exclusive_sets = [] # list of lists of syms
+      @mandatory = []
+    end
+
+    def add_switches(syms)
+      @switches += syms
+    end
+
+    def add_mutually_exclusive_set(syms)
+      @mutually_exclusive_sets << syms.to_set
+    end
+
+    def add_mandatory_switch(sym)
+      @mandatory << sym
+    end
+
+    def check_mutual_exclusion(syms)
+      nr_sets = @mutually_exclusive_sets.size
+      set_counts = Array.new(nr_sets, [])
+
+      syms.each do |s|
+        # is it in an exclusive set?
+        0.upto(nr_sets - 1) do |n|
+          if @mutually_exclusive_sets[n].member?(s)
+            set_counts[n] << s
+          end
+        end
+      end
+
+      0.upto(nr_sets - 1) do |n|
+        if set_counts[n].size > 1
+          msg = "mutually exclusive options used:\n"
+          set_counts[n].each {|sym| msg += "    #{sym}\n"}
+          raise ParseError, msg
+        end
+      end
+    end
+
+    def check_mandatory(syms)
+      missing = []
+
+      @mandatory.each do |m|
+        unless syms.member?(m)
+          missing << m
+        end
+      end
+
+      if missing.size > 0
+        msg = "missing mandatory switches:\n"
+        missing.each do |m|
+          msg += "  #{m}\n"
+        end
+
+        raise ParseError, msg
+      end
+    end
+  end
+
+  class Parser
+    GLOBAL_SYM = :global__
+
+    def initialize(&block)
+      @switches = {}
+      @global_switches = []
+      @value_types = {}
+      @commands = Hash.new {|hash, key| Command.new}
+      @current_command = @commands[GLOBAL_SYM]
+
+      configure(&block) if block
+    end
+
+    def configure(&block)
+      self.instance_eval(&block)
+    end
+
+    def value_type(sym, &parser)
+      if @value_types.member?(sym)
+        raise ConfigureError, "duplicate value type '#{sym}'"
+      end
+
+      @value_types[sym] = parser
+    end
+
+    def simple_switch(sym, *flags)
+      @switches[sym] = Switch.new(flags)
+    end
+
+    def value_switch(sym, value_sym, *flags)
+      @switches[sym] = Switch.new(flags, get_value_parser(value_sym))
+    end
+
+    def global(&block)
+      command(GLOBAL_SYM, &block)
+    end
+
+    def command(sym, &block)
+      old = @current_command
+      @current_command = @commands[sym] = Command.new
+
+      if block
+        release = lambda {@current_command = old}
+        bracket_(release) do
+          self.instance_eval(&block)
+        end
+      end
+    end
+
+    def switches(*syms)
+      check_switches_are_defined(syms)
+      @current_command.add_switches(syms)
+    end
+
+    def one_of(*syms)
+      check_switches_are_defined(syms)
+      @current_command.add_switches(syms)
+      @current_command.add_mutually_exclusive_set(syms)
+    end
+
+    def mandatory(sym)
+      syms = [sym]
+      check_switches_are_defined(syms)
+      @current_command.add_switches(syms)
+      @current_command.add_mandatory_switch(sym)
+    end
+
+    def parse(handler, *args)
+      command, opts, plain_args = parse_(args)
+      handler.send(command, opts, plain_args)
+    end
+
+    private
+    def parse_value(arg, s, args)
+      if s.parser
+        if args.size == 0
+          raise ParseError, "no value specified for switch '#{arg}'"
+        end
+
+        value = args.shift
+        begin
+          s.parser.call(value)
+        rescue => e
+          raise ParseError, "couldn't parse value '#{arg}=#{value}'\n#{e}"
+        end
+      else
+        true
+      end
+    end
+
+    def parse_(args)
+      in_command = false
+      opts = {}
+      plain_args = []
+      valid_switches = @commands[GLOBAL_SYM].switches
+      command = :global_command
+
+      while args.size > 0 do
+        arg = args.shift
+
+        if arg =~ /^-/
+          sym, s = find_switch(valid_switches, arg)
+          opts[sym] = parse_value(arg, s, args)
+
+        else
+          cmd = arg.intern
+
+          if !in_command && @commands.member?(cmd)
+            command = cmd
+            valid_switches = @commands[cmd].switches
+            in_command = true
+          else
+            plain_args << arg
+          end
+        end
+      end
+
+      @commands[command].check_mutual_exclusion(opts.keys)
+      @commands[command].check_mandatory(opts.keys)
+      [command, opts, plain_args]
+    end
+
+    def check_switches_are_defined(syms)
+      syms.each do |sym|
+        raise ConfigureError, "unknown switch '#{sym}'" unless @switches.member?(sym)
+      end
+    end
+
+    def find_switch(valid_switches, switch)
+      catch :found do
+        valid_switches.each do |sym|
+          s = @switches[sym]
+          if s.has_flag?(switch)
+            throw :found, [sym, s]
+          end
+        end
+
+        raise ParseError, "unexpected switch '#{switch}'"
+      end
+    end
+
+    def get_value_parser(sym)
+      if @value_types.member?(sym)
+        @value_types[sym]
+      else
+        raise ConfigureError, "unknown value type '#{sym}'"
+      end
+    end
+  end
+end
+
+#----------------------------------------------------------------

data/spec/command_line_spec.rb

@@ -0,0 +1,358 @@
+require 'spec_helper'
+
+include CommandLine
+
+#----------------------------------------------------------------
+
+describe "Parser" do
+  before :each do
+    @clh = Parser.new
+  end
+
+  def help_switch
+      @clh.simple_switch :help, '--help', '-h'
+  end
+
+  describe "creation" do
+    it "should take a config block" do
+      block_watcher = mock()
+      block_watcher.should_receive(:executed)
+
+      clh = Parser.new do
+        value_type :string do |str|
+          str
+        end
+
+        block_watcher.executed
+      end
+    end
+  end
+
+  describe "value types" do
+    it "should allow you to register new value types" do
+      @clh.configure do
+        value_type :string do |str|
+          str
+        end
+
+        value_type :int do |str|
+          str.to_i
+        end
+      end
+    end
+
+    it "should fail it you try and define a duplicate value type" do
+      @clh.value_type :string do |str|
+        str
+      end
+
+      expect do
+        @clh.value_type :string do |str|
+          str
+        end
+      end.to raise_error(ConfigureError, /string/)
+    end
+  end
+
+  describe "switches are defined separately from commands" do
+    it "should let you define binary switch" do
+      help_switch
+    end
+
+    it "should fail if you try and define a switch that takes an unknown value type" do
+      expect {@clh.value_switch :resize_to, :volume_size, '--resize-to'}.to raise_error(ConfigureError, /volume_size/)
+    end
+
+    it "should let you define an option that takes a single value" do
+      @clh.configure do
+        value_type :volume_size do |str|
+          str.to_i
+        end
+
+        value_switch :resize_to, :volume_size, '--resize-to'
+      end
+    end
+  end
+
+  describe "global switches" do
+    it "should let you bind global switch" do
+      help_switch
+      @clh.configure do
+        global do
+          switches :help
+        end
+      end
+    end
+
+    it "should raise an error if the switch hasn't been previously defined" do
+      expect do
+        @clh.global do
+          switches :become_sentient
+        end
+      end.to raise_error(ConfigureError)
+    end
+  end
+
+  describe "sub commands" do
+    it "should let you register a command" do
+      @clh.configure do
+        command(:create) {}
+      end
+    end
+
+    it "should let you omit the block for a command" do
+      @clh.configure do
+        command :create
+      end
+    end
+
+    it "should let you bind switches" do
+      @clh.configure do
+        simple_switch :grow_to, '--grow-to'
+        simple_switch :grow_by, '--grow-by'
+        simple_switch :shrink_to, '--shrink-to'
+        simple_switch :shrink_by, '--shrink-by'
+
+        command :resize do
+          switches :grow_to, :grow_by, :shrink_to, :shrink_by
+        end
+      end
+    end
+  end
+
+  describe "parsing" do
+    describe "global command" do
+      it "should handle no switches" do
+        handler = mock()
+        handler.should_receive(:global_command).with({}, [])
+        @clh.parse(handler)
+      end
+
+      it "should raise a ParseError if an unrecognised switch is used" do
+        handler = mock()
+        expect {@clh.parse(handler, '--go-back-in-time')}.to raise_error(ParseError, /--go-back-in-time/)
+      end
+
+      it "should handle binary switches" do
+        handler = mock()
+        handler.should_receive(:global_command).with({:help => true}, [])
+
+        @clh.configure do
+          simple_switch :help, '--help', '-h'
+          global do
+            switches :help
+          end
+        end
+
+        @clh.parse(handler, '-h')
+      end
+
+      it "should handle multiple binary switches" do
+        handler = mock()
+        handler.should_receive(:global_command).with({:help => true, :ro => true}, [])
+
+        @clh.configure do
+          simple_switch :help, '--help', '-h'
+          simple_switch :ro, '--read-only', '-r'
+
+          global do
+            switches :help, :ro
+          end
+        end
+
+        @clh.parse(handler, '-h', '--read-only')
+      end
+
+      it "should handle valued switches" do
+        handler = mock()
+
+        @clh.configure do
+          value_type :int do |str|
+            str.to_i
+          end
+
+          value_switch :count, :int, '--count', '-c'
+
+          global do
+            switches :count
+          end
+        end
+
+        handler.should_receive(:global_command).
+          with({:count => 17}, [])
+        @clh.parse(handler, '--count', '17')
+
+        handler.should_receive(:global_command).
+          with({:count => 17}, ['one', 'two'])
+        @clh.parse(handler, 'one', '-c', '17', 'two')
+      end
+
+      it "should raise an ArgumentError if no value is given for a valued switch" do
+        handler = mock()
+
+        @clh.configure do
+          value_type :int do |str|
+            str.to_i
+          end
+
+          value_switch :count, :int, '--count', '-c'
+
+          global do
+            switches :count
+          end
+        end
+
+        expect do
+          @clh.parse(handler, '--count')
+        end.to raise_error(ParseError, /count/)
+      end
+
+      it "should filter non-switches out" do
+        handler = mock()
+        handler.should_receive(:global_command).
+          with({:help => true, :ro => true}, ['my_file', 'my_other_file'])
+
+        @clh.configure do
+          simple_switch :help, '--help', '-h'
+          simple_switch :ro, '--read-only', '-r'
+
+          global do
+            switches :help, :ro
+          end
+        end
+
+        @clh.parse(handler, '-h', 'my_file', '--read-only', 'my_other_file')
+      end
+    end
+
+    describe "simple commands" do
+      it "should handle commands that take no switches" do
+        @clh.configure do
+          command :create do
+          end
+        end
+
+        handler = mock()
+        handler.should_receive(:create).with({}, ['fred'])
+        @clh.parse(handler, 'create', 'fred')
+      end
+    end
+
+    describe "commands" do
+      before :each do
+        @clh.configure do
+          value_type :int do |str|
+            str.to_i
+          end
+
+          value_switch :grow_to, :int, '--grow-to'
+          value_switch :grow_by, :int, '--grow-by'
+          value_switch :shrink_to, :int, '--shrink-to'
+          value_switch :shrink_by, :int, '--shrink-by'
+
+          command :resize do
+            switches :grow_to, :grow_by, :shrink_to, :shrink_by
+          end
+
+          command :shrink do
+            switches :grow_to, :grow_by, :shrink_to, :shrink_by
+          end
+
+          command :grow do
+            switches :grow_to, :grow_by, :shrink_to, :shrink_by
+          end
+        end
+      end
+
+      it "should allow you to define a sub command" do
+        handler = mock()
+        handler.should_receive(:resize).with({:grow_to => 12345}, ['fred'])
+        @clh.parse(handler, 'resize', '--grow-to', '12345', 'fred')
+      end
+
+      it "should prevent you calling two sub commands on the same line" do
+        handler = mock()
+        handler.should_receive(:resize).
+          with({:grow_to => 1234, :shrink_to => 2345}, ['shrink', 'fred'])
+        @clh.parse(handler, 'resize', '--grow-to', '1234', 'shrink', '--shrink-to', '2345', 'fred')
+      end
+    end
+
+    describe "exclusive switches" do
+      before :each do
+        @clh.configure do
+          value_type :int do |str|
+            str.to_i
+          end
+
+          value_switch :grow_to, :int, '--grow-to'
+          value_switch :grow_by, :int, '--grow-by'
+          value_switch :shrink_to, :int, '--shrink-to'
+          value_switch :shrink_by, :int, '--shrink-by'
+
+          command :resize do
+            one_of :grow_to, :grow_by, :shrink_to, :shrink_by
+          end
+        end
+      end
+
+      it "should parse one exclusive switch" do
+        handler = mock()
+        handler.should_receive(:resize).
+          with({:grow_to => 1234}, ['fred'])
+        @clh.parse(handler, 'resize', '--grow-to', '1234', 'fred')
+      end
+
+      it "should raise a ParseError if more than one switch from an exclusive set is defined" do
+        handler = mock()
+        expect do
+          @clh.parse(handler, 'resize', '--grow-to', '1234', '--shrink-by', '2345', 'fred')
+        end.to raise_error(ParseError, /mutually exclusive/)
+        # FIXME: would be nice to see the actual flags in the exception
+      end
+
+      it "should let you define more than one exclusive set" do
+        pending
+      end
+    end
+
+    it "should handle --foo=<value>" do
+      pending "todo"
+    end
+  end
+
+  describe "mandatory switches" do
+    before :each do
+      @clh.configure do
+        value_type :int do |str|
+          str.to_i
+        end
+
+        value_switch :grow_to, :int, '--grow-to'
+        value_switch :grow_by, :int, '--grow-by'
+        value_switch :shrink_to, :int, '--shrink-to'
+        value_switch :shrink_by, :int, '--shrink-by'
+
+        command :resize do
+          mandatory :grow_to
+        end
+      end
+    end
+
+    it "should parse ok if mandatory switch is given" do
+      handler = mock()
+      handler.should_receive(:resize).
+        with({:grow_to => 3}, ['fred'])
+      @clh.parse(handler, 'resize', '--grow-to', '3', 'fred')
+    end
+
+    it "should raise a ParseError if a mandatory switch is omitted" do
+      handler = mock()
+      expect do
+        @clh.parse(handler, 'resize', 'fred')
+      end.to raise_error(ParseError, /grow_to/)
+    end
+  end
+end
+
+#----------------------------------------------------------------

data/spec/command_line_spec.rb~

@@ -0,0 +1,359 @@
+require 'spec_helper'
+require 'lib/command_line'
+
+include CommandLine
+
+#----------------------------------------------------------------
+
+describe "Parser" do
+  before :each do
+    @clh = Parser.new
+  end
+
+  def help_switch
+      @clh.simple_switch :help, '--help', '-h'
+  end
+
+  describe "creation" do
+    it "should take a config block" do
+      block_watcher = mock()
+      block_watcher.should_receive(:executed)
+
+      clh = Parser.new do
+        value_type :string do |str|
+          str
+        end
+
+        block_watcher.executed
+      end
+    end
+  end
+
+  describe "value types" do
+    it "should allow you to register new value types" do
+      @clh.configure do
+        value_type :string do |str|
+          str
+        end
+
+        value_type :int do |str|
+          str.to_i
+        end
+      end
+    end
+
+    it "should fail it you try and define a duplicate value type" do
+      @clh.value_type :string do |str|
+        str
+      end
+
+      expect do
+        @clh.value_type :string do |str|
+          str
+        end
+      end.to raise_error(ConfigureError, /string/)
+    end
+  end
+
+  describe "switches are defined separately from commands" do
+    it "should let you define binary switch" do
+      help_switch
+    end
+
+    it "should fail if you try and define a switch that takes an unknown value type" do
+      expect {@clh.value_switch :resize_to, :volume_size, '--resize-to'}.to raise_error(ConfigureError, /volume_size/)
+    end
+
+    it "should let you define an option that takes a single value" do
+      @clh.configure do
+        value_type :volume_size do |str|
+          str.to_i
+        end
+
+        value_switch :resize_to, :volume_size, '--resize-to'
+      end
+    end
+  end
+
+  describe "global switches" do
+    it "should let you bind global switch" do
+      help_switch
+      @clh.configure do
+        global do
+          switches :help
+        end
+      end
+    end
+
+    it "should raise an error if the switch hasn't been previously defined" do
+      expect do
+        @clh.global do
+          switches :become_sentient
+        end
+      end.to raise_error(ConfigureError)
+    end
+  end
+
+  describe "sub commands" do
+    it "should let you register a command" do
+      @clh.configure do
+        command(:create) {}
+      end
+    end
+
+    it "should let you omit the block for a command" do
+      @clh.configure do
+        command :create
+      end
+    end
+
+    it "should let you bind switches" do
+      @clh.configure do
+        simple_switch :grow_to, '--grow-to'
+        simple_switch :grow_by, '--grow-by'
+        simple_switch :shrink_to, '--shrink-to'
+        simple_switch :shrink_by, '--shrink-by'
+
+        command :resize do
+          switches :grow_to, :grow_by, :shrink_to, :shrink_by
+        end
+      end
+    end
+  end
+
+  describe "parsing" do
+    describe "global command" do
+      it "should handle no switches" do
+        handler = mock()
+        handler.should_receive(:global_command).with({}, [])
+        @clh.parse(handler)
+      end
+
+      it "should raise a ParseError if an unrecognised switch is used" do
+        handler = mock()
+        expect {@clh.parse(handler, '--go-back-in-time')}.to raise_error(ParseError, /--go-back-in-time/)
+      end
+
+      it "should handle binary switches" do
+        handler = mock()
+        handler.should_receive(:global_command).with({:help => true}, [])
+
+        @clh.configure do
+          simple_switch :help, '--help', '-h'
+          global do
+            switches :help
+          end
+        end
+
+        @clh.parse(handler, '-h')
+      end
+
+      it "should handle multiple binary switches" do
+        handler = mock()
+        handler.should_receive(:global_command).with({:help => true, :ro => true}, [])
+
+        @clh.configure do
+          simple_switch :help, '--help', '-h'
+          simple_switch :ro, '--read-only', '-r'
+
+          global do
+            switches :help, :ro
+          end
+        end
+
+        @clh.parse(handler, '-h', '--read-only')
+      end
+
+      it "should handle valued switches" do
+        handler = mock()
+
+        @clh.configure do
+          value_type :int do |str|
+            str.to_i
+          end
+
+          value_switch :count, :int, '--count', '-c'
+
+          global do
+            switches :count
+          end
+        end
+
+        handler.should_receive(:global_command).
+          with({:count => 17}, [])
+        @clh.parse(handler, '--count', '17')
+
+        handler.should_receive(:global_command).
+          with({:count => 17}, ['one', 'two'])
+        @clh.parse(handler, 'one', '-c', '17', 'two')
+      end
+
+      it "should raise an ArgumentError if no value is given for a valued switch" do
+        handler = mock()
+
+        @clh.configure do
+          value_type :int do |str|
+            str.to_i
+          end
+
+          value_switch :count, :int, '--count', '-c'
+
+          global do
+            switches :count
+          end
+        end
+
+        expect do
+          @clh.parse(handler, '--count')
+        end.to raise_error(ParseError, /count/)
+      end
+
+      it "should filter non-switches out" do
+        handler = mock()
+        handler.should_receive(:global_command).
+          with({:help => true, :ro => true}, ['my_file', 'my_other_file'])
+
+        @clh.configure do
+          simple_switch :help, '--help', '-h'
+          simple_switch :ro, '--read-only', '-r'
+
+          global do
+            switches :help, :ro
+          end
+        end
+
+        @clh.parse(handler, '-h', 'my_file', '--read-only', 'my_other_file')
+      end
+    end
+
+    describe "simple commands" do
+      it "should handle commands that take no switches" do
+        @clh.configure do
+          command :create do
+          end
+        end
+
+        handler = mock()
+        handler.should_receive(:create).with({}, ['fred'])
+        @clh.parse(handler, 'create', 'fred')
+      end
+    end
+
+    describe "commands" do
+      before :each do
+        @clh.configure do
+          value_type :int do |str|
+            str.to_i
+          end
+
+          value_switch :grow_to, :int, '--grow-to'
+          value_switch :grow_by, :int, '--grow-by'
+          value_switch :shrink_to, :int, '--shrink-to'
+          value_switch :shrink_by, :int, '--shrink-by'
+
+          command :resize do
+            switches :grow_to, :grow_by, :shrink_to, :shrink_by
+          end
+
+          command :shrink do
+            switches :grow_to, :grow_by, :shrink_to, :shrink_by
+          end
+
+          command :grow do
+            switches :grow_to, :grow_by, :shrink_to, :shrink_by
+          end
+        end
+      end
+
+      it "should allow you to define a sub command" do
+        handler = mock()
+        handler.should_receive(:resize).with({:grow_to => 12345}, ['fred'])
+        @clh.parse(handler, 'resize', '--grow-to', '12345', 'fred')
+      end
+
+      it "should prevent you calling two sub commands on the same line" do
+        handler = mock()
+        handler.should_receive(:resize).
+          with({:grow_to => 1234, :shrink_to => 2345}, ['shrink', 'fred'])
+        @clh.parse(handler, 'resize', '--grow-to', '1234', 'shrink', '--shrink-to', '2345', 'fred')
+      end
+    end
+
+    describe "exclusive switches" do
+      before :each do
+        @clh.configure do
+          value_type :int do |str|
+            str.to_i
+          end
+
+          value_switch :grow_to, :int, '--grow-to'
+          value_switch :grow_by, :int, '--grow-by'
+          value_switch :shrink_to, :int, '--shrink-to'
+          value_switch :shrink_by, :int, '--shrink-by'
+
+          command :resize do
+            one_of :grow_to, :grow_by, :shrink_to, :shrink_by
+          end
+        end
+      end
+
+      it "should parse one exclusive switch" do
+        handler = mock()
+        handler.should_receive(:resize).
+          with({:grow_to => 1234}, ['fred'])
+        @clh.parse(handler, 'resize', '--grow-to', '1234', 'fred')
+      end
+
+      it "should raise a ParseError if more than one switch from an exclusive set is defined" do
+        handler = mock()
+        expect do
+          @clh.parse(handler, 'resize', '--grow-to', '1234', '--shrink-by', '2345', 'fred')
+        end.to raise_error(ParseError, /mutually exclusive/)
+        # FIXME: would be nice to see the actual flags in the exception
+      end
+
+      it "should let you define more than one exclusive set" do
+        pending
+      end
+    end
+
+    it "should handle --foo=<value>" do
+      pending "todo"
+    end
+  end
+
+  describe "mandatory switches" do
+    before :each do
+      @clh.configure do
+        value_type :int do |str|
+          str.to_i
+        end
+
+        value_switch :grow_to, :int, '--grow-to'
+        value_switch :grow_by, :int, '--grow-by'
+        value_switch :shrink_to, :int, '--shrink-to'
+        value_switch :shrink_by, :int, '--shrink-by'
+
+        command :resize do
+          mandatory :grow_to
+        end
+      end
+    end
+
+    it "should parse ok if mandatory switch is given" do
+      handler = mock()
+      handler.should_receive(:resize).
+        with({:grow_to => 3}, ['fred'])
+      @clh.parse(handler, 'resize', '--grow-to', '3', 'fred')
+    end
+
+    it "should raise a ParseError if a mandatory switch is omitted" do
+      handler = mock()
+      expect do
+        @clh.parse(handler, 'resize', 'fred')
+      end.to raise_error(ParseError, /grow_to/)
+    end
+  end
+end
+
+#----------------------------------------------------------------

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'ejt_command_line'
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ejt_command_line
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joe Thornber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Yet another command line parser.  Allows you define argument types
+email:
+- ejt@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ejt_command_line.gemspec
+- lib/ejt_command_line.rb
+- lib/ejt_command_line/version.rb
+- spec/command_line_spec.rb
+- spec/command_line_spec.rb~
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- GPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Command line parser
+test_files:
+- spec/command_line_spec.rb
+- spec/command_line_spec.rb~
+- spec/spec_helper.rb