dencli 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81af9b5ecb0bfa6a5c5d0546bef0424ab3301e5306222a9a0db5050039f20049
-  data.tar.gz: cdb5ce86ac9ba4e8c574c5c3b688b3e82874c35a9b6873cf9f294800925c9d31
+  metadata.gz: 127668bd8bd4de7dc572ce5c72be6403ca49e9da7690ceb7746c913a497495c3
+  data.tar.gz: b28f1e67d5c029df9917f6f9609a8d0c718c8a6cda35a0cf1a283cf37a925adb
 SHA512:
-  metadata.gz: b82a4b1d8f179b3b12d481f6bd63b891d70f695987d9b0efc81eb0c40f34d984b14b8714c25b0a1b6ef090b6be97055040e5cc0d967624e1c821112a1e0b8bd5
-  data.tar.gz: 64eb45044b043717ad869b3cab606e5b2283c2666fa82df2ffc3b5f13e30de3d3b9672ab72ab64424688fda8c5535542217511b72d13da509cc88dd91f546869
+  metadata.gz: e5fce26cb4eae5698536a1c1ffbae0571783432acef83451477daf259ee6aed1699542f4a93909c1bc3ac25095b3153a1381f32efa827f489cb3885cba557e7d
+  data.tar.gz: 8b22f6c8dfdd91fef4ce45819377ac5773e82a01ca168624dbff789d942cb32dec2677de396574198f7643f20f4401a32955239e67b621ecdebf5eb8847f854f

data/bin/example.rb

@@ -1,25 +1,47 @@
 #!/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( :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:|
+		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)
+
 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| STDERR.puts sub2.help(*args) })
+		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,184 @@
 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 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 help() "Usage: #{usage}\n#{description}\n#{options_help}" 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.as.first }.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 " "}]")
+			) : '...')
+	end
+
+	def options_help
+		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"
+		@options.map {|_, 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?
+			format % [ s, y, l, d ]
+		}.join "\n"
+	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 initialize cmd, name, opt, *alts, desc, default: NilClass, **os, &conv
+			long = short = val = nil
+			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
+			end
+			@name, @short, @long, @val, @desc, @default, @os, @conv =
+				name.to_s.to_sym, short, long, val, desc, default, os, conv || lambda{|v|v}
+			@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
+			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
@@ -120,7 +120,7 @@ class DenCli::Interactive
 		return nil  if line.nil?
 		begin
 			cur.call *line
-		rescue ::UsageError
+		rescue ::DenCli::UsageError
 			STDERR.puts "! #$!"
 		end
 		true

data/lib/dencli/sub.rb

@@ -1,28 +1,32 @@
 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 usage
+		"#{full_cmd.join ' '} ..."
+	end
+
 	def help n = nil, *a
 		if n.nil?
-			r = "#{full_cmd.join ' '}: #{desc}\n\n"
-			m = @subs.map {|k,_| k.length }.max
+			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" % [k, c.desc]  unless k.nil?
+				r += "  % -#{m}s  %s\n" % [c.usage, c.description]  unless k.nil?
 			end
 			r
 		elsif @aliases.has_key? n
 			@aliases[n].help *a
 		else
-			raise UnknownCommand, "unknown command: #{_full_cmd( [n])[1..-1].join ' '}, available for #{full_cmd[1..-1].join' '}: #{@subs.keys.join ' '}"
+			raise DenCli::UnknownCommand, "unknown command: #{_full_cmd( [n])[1..-1].join ' '}, available for #{full_cmd[1..-1].join' '}: #{@subs.keys.join ' '}"
 		end
 	end
 
@@ -31,7 +35,7 @@ class DenCli::Sub
 		if @aliases.has_key? n
 			@aliases[n].call *a
 		else
-			raise UnknownCommand, "unknown command: #{_full_cmd( [n])[1..-1].join ' '}, available for #{full_cmd[1..-1].join' '}: #{@subs.keys.join ' '}"
+			raise DenCli::UnknownCommand, "unknown command: #{_full_cmd( [n])[1..-1].join ' '}, available for #{full_cmd[1..-1].join' '}: #{@subs.keys.join ' '}"
 		end
 	end
 
@@ -46,13 +50,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 +70,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.0'
+	VERSION = '0.4.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,12 +68,12 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dencli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.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