kxi 1.0.1 → 1.0.2

data/lib/kxi/application/version_expression.rb

@@ -1,70 +1,95 @@
-# Created by Matyáš Pokorný on 2018-01-27.
-
-module KXI
-	module Application
-		class VersionExpression
-			COMP_EQ  = '='
-			COMP_LEQ = '<='
-			COMP_LT  = '<'
-			COMP_GEQ = '>='
-			COMP_GT  = '>'
-			COMP_AT  = '~>'
-			
-			def comparison
-				@comp
-			end
-			
-			def major
-				@major
-			end
-			
-			def minor
-				@minor
-			end
-			
-			def patch
-				@patch
-			end
-			
-			def initialize(comp, major, minor = nil, patch = nil)
-				@comp   = comp
-				@major  = major
-				@minor  = minor
-				@patch  = patch
-				@target = KXI::Application::Version.new(major, minor == nil ? 0 : minor, patch == nil ? 0 : patch)
-			end
-			
-			# @param ver [KXI::Application::Version]
-			def matches?(ver)
-				case @comp
-					when COMP_EQ
-						return (
-						ver.major == @major and
-							ver.minor == (@minor == nil ? 0 : @minor) and
-							ver.patch == (@patch == nil ? 0 : @patch)
-						)
-					when COMP_AT
-						return (
-						ver.major == @major and
-							(@minor == nil or ver.minor == @minor) and
-							(@patch == nil or ver.patch == @patch)
-						)
-					when COMP_GEQ
-						return ver >= @target
-					when COMP_LEQ
-						return ver <= @target
-					when COMP_GT
-						return ver > @target
-					when COMP_LT
-						return ver < @target
-				end
-			end
-			
-			def self.parse(str)
-				m = /^\s*(?'cm'>|<|>=|<=|=|~>)\s*(?'mj'\d+)\s*(\.\s*(?'mi'\d+))?\s*(\.\s*(?'pt'\d+))?\s*?$/m.match(str)
-				raise(KXI::Exceptions::ParseException.new('version expression', str)) if m == nil
-				return VersionExpression.new(m['cm'], m['mj'].to_i, m['mi']&.to_i, m['pt']&.to_i)
-			end
-		end
-	end
+# Created by Matyáš Pokorný on 2018-01-27.
+
+module KXI
+	module Application
+		# Represents a comparison of two semantic versions
+		class VersionExpression
+			# Equivalence comparison
+			COMP_EQ  = '='
+			# Less than or equivalent to comparison
+			COMP_LEQ = '<='
+			# Less than comparison
+			COMP_LT  = '<'
+			# Grater than or equivalent to comparison
+			COMP_GEQ = '>='
+			# Grater than comparison
+			COMP_GT  = '>'
+			# Minimal requirement comparison
+			COMP_AT  = '~>'
+			
+			# Get the comparison of versions
+			# @return [string] Comparison of versions
+			def comparison
+				@comp
+			end
+			
+			# Gets the major number of left-side version
+			# @return [int] Major number version
+			def major
+				@major
+			end
+			
+			# Gets the minor number of left-side version
+			# @return [int,nil] Minor number version
+			def minor
+				@minor
+			end
+			
+			# Gets the patch number of left-side version
+			# @return [int,nil] Patch number version
+			def patch
+				@patch
+			end
+			
+			# Instantiates the {KXI::Application::VersionExpression} class
+			# @param [string] comp Comparison rule of expression
+			# @param [int] major Major number of left-side version
+			# @param [int,nil] minor Minor number of left-side version
+			# @param [int,nil] patch Patch number of left-side version
+			def initialize(comp, major, minor = nil, patch = nil)
+				@comp   = comp
+				@major  = major
+				@minor  = minor
+				@patch  = patch
+				@target = KXI::Application::Version.new(major, minor == nil ? 0 : minor, patch == nil ? 0 : patch)
+			end
+			
+			# Checks whether expression is true for given version
+			# @param ver [KXI::Application::Version] Right-side version of expression
+			# @return [bool] True if expression is valid; otherwise false
+			def matches?(ver)
+				case @comp
+					when COMP_EQ
+						return (
+						ver.major == @major and
+							ver.minor == (@minor == nil ? 0 : @minor) and
+							ver.patch == (@patch == nil ? 0 : @patch)
+						)
+					when COMP_AT
+						return (
+						ver.major == @major and
+							(@minor == nil or ver.minor == @minor) and
+							(@patch == nil or ver.patch == @patch)
+						)
+					when COMP_GEQ
+						return ver >= @target
+					when COMP_LEQ
+						return ver <= @target
+					when COMP_GT
+						return ver > @target
+					when COMP_LT
+						return ver < @target
+				end
+			end
+			
+			# Parses a version expression from its string form
+			# @param [string] str String representation of version expression
+			# @return [KXI::Application::VersionExpression] Version expression equivalent to given string
+			def self.parse(str)
+				m = /^\s*(?'cm'>|<|>=|<=|=|~>)\s*(?'mj'\d+)\s*(\.\s*(?'mi'\d+))?\s*(\.\s*(?'pt'\d+))?\s*?$/m.match(str)
+				raise(KXI::Exceptions::ParseException.new('version expression', str)) if m == nil
+				return VersionExpression.new(m['cm'], m['mj'].to_i, m['mi']&.to_i, m['pt']&.to_i)
+			end
+		end
+	end
 end

