cli 0.2.0 → 0.3.0

data/README.md

@@ -2,11 +2,13 @@
 
 Command Line Interface gem allows you to quickly specify command argument parser that will automatically handle usage rendering, casting, default values and other stuff for you.
 
-CLI supports specifying:
+CLI supports following specifiers:
 
-* switches - (`--name` or `-n`) binary operators, by default set to nil and when specified set to true
-* options - (`--name John` or `-n John`) switches that take value; default value can be given, otherwise default to nil
-* arguments - (`John`) capture command arguments that are not switches
+* switch - (`--verbose` or `-v`) binary operators, by default set to nil, when specified set to true
+* option - (`--name John` or `-n John`) switches that take value; default value can be specified, otherwise defaults to nil
+* options - (`-n John -n Frank`) like option but can be used multiple times on command line; default value or array of values can be given, otherwise defaults to empty array
+* argument - (`John`) capture single command; default value can be specified; raises error if not given
+* arguments - (`John Frank`) capture multiple command arguments; defaults to empty array
 * stdin - if standard input is to be handled it can be mentioned in usage output; also stdin data casting is supported
 
 Each element can have description that will be visible in the usage output.
@@ -142,22 +144,27 @@ The `options` variable will contain:
 The `arguments` specifier matched value will always be an array of casted elements.
 Default and mandatory arguments will have priority on matching values (see specs for examples).
 
