kxi 1.0.1 → 1.0.2

data/lib/kxi/collections/enumerator.rb

@@ -1,32 +1,32 @@
-# Created by Matyáš Pokorný on 2017-12-28.
-
-module KXI
-	module Collections
-		# Allows iteration over a collection
-		# @abstract
-		class Enumerator
-			# Selects first item in collection
-			# @return [Bool] True if collection contains elements; otherwise false
-			# @abstract
-			def rewind
-				raise(KXI::Exceptions::AbstractException.new(Enumerator))
-			end
-			
-			# Advances enumerator to next item
-			# @return [Bool] True if item is available; false otherwise
-			# @raise [KXI::Exceptions::AbstractException] When method is not implemented in superclass
-			# @abstract
-			def next
-				raise(KXI::Exceptions::AbstractException.new(Enumerator))
-			end
-			
-			# Returns current item
-			# @return [Object] Current item
-			# @raise [KXI::Exceptions::AbstractException] When method is not implemented in superclass
-			# @abstract
-			def current
-				raise(KXI::Exceptions::AbstractException.new(Enumerator))
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2017-12-28.
+
+module KXI
+	module Collections
+		# Allows iteration over a collection
+		# @abstract
+		class Enumerator
+			# Selects first item in collection
+			# @return [Bool] True if collection contains elements; otherwise false
+			# @abstract
+			def rewind
+				raise(KXI::Exceptions::AbstractException.new(Enumerator))
+			end
+			
+			# Advances enumerator to next item
+			# @return [Bool] True if item is available; false otherwise
+			# @raise [KXI::Exceptions::AbstractException] When method is not implemented in superclass
+			# @abstract
+			def next
+				raise(KXI::Exceptions::AbstractException.new(Enumerator))
+			end
+			
+			# Returns current item
+			# @return [Object] Current item
+			# @raise [KXI::Exceptions::AbstractException] When method is not implemented in superclass
+			# @abstract
+			def current
+				raise(KXI::Exceptions::AbstractException.new(Enumerator))
+			end
+		end
+	end
 end

data/lib/kxi/collections/hash_collection.rb

