kxi 1.0.1 → 1.0.2

data/lib/kxi/application/config_reader.rb

@@ -1,17 +1,17 @@
-# Created by Matyáš Pokorný on 2018-01-24.
-
-module KXI
-	module Application
-		# Parses configuration
-		# @abstract
-		class ConfigReader
-			# Parses configuration from file
-			# @param str [String] Data to parse
-			# @return [Hash] Parsed configuration
-			# @abstract
-			def parse(str)
-				raise(KXI::Exceptions::AbstractException.new(KXI::Application::ConfigReader))
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-24.
+
+module KXI
+	module Application
+		# Parses configuration
+		# @abstract
+		class ConfigReader
+			# Parses configuration from file
+			# @param str [String] Data to parse
+			# @return [Hash] Parsed configuration
+			# @abstract
+			def parse(str)
+				raise(KXI::Exceptions::AbstractException.new(KXI::Application::ConfigReader))
+			end
+		end
+	end
 end

data/lib/kxi/application/event.rb

@@ -1,36 +1,36 @@
-# Created by Matyáš Pokorný on 2018-01-26.
-
-module KXI
-	module Application
-		# Event handler
-		class Event
-			# Adds hook to handler
-			# @return [Number] Id of hook
-			# @yield [sender, *args] Action block of hook
-			# @yieldparam sender [Object] Invoker of event
-			# @yieldparam args [Array<Object, nil>] Arguments of invocation
-			def add(&block)
-				@hooks.push(block)
-				return @hooks.length - 1
-			end
-			
-			# Removes hook from handler
-			# @param id [Number] Id of hook to remove
-			def remove(id)
-				@hooks.delete_at(id)
-			end
-			
-			# Instantiates the {KXI::Application::Event} class
-			def initialize
-				@hooks = []
-			end
-			
-			# Invokes all hooks
-			# @param sender [Object] Invoker of event
-			# @param args [Array<Object, nil>] Arguments of invocation
-			def fire(sender, *args)
-				@hooks.each { |h| h.call(sender, *args) }
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-26.
+
+module KXI
+	module Application
+		# Event handler
+		class Event
+			# Adds hook to handler
+			# @return [Number] Id of hook
+			# @yield [sender, *args] Action block of hook
+			# @yieldparam sender [Object] Invoker of event
+			# @yieldparam args [Array<Object, nil>] Arguments of invocation
+			def add(&block)
+				@hooks.push(block)
+				return @hooks.length - 1
+			end
+			
+			# Removes hook from handler
+			# @param id [Number] Id of hook to remove
+			def remove(id)
+				@hooks.delete_at(id)
+			end
+			
+			# Instantiates the {KXI::Application::Event} class
+			def initialize
+				@hooks = []
+			end
+			
+			# Invokes all hooks
+			# @param sender [Object] Invoker of event
+			# @param args [Array<Object, nil>] Arguments of invocation
+			def fire(sender, *args)
+				@hooks.each { |h| h.call(sender, *args) }
+			end
+		end
+	end
 end

data/lib/kxi/application/logger.rb

