kxi 1.0.1 → 1.0.2

data/lib/kxi/cli/argument_values.rb

@@ -1,84 +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}'!")) unless @vals.include?(index)
-				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.include?(arg.name)
-						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] = { :argument => arg, :value => arg.default }
-					end
-				end
-			end
-		end
-	end
+# 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}'!")) unless @vals.include?(index)
+				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.include?(arg.name)
+						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] = { :argument => arg, :value => arg.default }
+					end
+				end
+			end
+		end
+	end
 end

data/lib/kxi/cli/explicit_argument.rb

@@ -1,39 +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
+# 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

@@ -1,16 +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
+# 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

@@ -1,60 +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
+# 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/property_list.rb

@@ -1,49 +1,58 @@
-# Created by Matyáš Pokorný on 2018-01-24.
-
-module KXI
-	module CLI
-		class PropertyList
-			def initialize
-				@align = 0
-				@data = {}
-			end
-			
-			def field(name, value)
-				@data[name] = value
-				@align = name.length if name.length > @align
-			end
-			
-			def render(cols = 4)
-				@data.each_pair do |k, v|
-					if v.kind_of?(Array)
-						print("#{pad(k)}: ")
-						v.each_index do |idx|
-							if idx > 0 and idx % cols == 0
-								puts('')
-								print(' ' * (@align + 2))
-							elsif idx > 0
-								print(', ')
-							end
-							print(v[idx])
-						end
-						puts('')
-					else
-						puts("#{pad(k)}: #{v}")
-					end
-				end
-			end
-	
-			def pad(key)
-				d = false
-				p = ''
-				(@align - key.length).times do |i|
-					p = (d ? '.' : ' ') + p
-					d = (not d)
-				end
-				return key + p
-			end
-			
-			private :pad
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-24.
+
+module KXI
+	module CLI
+		# Property list renderer
+		class PropertyList
+			# Instantiates the {KXI::CLI::PropertyList} class
+			def initialize
+				@align = 0
+				@data = {}
+			end
+			
+			# Sets a property
+			# @param [string] name Name of the property
+			# @param [string,Array<string>] value Value of the property
+			def field(name, value)
+				@data[name] = value
+				@align = name.length if name.length > @align
+			end
+			
+			# Renders the property list into stdout
+			# @param [integer] cols Determines the maximal number of columns for array rendering
+			def render(cols = 4)
+				@data.each_pair do |k, v|
+					if v.kind_of?(Array)
+						print("#{pad(k)}: ")
+						v.each_index do |idx|
+							if idx > 0 and idx % cols == 0
+								puts('')
+								print(' ' * (@align + 2))
+							elsif idx > 0
+								print(', ')
+							end
+							print(v[idx])
+						end
+						puts('')
+					else
+						puts("#{pad(k)}: #{v}")
+					end
+				end
+			end
+			
+			# Adds a space-dot-space padding
+			# @param [string] key Key to add padding to
+			def pad(key)
+				d = false
+				p = ''
+				(@align - key.length).times do |i|
+					p = (d ? '.' : ' ') + p
+					d = (not d)
+				end
+				return key + p
+			end
+			
+			private :pad
+		end
+	end
 end