@@ -1,101 +1,101 @@
-# Created by Matyáš Pokorný on 2017-12-29.
-
-module KXI
-	module Collections
-		# Makes hash enumerable.
-		# Every key-value pair of hash is represented by {KXI::Collections::HashCollection::HashEnumerator::KeyValuePair} class
-		class HashCollection < KXI::Collections::Enumerable
-			# Instantiates the {KXI::Collections::HashCollection} class
-			# @param hash [Hash] Hash for enumeration
-			def initialize(hash)
-				super()
-				@hash = hash
-			end
-			
-			# Creates a new {KXI::Collections::Enumerator} bound to this instance
-			# @return [KXI::Collections::Enumerator] Enumerator bound to this instance
-			def create_enumerator
-				HashEnumerator.new(@hash)
-			end
-			
-			# Gets value from hash at given key
-			# @param key [Object] Key of value to obtain
-			# @return [Object] Obtained value
-			def [](key)
-				lock do
-					return @hash[key]
-				end
-			end
-			
-			# Sets value to hash at given key
-			# @param key [Object] Key of pair to set
-			# @param value [Object] Value to set the pair to
-			# @return [Object] Given value
-			def []=(key, value)
-				lock(true) do
-					@hash[key] = value
-				end
-				return value
-			end
-			
-			# Enumerates hash as key-value pairs represented by the {KXI::Collections::HashCollection::HashEnumerator::KeyValuePair} class
-			class HashEnumerator < KXI::Collections::Enumerator
-				# Instantiates the {KXI::Collections::HashCollection::HashEnumerator} class
-				# @param hash [Hash] Hash for enumeration
-				def initialize(hash)
-					@hash = hash
-					@keys = hash.keys
-					@current = 0
-				end
-				
-				# Selects first item in collection
-				# @return [Bool] True if collection contains elements; otherwise false
-				def rewind
-					@current = 0
-					return @keys.length > 0
-				end
-				
-				# Advances enumerator to next item
-				# @return [Bool] True if item is available; false otherwise
-				# @raise [KXI::Exceptions::AbstractException] When method is not implemented in superclass
-				def next
-					@current += 1
-					return @keys.length > @current
-				end
-				
-				# Returns current item
-				# @return [Object] Current item
-				# @raise [KXI::Exceptions::AbstractException] When method is not implemented in superclass
-				def current
-					k = @keys[@current]
-					KeyValuePair.new(k, @hash[k])
-				end
-				
-				# Represents a key-value pair
-				class KeyValuePair
-					# Returns the key of pair
-					# @return [Object] Key of pair
-					def key
-						@key
-					end
-					
-					# Returns the value of pair
-					# @return [Object] Value of pair
-					def value
-						@val
-					end
-					
-					# Instantiates the {KXI::Collections::HashCollection::HashEnumerator::KeyValuePair} class
-					# @param k [Object] Key of pair
-					# @param v [Object] Value of pair
-					def initialize(k, v)
-						@key = k
-						@val = v
-					end
-				end
-			end
-			
-			protected :create_enumerator
-		end
-	end
+# Created by Matyáš Pokorný on 2017-12-29.
+
+module KXI
+	module Collections
+		# Makes hash enumerable.
+		# Every key-value pair of hash is represented by {KXI::Collections::HashCollection::HashEnumerator::KeyValuePair} class
+		class HashCollection < KXI::Collections::Enumerable
+			# Instantiates the {KXI::Collections::HashCollection} class
+			# @param hash [Hash] Hash for enumeration
+			def initialize(hash)
+				super()
+				@hash = hash
+			end
+			
+			# Creates a new {KXI::Collections::Enumerator} bound to this instance
+			# @return [KXI::Collections::Enumerator] Enumerator bound to this instance
+			def create_enumerator
+				HashEnumerator.new(@hash)
+			end
+			
+			# Gets value from hash at given key
+			# @param key [Object] Key of value to obtain
+			# @return [Object] Obtained value
+			def [](key)
+				lock do
+					return @hash[key]
+				end
+			end
+			
+			# Sets value to hash at given key
+			# @param key [Object] Key of pair to set
+			# @param value [Object] Value to set the pair to
+			# @return [Object] Given value
+			def []=(key, value)
+				lock(true) do
+					@hash[key] = value
+				end
+				return value
+			end
+			
+			# Enumerates hash as key-value pairs represented by the {KXI::Collections::HashCollection::HashEnumerator::KeyValuePair} class
+			class HashEnumerator < KXI::Collections::Enumerator
+				# Instantiates the {KXI::Collections::HashCollection::HashEnumerator} class
+				# @param hash [Hash] Hash for enumeration
+				def initialize(hash)
+					@hash = hash
+					@keys = hash.keys
+					@current = 0
+				end
+				
+				# Selects first item in collection
+				# @return [Bool] True if collection contains elements; otherwise false
+				def rewind
+					@current = 0
+					return @keys.length > 0
+				end
+				
+				# Advances enumerator to next item
+				# @return [Bool] True if item is available; false otherwise
+				# @raise [KXI::Exceptions::AbstractException] When method is not implemented in superclass
+				def next
+					@current += 1
+					return @keys.length > @current
+				end
+				
+				# Returns current item
+				# @return [Object] Current item
+				# @raise [KXI::Exceptions::AbstractException] When method is not implemented in superclass
+				def current
+					k = @keys[@current]
+					KeyValuePair.new(k, @hash[k])
+				end
+				
+				# Represents a key-value pair
+				class KeyValuePair
+					# Returns the key of pair
+					# @return [Object] Key of pair
+					def key
+						@key
+					end
+					
+					# Returns the value of pair
+					# @return [Object] Value of pair
+					def value
+						@val
+					end
+					
+					# Instantiates the {KXI::Collections::HashCollection::HashEnumerator::KeyValuePair} class
+					# @param k [Object] Key of pair
+					# @param v [Object] Value of pair
+					def initialize(k, v)
+						@key = k
+						@val = v
+					end
+				end
+			end
+			
+			protected :create_enumerator
+		end
+	end
 end

data/lib/kxi/collections/protected_collection.rb

