dencli 0.4.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 127668bd8bd4de7dc572ce5c72be6403ca49e9da7690ceb7746c913a497495c3
-  data.tar.gz: b28f1e67d5c029df9917f6f9609a8d0c718c8a6cda35a0cf1a283cf37a925adb
+  metadata.gz: b51686dc165e8a0fa5dad00dea71e56a4007be3ad050de0e7a73b3f7587baefa
+  data.tar.gz: 97ce2e6f4bb16974e8b1375133fbcbf8be7b1d4f15491935ebcda55557b3784f
 SHA512:
-  metadata.gz: e5fce26cb4eae5698536a1c1ffbae0571783432acef83451477daf259ee6aed1699542f4a93909c1bc3ac25095b3153a1381f32efa827f489cb3885cba557e7d
-  data.tar.gz: 8b22f6c8dfdd91fef4ce45819377ac5773e82a01ca168624dbff789d942cb32dec2677de396574198f7643f20f4401a32955239e67b621ecdebf5eb8847f854f
+  metadata.gz: 5a98c654de4a78a1dc07c41a8cd2dffcba9d34b57c03b80784b8d652f155d5a53f54370906ec51404c0b6df45a4e387fb8027b5938539780a50e680b9dfbd123
+  data.tar.gz: 3a0e657604254c35e65ae6c501af0c79fd6887b7cb45b8a4ea1693c6fd666eddf04d5e3b060841bf6b0619c35bfdd6af61e98d9598090c9101f4631d993d84ee

data/bin/example.rb

@@ -4,16 +4,27 @@ require 'pathname'
 $:.unshift Pathname.new(__FILE__).dirname.dirname.join('lib').to_s
 require 'dencli'
 
-cli = DenCli.new 'example', "This is an example for generate a DenCli-API"
-cli.cmd( :example, "I have an example command") { STDERR.puts "This is an example" }
-cli.cmd( :help, "", aliases: [nil, '-h', '--help']) {|*args| STDERR.puts cli.help(*args) }
-
-cli.cmd( :args, "Expects and prints given arguments", &lambda {|a, b, c:, d:, e:|
+cli = DenCli.new :example, "This is an example for generate a DenCli-API"
+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
 	}).
 	opt( :c, '-c=ForC', "Option c").
-	opt( :d, '-d=ForD', "Option d", default: "something").
-	opt( :e, '-e', "Toggle e", default: false)
+	opt( :d, '-dForD', "Option d", default: "something").
+	opt( :e, '-e', "Toggle e", default: false).
+	opt( :f, '--[no-]f', "Toggle f", default: false).
+	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( :help, "", aliases: [nil, '-h', '--help'], &lambda {|*args, full:|
+	if full
+		cli.help_full *args, output: STDERR
+	else
+		cli.help *args, 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) }
@@ -29,7 +40,7 @@ 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 {|*args| STDERR.puts sub2.help(*args) })
+		sub2.cmd( :help, "", aliases: [nil, '-h', '--help'], &lambda {|*args| sub2.help( *args, output: STDERR) })
 		sub2.cmd( :last, "The last example", &lambda { STDERR.puts "The last example" })
 
 		sub2.sub( :'sub-commands', "Endless Sub-Sub- ...") do |sub3|

data/lib/dencli/cmd.rb

@@ -7,6 +7,12 @@ class DenCli::CMD
 	def initialize parent, name, description, exe
 		raise "Proc expected, instead of: #{exe.inspect}"  unless Proc === exe
 		@parent, @name, @description, @exe = parent, name, description, lambda( &exe)
+		@parameters = @exe.parameters
+		@arguments_required = @exe.parameters.select {|e| :req == e[0] }.map {|e| e[1] }
+		@arguments_additional = @exe.parameters.select {|e| :opt == e[0] }.map {|e| e[1] }
+		@arguments = @exe.parameters.select {|e| :req == e[0] or :opt == e[0] }.map {|e| e[1] }
+		@options_required = @exe.parameters.select {|e| :keyreq == e[0] }.map {|e| e[1] }
+		@options_additional = @exe.parameters.select {|e| :key == e[0] }.map {|e| e[1] }
 		@options = {}
 		completion {|*a| [] }
 	end