+`options` specifier can be used to allow specifing same option multiple times.
+The `options` specifier matched value will always be an array of casted elements or empty if option not specified.
+
 ```ruby
 require 'cli'
 require 'pathname'
 
-options = CLI.new do
+values = CLI.new do
 	description 'Lists content of directories'
 	switch :long, :short => :l, :description => 'use long listing'
+	options :exclude, :short => :e, :description => 'exclude files from listing'
 	arguments :directories, :cast => Pathname, :default => '.', :description => 'directories to list content of'
 end.parse!
 
-options.directories.each do |dir|
+values.directories.each do |dir|
 	next unless dir.directory?
 	dir.each_entry do |e|
 		next if e.to_s == '.' or e.to_s == '..'
 		e = dir + e
-		if options.long
+		next if values.exclude.include? e.to_s
+		if values.long
 			puts "#{e.stat.uid}:#{e.stat.gid} #{e}"
 		else
 			puts e
@@ -168,11 +175,13 @@ end
 
 Example help message:
 
-    Usage: ls [switches] [--] directories*
+    Usage: ls [switches|options] [--] directories*
     Lists content of directories
     Switches:
        --long (-l) - use long listing
        --help (-h) - display this help message
+    Options:
+       --exclude* (-e) - exclude files from listing
     Arguments:
        directories* [.] - directories to list content of
 
@@ -192,6 +201,20 @@ Prints:
     features
     ...
 
+Excluding .git and .gitignore:
+
+    examples/ls -e .git -e .gitignore
+
+Prints:
+
+    .document
+    .README.md.swp
+    .rspec
+    cli.gemspec
+    examples
+    features
+    ...
+
 With directory list:
     
     examples/ls *

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/cli.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cli"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2011-12-20"
+  s.date = "2011-12-21"
   s.description = "Provides DSL for command-line options, switches and arguments parser and stdin handling with generated usage printer"
   s.email = "jpastuszek@gmail.com"
   s.extra_rdoc_files = [

data/examples/ls

@@ -2,18 +2,20 @@
 require 'cli'
 require 'pathname'
 
-options = CLI.new do
+values = CLI.new do
 	description 'Lists content of directories'
 	switch :long, :short => :l, :description => 'use long listing'
+	options :exclude, :short => :e, :description => 'exclude files from listing'
 	arguments :directories,	:cast => Pathname, :default => '.', :description => 'directories to list content of'
 end.parse!
 
-options.directories.each do |dir|
+values.directories.each do |dir|
 	next unless dir.directory?
 	dir.each_entry do |e|
 		next if e.to_s == '.' or e.to_s == '..'
 		e = dir + e
-		if options.long
+		next if values.exclude.include? e.to_s
+		if values.long
 			puts "#{e.stat.uid}:#{e.stat.gid} #{e}"
 		else
 			puts e

data/lib/cli.rb

@@ -94,6 +94,12 @@ class CLI
 			send((argument.name.to_s + '=').to_sym, value) 
 		end
 
+		def append(argument, value)
+			v = (send(argument.name.to_s) or [])
+			v << value
+			send((argument.name.to_s + '=').to_sym, v) 
+		end
+
 		def set(argument)
 			value(argument, true)
 		end
@@ -162,6 +168,17 @@ class CLI
 		@options << option_dsl
 	end
 
+	def options(name, options = {})
+		option_dsl = DSL::Options.new(name, options)
+
+		raise ParserError::LongNameSpecifiedTwiceError.new('option', option_dsl) if @options.has_long?(option_dsl) 
+		raise ParserError::LongNameSpecifiedTwiceError.new('switch and option', option_dsl) if @switches.has_long?(option_dsl) 
+		raise ParserError::ShortNameSpecifiedTwiceError.new('option', option_dsl) if @options.has_short?(option_dsl) 
+		raise ParserError::ShortNameSpecifiedTwiceError.new('switch and option', option_dsl) if @switches.has_short?(option_dsl) 
+
+		@options << option_dsl
+	end
+
 	def parse(_argv = ARGV, stdin = STDIN, stderr = STDERR)
 		values = Values.new
 		argv = _argv.dup
@@ -181,6 +198,11 @@ class CLI
 			end
 		end
 
+		# initialize multi options
+		@options.multiple.each do |o|
+			values.value(o, [])
+		end
+
 		# set defaults
 		@options.defaults.each do |o|
 			values.value(o, o.cast(o.default))
@@ -196,7 +218,11 @@ class CLI
 				values.set(switch)
 			elsif option = @options.find(arg)
 				value = argv.shift or raise ParsingError::MissingOptionValueError.new(option)
-				values.value(option, option.cast(value))
+				if option.multiple?
+					values.append(option, option.cast(value))
+				else
+					values.value(option, option.cast(value))
+				end
 				mandatory_options.delete(option)
 			else
 				raise ParsingError::UnknownSwitchError.new(arg) unless switch
@@ -210,24 +236,24 @@ class CLI
 
 		# process arguments
 		arguments = @arguments.dup
-		mandatory_arguments_left = @arguments.mandatory.length
-
 		while argument = arguments.shift
-			value = if argv.length == mandatory_arguments_left and not argument.mandatory?
-				argument.default # use defaults for optional arguments
+			value = if arguments.mandatory.length >= argv.length and argument.has_default?
+				argument.default
 			else
-				argv.shift or raise ParsingError::MandatoryArgumentNotSpecifiedError.new(argument)
-			end
-
-			if argument.multiple?
-				value = [value] unless value.is_a? Array
-				while argv.length > arguments.length
-					value << argv.shift
+				raise ParsingError::MandatoryArgumentNotSpecifiedError.new(argument) if argv.empty?
+				arg = argv.shift
+
+				if argument.multiple?
+					v = [arg]
+					while argv.length > arguments.length
+						v << argv.shift
+					end
+					v
+				else
+					arg
 				end
 			end
 
-			mandatory_arguments_left -= 1 if argument.mandatory?
-
 			values.value(argument, argument.cast(value))
 		end
 
@@ -291,8 +317,11 @@ class CLI
 		unless @options.empty?
 			out.puts "Options:"
 			@options.each do |o|
-				out.print '   '
-				out.print o.switch
+				unless o.multiple?
+					out.print "   #{o.switch}"
+				else
+					out.print "   #{o.switch}*"
+				end
 				out.print " (#{o.switch_short})" if o.has_short?
 				out.print " [%s]" % o.default if o.has_default?
 				out.print " - #{o.description}" if o.description?

data/lib/cli/dsl.rb

@@ -66,6 +66,13 @@ class CLI
 			end
 		end
 
+		module MultiDefault
+			def default
+				value = @options[:default]
+				value.is_a?(Array) ? value.map{|v| v.to_s} : [value.to_s]
+			end
+		end
+
 		class Input < DSL::Base
 			include DSL::Cast
 			include DSL::Description
@@ -90,6 +97,8 @@ class CLI
 		end
 
 		class Arguments < Argument
+			include DSL::MultiDefault
+
 			def cast(values)
 				out = []
 				values.each do |v|
@@ -98,15 +107,6 @@ class CLI
 				out
 			end
 
-			def default
-				value = @options[:default]
-				if value.is_a? Array
-					value.map{|v| v.to_s}
-				else
-					value.to_s
-				end
-			end
-
 			def multiple?
 				true
 			end
@@ -151,6 +151,18 @@ class CLI
 			def mandatory?
 				not has_default? and @options[:required]
 			end
+
+			def multiple?
+				false
+			end
+		end
+
+		class Options < Option
+			include DSL::MultiDefault
+
+			def multiple?
+				true
+			end
 		end
 	end
 end

data/lib/cli/options.rb

@@ -8,5 +8,9 @@ class CLI::Options < CLI::Switches
 	def mandatory
 		select{|o| o.mandatory?}
 	end
+
+	def multiple
+		select{|a| a.multiple?}
+	end
 end
 

data/spec/option_spec.rb

@@ -26,6 +26,14 @@ describe CLI do
 			ps.size.should == 24
 		end
 
+		it "should support casting of multiple options" do
+			ps = CLI.new do
+				options :size, :cast => Integer
+			end.parse(['--size', '24', '--size', '10'])
+			ps.size.should be_a Array
+			ps.size.should == [24, 10]
+		end
+
 		it "should support casting with lambda" do
 			ps = CLI.new do
 				option :size, :cast => lambda{|v| v.to_i + 2}
@@ -79,6 +87,13 @@ describe CLI do
 			ps.gold.should be_nil
 		end
 
+		it "not given option that can be specified multiple times should be an empty array" do
+			ps = CLI.new do
+				options :size, :cast => Integer
+			end.parse([])
+			ps.size.should == []
+		end
+
 		it "should handle multiple long and short intermixed options" do
 			ps = CLI.new do
 				option :location, :short => :l
@@ -96,6 +111,32 @@ describe CLI do
 			ps.gold.should be_nil
 		end
 
+		it "should support options that can be specified multiple times" do
+			ps = CLI.new do
+				options :power_up, :short => :p
+			end.parse(['--power-up', 'fire'])
+			ps.power_up.should == ['fire']
+
+			ps = CLI.new do
+				options :power_up, :short => :p
+			end.parse(['--power-up', 'fire', '-p', 'water', '--power-up', 'air', '-p', 'ground'])
+			ps.power_up.should == ['fire', 'water', 'air', 'ground']
+		end
+
+		it "should support options that can be specified multiple times can have single default" do
+			ps = CLI.new do
+				options :power_up, :short => :p, :default => 'fire'
+			end.parse([])
+			ps.power_up.should == ['fire']
+		end
+
+		it "should support options that can be specified multiple times can have multiple defaults" do
+			ps = CLI.new do
+				options :power_up, :short => :p, :default => ['fire', 'air']
+			end.parse([])
+			ps.power_up.should == ['fire', 'air']
+		end
+
 		it "should raise error if not symbol and optional hash is passed" do
 			lambda {
 				ps = CLI.new do

data/spec/usage_spec.rb

@@ -261,7 +261,7 @@ describe CLI do
 				switch :run
 				option :location, :short => :r, :description => "place where server is located"
 				option :group, :default => 'red'
-				option :power_up, :short => :p
+				options :power_up, :short => :p
 				option :speed, :short => :s, :cast => Integer
 				option :the_number_of_the_beast, :short => :b, :cast => Integer, :default => 666, :description => "The number of the beast"
 				option :size
@@ -289,7 +289,7 @@ Switches:
 Options:
    --location (-r) - place where server is located
    --group [red]
-   --power-up (-p)
+   --power-up* (-p)
    --speed (-s)
    --the-number-of-the-beast (-b) [666] - The number of the beast
    --size

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cli
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jakub Pastuszek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-20 00:00:00 Z
+date: 2011-12-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development