@@ -1,20 +1,21 @@
-# Created by Matyáš Pokorný on 2018-01-20.
-
-module KXI
-	module Collections
-		class ProtectedCollection < KXI::Collections::Enumerable
-			# Instantiates the {KXI::Collections::ArrayCollection} class
-			# @param enum [KXI::Collections::Enumerable] Protected enumerable
-			def initialize(enum = [])
-				super()
-				@enum = enum
-			end
-			
-			# Creates a new {KXI::Collections::Enumerator} bound to this instance
-			# @return [KXI::Collections::Enumerator] Enumerator bound to this instance
-			def create_enumerator
-				@enum.create_enumerator
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-20.
+
+module KXI
+	module Collections
+		# Represents a collection that can only be enumerated
+		class ProtectedCollection < KXI::Collections::Enumerable
+			# Instantiates the {KXI::Collections::ArrayCollection} class
+			# @param enum [KXI::Collections::Enumerable] Protected enumerable
+			def initialize(enum = [])
+				super()
+				@enum = enum
+			end
+			
+			# Creates a new {KXI::Collections::Enumerator} bound to this instance
+			# @return [KXI::Collections::Enumerator] Enumerator bound to this instance
+			def create_enumerator
+				@enum.create_enumerator
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/abstract_exception.rb

@@ -1,35 +1,35 @@
-# Created by Matyáš Pokorný on 2017-12-28.
-module KXI
-	module Exceptions
-		# Raised when method that was supposed to be implemented by super class wasn't
-		class AbstractException < Exception
-			# Returns the abstract class
-			# @return [Class] Abstract class
-			def class
-				@class
-			end
-			
-			# Returns the file that contains the abstract class
-			# @return [String] Path of file that contains the abstract class
-			def file
-				@file
-			end
-			
-			# Returns name of the abstract method
-			# @return [String] Name of the abstract method
-			def method
-				@mtd
-			end
-			
-			# Instantiates the {KXI::Exceptions::AbstractException} class
-			# @param cl [Class] Abstract class
-			def initialize(cl)
-				frame = Reflection::StackFrame.callstack(3).first
-				@file = frame.file
-				@mtd = frame.method
-				super("Abstract method #{cl.name}##{@mtd} wasn't implemented!")
-				@class = cl
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2017-12-28.
+module KXI
+	module Exceptions
+		# Raised when method that was supposed to be implemented by super class wasn't
+		class AbstractException < Exception
+			# Returns the abstract class
+			# @return [Class] Abstract class
+			def class
+				@class
+			end
+			
+			# Returns the file that contains the abstract class
+			# @return [String] Path of file that contains the abstract class
+			def file
+				@file
+			end
+			
+			# Returns name of the abstract method
+			# @return [String] Name of the abstract method
+			def method
+				@mtd
+			end
+			
+			# Instantiates the {KXI::Exceptions::AbstractException} class
+			# @param cl [Class] Abstract class
+			def initialize(cl)
+				frame = Reflection::StackFrame.callstack(3).first
+				@file = frame.file
+				@mtd = frame.method
+				super("Abstract method #{cl.name}##{@mtd} wasn't implemented!")
+				@class = cl
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/argument_exception.rb

@@ -1,22 +1,22 @@
-# Created by Matyáš Pokorný on 2018-01-20.
-
-module KXI
-	module Exceptions
-		# Raised when command-line parser encounters an error
-		class ArgumentException < Exception
-			# Get the name of argument
-			# @return [String] Name of argument
-			def argument
-				@arg
-			end
-			
-			# Instantiates the {KXI::Exceptions::ArgumentException} class
-			# @param arg [String] Name of argument
-			# @param msg [String] Error message
-			def initialize(arg, msg)
-				super("<#{arg}> #{msg}")
-				@arg = arg
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-20.
+
+module KXI
+	module Exceptions
+		# Raised when command-line parser encounters an error
+		class ArgumentException < Exception
+			# Get the name of argument
+			# @return [String] Name of argument
+			def argument
+				@arg
+			end
+			
+			# Instantiates the {KXI::Exceptions::ArgumentException} class
+			# @param arg [String] Name of argument
+			# @param msg [String] Error message
+			def initialize(arg, msg)
+				super("<#{arg}> #{msg}")
+				@arg = arg
+			end
+		end
+	end
 end

data/lib/kxi/exceptions/collection_exception.rb

@@ -1,14 +1,14 @@
-# Created by Matyáš Pokorný on 2017-12-28.
-
-module KXI
-	module Exceptions
-		# Raised when collection encounters an error
-		class CollectionException < Exception
-			# Instantiates the {KXI::Exceptions::CollectionException} class
-			# @param msg [String] Exception message
-			def initialize(msg)
-				super(msg)
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2017-12-28.
+
+module KXI
+	module Exceptions
+		# Raised when collection encounters an error
+		class CollectionException < Exception
+			# Instantiates the {KXI::Exceptions::CollectionException} class
+			# @param msg [String] Exception message
+			def initialize(msg)
+				super(msg)
+			end
+		end
+	end
 end