dencli 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b139df1946e2bbf2534d8bcd9a5d22927d8b18f2353f12687789405c783077cf
-  data.tar.gz: 7cd494d8569c7fe6c56364d25f8b79da3d21511160cb308854096dc4f157e5da
+  metadata.gz: b59309b03abb2d1a44eda112c289335eed1a252bccd89404a4e5017ff876657f
+  data.tar.gz: 0ecfaff2dd2928bfdc134ee3dc92737ae2776737e6ada66fd1432de5b470ab76
 SHA512:
-  metadata.gz: ecbab8d3d760c9c88a023b0bb13e6ca185e7b91b4c2519452db7bae7e3254b625fde572325423cc5476866978dd92c0d2e931819308e34b35ff50ce474578915
-  data.tar.gz: d7f8d1dc2bba5c493864091c3b15c577892465a305a4fd826ecb6013c51e729f0245d1a1ad0ada935dd8f7a1928aac85f23d014a52a0ba468fd9c945b34cdc95
+  metadata.gz: d27d7f9d307e1e86684ebb7e771ff865d0d10e4cde501951947997e98d25aafff123826c1973e7615ab45edd7c2bd3d60eacefa56835eacd976a4e9a9f4ed2d8
+  data.tar.gz: 70f63e628dcd9b7c2cc8da2302ef0dc33a170efc6281173c05f31b09657c0f4b616cd71faaa3ea09738e629b021e51e6018fda33535d2d34d8570caa0db32acc

data/bin/example.rb

@@ -1,25 +1,55 @@
 #!/usr/bin/env ruby
 
+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( :args, "Expects and prints given arguments", &lambda {|a, b, c:, d:, e:|
+		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( :f, '--[no-]f', "Toggle f", default: false)
+
 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( :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) }
 	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( :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
+		}).
+		opt( :c, '-c=ForC', "Option c").
+		opt( :d, '-d=ForD', "Option d (implicit default)").
+		opt( :e, '-e', "Toggle e")
+
 	sub.sub( :deeper, "You want to have Sub-Sub-Commands?") do |sub2|
-		sub2.cmd( :help, "") {|*args| STDERR.puts cli.help( 'more', 'deeper', *args) }
-		sub2.cmd( :last, "The last example") { STDERR.puts "The last example" }
+		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|
-			sub2.cmd( :help, "") {|*args| STDERR.puts cli.help( 'more', 'deeper', 'sub-commands', *args) }
+			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
 
-cli.call *ARGV
+begin
+	cli.call *ARGV
+rescue DenCli::UsageError
+	STDERR.puts $!
+	exit 1
+end

data/lib/dencli/cmd.rb

@@ -1,30 +1,214 @@
 require_relative '../dencli'
 
+
 class DenCli::CMD
-	attr_reader :parent, :name, :desc, :exe, :completion
+	attr_reader :parent, :name, :description, :exe, :completion, :options
 
-	def initialize parent, name, desc, exe
+	def initialize parent, name, description, exe
 		raise "Proc expected, instead of: #{exe.inspect}"  unless Proc === exe
-		@parent, @name, @desc, @exe = parent, name, desc, exe
+		@parent, @name, @description, @exe = parent, name, description, lambda( &exe)
+		@options = {}
 		completion {|*a| [] }
 	end
 
 	def _full_cmd( post) parent._full_cmd [@name]+post end
 	def full_cmd() _full_cmd [] end
-	def call( *a) @exe.call *a end
-	def help() "#{parent.full_cmd.join ' '} #{name}\n#{    desc}" end
 
