cli 0.1.1 → 0.2.0

data/README.md

@@ -27,7 +27,7 @@ require 'ip'
 
 options = CLI.new do
 	description 'Example CLI usage for Sinatra server application'
-	version (cli_root + 'VERSION').read
+	version "1.0.0"
 	switch :no_bind,			:description => "Do not bind to TCP socket - useful with -s fastcgi option"
 	switch :no_logging,			:description => "Disable logging"
 	switch :debug,				:description => "Enable debugging"
@@ -96,6 +96,7 @@ Example version output:
 
 ```ruby
 require 'cli'
+require 'pathname'
 require 'yaml'
 
 options = CLI.new do
@@ -135,6 +136,100 @@ The `options` variable will contain:
 
     #<CLI::Values location="Singapore", stdin={:parser=>{:failures=>0, :successes=>41}}, jekyll_dir=#<Pathname:/var/lib/vhs/jekyll>, csv_dir=#<Pathname:csv>>
 
+### Ls like utility
+
+`arguments` specifier can be used to match multiple arguments.
+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).
+
+```ruby
+require 'cli'
+require 'pathname'
+
+options = CLI.new do
+	description 'Lists content of directories'
+	switch :long, :short => :l, :description => 'use long listing'
+	arguments :directories, :cast => Pathname, :default => '.', :description => 'directories to list content of'
+end.parse!
+
+options.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
+			puts "#{e.stat.uid}:#{e.stat.gid} #{e}"
+		else
+			puts e
+		end
+	end
+end
+```
+
+Example help message:
+
+    Usage: ls [switches] [--] directories*
+    Lists content of directories
+    Switches:
+       --long (-l) - use long listing
+       --help (-h) - display this help message
+    Arguments:
+       directories* [.] - directories to list content of
+
+Example usage:
+
+    examples/ls
+
+Prints:
+
+    .document
+    .git
+    .gitignore
+    .README.md.swp
+    .rspec
+    cli.gemspec
+    examples
+    features
+    ...
+
+With directory list:
+    
+    examples/ls *
+
+Prints:
+
+    examples/.ls.swp
+    examples/ls
+    examples/processor
+    examples/sinatra
+    features/cli.feature
+    features/step_definitions
+    features/support
+    lib/cli
+    lib/cli.rb
+    pkg/cli-0.0.1.gem
+    pkg/cli-0.0.2.gem
+    ...
+    
+Long printout:
+
+    examples/ls -l *
+
+Prints:
+
+    501:20 examples/.ls.swp
+    501:20 examples/ls
+    501:20 examples/processor
+    501:20 examples/sinatra
+    501:20 features/cli.feature
+    501:20 features/step_definitions
+    501:20 features/support
+    501:20 lib/cli
+    501:20 lib/cli.rb
+    501:20 pkg/cli-0.0.1.gem
+    501:20 pkg/cli-0.0.2.gem
+    ...
+    
 ## Contributing to CLI
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/cli.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cli"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2011-12-19"
+  s.date = "2011-12-20"
   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 = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "cli.gemspec",
+    "examples/ls",
     "examples/processor",
     "examples/sinatra",
     "features/cli.feature",

data/examples/ls

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -rrubygems
+require 'cli'
+require 'pathname'
+
+options = CLI.new do
+	description 'Lists content of directories'
+	switch :long, :short => :l, :description => 'use long listing'
+	arguments :directories,	:cast => Pathname, :default => '.', :description => 'directories to list content of'
+end.parse!
+
+options.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
+			puts "#{e.stat.uid}:#{e.stat.gid} #{e}"
+		else
+			puts e
+		end
+	end
+end
+

data/examples/processor

@@ -1,9 +1,6 @@
-#!/usr/bin/ruby
-require 'pathname'
-cli_root = Pathname.new(__FILE__).dirname + '..'
-$LOAD_PATH.unshift(cli_root + 'lib')
-
+#!/usr/bin/ruby -rrubygems
 require 'cli'
+require 'pathname'
 require 'yaml'
 
 options = CLI.new do

data/examples/sinatra

@@ -1,14 +1,10 @@
-#!/usr/bin/ruby
-require 'pathname'
-cli_root = Pathname.new(__FILE__).dirname + '..'
-$LOAD_PATH.unshift(cli_root + 'lib')
-
+#!/usr/bin/ruby -rrubygems
 require 'cli'
 require 'ip'
 
 options = CLI.new do
 	description 'Example CLI usage for Sinatra server application'
-	version (cli_root + 'VERSION').read
+	version "1.0.0"
 	switch :no_bind,					:description => "Do not bind to TCP socket - useful with -s fastcgi option"
 	switch :no_logging,				:description => "Disable logging"
 	switch :debug,						:description => "Enable debugging"

data/lib/cli.rb

@@ -49,6 +49,12 @@ class CLI
 				super("short name for #{switch_dsl.switch} has to be one letter symbol, got #{short.inspect}")
 			end
 		end
+
+		class MultipleArgumentsSpecifierError < ParserError
+			def initialize(arguments_dsl)
+				super("only one 'arguments' specifier can be used, got: #{arguments_dsl.join(', ')}")
+			end
+		end
 	end
 
 	class ParsingError < ArgumentError
@@ -124,6 +130,16 @@ class CLI
 		@arguments << argument_dsl
 	end
 
+	def arguments(name, options = {})
+		arguments_dsl = DSL::Arguments.new(name, options)
+
+		raise ParserError::ArgumentNameSpecifiedTwice.new(arguments_dsl.name) if @arguments.has?(arguments_dsl)
+
+		@arguments << arguments_dsl
+
+		raise ParserError::MultipleArgumentsSpecifierError.new(@arguments.multiple) if @arguments.multiple.length > 1
+	end
+
 	def switch(name, options = {})
 		switch_dsl = DSL::Switch.new(name, options)
 
@@ -203,6 +219,13 @@ class CLI
 				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
+				end
+			end
+
 			mandatory_arguments_left -= 1 if argument.mandatory?
 
 			values.value(argument, argument.cast(value))
@@ -243,7 +266,7 @@ class CLI
 		out.print ' [switches]' if not @switches.empty? and @options.empty?
 		out.print ' [options]' if @switches.empty? and not @options.empty?
 		out.print ' [--]' if not @arguments.empty? and (not @switches.empty? or not @options.empty?)
-		out.print ' ' + @arguments.map{|a| a.to_s}.join(' ') unless @arguments.empty?
+		out.print ' ' + @arguments.map{|a| a.multiple? ? a.to_s + '*': a.to_s}.join(' ') unless @arguments.empty?
 		out.print " < #{@stdin}" if @stdin
 
 		out.puts
@@ -281,7 +304,14 @@ class CLI
 		unless described_arguments.empty?
 			out.puts "Arguments:"
 			described_arguments.each do |a|
-				out.puts "   #{a} - #{a.description}"
+				unless a.multiple?
+					out.print "   #{a}"
+				else
+					out.print "   #{a}*"
+				end
+				out.print " [%s]" % (a.default.is_a?(Array) ? a.default.join(' ') : a.default) if a.has_default?
+				out.print " - #{a.description}"
+				out.puts
 			end
 		end
 

data/lib/cli/arguments.rb

@@ -6,5 +6,9 @@ class CLI::Arguments < Array
 	def mandatory
 		select{|a| a.mandatory?}
 	end
+
+	def multiple
+		select{|a| a.multiple?}
+	end
 end
 

data/lib/cli/dsl.rb

@@ -83,6 +83,33 @@ class CLI
 			def to_s
 				name.to_s.tr('_', '-')
 			end
+
+			def multiple?
+				false
+			end
+		end
+
+		class Arguments < Argument
+			def cast(values)
+				out = []
+				values.each do |v|
+					out << super(v)
+				end
+				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
 		end
 
 		class Switch < DSL::Base

data/spec/argument_spec.rb

@@ -10,7 +10,7 @@ describe CLI do
 			ps.log.should == '/tmp'
 		end
 
-		it "non empty, non optional with class casting" do
+		it "should cast mandatory argument" do
 			ps = CLI.new do
 				argument :log, :cast => Pathname
 			end.parse(['/tmp'])
@@ -18,7 +18,7 @@ describe CLI do
 			ps.log.to_s.should == '/tmp'
 		end
 
-		it "non empty, non optional with builtin class casting" do
+		it "should cast mandatory argument to numerical class" do
 			ps = CLI.new do
 				argument :number, :cast => Integer
 			end.parse(['123'])
@@ -32,6 +32,49 @@ describe CLI do
 			ps.number.should == 123.0
 		end
 
+		it "should cast default value" do
+			ps = CLI.new do
+				argument :number, :cast => Integer, :default => '123'
+			end.parse([])
+			ps.number.should be_a Integer
+			ps.number.should == 123
+		end
+
+		it "should cast value of multiple arguments argument" do
+			ps = CLI.new do
+				arguments :numbers, :cast => Integer
+			end.parse(['1', '2', '3'])
+			ps.numbers.should be_a Array
+			ps.numbers[0].should be_a Integer
+			ps.numbers[0].should == 1
+			ps.numbers[1].should be_a Integer
+			ps.numbers[1].should == 2
+			ps.numbers[2].should be_a Integer
+			ps.numbers[2].should == 3
+		end
+
+		it "should cast single default value of multiple arguments argument" do
+			ps = CLI.new do
+				arguments :numbers, :cast => Integer, :default => '1'
+			end.parse([])
+			ps.numbers.should be_a Array
+			ps.numbers[0].should be_a Integer
+			ps.numbers[0].should == 1
+		end
+
+		it "should cast default value array of multiple arguments argument" do
+			ps = CLI.new do
+				arguments :numbers, :cast => Integer, :default => ['1', '2', '3']
+			end.parse([])
+			ps.numbers.should be_a Array
+			ps.numbers[0].should be_a Integer
+			ps.numbers[0].should == 1
+			ps.numbers[1].should be_a Integer
+			ps.numbers[1].should == 2
+			ps.numbers[2].should be_a Integer
+			ps.numbers[2].should == 3
+		end
+
 		it "should handle multiple arguments" do
 			ps = CLI.new do
 				argument :log, :cast => Pathname
@@ -43,6 +86,20 @@ describe CLI do
 			ps.test.should == 'hello'
 		end
 
+		it "should handle multi arguments" do
+			ps = CLI.new do
+				argument :log, :cast => Pathname
+				arguments :words
+			end.parse(['/tmp', 'hello', 'world', 'test'])
+			ps.log.should be_a Pathname
+			ps.log.to_s.should == '/tmp'
+
+			ps.words.should be_a Array
+			ps.words[0].should == 'hello'
+			ps.words[1].should == 'world'
+			ps.words[2].should == 'test'
+		end
+
 		it "should raise error if not symbol and optional hash is passed" do
 			lambda {
 				ps = CLI.new do
@@ -83,6 +140,16 @@ describe CLI do
 			}.should raise_error CLI::ParsingError::CastError, "failed to cast: 'log' to type: IP: invalid address"
 		end
 
+		it "should raise error if multiple artuments argument defined twice" do
+			lambda {
+				ps = CLI.new do
+					arguments :test1
+					argument :test2
+					arguments :test3
+				end
+			}.should raise_error CLI::ParserError::MultipleArgumentsSpecifierError, "only one 'arguments' specifier can be used, got: test1, test3"
+		end
+
 		describe "with defaults" do
 			it "when not enought arguments given it should fill required arguments only with defaults" do
 				ps = CLI.new do
@@ -127,6 +194,60 @@ describe CLI do
 				ps.test.should == 'world'
 				ps.code.should == 123
 			end
+
+			it "should fill multiple argumets argument with remaining arguments after filling mandatory and default arguments" do
+				ps = CLI.new do
+					argument :log, :cast => Pathname
+					argument :magick, :default => 'word'
+					argument :test
+					arguments :words
+					argument :test2
+					argument :code, :cast => Integer, :default => '123'
+				end.parse(['/tmp', 'number', 'test', 'hello', 'world', 'abc', 'test2', '42'])
+
+				ps.log.to_s.should == '/tmp'
+				ps.magick.should == 'number'
+				ps.test.should == 'test'
+				ps.words.should == ['hello', 'world', 'abc']
+				ps.test2.should == 'test2'
+				ps.code.should == 42
+			end
+
+			it "should use default single value for multiple arguments argument when not enought arguments given" do
+				ps = CLI.new do
+					argument :log, :cast => Pathname
+					argument :magick, :default => 'word'
+					argument :test
+					arguments :words, :default => 'hello'
+					argument :test2
+					argument :code, :cast => Integer, :default => '123'
+				end.parse(['/tmp', 'test', 'test2'])
+
+				ps.log.to_s.should == '/tmp'
+				ps.magick.should == 'word'
+				ps.test.should == 'test'
+				ps.words.should == ['hello']
+				ps.test2.should == 'test2'
+				ps.code.should == 123
+			end
+
+			it "should use default array of values for multiple arguments argument when not enought arguments given" do
+				ps = CLI.new do
+					argument :log, :cast => Pathname
+					argument :magick, :default => 'word'
+					argument :test
+					arguments :words, :default => ['hello', 'world', 'abc']
+					argument :test2
+					argument :code, :cast => Integer, :default => '123'
+				end.parse(['/tmp', 'test', 'test2'])
+
+				ps.log.to_s.should == '/tmp'
+				ps.magick.should == 'word'
+				ps.test.should == 'test'
+				ps.words.should == ['hello', 'world', 'abc']
+				ps.test2.should == 'test2'
+				ps.code.should == 123
+			end
 		end
 	end
 end

data/spec/usage_spec.rb

@@ -272,10 +272,11 @@ describe CLI do
 				argument :number, :cast => Integer
 				argument :code, :cast => Integer, :default => '123', :description => "secret code"
 				argument :illegal_prime, :cast => Integer, :description => "prime number that represents information that it is forbidden to possess or distribute"
+				arguments :files, :cast => Pathname, :default => ['test', '1', '2'], :description => "files to process"
 			end.usage
 
 			u.should == <<EOS
-Usage: rspec [switches|options] [--] log magick string number code illegal-prime < log-data
+Usage: rspec [switches|options] [--] log magick string number code illegal-prime files* < log-data
 Log file processor
 Input:
    log-data - YAML formatted log data
@@ -294,8 +295,9 @@ Options:
    --size
 Arguments:
    log - log file to process
-   code - secret code
+   code [123] - secret code
    illegal-prime - prime number that represents information that it is forbidden to possess or distribute
+   files* [test 1 2] - files to process
 EOS
 		end
 	end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cli
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jakub Pastuszek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-19 00:00:00 Z
+date: 2011-12-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -142,6 +142,7 @@ files:
 - Rakefile
 - VERSION
 - cli.gemspec
+- examples/ls
 - examples/processor
 - examples/sinatra
 - features/cli.feature