@@ -1,156 +1,156 @@
-# Created by Matyáš Pokorný on 2018-01-26.
-
-module KXI
-	module Application
-		# Allows simple unstructured (time-independent) logging
-		class Logger
-			# Gets the message event
-			# @return [KXI::Application::Event] Message event
-			def on_message
-				@event
-			end
-			
-			# Attaches action to message event
-			# @param min [KXI::Application::Logger::Message::Severity] Minimal severity of message
-			# @yield [msg] Event action
-			# @yieldparam msg [KXI::Application::Logger::Message] Logger message
-			# @return [Number] Id of event hook
-			def attach(min = Message::Severity::COMMAND, &block)
-				return @event.add { |s, msg| block.call(msg) if msg.severity.level >= min.level }
-			end
-			
-			# Instantiates the {KXI::Application::Logger} class
-			def initialize
-				@event = KXI::Application::Event.new
-				@start = DateTime.now
-			end
-			
-			# Logs message with the {KXI::Application::Logger::Message::Severity::COMMAND} severity
-			# @param cmd [String] Executed command
-			def command(cmd)
-				log(Message::Severity::COMMAND, cmd)
-			end
-			
-			# Logs message with the {KXI::Application::Logger::Message::Severity::TRACE} severity
-			# @param msg [String] Text of message
-			def trace(msg)
-				log(Message::Severity::TRACE, msg)
-			end
-			
-			# Logs message with the {KXI::Application::Logger::Message::Severity::DEBUG} severity
-			# @param msg [String] Text of message
-			def debug(msg)
-				log(Message::Severity::DEBUG, msg)
-			end
-			
-			# Logs message with the {KXI::Application::Logger::Message::Severity::INFO} severity
-			# @param msg [String] Text of message
-			def info(msg)
-				log(Message::Severity::INFO, msg)
-			end
-			
-			# Logs message with the {KXI::Application::Logger::Message::Severity::WARNING} severity
-			# @param msg [String] Text of message
-			def warning(msg)
-				log(Message::Severity::WARNING, msg)
-			end
-			
-			# Logs message with the {KXI::Application::Logger::Message::Severity::ERROR} severity
-			# @param msg [String] Text of message
-			def error(msg)
-				log(Message::Severity::ERROR, msg)
-			end
-			
-			# Logs message with the {KXI::Application::Logger::Message::Severity::FATAL} severity
-			# @param msg [String] Text of message
-			def fatal(msg)
-				log(Message::Severity::FATAL, msg)
-			end
-			
-			def log(severity, msg)
-				now = DateTime.now
-				@event.fire(self, Message.new(severity, now - @start, now, msg))
-			end
-			
-			private :log
-			
-			# Represents a log message
-			class Message
-				# Represents severity of message
-				class Severity
-					# Gets the name of severity
-					# @return [String] Name of severity
-					def name
-						@name
-					end
-					
-					# Gets the level of severity
-					# @return [Number] Level of severity
-					def level
-						@lvl
-					end
-					
-					# Instantiates the [KXI::Application::Logger::Message::Severity] class
-					# @param nm [String] Name of severity
-					# @param lvl [Number] Level of severity
-					def initialize(nm, lvl)
-						@name = nm
-						@lvl  = lvl
-					end
-					
-					
-					# Severity of messages that log execution of external commands
-					COMMAND = Severity.new('command', 0)
-					# Severity of messages that allow tracing of execution paths
-					TRACE = Severity.new('trace', 1)
-					# Severity of messages used for debugging
-					DEBUG = Severity.new('debug', 2)
-					# Severity of messages that user should know about
-					INFO = Severity.new('info', 3)
-					# Severity of messages that notify about something that might lead in future to problems
-					WARNING = Severity.new('warning', 4)
-					# Severity of messages that notify about problems that application can recover from
-					ERROR = Severity.new('error', 5)
-					# Severity of messages that notify about problems that application cannot recover from
-					FATAL = Severity.new('fatal', 6)
-				end
-				
-				# Gets the severity of message
-				# @return [KXI::Application::Logger::Message:Severity] Severity of message
-				def severity
-					@sev
-				end
-				
-				# Gets time at which the message was created
-				# @return [DateTime] Time of creation
-				def absolute_time
-					@ttime
-				end
-				
-				# Gets time, relative to creation of logger, at which the message was created
-				# @return [DateTime] Relative time of creation
-				def relative_time
-					@rtime
-				end
-				
-				# Gets the text message
-				# @return [String] Message
-				def message
-					@msg
-				end
-				
-				# Instantiates the {KXI::Application::Logger::Message} class
-				# @param severity [KXI::Application::Logger::Message::Severity] Severity of message
-				# @param rtime [DateTime] Relative time of message
-				# @param ttime [DateTime] Absolute time of message
-				# @param message [String] Text of message
-				def initialize(severity, rtime, ttime, message)
-					@sev   = severity
-					@rtime = rtime
-					@ttime = ttime
-					@msg   = message
-				end
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-26.
+
+module KXI
+	module Application
+		# Allows simple unstructured (time-independent) logging
+		class Logger
+			# Gets the message event
+			# @return [KXI::Application::Event] Message event
+			def on_message
+				@event
+			end
+			
+			# Attaches action to message event
+			# @param min [KXI::Application::Logger::Message::Severity] Minimal severity of message
+			# @yield [msg] Event action
+			# @yieldparam msg [KXI::Application::Logger::Message] Logger message
+			# @return [Number] Id of event hook
+			def attach(min = Message::Severity::COMMAND, &block)
+				return @event.add { |s, msg| block.call(msg) if msg.severity.level >= min.level }
+			end
+			
+			# Instantiates the {KXI::Application::Logger} class
+			def initialize
+				@event = KXI::Application::Event.new
+				@start = DateTime.now
+			end
+			
+			# Logs message with the {KXI::Application::Logger::Message::Severity::COMMAND} severity
+			# @param cmd [String] Executed command
+			def command(cmd)
+				log(Message::Severity::COMMAND, cmd)
+			end
+			
+			# Logs message with the {KXI::Application::Logger::Message::Severity::TRACE} severity
+			# @param msg [String] Text of message
+			def trace(msg)
+				log(Message::Severity::TRACE, msg)
+			end
+			
+			# Logs message with the {KXI::Application::Logger::Message::Severity::DEBUG} severity
+			# @param msg [String] Text of message
+			def debug(msg)
+				log(Message::Severity::DEBUG, msg)
+			end
+			
+			# Logs message with the {KXI::Application::Logger::Message::Severity::INFO} severity
+			# @param msg [String] Text of message
+			def info(msg)
+				log(Message::Severity::INFO, msg)
+			end
+			
+			# Logs message with the {KXI::Application::Logger::Message::Severity::WARNING} severity
+			# @param msg [String] Text of message
+			def warning(msg)
+				log(Message::Severity::WARNING, msg)
+			end
+			
+			# Logs message with the {KXI::Application::Logger::Message::Severity::ERROR} severity
+			# @param msg [String] Text of message
+			def error(msg)
+				log(Message::Severity::ERROR, msg)
+			end
+			
+			# Logs message with the {KXI::Application::Logger::Message::Severity::FATAL} severity
+			# @param msg [String] Text of message
+			def fatal(msg)
+				log(Message::Severity::FATAL, msg)
+			end
+			
+			def log(severity, msg)
+				now = DateTime.now
+				@event.fire(self, Message.new(severity, now - @start, now, msg))
+			end
+			
+			private :log
+			
+			# Represents a log message
+			class Message
+				# Represents severity of message
+				class Severity
+					# Gets the name of severity
+					# @return [String] Name of severity
+					def name
+						@name
+					end
+					
+					# Gets the level of severity
+					# @return [Number] Level of severity
+					def level
+						@lvl
+					end
+					
+					# Instantiates the [KXI::Application::Logger::Message::Severity] class
+					# @param nm [String] Name of severity
+					# @param lvl [Number] Level of severity
+					def initialize(nm, lvl)
+						@name = nm
+						@lvl  = lvl
+					end
+					
+					
+					# Severity of messages that log execution of external commands
+					COMMAND = Severity.new('command', 0)
+					# Severity of messages that allow tracing of execution paths
+					TRACE = Severity.new('trace', 1)
+					# Severity of messages used for debugging
+					DEBUG = Severity.new('debug', 2)
+					# Severity of messages that user should know about
+					INFO = Severity.new('info', 3)
+					# Severity of messages that notify about something that might lead in future to problems
+					WARNING = Severity.new('warning', 4)
+					# Severity of messages that notify about problems that application can recover from
+					ERROR = Severity.new('error', 5)
+					# Severity of messages that notify about problems that application cannot recover from
+					FATAL = Severity.new('fatal', 6)
+				end
+				
+				# Gets the severity of message
+				# @return [KXI::Application::Logger::Message:Severity] Severity of message
+				def severity
+					@sev
+				end
+				
+				# Gets time at which the message was created
+				# @return [DateTime] Time of creation
+				def absolute_time
+					@ttime
+				end
+				
+				# Gets time, relative to creation of logger, at which the message was created
+				# @return [DateTime] Relative time of creation
+				def relative_time
+					@rtime
+				end
+				
+				# Gets the text message
+				# @return [String] Message
+				def message
+					@msg
+				end
+				
+				# Instantiates the {KXI::Application::Logger::Message} class
+				# @param severity [KXI::Application::Logger::Message::Severity] Severity of message
+				# @param rtime [DateTime] Relative time of message
+				# @param ttime [DateTime] Absolute time of message
+				# @param message [String] Text of message
+				def initialize(severity, rtime, ttime, message)
+					@sev   = severity
+					@rtime = rtime
+					@ttime = ttime
+					@msg   = message
+				end
+			end
+		end
+	end
 end

