kxi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a376bd573bfb44dbeae16f773f883a1f55daedd7
+  data.tar.gz: 4cbb2897d3c73fe15b882a26d79f8d3bdc387244
+SHA512:
+  metadata.gz: 7d040d8a1a051f68268ba981ea84e69fcf5bd547f801c3411511bcb3b3edd2da4e23befcb9171fe6b43655bdd2adca2ef6b8de387fa5874f8d8b76b79cbabac7
+  data.tar.gz: c35695494016d0625076379ffcc9370e5c4299cc47cc19f4979d10ee0cd4f9ac01c3d4f3e27051f1c2859c18a4099aa830324545fb1ef0d0ab45ec671c405ed8

data/lib/kxi/cli/anonymous_argument.rb

@@ -0,0 +1,51 @@
+# Created by Matyáš Pokorný on 2018-01-20.
+
+module KXI
+	module CLI
+		# Represents anonymous argument (eg.: verb VALUE)
+		class AnonymousArgument < KXI::CLI::Argument
+			# Gets default value of argument
+			# @return [Object] Default value of argument
+			def default
+				@def
+			end
+			
+			# Gets whether argument is variadic
+			# @return [Bool] True if argument is variadic; false otherwise
+			def variadic?
+				@var
+			end
+			
+			# Gets syntax of argument
+			# @return [String] Syntax of argument
+			def syntax
+				"#{required? ? '<' : '['}#{name}#{required? ? '>' : ']'}"
+			end
+			
+			# Gets full descriptive name of argument
+			# @return [String] Full name of argument
+			def headline
+				super.upcase
+			end
+			
+			# Instantiates the {KXI::CLI::AnonymousArgument} class
+			# @param nm [String] Name of argument
+			# @param desc [String] Description of argument
+			# @param rq [Bool] Indicates whether argument is required
+			# @param df Default value of argument
+			# @param var [Bool] Indicates whether argument is variadic
+			def initialize(nm, desc, rq = true, df = nil, var = false, &validator)
+				super(nm, desc, rq, 5 - (var ? 1 : 0) - (rq ? 0 : 1))
+				@def = df
+				@var = var
+				@val = validator
+			end
+			
+			# Validates value of argument
+			# @param val [String, Array<String>] Value of argument
+			def validate(val)
+				@val.call(val) if @val != nil
+			end
+		end
+	end
+end

data/lib/kxi/cli/argument.rb

@@ -0,0 +1,57 @@
+# Created by Matyáš Pokorný on 2018-01-20.
+
+module KXI
+	module CLI
+		# Represents argument of command-line interface
+		class Argument
+			# Gets the name of argument
+			# @return [String] Name of argument
+			def name
+				@name
+			end
+			
+			# Gets syntax of argument
+			# @return [String] Syntax of argument
+			def syntax
+				name
+			end
+			
+			# Gets full descriptive name of argument
+			# @return [String] Full name of argument
+			def headline
+				name
+			end
+			
+			# Gets the description of argument
+			# @return [String] Description of argument
+			def description
+				@desc
+			end
+			
+			# Indicates whether argument is mandatory
+			# @return [Bool] True if argument is mandatory; otherwise false
+			def required?
+				@req
+			end
+			
+			# Gets the order of argument (in descending order)
+			# @return [Number] Order of argument
+			def order
+				@order
+			end
+			
+			# Instantiates the {KXI::CLI::Argument} class
+			# @param nm [String] Name of argument
+			# @param desc [String] Description of argument
+			# @param req [Bool] Determines whether argument is mandatory
+			# @param order [Number] Order of argument
+			def initialize(nm, desc, req, order)
+				raise(Exception.new('Invalid argument name!')) unless /^[A-Za-z0-9\-]+$/m =~ nm
+				@name  = nm.downcase
+				@desc  = desc
+				@req   = req
+				@order = order
+			end
+		end
+	end
+end

data/lib/kxi/cli/argument_values.rb

