dencli 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71cb3a66fe8101078796ec7dfb0c793d315416020c76e11f2b312c32f6d3c1b2
-  data.tar.gz: 1675ca2b4f22fc083948bec274aa75c067e41622dc3d65059a9b200a86d21e0e
+  metadata.gz: b4f8e9d3af41176bba078797a33ed1116dee0d1bbdfdce64b4662ba084c0630e
+  data.tar.gz: 38c29fe476f8c31af57706a915fb5503a9f0ef3f81aab74675206980013bbd6a
 SHA512:
-  metadata.gz: 938480ac26fa9cbac07118edfa407b1a59d2e9534b43fdd308bf4e81a96e78a20fc2b3d3143029d6a8b1f516ebbd14af7507ae703e395d46ad4abfdbd3b42844
-  data.tar.gz: af52e24ace634da494e17b5efa06bdc475fa64d9250218d38b1c60ee7d4b9897cfdce6cf6cf54f141acca8ec836140a2ad368ac27ceb0bbd2b1cdf1c3b43598a
+  metadata.gz: a028b051a9ae055280811ba2dbe61f7e4c1ed9452cc015c4dea75f429ffa4ff768baaf0373aee46fa316563840fbd2abe450a7437647555dc117e2beabcd740b
+  data.tar.gz: 2dee7a4e46e861dec67df330db80789ba9dcb2ea05f7274853e8963235ee52a3e04572be72c2ed1c33351e9cae6a87ad809cfd32bd48fd6ec393b99a5e0ba7b5

data/bin/example.rb

@@ -1,10 +1,207 @@
 #!/usr/bin/env ruby
 
 require 'pathname'
-$:.unshift Pathname.new(__FILE__).dirname.dirname.join('lib').to_s
-require 'dencli'
+require 'shellwords'
+require 'stringio'
+require 'ipaddr'
+require_relative '../lib/dencli'
 
 cli = DenCli.new :example, "This is an example for generate a DenCli-API"