-	def complete( *pre, str) @completion.call *pre, str end
+	def parameters() @exe.parameters end
+	def arguments_required() @exe.parameters.select {|e| :req == e[0] }.map {|e| e[1] } end
+	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 complete *pre, str
+		@completion.call *pre, str
+	end
+
+	def call *as
+		os = {}
+		unless @options.empty?
+			# options like --abc | -x will be provided in os
+			options = OptionParser.new
+			options.banner = "#{full_cmd.join ' '}"
+			# see also @options-array
+			@options.each {|_, opt| opt.on options, os }
+			as = options.parse! as
+		end
+		if @exe.lambda?
+			# The difference between a lambda and a Proc is, that Proc has anytime arity=-1.
+			# There will be no check if all arguments are given or some were missing or more than expected.
+			# lambda checks these arguments and has a arity.
+			# We will check it to provide useful errors.
+			pars = required
+			if as.length < pars.length
+				raise DenCli::UsageError, "Missing parameter(s): #{pars[as.length..-1].join " "}"
+			end
+			if parameters.select {|e| :rest == e[0] }.empty?
+				pars = pars + additional
+				if as.length > pars.length
+					raise DenCli::UsageError, "Unused parameter(s): #{as[-pars.length..-1].shelljoin}"
+				end
+			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.long || o.short }.join ', '}"
+			end
+		end
+		@exe.call *as, **os
+	end
+
+	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.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, &exe
+		yield self
+	end
+
+	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
+			l = o.long&.length || 0
+			v = o.val&.length || 0
+			d = o.desc&.to_s&.length || 0
+			d += 3 + o.default.to_s.length  if o.default?
+			if 0 == l
+				x = s + (0==v ? 0 : 1+v)
+				sc = x  if sc < x
+			else
+				sc = s  if sc < s
+				x = l + (0==v ? 0 : 1+v)
+				lc = x  if lc < x
+			end
+			dc = d  if dc < d
+		end
+		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
+				y = ' '
+			elsif s.nil?
+				l += "=#{v}"  if v
+				y = ' '
+			end
+			d = o.desc || ''
+			d += " (#{o.default})"  if o.default?
+			output << format % [ s, y, l, d ]
+		end
+	end
 
 	def completion &exe
 		@completion = exe
 		self
 	end
 
+	class Opt
+		attr_reader :name, :long, :short, :val, :desc, :os, :conv, :req
+		def required?() @req end
+		def default?() NilClass != @default end
+		def default() NilClass == @default ? nil : @default end
+
+		def parse_opt_string opt
+			case opt
+			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
+		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
+				elsif cmd.exe.lambda?
+					! cmd.exe.parameters.select {|e| [:keyreq, @name] == e[0..1] }.empty?
+				else
+					nil
+				end
+		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
+		end
+
+		def inspect
+			"#<%s:0x%016x %s %s %s %s (%p) %p os=%p conv=%s>" % [
+				self.class.name, object_id, @req ? "<#{@name}>" : "[#{@name}]",
+				@short, @long, @val, @default, @desc, @os,
+				@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)
+		@options[r.name] = r
+		self
+	end
+
 	def inspect