@@ -0,0 +1,84 @@
+# Created by Matyáš Pokorný on 2018-01-21.
+
+module KXI
+	module CLI
+		# Manages values of arguments
+		class ArgumentValues
+			# Instantiates the {KXI::CLI::ArgumentValues} class
+			# @param args [Array<KXI::CLI::Argument>] Expected arguments
+			def initialize(args)
+				@args = args
+				@vals = {}
+				args.each do |a|
+					if a.is_a?(KXI::CLI::FlagArgument)
+						@vals[a.name] = { :argument => a, :value => false }
+					end
+				end
+			end
+			
+			# Assigns (or adds) a value to argument
+			# @param arg [KXI::CLI::Argument] Argument to set
+			# @param val [String] Value to assign
+			def set(arg, val)
+				if arg.is_a?(KXI::CLI::FlagArgument)
+					raise(KXI::Exceptions::ArgumentException.new(arg.name, 'Flag set multiple times!')) if @vals[arg.name][:value]
+					@vals[arg.name][:value] = val
+				else
+					if arg.variadic?
+						@vals[arg.name] = { :argument => arg, :value => [] } if @vals[arg.name] == nil
+						@vals[arg.name][:value].push(val)
+					else
+						raise(KXI::Exceptions::ArgumentException.new(arg.name, 'Argument set multiple times!')) if @vals[arg.name] != nil
+						begin
+							arg.validate(val)
+						rescue Exception => ex
+							raise(KXI::Exceptions::ArgumentException.new(arg.name, ex.message))
+						end
+						@vals[arg.name] = { :argument => arg, :value => val }
+					end
+				end
+			end
+			
+			# Gets value of argument
+			# @param index [String, Symbol, KXI::CLI::Argument] Name of argument
+			# @return [String] Value of argument
+			def []=(index)
+				if index.is_a?(Symbol)
+					index = index.to_s
+				elsif index.is_a?(KXI::CLI::Argument)
+					index = index.name
+				end
+				raise(Exception.new("Undefined argument #{index}!")) if @vals[index] == nil
+				return @vals[index][:value]
+			end
+			
+			# Converts class to {Hash}
+			# @return [Hash] Equivalent hash
+			def to_h
+				ret = {}
+				@vals.each_pair do |k, v|
+					ret[k] = v[:value]
+				end
+				return ret
+			end
+			
+			# Validates variadic arguments and checks for minimal argument requirements
+			def finish
+				@args.each do |arg|
+					if @vals[arg.name] != nil
+						unless arg.is_a?(KXI::CLI::FlagArgument)
+							begin
+								arg.validate(@vals[arg.name][:value])
+							rescue Exception => ex
+								raise(KXI::Exceptions::ArgumentException.new(arg.name, ex.message))
+							end
+						end
+					else
+						raise(KXI::Exceptions::ArgumentException.new(arg.name, 'Argument is mandatory!')) if arg.required?
+						@vals[arg.name] = arg.default
+					end
+				end
+			end
+		end
+	end
+end

data/lib/kxi/cli/explicit_argument.rb

@@ -0,0 +1,39 @@
+# Created by Matyáš Pokorný on 2018-01-20.
+
+module KXI
+	module CLI
+		# Represents argument specified explicitly with name
+		class ExplicitArgument < KXI::CLI::Argument
+			# Gets full descriptive name of argument
+			# @return [String] Full name of argument
+			def headline
+				ret = ''
+				ret = "-#{@sh}, " if @sh != nil
+				ret += "--#{name}"
+				return ret
+			end
+			
+			# Gets syntax of argument
+			# @return [String] Syntax of argument
+			def syntax
+				headline
+			end
+			
+			# Gets the shortcut symbol of argument
+			# @return [String] Shortcut symbol of argument
+			def shortcut
+				@sh
+			end
+			
+			# Instantiates the {KXI::CLI::ExplicitArgument} class
+			# @param nm [String] Name of argument
+			# @param desc [String] Description of argument
+			# @param sh [String, nil] Shortcut of argument
+			# @param req [Bool] Specifies whether argument is mandatory
+			def initialize(nm, desc, sh = nil, req = false)
+				super(nm, desc, req, req ? 2 : 1)
+				@sh = sh
+			end
+		end
+	end
+end

data/lib/kxi/cli/flag_argument.rb

@@ -0,0 +1,16 @@
+# Created by Matyáš Pokorný on 2018-01-20.
+
+module KXI
+	module CLI
+		# Represents the flag argument (eg.: -f, --flag)
+		class FlagArgument < KXI::CLI::ExplicitArgument
+			# Instantiates the {KXI::CLI::FlagArgument} class
+			# @param nm [String] Name of argument
+			# @param desc [String] Description of argument
+			# @param sh [String] Shortcut of argument
+			def initialize(nm, desc, sh = nil)
+				super(nm, desc, sh)
+			end
+		end
+	end
+end

data/lib/kxi/cli/named_argument.rb