data/lib/kxi/application/workspace.rb

@@ -0,0 +1,105 @@
+# Created by Matyáš Pokorný on 2018-03-23.
+
+module KXI
+	module Application
+		# Represents a workspace (directory)
+		class Workspace
+			# Instantiates the {KXI::Application::Workspace} class
+			# @param path [String] Path to workspace
+			# @param mk [Bool] True if workspace should be created; otherwise false
+			def initialize(path, mk = false)
+				@path = File.expand_path(path)
+				validate
+				make if mk
+			end
+			
+			# Gets path relative to this workspace
+			# @param path [String] Parts of path
+			# @return [String] The combined path
+			def path(*path)
+				return @path if path.length == 0
+				return File.expand_path(File.join(@path, *path))
+			end
+			
+			# Obtains the parent of this workspace, if it exists
+			# @return [KXI::Application::Workspace, nil] Parent workspace if any; nil otherwise
+			def parent
+				dir = File.dirname(@path)
+				return nil if KXI::Platform.this.path_case_sensitive? ? dir == @path : dir.downcase == @path.downcase
+				return KXI::Application::Workspace.new(dir)
+			end
+			
+			# Checks if workspace physically exists in the file system
+			# @return [Bool] True if workspace exists; false otherwise
+			def made?
+				validate
+				return Dir.exists?(@path)
+			end
+			
+			# Creates the workspace, if it doesn't exist
+			def make
+				validate
+				return if made?
+				p = parent
+				p.make unless parent == nil
+				Dir.mkdir(@path)
+			end
+			
+			# Gets a child workspace
+			# @param [String] path Path to child workspace
+			# @return [KXI::Application::Workspace] Child workspace
+			def inner(*path)
+				return KXI::Application::Workspace.new(path(*path))
+			end
+			
+			# Opens a file withing the workspace
+			# @overload open(mode, *path)
+			# 	@param mode [String] IO mode to open the file with
+			# 	@param path [String] Path to desired file
+			# 	@return [IO] File handle
+			# @overload open(mode, *path)
+			# 	@param mode [String] IO mode to open the file with
+			# 	@param path [String] Path to desired file
+			# 	@yield [handle] Block where file is used
+			# 	@yieldparam handle [IO] Handle of block
+			def open(mode, *path)
+				h = File.open(path(*path), mode)
+				return h unless block_given?
+				begin
+					yield(h)
+				ensure
+					h.flush
+					h.close
+				end
+			end
+			
+			# Preforms lookup of files (glob)
+			# @param ptt [String, nil] Pattern for searching, returns all files if nil
+			# @param rec [Bool] Determines weather search is recursive
+			# @return [Array<String>] Found files
+			def files(ptt = nil, rec = true)
+				ptt = '*' if ptt == nil
+				ptt = File.join('**', ptt) if rec
+				return Dir.glob(path(ptt), File::FNM_DOTMATCH).select { |i| File.exists?(i) and not File.directory?(i) }.collect { |i| File.expand_path(i) }
+			end
+			
+			# Preforms lookup of directories (glob)
+			# @param ptt [String, nil] Pattern for searching, returns all directories if nil
+			# @param rec [Bool] Determines weather search is recursive
+			# @return [Array<String>] Found directories
+			def dirs(ptt = nil, rec = true)
+				ptt = '*' if ptt == nil
+				ptt = File.join('**', ptt) if rec
+				return Dir.glob(path(ptt), File::FNM_DOTMATCH).select { |i| File.exists?(i) and File.directory?(i) }.collect { |i| File.expand_path(i) }
+			end
+			
+			# Validates path of workspace
+			# @raise [KXI::Exceptions::WorkspaceCollisionException] If workspace path is used by file
+			def validate
+				raise(KXI::Exceptions::WorkspaceCollisionException.new(@path)) if File.exists?(@path) and not File.directory?(@path)
+			end
+			
+			private :validate
+		end
+	end
+end

data/lib/kxi/cli/anonymous_argument.rb

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

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