@@ -14,19 +20,17 @@ class DenCli::CMD
 	def _full_cmd( post) parent._full_cmd [@name]+post end
 	def full_cmd() _full_cmd [] end
 
-	def parameters() @exe.parameters end
-	def arguments_required() @exe.parameters.select {|e| :req == e[0] }.map {|e| e[1] } end
+	attr_reader :parameters,
+		:arguments_required, :arguments_additional, :arguments,
+		:options_required, :options_additional
 	alias required arguments_required
-	def arguments_additional() @exe.parameters.select {|e| :opt == e[0] }.map {|e| e[1] } end
 	alias additional arguments_additional
-	def arguments() @exe.parameters.select {|e| :req == e[0] or :opt == e[0] }.map {|e| e[1] } end
-	def options_required() @exe.parameters.select {|e| :keyreq == e[0] }.map {|e| e[1] } end
-	def options_additional() @exe.parameters.select {|e| :key == e[0] }.map {|e| e[1] } end
 
-	def help() "Usage: #{usage}\n#{description}\n#{options_help}" end
-	def complete( *pre, str) @completion.call *pre, str end
+	def complete *pre, str
+		@completion.call *pre, str
+	end
 
-	def call( *as)
+	def call *as
 		os = {}
 		unless @options.empty?
 			# options like --abc | -x will be provided in os
@@ -53,25 +57,58 @@ class DenCli::CMD
 			end
 			kr = @options.select {|_, o| o.required? and not os.has_key? o.name }
 			unless kr.empty?
-				raise DenCli::UsageError, "Missing argument(s): #{kr.map {|o| o.as.first }.join ', '}"
+				raise DenCli::UsageError, "Missing argument(s): #{kr.map {|_, o| o.long || o.short }.join ', '}"
 			end
 		end
 		@exe.call *as, **os
 	end
 
