dencli 0.5.0 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b59309b03abb2d1a44eda112c289335eed1a252bccd89404a4e5017ff876657f
-  data.tar.gz: 0ecfaff2dd2928bfdc134ee3dc92737ae2776737e6ada66fd1432de5b470ab76
+  metadata.gz: 71cb3a66fe8101078796ec7dfb0c793d315416020c76e11f2b312c32f6d3c1b2
+  data.tar.gz: 1675ca2b4f22fc083948bec274aa75c067e41622dc3d65059a9b200a86d21e0e
 SHA512:
-  metadata.gz: d27d7f9d307e1e86684ebb7e771ff865d0d10e4cde501951947997e98d25aafff123826c1973e7615ab45edd7c2bd3d60eacefa56835eacd976a4e9a9f4ed2d8
-  data.tar.gz: 70f63e628dcd9b7c2cc8da2302ef0dc33a170efc6281173c05f31b09657c0f4b616cd71faaa3ea09738e629b021e51e6018fda33535d2d34d8570caa0db32acc
+  metadata.gz: 938480ac26fa9cbac07118edfa407b1a59d2e9534b43fdd308bf4e81a96e78a20fc2b3d3143029d6a8b1f516ebbd14af7507ae703e395d46ad4abfdbd3b42844
+  data.tar.gz: af52e24ace634da494e17b5efa06bdc475fa64d9250218d38b1c60ee7d4b9897cfdce6cf6cf54f141acca8ec836140a2ad368ac27ceb0bbd2b1cdf1c3b43598a

data/bin/example.rb

@@ -4,21 +4,24 @@ 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:|
+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( :d, '-dForD', "Option d", default: "something").
 	opt( :e, '-e', "Toggle e", default: false).
-	opt( :f, '--[no-]f', "Toggle f", 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:|
+cli.cmd( :help, "An example for help", aliases: [nil, '-h', '--help'], &lambda {|*commands, full:|
 	if full
-		cli.help_full *args, output: STDERR
+		cli.help_full *commands, output: STDERR
 	else
-		cli.help *args, output: STDERR
+		cli.help *commands, output: STDERR
 	end
 }).
 	opt( :full, '-f', '--[no-]full', "Print all commands and sub-commands.", default: false)
@@ -37,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| sub2.help( *args, output: STDERR) })
+		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|

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,14 +20,11 @@ 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 complete *pre, str
 		@completion.call *pre, str
@@ -54,7 +57,7 @@ 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.long || o.short }.join ', '}"
+				raise DenCli::UsageError, "Missing argument(s): #{kr.map {|_, o| o.long || o.short }.join ', '}"
 			end
 		end
 		@exe.call *as, **os
@@ -69,19 +72,27 @@ class DenCli::CMD
 	def _usage output
 		output << full_cmd.join( ' ')
 		@options.each do |_, o|
-			s = "#{o.short||o.long}#{o.val ? ?= : ''}#{o.val}"
+			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?
+			parameters.each do |(type, name)|
+				case type
+				when :req
+					output << " <#{name}>"
+				when :opt
+					output << " [<#{name}>]"
+				when :rest
+					output << " [<#{name}> ...]"
+				end
+			end
 		else
 			output << ' ...'
 		end
 	end
 
-	def commands *args, &exe
-		yield self
+	def commands *args
+		yield name, self
 	end
 
 	def goto *args
@@ -127,7 +138,7 @@ class DenCli::CMD
 		@options.map do |_, o|
 			s, l, v, y = o.short, o.long, o.val, ','
 			if l.nil?
-				s += "=#{v}"  if v
+				s += "#{v}"  if v
 				y = ' '
 			elsif s.nil?
 				l += "=#{v}"  if v
@@ -158,9 +169,9 @@ class DenCli::CMD
 				@long, @val = $1, $2 || @val
 			when /\A(--[^=]+)\z/
 				@long, @val = $1, nil
-			when /\A(-[^=-]+)=(.+)\z/
+			when /\A(-[^=-])=?(.+)\z/
 				@short, @val = $1, $2 || @val
-			when /\A(-[^=-]+)\z/
+			when /\A(-[^=-])\z/
 				@short, @val = $1, nil
 			else
 				raise ArgumentError, "Unexpected format for option: #{opt.inspect}"

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
 
@@ -11,8 +14,19 @@ class DenCli::Sub
 	def full_cmd() _full_cmd [] end
 	def []( k) @aliases[k] end
 
-	def usage
-		"#{full_cmd.join ' '} ..."
+	def usage output: nil
+		output ||= ''
+		_usage output
+		output
+	end
+
+	def _usage output
+		output << full_cmd.join( ' ')
+		if @aliases.has_key? nil
+			output << " [<command> ...]"
+		else
+			output << " <command> [...]"
+		end
 	end
 
 	def help n = nil, *a, output: nil
@@ -33,7 +47,7 @@ class DenCli::Sub
 	end
 
 	def commands &exe
-		yield self
+		yield name, self
 		@subs.each {|k, c| c.commands &exe }
 	end
 
@@ -43,37 +57,39 @@ class DenCli::Sub
 		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
+	class <<self
+		def _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/).each do |l|
+					c = 0
+					l.split( %r< >).each 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
-				prefix = "\n#{' ' * n}"
+				output << "\n"
 			end
-			output << "\n"
+			output
 		end
-		output
 	end
 
 	def goto *a
@@ -96,6 +112,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.5.0'
+	VERSION = '0.5.4'
 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

metadata

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