+
+class Capture
+	def initialize cli, verbose:
+		@cli, @counter, @verbose = cli, 0, verbose
+	end
+
+	def capture
+		@args = NilClass
+		@counter += 1
+		stdout, stderr = $stdout, $stderr
+		$stdout = $stderr = StringIO.new
+		begin
+			yield stdout, stderr
+		ensure
+			$stderr, $stdout = stderr, stdout
+		end
+	end
+
+	def args= args
+		@args = args
+	end
+
+	def logstart command
+		STDERR.printf "[% 4d] \e[1;35m? \e[0m %s tests %s\r", @counter, $0.shellescape, command.shelljoin
+	end
+
+	def logok info, command
+		STDERR.printf "[% 4d] \e[1;32mok\e[0m %s | %s tests %s\e[J\n", @counter, info, $0.shellescape, command.shelljoin
+	end
+
+	def logfail command
+		STDERR.printf "[% 4d] \e[1;31mer\e[0m %s tests %s\e[J\n", @counter, $0.shellescape, command.shelljoin
+	end
+
+	def logexception prefix, exception
+		loginfo "#{prefix} (#{exception.class.name}) #{exception}"
+		exception.backtrace[0...-Kernel.caller.length].each {|l| loginfo "  #{l}" }
+	end
+
+	def loginfo text
+		STDERR.printf "           %s\n", text
+	end
+
+	def should_ok expect, *command
+		logstart command
+		$capture.capture { @cli.call 'tests', *command }
+		if expect === @args
+			logok @args, command
+		else
+			logfail command
+			loginfo "expected args: #{expect.inspect}"
+			loginfo "given args: #{@args.inspect}"
+			STDERR.puts
+		end
+	rescue SystemExit
+		if 0 == $!.status
+			logok @args, command
+		else
+			logfail command
+		end
+	rescue Object
+		logfail command
+		logexception "unexpected raise:", $!
+		STDERR.puts
+	end
+
+	def should_fail exception, message, *command
+		logstart command
+		$capture.capture { @cli.call 'tests', *command }
+		logfail command
+	rescue exception
+		if message === $!.message
+			logok exception, command
+			if @verbose
+				logexception "raised:", $!
+				STDERR.puts
+			end
+		else
+			logexception "unexpected message:", $!
+			STDERR.puts
+		end
+	rescue Object
+		logfail command
+		logexception "unexpected raised:", $!
+		STDERR.puts
+	end
+end
+
+cli.sub :tests, "Some tests", noshortaliases: true do |tcli|
+	OptionParser.accept IPAddr do |arg|
+		begin
+			IPAddr.new arg
+		rescue IPAddr::InvalidAddressError
+			raise OptionParser::InvalidArgument, "#{$!.message}: #{arg}"
+		end
+	end
+
+	tcli.cmd( :'-', "No arguments no options expected", &lambda {|| $capture.args = [] })
+	tcli.cmd( :'arg', "", &lambda {|one| $capture.args = [one] })
+	tcli.cmd( :'oar', "", &lambda {|one=nil| $capture.args = [one] })
+	tcli.cmd( :'arg-arg', "", &lambda {|one, two| $capture.args = [one, two] })
+	tcli.cmd( :'oar-oar', "", &lambda {|one=nil, two=nil| $capture.args = [one, two] })
+	tcli.cmd( :'arg-oar', "expected", &lambda {|one, two=nil| $capture.args = [one, two] })
+	tcli.cmd( :'oar-arg', "expected", &lambda {|one=nil, two| $capture.args = [one, two] })
+	tcli.cmd( :'bool', '', &lambda {|a:| $capture.args = [a] }).opt(:a, '-a', '')
+	tcli.cmd( :'optbool', '', &lambda {|a: nil| $capture.args = [a] }).opt(:a, '-a', '')
+	tcli.cmd( :'defbool', '', &lambda {|a:| $capture.args = [a] }).opt(:a, '-a', '', default: 'default')
+	tcli.cmd( :'str', '', &lambda {|a:| $capture.args = [a] }).opt(:a, '-a=STR', '')
+	tcli.cmd( :'lstr', '', &lambda {|a:| $capture.args = [a] }).opt(:a, '--astr=STR', '')
+	tcli.cmd( :'bstr', '', &lambda {|a:| $capture.args = [a] }).opt(:a, '-a', '--astr=STR', '')
+	tcli.cmd( :'ipaddr', '', &lambda {|a:| $capture&.args = [a] }).opt(:a, '-a', '--addr=ADDR', IPAddr, '')
+
+	tcli.cmd( :run, "Run all tests") do |verbose:|
+		$capture = Capture.new cli, verbose: verbose
+
+		$capture.should_fail DenCli::UnknownCommand, //, 'unknown-command'
+
+		$capture.should_ok [], '-'
+		$capture.should_fail DenCli::UsageError, //, '-', 'unexpected'
+
+		$capture.should_ok %w[first], 'arg', 'first'
+		$capture.should_fail DenCli::UsageError, //, 'arg'
+		$capture.should_fail DenCli::UsageError, //, 'arg', 'first', 'unexpected'
+
+		$capture.should_ok %w[first], 'oar', 'first'
+		$capture.should_ok [nil], 'oar'
+		$capture.should_fail DenCli::UsageError, //, 'oar', 'first', 'unexpected'
+
+		$capture.should_ok %w[first two], 'oar-oar', 'first', 'two'
+		$capture.should_ok ['first', nil], 'oar-oar', 'first'
+		$capture.should_ok [nil,nil], 'oar-oar'
+		$capture.should_fail DenCli::UsageError, //, 'oar-oar', 'first', 'two', 'unexpected'
+
+		$capture.should_ok %w[first two], 'arg-oar', 'first', 'two'
+		$capture.should_ok ['first', nil], 'arg-oar', 'first'
+		$capture.should_fail DenCli::UsageError, //, 'arg-oar'
+
+		$capture.should_ok [nil, 'first'], 'oar-arg', 'first'
+		$capture.should_ok ['first', 'second'], 'oar-arg', 'first', 'second'
+		$capture.should_fail DenCli::UsageError, //, 'oar-arg'
+		$capture.should_fail DenCli::UsageError, //, 'oar-arg', 'first', 'two', 'unexpected'
+
+		$capture.should_ok [true], 'bool', '-a'
+		$capture.should_fail DenCli::UsageError, //, 'bool'
+		$capture.should_fail DenCli::UsageError, //, 'bool', '-a', 'unexpected'
+		$capture.should_fail OptionParser::InvalidOption, //, 'bool', '-b'
+		$capture.should_fail OptionParser::InvalidOption, //, 'bool', '--unexpected'
+		$capture.should_fail DenCli::UsageError, //, 'bool', 'unexpected'
+
+		$capture.should_ok [true], 'optbool', '-a'
+		$capture.should_ok [nil], 'optbool'
+		$capture.should_fail DenCli::UsageError, //, 'optbool', '-a', 'unexpected'
+		$capture.should_fail OptionParser::InvalidOption, //, 'optbool', '-b'
+		$capture.should_fail OptionParser::InvalidOption, //, 'optbool', '--unexpected'
+		$capture.should_fail DenCli::UsageError, //, 'optbool', 'unexpected'
+
+		$capture.should_ok [true], 'defbool', '-a'
+		$capture.should_ok ['default'], 'defbool'
+		$capture.should_fail DenCli::UsageError, //, 'defbool', '-a', 'unexpected'
+		$capture.should_fail OptionParser::InvalidOption, //, 'defbool', '-b'
+		$capture.should_fail OptionParser::InvalidOption, //, 'defbool', '--unexpected'
+		$capture.should_fail DenCli::UsageError, //, 'defbool', 'unexpected'
+
+		$capture.should_ok %w[first], 'str', '-a', 'first'
+		$capture.should_ok %w[first], 'str', '-afirst'
+		$capture.should_fail OptionParser::MissingArgument, //, 'str', '-a'
+		$capture.should_fail DenCli::UsageError, //, 'str'
+		$capture.should_fail OptionParser::InvalidOption, //, 'str', '-b'
+		$capture.should_fail OptionParser::InvalidOption, //, 'str', '--unexpected'
+		$capture.should_fail DenCli::UsageError, //, 'str', 'unexpected'
+
+		$capture.should_ok %w[first], 'lstr', '--astr', 'first'
+		$capture.should_ok %w[first], 'lstr', '--astr=first'
+		$capture.should_fail OptionParser::MissingArgument, //, 'lstr', '--astr'
+		$capture.should_fail DenCli::UsageError, //, 'lstr'
+		$capture.should_fail OptionParser::InvalidOption, //, 'lstr', '-b'
+		$capture.should_fail OptionParser::InvalidOption, //, 'lstr', '--unexpected'
+		$capture.should_fail DenCli::UsageError, //, 'lstr', 'unexpected'
+
+		$capture.should_ok %w[first], 'bstr', '-a', 'first'
+		$capture.should_ok %w[first], 'bstr', '-afirst'
+		$capture.should_ok %w[first], 'bstr', '--astr', 'first'
+		$capture.should_ok %w[first], 'bstr', '--astr=first'
+		$capture.should_fail OptionParser::MissingArgument, //, 'bstr', '--astr'
+		$capture.should_fail OptionParser::MissingArgument, //, 'bstr', '-a'
+		$capture.should_fail DenCli::UsageError, //, 'bstr'
+		$capture.should_fail OptionParser::InvalidOption, //, 'bstr', '-b'
+		$capture.should_fail OptionParser::InvalidOption, //, 'bstr', '--unexpected'
+		$capture.should_fail DenCli::UsageError, //, 'bstr', 'unexpected'
+
+		$capture.should_ok [IPAddr.new('1.2.3.4')], 'ipaddr', '-a', '1.2.3.4'
+		$capture.should_fail OptionParser::InvalidArgument, /invalid address/, 'ipaddr', '-a', '1.2.3.400'
+	end.opt( :verbose, '-v', 'Prints additional information per test', default: false)
+end
+
 cli.cmd( :args, "Expects and prints given arguments",
 	&lambda {|a, b, c:, d:, e:, f:, g:|
 		p a: a, b: b, c: c, d: d, e: e
@@ -16,21 +213,20 @@ cli.cmd( :args, "Expects and prints given arguments",
 	opt( :g, '--long-option=sth', "Long option, no short option", default: "nothing").
 	opt( :h, '-hsth', "No long option, only short option", default: "nothing")
 
-cli.cmd( :example, "I have an example command") { STDERR.puts "This is an example" }
+cli.cmd( :example, "I have an example command") { $stderr.puts "This is an example" }
 cli.cmd( :help, "An example for help", aliases: [nil, '-h', '--help'], &lambda {|*commands, full:|
 	if full
-		cli.help_full *commands, output: STDERR
+		cli.help_full *commands, output: $stderr
 	else
-		cli.help *commands, output: STDERR
+		cli.help *commands, output: $stderr
 	end
 }).
 	opt( :full, '-f', '--[no-]full', "Print all commands and sub-commands.", default: false)
 
 cli.sub( :more, "Sub-Commands are also possible with a new cli") do |sub|
-	sub.cmd( :help, "", aliases: [nil, '-h', '--help']) {|*args| STDERR.puts sub.help(*args) }
-	sub.cmd( :help, "") {|*args| STDERR.puts cli.help( 'more', *args) }
-	sub.cmd( :example, "Here is an example, too") { STDERR.puts "This is an other example" }
-	sub.cmd( :foo, "BAR") { STDERR.puts "FOO bar"}
+	sub.cmd( :help, "", aliases: [nil, '-h', '--help']) {|*args| $stderr.puts sub.help(*args) }
+	sub.cmd( :example, "Here is an example, too") { $stderr.puts "This is an other example" }
+	sub.cmd( :foo, "BAR") { $stderr.puts "FOO bar"}
 
 	sub.cmd( :args, "Expects and prints given arguments", &lambda {|a, b=1, c:, d: 5, e:|
 			p a: a, b: b, c: c, d: d, e: e
@@ -40,12 +236,12 @@ cli.sub( :more, "Sub-Commands are also possible with a new cli") do |sub|
 		opt( :e, '-e', "Toggle e")
 
 	sub.sub( :deeper, "You want to have Sub-Sub-Commands?") do |sub2|
-		sub2.cmd( :help, "", aliases: [nil, '-h', '--help'], &lambda {|*commands| sub2.help( *commands, output: STDERR) })
-		sub2.cmd( :last, "The last example", &lambda { STDERR.puts "The last example" })
+		sub2.cmd( :help, "", aliases: [nil, '-h', '--help'], &lambda {|*commands| sub2.help( *commands, output: $stderr) })
+		sub2.cmd( :last, "The last example", &lambda { $stderr.puts "The last example" })
 
 		sub2.sub( :'sub-commands', "Endless Sub-Sub- ...") do |sub3|
-			sub3.cmd( :help, "") {|*args| STDERR.puts sub3.help( sub3, *args) }
-			sub3.cmd( :hehe, "The real last example", min: 2) { STDERR.puts "Trust me!" }
+			sub3.cmd( :help, "") {|*args| $stderr.puts sub3.help( sub3, *args) }
+			sub3.cmd( :hehe, "The real last example", min: 2) { $stderr.puts "Trust me!" }
 		end
 	end
 end
@@ -53,6 +249,6 @@ end
 begin
 	cli.call *ARGV
 rescue DenCli::UsageError
-	STDERR.puts $!
+	$stderr.puts $!
 	exit 1
 end

data/lib/dencli/cmd.rb

@@ -60,7 +60,11 @@ class DenCli::CMD
 				raise DenCli::UsageError, "Missing argument(s): #{kr.map {|_, o| o.long || o.short }.join ', '}"
 			end
 		end
-		@exe.call *as, **os
+		if os.empty?
+			@exe.call *as
+		else
+			@exe.call *as, **os
+		end
 	end
 
 	def usage output: nil
@@ -87,7 +91,7 @@ class DenCli::CMD
 				end
 			end
 		else
-			output << ' ...'
+			output << ' [...]'
 		end
 	end
 
@@ -156,7 +160,7 @@ class DenCli::CMD
 	end
 
 	class Opt
-		attr_reader :name, :long, :short, :val, :desc, :os, :conv, :req
+		attr_reader :name, :long, :short, :type, :val, :desc, :conv, :req
 		def required?() @req end
 		def default?() NilClass != @default end
 		def default() NilClass == @default ? nil : @default end
@@ -179,11 +183,12 @@ class DenCli::CMD
 		end
 		private :parse_opt_string
 
-		def initialize cmd, name, opt, *alts, desc, default: NilClass, **os, &conv
-			@name, @desc, @default, @os, @conv, @val =
-				name.to_s.to_sym, desc, default, os, conv || lambda{|v|v}, nil
+		def initialize cmd, name, opt, *args, desc, default: NilClass, &conv
+			@name, @desc, @default, @conv, @val, @type =
+				name.to_s.to_sym, desc, default, conv || lambda{|v|v}, nil, nil
 			parse_opt_string opt
-			alts.each &method( :parse_opt_string)
+			@type = args.pop  if OptionParser.top.atype.has_key? args.last
+			args.each &method( :parse_opt_string)
 			@req =
 				if NilClass != default
 					false
@@ -196,30 +201,32 @@ class DenCli::CMD
 
 		def on parser, store
 			store[@name] = @default  if default?
-			parser.on "#{@short}#{@val ? ?= : ''}#{@val}", "#{@long}#{@val ? ?= : ''}#{@val}", **@os do |val|
+			short = "#{@short}#{@val ? ?= : ''}#{@val}"
+			long = "#{@long}#{@val ? ?= : ''}#{@val}"
+			parser.on short, long, *[@type].compact do |val|
 				store[@name] = @conv[val]
 			end
 		end
 
 		def inspect
-			"#<%s:0x%016x %s %s %s %s (%p) %p os=%p conv=%s>" % [
+			"#<%s:0x%x %s %s %s %s (%p) %p conv=%s>" % [
 				self.class.name, object_id, @req ? "<#{@name}>" : "[#{@name}]",
-				@short, @long, @val, @default, @desc, @os,
+				@short, @long, @val, @default, @desc, @type ? " type=#{type}" : '',
 				@exe ? "<#{@exe.lambda? ? :lambda: :proc} ##{@exe.arity}>" : "nil"
 			]
 		end
 	end
 
-	def opt name, opt, *alts, desc, **os, &conv
-		r = Opt.new( self, name, opt, *alts, desc, **os, &conv)
+	def opt name, opt, *args, desc, default: NilClass, &conv
+		r = Opt.new( self, name, opt, *args, desc, default: default, &conv)
 		@options[r.name] = r
 		self
 	end
 
 	def inspect
-		"#<%s:0x%x %s @name=%p @description=%p @parent=<%s:0x%x %s> @exe=<arity=%d>>" % [
+		"#<%s:0x%x %s @name=%p @description=%p @options=%p @parent=<%s:0x%x %s> @exe=<arity=%d>>" % [
 			self.class.name, self.object_id, self.full_cmd,
-			@name, @description, @parent.class.name, @parent.class.object_id, @parent.full_cmd,
+			@name, @description, @options.values, @parent.class.name, @parent.class.object_id, @parent.full_cmd,
 			@exe.arity
 		]
 	end

data/lib/dencli/interactive.rb

@@ -121,7 +121,7 @@ class DenCli::Interactive
 		begin
 			cur.call *line
 		rescue ::DenCli::UsageError
-			STDERR.puts "! #$!"
+			$stderr.puts "! #$!"
 		end
 		true
 	end

data/lib/dencli/sub.rb

@@ -3,11 +3,12 @@ require_relative '../dencli'
 class DenCli::Sub
 	attr_reader :parent, :name, :description, :subs, :aliases
 
-	def initialize parent, name, description
+	def initialize parent, name, description, noshortaliases: nil
 		#DenCli::assert_type self, __method__, :name, name, Symbol
 		#DenCli::assert_type self, __method__, :parent, parent, DenCli, DenCli::Sub
 		#DenCli::assert_type self, __method__, :description, description, String
 		@parent, @name, @description, @subs, @aliases = parent, name, "-> #{description}", {}, {}
+		@noshortaliases = ! ! noshortaliases
 	end
 
 	def _full_cmd( post) parent._full_cmd [@name]+post end
@@ -118,16 +119,27 @@ class DenCli::Sub
 		#DenCli::assert_type self, __method__, :aliases, aliases, Array, NilClass
 		name = name.to_s  unless name.nil?
 		@subs[name] = obj
-		DenCli.gen_aliases( name, min) {|a| @aliases[a] = obj }
+		if @noshortaliases
+			warn "Command/Alias already exists: #{full_cmd.join ' '} #{name}"  if @aliases.has_key? name
+			@aliases[name] = obj
+		else
+			DenCli.gen_aliases name, min do |a|
+				warn "Command/Alias already exists: #{full_cmd.join ' '} #{a}"  if @aliases.has_key? a
+				@aliases[a] ||= obj
+			end
+		end
 		if aliases
-			[*aliases].each {|a| @aliases[a] = obj }
+			[*aliases].each do |a|
+				raise ArgumentError, "Alias already exists: #{full_cmd.join ' '} #{a}"  if @aliases.has_key? a
+				@aliases[a] = obj
+			end
 		end
 		obj
 	end
 	private :_add
 
-	def sub name, description, min: nil, aliases: nil, &exe
-		r = _add name, min, DenCli::Sub.new( self, name, description), aliases
+	def sub name, description, min: nil, aliases: nil, noshortaliases: nil, &exe
+		r = _add name, min, DenCli::Sub.new( self, name, description, noshortaliases: noshortaliases), aliases
 		block_given? ? yield( r) : r
 	end
 
@@ -141,7 +153,7 @@ class DenCli::Sub
 		elsif sub = @subs[pre[0]]
 			sub.complete *pre[1..-1], str
 		else
-			STDOUT.print "\a"
+			$stdout.print "\a"
 		end
 	end
 

data/lib/dencli/version.rb

@@ -1,3 +1,3 @@
 class DenCli
-	VERSION = '0.5.4'
+	VERSION = '0.5.5'
 end

data/lib/dencli.rb

@@ -51,11 +51,16 @@ class DenCli
 		# `g(:abc)` => `["a", "ab", "abc"]`
 		# `g(:abcdef, 4)` => `["abcd", "abcde", "abcdef"]`
 		def gen_aliases cmd, min = nil
-			r = ((min||1)-1).upto cmd.length-1
+			case min
+			when false then min = cmd.length
+			when nil then min = 1
+			end
+			r = ([min, 1].max - 1).upto cmd.length-2
 			if block_given?
 				r.each {|i| yield cmd[0..i] }
+				yield cmd
 			else
-				r.map  {|i| cmd[0..i] }
+				r.map  {|i| cmd[0..i] } + [cmd]
 			end
 		end
 		alias g gen_aliases
@@ -96,7 +101,7 @@ class DenCli
 	end
 
 	def help_full *args, output: nil
-		output ||= STDOUT
+		output ||= $stdout
 		x = @subs.goto *args
 		_help_full output, x
 	end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dencli
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Denis Knauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec