kxi 1.0.0

data/lib/kxi/collections/hash_collection.rb

@@ -0,0 +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
+end

data/lib/kxi/collections/protected_collection.rb

@@ -0,0 +1,20 @@
+# 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
+end

data/lib/kxi/exceptions/abstract_exception.rb

@@ -0,0 +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
+end

data/lib/kxi/exceptions/argument_exception.rb

@@ -0,0 +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
+end

data/lib/kxi/exceptions/collection_exception.rb

@@ -0,0 +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
+end

data/lib/kxi/exceptions/invalid_type_exception.rb

@@ -0,0 +1,33 @@
+# Created by Matyáš Pokorný on 2017-12-30.
+
+module KXI
+	module Exceptions
+		# Raised when some value is of unexpected type
+		class InvalidTypeException < Exception
+			# Returns expected types
+			# @return [Array<Class>] Expected types
+			def expected
+				@exp
+			end
+			
+			# Returns actual type
+			# @return [Class] Actual type
+			def actual
+				@act
+			end
+			
+			# Instantiates the [KXI::Exceptions::InvalidTypeException] class
+			# @param exp [Array<Class>] Expected types
+			# @param act [Class] Actual type
+			def initialize(act, *exp)
+				if exp.length == 1
+					super("Value is of unexpected type! Expected <#{exp[0].name}> got <#{act.name}>")
+				else
+					super("Value is of unexpected type! Expected { #{exp.collect {|i| "<#{i}>"}.join(', ')} } got <#{act.name}>")
+				end
+				@exp = exp
+				@act = act
+			end
+		end
+	end
+end

data/lib/kxi/exceptions/no_argument_exception.rb

@@ -0,0 +1,21 @@
+# Created by Matyáš Pokorný on 2018-01-21.
+
+module KXI
+	module Exceptions
+		# Raised when argument value has no binding argument
+		class NoArgumentException < Exception
+			# Gets the erroneous value
+			# @return [String] Erroneous value
+			def value
+				@val
+			end
+			
+			# Instantiates the {KXI::Exceptions::NoArgumentException} class
+			# @param val [String] Erroneous value
+			def initialize(val)
+				super("Value '#{val}' has no argument to bind to!")
+				@val = val
+			end
+		end
+	end
+end

data/lib/kxi/exceptions/not_implemented_exception.rb

@@ -0,0 +1,13 @@
+# Created by Matyáš Pokorný on 2017-12-29.
+
+module KXI
+	module Exceptions
+		# Raised when given part of code isn't yet implemented
+		class NotImplementedException < Exception
+			# Instantiates the {KXI::Exceptions::NotImplementedException} class
+			def initialize
+				super('Code not implemented yet!')
+			end
+		end
+	end
+end

data/lib/kxi/exceptions/out_of_range_exception.rb

@@ -0,0 +1,44 @@
+# Created by Matyáš Pokorný on 2017-12-29.
+
+module KXI
+	module Exceptions
+		# Raised when certain value is out of range
+		class OutOfRangeException < Exception
+			# Returns erroneous value
+			# @return [Object] Erroneous value
+			def value
+				@val
+			end
+			
+			# Returns minimal expected value
+			# @return [Object, nil] Minimal expected value; nil if there is no minimum
+			def minimum
+				@min
+			end
+			
+			# Returns maximal expected value
+			# @return [Object, nil] Maximal expected value; nil if there is no maximum
+			def maximum
+				@max
+			end
+			
+			# Instantiates the {KXI::Exceptions::OutOfRangeException} class
+			# @param val [Object] Erroneous value
+			# @param min [Object, nil] Minimal expected value; nil if there is no minimum
+			# @param max [Object, nil] Maximal expected value; nil if there is no maximum
+			# @note If both min and max are nil, then range is empty set
+			def initialize(val, min = nil, max = nil)
+				if min == nil and max == nil
+					super("Value '#{val}' is out of range {}!")
+				elsif min == max
+					super("Value '#{val}' is out of range {#{min}}!")
+				else
+					super("Value '#{val}' is out of range #{(min == nil ? '(-∞' : "<#{min}")};#{(max == nil ? '∞)' : "#{max}>")}!")
+				end
+				@val = val
+				@min = min
+				@max = max
+			end
+		end
+	end
+end

data/lib/kxi/exceptions/verb_expected_exception.rb

@@ -0,0 +1,21 @@
+# Created by Matyáš Pokorný on 2018-01-21.
+
+module KXI
+	module Exceptions
+		# Raised when specific verb was expected
+		class VerbExpectedException < Exception
+			# Gets array of verbs that were expected
+			# @return [Array<String>] Expected verbs
+			def verbs
+				@verbs
+			end
+			
+			# Instantiates the {KXI::CLI::VerbExpectedException} class
+			# @param verbs [Array<String>] Expected verbs
+			def initialize(verbs)
+				super("Expected verb! (#{verbs.join(', ')})")
+				@verbs = verbs
+			end
+		end
+	end
+end

data/lib/kxi/reflection/stack_frame.rb

@@ -0,0 +1,81 @@
+# Created by Matyáš Pokorný on 2017-12-28.
+module KXI
+	module Reflection
+		# Represents frame of call stack
+		class StackFrame
+			# Returns the file of frame
+			# @return [String] File of frame
+			def file
+				@file
+			end
+			
+			# Returns the line number of frame
+			# @return [Number] Line number of frame
+			def line
+				@line
+			end
+			
+			# Returns the context of frame
+			# @return [String] Context of frame
+			def context
+				@context
+			end
+			
+			# Indicates whether frame is block
+			# @return [Bool] True if stack frame represents call to block; false otherwise
+			def block?
+				@block != nil
+			end
+			
+			# Returns containing method of frame; nil if none
+			# @return [String, nil] Name of method that the stack frame represents
+			def method
+				return nil if @block != nil and @block[0] == '<' and @block[@block.length - 1] == '>'
+				return @block unless @block == nil
+				return nil if @context[0] == '<' and @context[@context.length - 1] == '>'
+				@context
+			end
+			
+			# Instantiates the {KXI::Reflection::StackFrame} class
+			# @param file [String] File of frame
+			# @param line [Number] Line number of frame
+			# @param context [String, nil] Context of frame
+			def initialize(file, line, context = nil)
+				@file    = file
+				@line    = line
+				@context = context
+				if context == nil
+					@block = nil
+				else
+					mt     = /^block (\((?'levels'\d+) levels\) )?in (?'method'.+)$/mi.match(context)
+					@block = mt == nil ? nil : mt['method']
+				end
+			end
+			
+			# Converts class to string
+			# @return [String] Equivalent string
+			def to_s
+				"#{@file}:#{@line}#{(@context != nil ? ": in `#{@context}'" : '')}"
+			end
+			
+			# Parses callstack into array of {KXI::Reflection::StackFrame}
+			# @param skip [Number] Number of callstack records to ignore
+			# @return [Array<KXI::Reflection::StackFrame>] Equivalent array of stack frames
+			def self.callstack(skip = 1)
+				ret = []
+				caller(skip).each do |bt|
+					ret.push(from_backtrace(bt))
+				end
+				return ret
+			end
+			
+			# Parses backtrace line into {KXI::Reflection::StackFrame}
+			# @param bt [String] Backtrace line
+			# @return [KXI::Reflection::StackFrame] Equivalent stack frame
+			def self.from_backtrace(bt)
+				mt = /(?'file'.+?):(?'line'\d+)(:\s*in\s*`(?'context'.+?)')?/.match(bt)
+				StackFrame.new(mt['file'], mt['line'].to_i, mt['context'])
+			end
+		end
+	end
+end

data/lib/kxi/version.rb

@@ -0,0 +1,4 @@
+module KXI
+	# Version of KXI
+  VERSION = '1.0.0'
+end

data/lib/kxi.rb

@@ -0,0 +1,22 @@
+require 'kxi/version'
+require 'kxi/exceptions/abstract_exception'
+require 'kxi/exceptions/collection_exception'
+require 'kxi/exceptions/out_of_range_exception'
+require 'kxi/exceptions/not_implemented_exception'
+require 'kxi/exceptions/argument_exception'
+require 'kxi/exceptions/no_argument_exception'
+require 'kxi/exceptions/verb_expected_exception'
+require 'kxi/exceptions/invalid_type_exception'
+require 'kxi/reflection/stack_frame'
+require 'kxi/collections/enumerator'
+require 'kxi/collections/enumerable'
+require 'kxi/collections/array_collection'
+require 'kxi/collections/hash_collection'
+require 'kxi/collections/protected_collection'
+require 'kxi/cli/argument'
+require 'kxi/cli/explicit_argument'
+require 'kxi/cli/anonymous_argument'
+require 'kxi/cli/flag_argument'
+require 'kxi/cli/named_argument'
+require 'kxi/cli/argument_values'
+require 'kxi/cli/verb'

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: kxi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matyáš Pokorný
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A collection of classes to help with development of Ruby applications
+email:
+- matyaspoko@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/kxi.rb
+- lib/kxi/cli/anonymous_argument.rb
+- lib/kxi/cli/argument.rb
+- lib/kxi/cli/argument_values.rb
+- lib/kxi/cli/explicit_argument.rb
+- lib/kxi/cli/flag_argument.rb
+- lib/kxi/cli/named_argument.rb
+- lib/kxi/cli/verb.rb
+- lib/kxi/collections/array_collection.rb
+- lib/kxi/collections/enumerable.rb
+- lib/kxi/collections/enumerator.rb
+- lib/kxi/collections/hash_collection.rb
+- lib/kxi/collections/protected_collection.rb
+- lib/kxi/exceptions/abstract_exception.rb
+- lib/kxi/exceptions/argument_exception.rb
+- lib/kxi/exceptions/collection_exception.rb
+- lib/kxi/exceptions/invalid_type_exception.rb
+- lib/kxi/exceptions/no_argument_exception.rb
+- lib/kxi/exceptions/not_implemented_exception.rb
+- lib/kxi/exceptions/out_of_range_exception.rb
+- lib/kxi/exceptions/verb_expected_exception.rb
+- lib/kxi/reflection/stack_frame.rb
+- lib/kxi/version.rb
+homepage: https://github.com/cryocz/kxi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Classes for Ruby survival
+test_files: []