-	def usage
-		args =
-			@options.map do |_, o|
-				s = "#{o.short}#{o.val ? ?= : ''}#{o.val}"; o.required? ? "#{s} " : "[#{s}] "
-			end
-		"#{full_cmd.join ' '}  #{args.join ''}"+
-			(@exe.lambda? ? (
-				required.map{|s|"<#{s}>"}.join( " ")+
-				(additional.empty? ? "" : " [#{additional.map{|s|"<#{s}>"}.join " "}]")
-			) : '...')
+	def usage output: nil
+		output ||= ''
+		_usage output
+		output
+	end
+
+	def _usage output
+		output << full_cmd.join( ' ')
+		@options.each do |_, o|
+			s = "#{o.short||o.long}#{(!o.short && o.val) ? ?= : ''}#{o.val}"
+			output << (o.required? ? " #{s}" : " [#{s}]")
+		end
+		if @exe.lambda?
+			required.each {|s| output << " <#{s}>" }
+			output << " [#{additional.map{|s|"<#{s}>"}.join " "}]"  unless additional.empty?
+		else
+			output << ' ...'
+		end
+	end
+
+	def commands *args
+		yield name, self
 	end
 
-	def options_help
+	def goto *args
+		self
+	end
+
+	def help output: nil
+		output ||= ''
+		_help output
+		output
+	end
+
+	def _help output
+		output << "Usage: #{usage}\n#{description}\n"
+		_help_options output
+	end
+
+	def help_options output: nil
+		output ||= ''
+		_help_options output
+		output
+	end
+
+	def _help_options output
 		sc, lc, dc = 0, 0, 0
 		@options.each do |_, o|
 			s = o.short&.length || 0
@@ -89,8 +126,8 @@ class DenCli::CMD
 			end
 			dc = d  if dc < d
 		end
-		format = "  %-#{sc}s%s %-#{lc}s %s"
-		@options.map {|_, o|
+		format = "  %-#{sc}s%s %-#{lc}s %s\n"
+		@options.map do |_, o|
 			s, l, v, y = o.short, o.long, o.val, ','
 			if l.nil?
 				s += "=#{v}"  if v
@@ -101,8 +138,8 @@ class DenCli::CMD
 			end
 			d = o.desc || ''
 			d += " (#{o.default})"  if o.default?
-			format % [ s, y, l, d ]
-		}.join "\n"
+			output << format % [ s, y, l, d ]
+		end
 	end
 
 	def completion &exe
@@ -116,34 +153,29 @@ class DenCli::CMD
 		def default?() NilClass != @default end
 		def default() NilClass == @default ? nil : @default end
 
-		def initialize cmd, name, opt, *alts, desc, default: NilClass, **os, &conv
-			long = short = val = nil
+		def parse_opt_string opt
 			case opt
-			when /\A(--[^=-]+)=(.+)\z/
-				long, val = $1, $2
-			when /\A(--[^=-]+)\z/
-				long, val = $1, nil
-			when /\A(-[^=-]+)=(.+)\z/
-				short, val = $1, $2
-			when /\A(-[^=-]+)\z/
-				short, val = $1, nil
-			else raise ArgumentError, "Unexpected format for option: #{opt.inspect}"
-			end
-			alts.each do |alt|
-				case alt
-				when /\A(--[^=-]+)=(.+)\z/
-					long, val = $1, val || $2
-				when /\A(--[^=-]+)\z/
-					long, val = $1, nil
-				when /\A(-[^=-]+)=(.+)\z/
-					short, val = $1, val || $2
-				when /\A(-[^=-]+)\z/
-					short, val = $1, nil
-				else raise ArgumentError, "Unexpected format for option: #{alt.inspect}"
-				end
+			when /\A(--\[no-\][^=]+)\z/
+				@long, @val = $1, nil
+			when /\A(--[^=]+)=(.+)\z/
+				@long, @val = $1, $2 || @val
+			when /\A(--[^=]+)\z/
+				@long, @val = $1, nil
+			when /\A(-[^=-])=?(.+)\z/
+				@short, @val = $1, $2 || @val
+			when /\A(-[^=-])\z/
+				@short, @val = $1, nil
+			else
+				raise ArgumentError, "Unexpected format for option: #{opt.inspect}"
 			end
-			@name, @short, @long, @val, @desc, @default, @os, @conv =
-				name.to_s.to_sym, short, long, val, desc, default, os, conv || lambda{|v|v}
+		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
+			parse_opt_string opt
+			alts.each &method( :parse_opt_string)
 			@req =
 				if NilClass != default
 					false
@@ -155,6 +187,7 @@ class DenCli::CMD
 		end
 
 		def on parser, store
+			store[@name] = @default  if default?
 			parser.on "#{@short}#{@val ? ?= : ''}#{@val}", "#{@long}#{@val ? ?= : ''}#{@val}", **@os do |val|
 				store[@name] = @conv[val]
 			end

data/lib/dencli/sub.rb

@@ -4,6 +4,9 @@ class DenCli::Sub
 	attr_reader :parent, :name, :description, :subs, :aliases
 
 	def initialize parent, name, description
+		#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}", {}, {}
 	end
 
@@ -15,16 +18,72 @@ class DenCli::Sub
 		"#{full_cmd.join ' '} ..."
 	end
 
-	def help n = nil, *a
+	def help n = nil, *a, output: nil
+		output ||= ''
+		_help output, n, *a
+		output
+	end
+
+	def _help output, n = nil, *a
 		if n.nil?
-			r = "#{full_cmd.join ' '}: #{description}\n\n"
-			m = @subs.map {|k,c| k.nil? ? 0 : c.usage.length }.max
-			@subs.each do |k, c|
-				r += "  % -#{m}s  %s\n" % [c.usage, c.description]  unless k.nil?
-			end
-			r
+			output << "#{full_cmd.join ' '}: #{description}\n\n"
+			self.class._help_commands output, @subs
 		elsif @aliases.has_key? n
-			@aliases[n].help *a
+			@aliases[n]._help output, *a
+		else
+			raise DenCli::UnknownCommand, "unknown command: #{_full_cmd( [n])[1..-1].join ' '}, available for #{full_cmd[1..-1].join' '}: #{@subs.keys.join ' '}"
+		end
+	end
+
+	def commands &exe
+		yield name, self
+		@subs.each {|k, c| c.commands &exe }
+	end
+
+	def help_commands output: nil
+		output ||= ''
+		self.class._help_commands output, subs.map {|_,c| c}
+		output
+	end
+
+	def self._help_commands output, subs
+		m = subs.map {|_name,c| x = c.usage.length; 25 < x ? 0 : x }.max
+		subs.each do |_name, c|
+			if 25 < c.usage.length
+				output << "% -#{m}s\n#{' ' * m} " % [c.usage]
+			else
+				output << "% -#{m}s " % [c.usage]
+			end
+			n = m+2
+			prefix = nil
+			c.description.split /\n/ do |l|
+				c = 0
+				l.split %r< > do |w|
+					if prefix
+						output << prefix
+						prefix = nil
+					end
+					wl = w.length
+					if 75 < c+wl
+						output << "\n#{' ' * n}#{w}"
+						c = n+2+wl
+					else
+						output << " #{w}"
+						c += 1 + wl
+					end
+				end
+				prefix = "\n#{' ' * n}"
+			end
+			output << "\n"
+		end
+		output
+	end
+
+	def goto *a
+		return self  if a.empty?
+		n, *a = *a
+		if @aliases.has_key? n
+			@aliases[n].goto *a
 		else
 			raise DenCli::UnknownCommand, "unknown command: #{_full_cmd( [n])[1..-1].join ' '}, available for #{full_cmd[1..-1].join' '}: #{@subs.keys.join ' '}"
 		end
@@ -40,6 +99,10 @@ class DenCli::Sub
 	end
 
 	def _add name, min, obj, aliases
+		#DenCli::assert_type self, __method__, :name, name, Symbol, NilClass
+		#DenCli::assert_type self, __method__, :min, min, Integer, NilClass
+		#DenCli::assert_type self, __method__, :obj, obj, DenCli::Sub, DenCli::CMD
+		#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 }

data/lib/dencli/version.rb

@@ -1,3 +1,3 @@
 class DenCli
-	VERSION = '0.4.0'
+	VERSION = '0.5.3'
 end

data/lib/dencli.rb

@@ -1,6 +1,13 @@
 require 'optparse'
 
+
 class DenCli
+	def self.assert_type klass, method, argument_name, object, *types
+		unless types.any? {|type| object.is_a? type }
+			raise ArgumentError, "#{klass.name}.#{method} expects #{types.map( &:to_s).join '|' } for #{argument_name}, not: #{object.inspect}"
+		end
+	end
+
 	class UsageError < ::RuntimeError
 	end
 	class UnknownCommand < UsageError
@@ -80,8 +87,22 @@ class DenCli
 		@subs.call *a
 	end
 
-	def help *args
-		@subs.help *args
+	def usage *args, **opts
+		@subs.usage *args, **opts
+	end
+
+	def help *args, **opts
+		@subs.help *args, **opts
+	end
+
+	def help_full *args, output: nil
+		output ||= STDOUT
+		x = @subs.goto *args
+		_help_full output, x
+	end
+
+	def _help_full output, subs
+		Sub._help_commands output, subs.to_enum( :commands)
 	end
 
 	def [] k

metadata

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