@@ -0,0 +1,60 @@
+# Created by Matyáš Pokorný on 2018-01-20.
+
+module KXI
+	module CLI
+		# Represents named argument (eg.: -a VALUE, --argument VALUE)
+		class NamedArgument < KXI::CLI::ExplicitArgument
+			# Gets default value of argument
+			# @return [Object] Default value of argument
+			def default
+				@def
+			end
+			
+			# Gets whether argument is variadic
+			# @return [Bool] True if argument is variadic; false otherwise
+			def variadic?
+				@var
+			end
+			
+			# Gets name of argument value
+			# @return [String] Name of argument value
+			def value_name
+				@vnm
+			end
+			
+			# Gets full descriptive name of argument
+			# @return [String] Full name of argument
+			def headline
+				"#{super} #{@var ? '...' : ''}#{@vnm.upcase}"
+			end
+			
+			# Gets syntax of argument
+			# @return [String] Syntax of argument
+			def syntax
+				"-#{(shortcut != nil ? shortcut : "-#{name}")} #{required? ? '<' : '['}#{@var ? '...' : ''}#{@vnm}#{required? ? '>' : ']'}"
+			end
+			
+			# Instantiates the {KXI::CLI::NamedArgument} class
+			# @param nm [String] Name of argument
+			# @param vn [String] Name of value
+			# @param desc [String] Description of argument
+			# @param sh [String] Shortcut of argument
+			# @param rq [Bool] Indicates whether argument is required
+			# @param df Default value of argument
+			# @param var [Bool] Indicates whether argument is variadic
+			def initialize(nm, vn, desc, sh = nil, rq = true, df = nil, var = false, &validator)
+				super(nm, desc, sh, rq)
+				@def = df
+				@vnm = vn
+				@var = var
+				@val = validator
+			end
+			
+			# Validates value of argument
+			# @param val [String, Array<String>] Value of argument
+			def validate(val)
+				@val.call(val) if @val != nil
+			end
+		end
+	end
+end

data/lib/kxi/cli/verb.rb