-		"#<%s:0x%x %s @name=%p @desc=%p @parent=<%s:0x%x %s> @exe=<arity=%d>>" % [
+		"#<%s:0x%x %s @name=%p @description=%p @parent=<%s:0x%x %s> @exe=<arity=%d>>" % [
 			self.class.name, self.object_id, self.full_cmd,
-			@name, @desc, @parent.class.name, @parent.class.object_id, @parent.full_cmd,
+			@name, @description, @parent.class.name, @parent.class.object_id, @parent.full_cmd,
 			@exe.arity
 		]
 	end

data/lib/dencli/interactive.rb

@@ -90,7 +90,7 @@ class DenCli::Interactive
 		c.subs.values.each do |n|
 			case n
 			when DenCli::Sub
-				n.cmd :exit, "<- #{n.parent.full_cmd.join ' '} - #{n.parent.desc[3..-1]}", min: 2 do
+				n.cmd :exit, "<- #{n.parent.full_cmd.join ' '} - #{n.parent.description[3..-1]}", min: 2 do
 					@cur = n.parent
 				end
 				n.cmd '', "", min: 2, aliases: [nil] do

data/lib/dencli/sub.rb

@@ -1,26 +1,86 @@
 require_relative '../dencli'
 
 class DenCli::Sub
-	attr_reader :parent, :name, :desc, :subs, :aliases
+	attr_reader :parent, :name, :description, :subs, :aliases
 
-	def initialize parent, name, desc
-		@parent, @name, @desc, @subs, @aliases = parent, name, "-> #{desc}", {}, {}
+	def initialize parent, name, description
+		@parent, @name, @description, @subs, @aliases = parent, name, "-> #{description}", {}, {}
 	end
 
 	def _full_cmd( post) parent._full_cmd [@name]+post end
 	def full_cmd() _full_cmd [] end
 	def []( k) @aliases[k] end
 
-	def help n = nil, *a
+	def usage
+		"#{full_cmd.join ' '} ..."
+	end
+
+	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 ' '}: #{desc}\n\n"
-			m = @subs.map {|k,_| k.length }.max
-			@subs.each do |k, c|
-				r += "  % -#{m}s  %s\n" % [k, c.desc]  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 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 {|c| x = c.usage.length; 25 < x ? 0 : x }.max
+		subs.each do |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
@@ -46,13 +106,13 @@ class DenCli::Sub
 	end
 	private :_add
 
-	def sub name, desc, min: nil, aliases: nil, &exe
-		r = _add name, min, DenCli::Sub.new( self, name, desc), aliases
+	def sub name, description, min: nil, aliases: nil, &exe
+		r = _add name, min, DenCli::Sub.new( self, name, description), aliases
 		block_given? ? yield( r) : r
 	end
 
-	def cmd name, desc, min: nil, aliases: nil, &exe
-		_add name, min, DenCli::CMD.new( self, name, desc, exe), aliases
+	def cmd name, description, min: nil, aliases: nil, &exe
+		_add name, min, DenCli::CMD.new( self, name, description, exe), aliases
 	end
 
 	def complete *pre, str
@@ -66,9 +126,9 @@ class DenCli::Sub
 	end
 
 	def inspect
-		"#<%s:0x%x %s @name=%p @desc=%p @subs={%s} @aliases={%s} @parent=<%s:0x%x %s>>" % [
+		"#<%s:0x%x %s @name=%p @description=%p @subs={%s} @aliases={%s} @parent=<%s:0x%x %s>>" % [
 			self.class.name, self.object_id, self.full_cmd,
-			@name, @desc, @subs.keys.join(', '), @aliases.keys.join(', '), @parent.class.name, @parent.class.object_id, @parent.full_cmd
+			@name, @description, @subs.keys.join(', '), @aliases.keys.join(', '), @parent.class.name, @parent.class.object_id, @parent.full_cmd
 		]
 	end
 end

data/lib/dencli/version.rb

@@ -1,3 +1,3 @@
 class DenCli
-	VERSION = '0.2.1'
+	VERSION = '0.5.0'
 end

data/lib/dencli.rb

@@ -1,3 +1,5 @@
+require 'optparse'
+
 class DenCli
 	class UsageError < ::RuntimeError
 	end
@@ -54,8 +56,8 @@ class DenCli
 
 	attr_reader :subs
 
-	def initialize progname, desc
-		@subs = Sub.new self, progname, desc
+	def initialize progname, description
+		@subs = Sub.new self, progname, description
 	end
 
 	def full_cmd
@@ -66,20 +68,34 @@ class DenCli
 		post
 	end
 
-	def sub *a, &exe
-		@subs.sub *a, &exe
+	def sub *a, **o, &exe
+		@subs.sub *a, **o, &exe
 	end
 
-	def cmd *a, &exe
-		@subs.cmd *a, &exe
+	def cmd *a, **o, &exe
+		@subs.cmd *a, **o, &exe
 	end
 
 	def call *a
 		@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.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Denis Knauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-27 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec