dencli 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4f8e9d3af41176bba078797a33ed1116dee0d1bbdfdce64b4662ba084c0630e
-  data.tar.gz: 38c29fe476f8c31af57706a915fb5503a9f0ef3f81aab74675206980013bbd6a
+  metadata.gz: 567eaa6ae13836be53cfc492496ae089be944c0a352f55023ac413e4f051c8d4
+  data.tar.gz: 7c3cb0ff03f0a738b56e785e8d2f9da76db16d0afab5c29fd5a53881476968cd
 SHA512:
-  metadata.gz: a028b051a9ae055280811ba2dbe61f7e4c1ed9452cc015c4dea75f429ffa4ff768baaf0373aee46fa316563840fbd2abe450a7437647555dc117e2beabcd740b
-  data.tar.gz: 2dee7a4e46e861dec67df330db80789ba9dcb2ea05f7274853e8963235ee52a3e04572be72c2ed1c33351e9cae6a87ad809cfd32bd48fd6ec393b99a5e0ba7b5
+  metadata.gz: d2bc0b876cc7eb05a8a778264c76c2721bc8328199042ae551793c4f744b4248845f2390558718cae07dd4da215b5d166caa391c0c503c7a65550549fe3e78a1
+  data.tar.gz: 634d5a0a2d0037b2c81e4b1d7b922413beb760b016b961560bd1bc8bfb85e5d34ed08e5947e38068ae6074f3f79f96cc5ab298d8c53b384d7a9adf6e809bb714

data/bin/example.rb

@@ -95,7 +95,62 @@ class Capture
 	end
 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
+	}).
+	opt( :c, '-c=ForC', "Option c").
+	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, "An example for help", aliases: [nil, '-h', '--help'], &lambda {|*commands, full:|
+	if full
+		cli.help_full *commands, output: $stderr
+	else
+		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( :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, "", 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- ... with a special alias") do |sub3|
+			# h    -> help
+			# he   -> hehe
+			# hel  -> help
+			# help -> help
+			# heh  -> hehe
+			# hehe -> hehe
+			sub3.cmd( :help, "", min: 3, aliases: [nil, :h]) {|*args| $stderr.puts sub3.help( *args) }
+			sub3.cmd( :hehe, "The real last example", min: 2) { $stderr.puts "Trust me!" }
+		end
+	end
+end
+
+cli.cmd( :cli, "Interactive shell", min: 3, &lambda {||
+	cli.interactive( File.basename($0, '.rb')).run
+})
+
 cli.sub :tests, "Some tests", noshortaliases: true do |tcli|
+	tcli.cmd( :help, "", min: 4) {|*args| $stderr.puts tcli.help( *args) }
 	OptionParser.accept IPAddr do |arg|
 		begin
 			IPAddr.new arg
@@ -202,50 +257,6 @@ cli.sub :tests, "Some tests", noshortaliases: true do |tcli|
 	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
-	}).
-	opt( :c, '-c=ForC', "Option c").
-	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, "An example for help", aliases: [nil, '-h', '--help'], &lambda {|*commands, full:|
-	if full
-		cli.help_full *commands, output: $stderr
-	else
-		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( :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, "", 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!" }
-		end
-	end
-end
-
 begin
 	cli.call *ARGV
 rescue DenCli::UsageError

data/lib/dencli/cmd.rb

@@ -2,11 +2,11 @@ require_relative '../dencli'
 
 
 class DenCli::CMD
-	attr_reader :parent, :name, :description, :exe, :completion, :options
+	attr_reader :parent, :name, :description, :exe, :completion, :options, :defined_in
 
-	def initialize parent, name, description, exe
+	def initialize parent, name, description, exe, defined_in
 		raise "Proc expected, instead of: #{exe.inspect}"  unless Proc === exe
-		@parent, @name, @description, @exe = parent, name, description, lambda( &exe)
+		@parent, @name, @description, @exe, @defined_in = parent, name, description, lambda( &exe), defined_in
 		@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] }
@@ -167,15 +167,15 @@ class DenCli::CMD
 
 		def parse_opt_string opt
 			case opt
-			when /\A(--\[no-\][^=]+)\z/
+			when /\A(--\[no-\][^= ]+)\z/
 				@long, @val = $1, nil
-			when /\A(--[^=]+)=(.+)\z/
+			when /\A(--[^= ]+)[= ](.+)\z/
 				@long, @val = $1, $2 || @val
-			when /\A(--[^=]+)\z/
+			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/interactive.rb

@@ -17,12 +17,15 @@ class DenCli::Interactive
 			end
 		read_history  if @histfile
 
-		Readline.vi_editing_mode  rescue NotImplementedError
+		begin
+			Readline.vi_editing_mode
+		rescue NotImplementedError
+		end
 		Readline.completion_append_character = " "
 		Readline.completion_proc = method :complete
 
 		prepare_sub cl.subs
-		cl.cmd :exit, "exit", min: 2 do
+		cl.cmd :exit, "exit", min: cl.has?(:ex) ? cl.has?(:exi) ? 4 : 3 : 2 do
 			exit 0
 		end
 		cl.subs.aliases['?'] = cl.subs.subs['help']
@@ -90,14 +93,16 @@ class DenCli::Interactive
 		c.subs.values.each do |n|
 			case n
 			when DenCli::Sub
-				n.cmd :exit, "<- #{n.parent.full_cmd.join ' '} - #{n.parent.description[3..-1]}", min: 2 do
-					@cur = n.parent
-				end
+				n.cmd :exit,
+						"<- #{n.parent.full_cmd.join ' '} - #{n.parent.description[3..-1]}",
+						min: n.has?(:ex) ? n.has?( :exi) ? 4 : 3 : 2,
+						&lambda {|| @cur = n.parent }
+				n.aliases.delete nil
+				n.subs.delete nil
 				n.cmd '', "", min: 2, aliases: [nil] do
 					@cur = n
 				end
-				n.subs.delete ''
-				n.aliases['?'] = n.subs['help']
+				n.aliases['?'] = n[:help]  if n.has? :help and not n.has? '?'
 				prepare_sub n
 			when DenCli::CMD
 			else raise "Unsupported sub-type: #{x}"

data/lib/dencli/sub.rb

@@ -1,19 +1,21 @@
 require_relative '../dencli'
 
 class DenCli::Sub
-	attr_reader :parent, :name, :description, :subs, :aliases
+	attr_reader :parent, :name, :description, :subs, :aliases, :defined_in
 
-	def initialize parent, name, description, noshortaliases: nil
+	def initialize parent, name, description, noshortaliases: nil, defined_in: 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
+		@noshortaliases, @defined_in = ! ! noshortaliases, defined_in || Kernel.caller
 	end
 
 	def _full_cmd( post) parent._full_cmd [@name]+post end
 	def full_cmd() _full_cmd [] end
-	def []( k) @aliases[k] end
+	def []( name) @aliases[name&.to_s] end
+	def has?( name) @aliases.has_key? name&.to_s end
+
 
 	def usage output: nil
 		output ||= ''
@@ -40,8 +42,8 @@ class DenCli::Sub
 		if n.nil?
 			output << "#{full_cmd.join ' '}: #{description}\n\n"
 			self.class._help_commands output, @subs