@@ -0,0 +1,281 @@
+# Created by Matyáš Pokorný on 2018-01-20.
+
+module KXI
+	module CLI
+		# Represents a verb of console interface
+		class Verb
+			# Gets the name of verb
+			# @return [String] Name of verb
+			def name
+				@name
+			end
+			
+			# Gets the description of verb
+			# @return [String] Description of verb
+			def description
+				@desc
+			end
+			
+			# Assigns action to this verb
+			# @yield [args] Action of verb
+			# @yieldparam args [KXI::CLI::ArgumentValues] Parsed values of arguments
+			def action(&block)
+				@action = block
+			end
+			
+			# Gets the arguments assigned to this verb
+			# @return [KXI::Collections::ProtectedCollection] Arguments of verb
+			def arguments
+				KXI::Collections::ProtectedCollection.new(@args)
+			end
+			
+			# Enables help for this verb and it's children
+			def enable_help
+				unless @help
+					@help = true
+					@verbs.foreach { |i| i.enable_help }
+				end
+			end
+			
+			# Instantiates the {KXI::CLI::Verb} class
+			# @param nm [String] Name of verb
+			# @param desc [String] Description of verb
+			# @param ctx [String] Context of verb
+			# @yield [verb] Initialization body of verb
+			# @yieldparam verb [KXI::CLI::Verb] Initialized verb
+			# @raise [Exception] When name of verb is invalid
+			def initialize(nm, desc, ctx = nil)
+				raise(Exception.new('Invalid name of verb!')) unless /^[A-Za-z0-9][A-Za-z0-9\-]*$/m =~ nm
+				@name   = nm.downcase
+				@desc   = desc
+				@verbs  = KXI::Collections::ArrayCollection.new
+				@args   = KXI::Collections::ArrayCollection.new
+				@action = nil
+				@ctx    = ctx
+				@help   = false
+				yield(self) if block_given?
+			end
+			
+			# Creates a new child verb
+			# @param name [String] Name of verb
+			# @param desc [String] Description of verb
+			# @return [KXI::CLI::Verb] Child verb
+			def verb(name, desc)
+				check_name(name)
+				add_verb(Verb.new(name, desc, @ctx == nil ? @name : "#{@ctx} #{@name}") { |v| yield(v) if block_given? })
+			end
+			
+			# Creates new optional anonymous argument
+			# @param name [String] Name of argument
+			# @param desc [String] Description of argument
+			# @param df [Object, nil] Default value of argument
+			# @param var [Bool] Determines whether argument is variadic
+			# @yield [val] Validator function for value of argument
+			# @yieldparam val [String, Array<String>] Value of argument
+			# @return [KXI::CLI::AnonymousArgument] Anonymous argument
+			def anonymous(name, desc, df = nil, var = false, &validator)
+				add_argument(KXI::CLI::AnonymousArgument.new(name, desc, false, df, var, &validator))
+			end
+			
+			
+			# Creates new mandatory anonymous argument
+			# @param name [String] Name of argument
+			# @param desc [String] Description of argument
+			# @param var [Bool] Determines whether argument is variadic
+			# @yield [val] Validator function for value of argument
+			# @yieldparam val [String, Array<String>] Value of argument
+			# @return [KXI::CLI::AnonymousArgument] Anonymous argument
+			def anonymous!(name, desc, var = false, &validator)
+				add_argument(KXI::CLI::AnonymousArgument.new(name, desc, true, nil, var, &validator))
+			end
+			
+			# Creates new optional named argument
+			# @param name [String] Name of argument
+			# @param val [String] Name of value
+			# @param desc [String] Description of argument
+			# @param sh [String, nil] Shortcut symbol
+			# @param df [Object, nil] Default value of argument
+			# @param var [Bool] Determines whether argument is variadic
+			# @yield [val] Validator function for value of argument
+			# @yieldparam val [String, Array<String>] Value of argument
+			# @return [KXI::CLI::NamedArgument] Named argument
+			def named(name, val, desc, sh = nil, df = nil, var = false, &validator)
+				add_argument(KXI::CLI::NamedArgument.new(name, val, desc, sh, false, df, var, &validator))
+			end
+			
+			
+			# Creates new mandatory named argument
+			# @param name [String] Name of argument
+			# @param val [String] Name of value
+			# @param desc [String] Description of argument
+			# @param sh [String, nil] Shortcut symbol
+			# @param var [Bool] Determines whether argument is variadic
+			# @yield [val] Validator function for value of argument
+			# @yieldparam val [String, Array<String>] Value of argument
+			# @return [KXI::CLI::NamedArgument] Named argument
+			def named!(name, val, desc, sh = nil, var = false, &validator)
+				add_argument(KXI::CLI::NamedArgument.new(name, val, desc, sh, true, nil, var, &validator))
+			end
+			
+			
+			# Creates new flag argument
+			# @param name [String] Name of flag
+			# @param desc [String] Description of flag
+			# @param sh [String, nil] Shortcut symbol
+			# @return [KXI::CLI::FlagArgument] Flag argument
+			def flag(name, desc, sh = nil)
+				add_argument(KXI::CLI::FlagArgument.new(name, desc, sh))
+			end
+			
+			# Parses and executes action of verb
+			# @param args [Array<String>] Given arguments
+			def act(*args)
+				args = ARGV if args.length == 0
+				hf = args.include?('-h') or args.include?('--help') or args.include?('-?')
+				if @verbs.count > 0
+					v = args.shift
+					if @help and (v == 'help' or hf)
+						if v == 'help' or v == nil
+							help
+						else
+							verb = @verbs.first { |i| i.name == v.downcase }
+							if verb == nil
+								help
+							else
+								verb.act(*args)
+							end
+						end
+					else
+						raise(KXI::Exceptions::VerbExpectedException.new(@verbs.select { |i| i.name }.to_array)) if v == nil
+						verb = @verbs.first { |i| i.name == v.downcase }
+						raise(KXI::Exceptions::VerbExpectedException.new(@verbs.select { |i| i.name }.to_array)) if verb == nil
+						verb.act(*args)
+					end
+				else
+					if @help and hf
+						help
+					else
+						vals = KXI::CLI::ArgumentValues.new(@args.to_array)
+						anon = @args.of_type(KXI::CLI::AnonymousArgument).order_by_descending { |a, b| a.order <=> b.order }
+						
+						ar = nil
+						args.each do |val|
+							if val.start_with?('-')
+								raise(KXI::Exceptions::ArgumentException.new(ar.name, 'Expected value!')) if ar != nil
+								raise(KXI::Exceptions::ArgumentException.new(val, 'Invalid syntax!')) if val.start_with?('---')
+								if val.start_with?('--')
+									raise(KXI::Exceptions::ArgumentException.new(val, 'Expected argument name!')) if val.length == 2
+									nm  = val[2..val.length - 1].downcase
+									arg = @args.first { |i| i.name == nm }
+									raise(KXI::Exceptions::ArgumentException.new(nm, 'No such argument exists!')) if arg == nil
+									if arg.is_a?(KXI::CLI::FlagArgument)
+										vals.set(arg, true)
+									elsif arg.is_a?(KXI::CLI::NamedArgument)
+										ar = arg
+									else
+										raise(KXI::Exceptions::ArgumentException.new(nm, 'Argument cannot be assigned explicitly!'))
+									end
+								else
+									raise(KXI::Exceptions::ArgumentException.new(val, 'Expected short argument name!')) if val.length == 1
+									nm  = val[1]
+									arg = @args.first { |i| i.shortcut == nm }
+									raise(KXI::Exceptions::ArgumentException.new(nm, 'No such argument exists!')) if arg == nil
+									if arg.is_a?(KXI::CLI::FlagArgument)
+										vals.set(arg, true)
+									elsif arg.is_a?(KXI::CLI::NamedArgument)
+										if val.length == 2
+											ar = arg
+										else
+											vals.set(arg, val[2..val.length - 1])
+										end
+									end
+								end
+							else
+								if ar != nil
+									vals.set(ar, val)
+									ar = nil
+								else
+									an = anon.first
+									raise(KXI::Exceptions::NoArgumentException.new(val)) if an == nil
+									vals.set(an, val)
+									anon.remove_at(0)
+								end
+							end
+						end
+						if @action == nil
+							raise(KXI::Exceptions::NotImplementedException.new)
+						else
+							vals.finish
+							@action.call(vals)
+						end
+					end
+				end
+			end
+			
+			# Prints help message of verb
+			def help
+				puts(@name)
+				puts("\t#{@desc}")
+				puts
+				puts('Usage:')
+				if @verbs.count == 0
+					print("\t")
+					print("#{@ctx} ") if @ctx != nil
+					print(@name)
+					args = @args.order_by_descending { |a, b| a.order <=> b.order }
+					args.where { |i| i.required? or i.is_a?(KXI::CLI::AnonymousArgument) }.foreach do |i|
+						print(" #{i.syntax}")
+					end
+					puts
+					if args.count > 0
+						puts
+						max = args.max { |a, b| a.headline.length <=> b.headline.length }.headline.length
+						args.foreach do |a|
+							puts("\t#{a.headline.ljust(max)}   #{a.description}")
+						end
+					end
+				else
+					max = @verbs.max { |a, b| a.name.length <=> b.name.length }.name.length
+					@verbs.foreach do |v|
+						print("\t")
+						print("#{@ctx} ") if @ctx != nil
+						puts("#{@name} #{v.name.ljust(max)}   #{v.description}")
+					end
+				end
+			end
+			
+			# Adds argument
+			# @param arg [KXI::CLI::Argument] Argument to add
+			def add_argument(arg)
+				check_name(arg.name)
+				if arg.is_a?(KXI::CLI::ExplicitArgument) and arg.shortcut != nil
+					raise(Exception.new("Short name '#{arg.shortcut}' is already in use!")) if @args.of_type(KXI::CLI::ExplicitArgument).any { |i| i.shortcut == arg.shortcut }
+				end
+				if arg.is_a?(KXI::CLI::AnonymousArgument) and arg.variadic?
+					raise(Exception.new("Verb can have only one variadic anonymous argument! (argument '#{arg.name}')")) if @args.of_type(KXI::CLI::AnonymousArgument).any { |i| i.variadic? }
+					raise(Exception.new("Verb cannot contain both optional and variadic anonymous arguments! (argument '#{arg.name}')")) if @args.of_type(KXI::CLI::AnonymousArgument).any { |i| not i.required? }
+				end
+				@args.add(arg)
+				@verbs.foreach { |i| i.add_argument(arg) }
+				return arg
+			end
+			
+			# Adds child verb
+			# @param v [KXI::CLI::Verb] Verb to add
+			def add_verb(v)
+				@args.foreach { |a| v.add_argument(a) }
+				@verbs.add(v)
+				v.enable_help if @help
+				return v
+			end
+			
+			def check_name(nm)
+				raise(Exception.new('Name must contain at least two characters!')) if nm == nil or nm.length < 2
+				nm = nm.downcase
+				raise(Exception.new("Name '#{nm}' is already in use!")) unless @verbs.all { |i| i.name != nm } && @args.all { |i| i.name != nm }
+			end
+			
+			private :check_name
+		end
+	end
+end