data/lib/kxi/application/version.rb

@@ -1,75 +1,107 @@
-# Created by Matyáš Pokorný on 2018-01-27.
-
-module KXI
-	module Application
-		class Version
-			def major
-				@major
-			end
-			
-			def minor
-				@minor
-			end
-			
-			def patch
-				@patch
-			end
-			
-			def identifier
-				@id
-			end
-			
-			def metadata
-				@meta
-			end
-			
-			def initialize(major, minor = 0, patch = 0, id = nil, meta = nil)
-				@major = major
-				@minor = minor
-				@patch = patch
-				@id    = id
-				@meta  = meta
-			end
-			
-			def to_s
-				"#{@major}.#{@minor}.#{@patch}#{@id == nil ? '' : "-#{@id}"}#{@meta == nil ? '' : "+#{@meta}"}"
-			end
-			
-			def ==(other)
-				return false unless other.is_a?(KXI::Application::Version)
-				return (@major == other.major and @minor == other.minor and @patch == other.patch and @id == other.identifier)
-			end
-			
-			def <(other)
-				raise(KXI::Exceptions::InvalidOperationException.new("Can't compare version to #{other.class.name}!")) unless other.is_a?(KXI::Application::Version)
-				return true if @major < other.major or @minor < other.minor or @patch < other.patch
-				return true if @id != nil and other.identifier == nil
-				return true if @id != nil and other.identifier != nil and @id < other.identifier
-				return false
-			end
-			
-			def <=(other)
-				raise(KXI::Exceptions::InvalidOperationException.new("Can't compare version to #{other.class.name}!")) unless other.is_a?(KXI::Application::Version)
-				return true if self == other
-				return true if @major < other.major or @minor < other.minor or @patch < other.patch
-				return true if @id != nil and other.identifier == nil
-				return true if @id != nil and other.identifier != nil and @id < other.identifier
-				return false
-			end
-			
-			def >(other)
-				return (not self <= other)
-			end
-			
-			def >=(other)
-				return (not self < other)
-			end
-			
-			def self.parse(str)
-				m = /^\s*(?'ma'\d+)\s*(\.\s*(?'mi'\d+))?\s*(\.\s*(?'pt'\d+))?\s*(-\s*(?'id'[0-9A-Z\-.]+))?\s*(\+\s*(?'mt'[0-9A-Z\-.]+))?\s*$/mi.match(str)
-				raise(KXI::Exceptions::ParseException.new('version', str)) if m == nil
-				return Version.new(m['ma'].to_i, m['mi'] != nil ? m['mi'].to_i : 0, m['pt'] != nil ? m['pt'].to_i : 0, m['id'], m['mt'])
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-27.
+
+module KXI
+	module Application
+		# Represents a version of semantic versioning 2.0.0 (https://semver.org)
+		class Version
+			# Gets the major number of version
+			# @return [integer] Major number of version
+			def major
+				@major
+			end
+			
+			# Gets the number minor of version
+			# @return [integer] Minor number of version
+			def minor
+				@minor
+			end
+			
+			# Gets the number patch of version
+			# @return [integer] Patch number of version
+			def patch
+				@patch
+			end
+			
+			# Gets the identifier of version
+			# @return [string] Identifier of version
+			def identifier
+				@id
+			end
+			
+			# Gets the metadata of version
+			# @return [string] Metadata of version
+			def metadata
+				@meta
+			end
+			
+			# Instantiates the {KXI::Application::Version} class
+			# @param [integer] major Major number of version
+			# @param [integer] minor Minor number of version
+			# @param [integer] patch Patch number of version
+			# @param [string,nil] id Identifier of version
+			# @param [string,nil] meta Metadata of version
+			def initialize(major, minor = 0, patch = 0, id = nil, meta = nil)
+				@major = major
+				@minor = minor
+				@patch = patch
+				@id    = id
+				@meta  = meta
+			end
+			
+			# Converts class to string representation
+			# @return [string] String representation of class
+			def to_s
+				"#{@major}.#{@minor}.#{@patch}#{@id == nil ? '' : "-#{@id}"}#{@meta == nil ? '' : "+#{@meta}"}"
+			end
+			
+			# Checks whether this version is equivalent to other version
+			# @return [bool] True when versions are equivalent; false otherwise
+			def ==(other)
+				return false unless other.is_a?(KXI::Application::Version)
+				return (@major == other.major and @minor == other.minor and @patch == other.patch and @id == other.identifier)
+			end
+			
+			# Checks whether this version is lower than other version
+			# @return [bool] True when this version is lower than the other; false otherwise
+			def <(other)
+				raise(KXI::Exceptions::InvalidTypeException.new(other.class, KXI::Application::Version)) unless other.is_a?(KXI::Application::Version)
+				return true if @major < other.major or @minor < other.minor or @patch < other.patch
+				return true if @id != nil and other.identifier == nil
+				return true if @id != nil and other.identifier != nil and @id < other.identifier
+				return false
+			end
+			
+			# Checks whether this version is lower than or equivalent to other version
+			# @return [bool] True when this version is lower than or equivalent to the other; false otherwise
+			def <=(other)
+				raise(KXI::Exceptions::InvalidTypeException.new(other.class, KXI::Application::Version)) unless other.is_a?(KXI::Application::Version)
+				return true if self == other
+				return true if @major < other.major or @minor < other.minor or @patch < other.patch
+				return true if @id != nil and other.identifier == nil
+				return true if @id != nil and other.identifier != nil and @id < other.identifier
+				return false
+			end
+			
+			# Checks whether this version is grater than other version
+			# @return [bool] True when this version is grater than the other; false otherwise
+			def >(other)
+				return (not self <= other)
+			end
+			
+			# Checks whether this version is grater than or equivalent to other version
+			# @return [bool] True when this version is grater than or equivalent to the other; false otherwise
+			def >=(other)
+				return (not self < other)
+			end
+			
+			# Parses a version from its string representation
+			# @param [string] str String representation of the version
+			# @return [KXI::Application::Version] Version equivalent to given string
+			def self.parse(str)
+				m = /^\s*(?'ma'\d+)\s*(\.\s*(?'mi'\d+))?\s*(\.\s*(?'pt'\d+))?\s*(-\s*(?'id'[0-9A-Z\-.]+))?\s*(\+\s*(?'mt'[0-9A-Z\-.]+))?\s*$/mi.match(str)
+				raise(KXI::Exceptions::ParseException.new('version', str)) if m == nil
+				return Version.new(m['ma'].to_i, m['mi'] != nil ? m['mi'].to_i : 0, m['pt'] != nil ? m['pt'].to_i : 0, m['id'], m['mt'])
+			end
+		end
+	end
 end