-		elsif @aliases.has_key? n
-			@aliases[n]._help output, *a
+		elsif has? n
+			self[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
@@ -96,8 +98,8 @@ class DenCli::Sub
 	def goto *a
 		return self  if a.empty?
 		n, *a = *a
-		if @aliases.has_key? n
-			@aliases[n].goto *a
+		if has? n
+			self[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
@@ -105,32 +107,33 @@ class DenCli::Sub
 
 	def call *a
 		n, *a = *a
-		if @aliases.has_key? n
-			@aliases[n].call *a
+		if has? n
+			self[n].call *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 _add name, min, obj, aliases
-		#DenCli::assert_type self, __method__, :name, name, Symbol, NilClass
+		#DenCli::assert_type self, __method__, :name, name, Symbol, String
 		#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?
+		name = name.to_s
 		@subs[name] = obj
 		if @noshortaliases
-			warn "Command/Alias already exists: #{full_cmd.join ' '} #{name}"  if @aliases.has_key? name
+			warn "Command/Alias for #{obj.full_cmd} defined in #{obj.defined_in} already exists: #{full_cmd.join ' '} #{name}.  Used by #{@aliases[name].full_cmd} defined in #{@aliases[name].defined_in}"  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
+				warn "Command/Alias for #{obj.full_cmd} defined in #{obj.defined_in} already exists: #{full_cmd.join ' '} #{a}.  Used by #{@aliases[a].full_cmd} defined in #{@aliases[a].defined_in}" if @aliases.has_key? a
 				@aliases[a] ||= obj
 			end
 		end
 		if aliases
 			[*aliases].each do |a|
-				raise ArgumentError, "Alias already exists: #{full_cmd.join ' '} #{a}"  if @aliases.has_key? a
+				a = a&.to_s
+				raise ArgumentError, "Alias for #{obj.full_cmd} defined in #{obj.defined_in} already exists: #{full_cmd.join ' '} #{a}.  Used by #{@aliases[a].full_cmd} defined in #{@aliases[a].defined_in}"  if @aliases.has_key? a
 				@aliases[a] = obj
 			end
 		end
@@ -138,13 +141,51 @@ class DenCli::Sub
 	end
 	private :_add
 
-	def sub name, description, min: nil, aliases: nil, noshortaliases: nil, &exe
-		r = _add name, min, DenCli::Sub.new( self, name, description, noshortaliases: noshortaliases), aliases
+	# Define a new sub-menu:
+	#
+	#   DenCli.new {|c|
+	#     c.sub( 'sub-command') {|s|
+	#       s.cmd( :hello, 'Greetings', &lambda {|| puts 'hello world' })
+	#     }
+	#   }
+	#
+	#   # ./prog sub-command hello
+	#
+	# name should be a string/symbol.  It will be converted to string.
+	# If provided, aliases must be a list of different aliases.  It will be converted to string.
+	def sub name, description, min: nil, aliases: nil, noshortaliases: nil, defined_in: nil, &exe
+		r = _add name.to_s, min, DenCli::Sub.new( self, name, description, noshortaliases: noshortaliases, defined_in: defined_in || Kernel.caller.first), aliases
 		block_given? ? yield( r) : r
 	end
 
-	def cmd name, description, min: nil, aliases: nil, &exe
-		_add name, min, DenCli::CMD.new( self, name, description, exe), aliases
+	# Define a new command:
+	#
+	#   DenCli.new {|c|
+	#     c.cmd( :hello, 'Greetings', &lambda {|| puts 'hello world' })
+	#   }
+	#
+	#   # ./prog hello
+	#   hello world
+	#
+	# name should be a string/symbol.  It will be converted to string.
+	# If provided, aliases must be a list of different aliases.  Except of nil, any alias will be converted to string.
+	# nil is an alias for a default command for sub-commands, but interactive shells.
+	#
+	#   DenCli.new {|c|
+	#     c.sub( :greetings, 'Hello, Welcome, ...') do |s|
+	#       s.cmd( :hello, 'A simple Hello', aliases: %w[hello-world hello_world], &lambda {|| puts 'Hello World' })
+	#       s.cmd( :welcome, 'More gracefull', aliases: [nil, 'welcome-world', :hello_world], &lambda {|| puts 'Welcome World' })
+	#     }
+	#   }
+	#
+	#   # ./prog greetings
+	#   Welcome World
+	#   # ./prog greetings welcome
+	#   Welcome World
+	#   # ./prog greetings hello
+	#   Hello World
+	def cmd name, description, min: nil, aliases: nil, defined_in: nil, &exe
+		_add name, min, DenCli::CMD.new( self, name, description, exe, defined_in || Kernel.caller.first), aliases
 	end
 
 	def complete *pre, str

data/lib/dencli/version.rb

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

data/lib/dencli.rb

@@ -80,6 +80,9 @@ class DenCli
 		post
 	end
 
+	def []( k) @subs[k] end
+	def has?( k) @subs.has? k end
+
 	def sub *a, **o, &exe
 		@subs.sub *a, **o, &exe
 	end
@@ -110,10 +113,6 @@ class DenCli
 		Sub._help_commands output, subs.to_enum( :commands)
 	end
 
-	def [] k
-		@subs[k]
-	end
-
 	def interactive *args, **opts
 		Interactive.new self, *args, **opts
 	end

metadata

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