libpath-ruby 0.2.1

data/lib/libpath/diagnostics.rb

@@ -0,0 +1,6 @@
+
+require 'libpath/diagnostics/parameter_checking'
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/diagnostics/parameter_checking.rb

@@ -0,0 +1,46 @@
+
+module LibPath # :nodoc:
+module Diagnostics # :nodoc:
+
+	# @!visibility private
+	def self.check_string_parameter param_value, param_name, **options # :nodoc:
+
+		case param_value
+		when nil
+
+			unless options[:allow_nil]
+
+				raise ::ArgumentError, "parameter '#{param_name}' may not be nil"
+			end
+
+			;
+		when ::String
+
+			;
+		else
+
+			unless param_value.respond_to?(:to_str)
+
+				raise ::TypeError, "parameter '#{param_name}' must be instance of #{::String} or respond to #to_str()"
+			end
+		end
+	end
+
+	# @!visibility private
+	def self.check_options h, *args, **options # :nodoc:
+
+		if known = options[:known] then
+
+			h.each_key do |k|
+
+				raise ::ArgumentError, "unknown key '#{k}'" unless known.include?(k)
+			end
+		end
+
+	end
+end # module Diagnostics
+end # module LibPath
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/exceptions.rb

@@ -0,0 +1,7 @@
+
+require 'libpath/excdeptions/libpath_base_exception'
+require 'libpath/excdeptions/malformed_name_exception'
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/exceptions/libpath_base_exception.rb

@@ -0,0 +1,77 @@
+
+# ######################################################################## #
+# File:         libpath/exceptions/libpath_base_exception.rb
+#
+# Purpose:      LibPathBaseException class
+#
+# Created:      30th January 2019
+# Updated:      16th April 2019
+#
+# Home:         http://github.com/synesissoftware/libpath.Ruby
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2019, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# * Neither the names of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+
+=begin
+=end
+
+module LibPath # :nodoc:
+module Exceptions # :nodoc:
+
+# Root exception for all LibPath exceptions
+#
+# NOTE: this class is abstract
+class LibPathBaseException < StandardError
+
+=begin
+
+	# TODO include Xqsr3's WithCause
+=end
+
+	def self.new *args
+
+		raise NoMethodError, "private method `new' called for #{self}:Class" if self == LibPathBaseException
+
+		super
+	end
+end
+
+end # module Exceptions
+end # module LibPath
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/exceptions/malformed_name_exception.rb

@@ -0,0 +1,85 @@
+
+# ######################################################################## #
+# File:         libpath/exceptions/malformed_name_exception.rb
+#
+# Purpose:      MalformedNameException class
+#
+# Created:      30th January 2019
+# Updated:      16th April 2019
+#
+# Home:         http://github.com/synesissoftware/libpath.Ruby
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2019, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# * Neither the names of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+
+=begin
+=end
+
+require 'libpath/exceptions/libpath_base_exception'
+
+module LibPath # :nodoc:
+module Exceptions # :nodoc:
+
+# Exception thrown when a malformed name is encountered
+class MalformedNameException < LibPathBaseException
+
+	# Initialises an instance from the given +name+ and optional +message+
+	#
+	# * *Parameters:*
+	#   - +name+ (String) The name that is malformed
+	#   - +message+ (String) {optional} The message. If +nil+ the message "malformed name '#{name}'" is used
+	def initialize name, message = nil
+
+		unless message
+
+			message = "malformed name '#{name}'"
+		end
+
+		super message
+
+		@name	=	name
+	end
+
+	# (String) The name that is malformed
+	attr_reader :name
+end
+
+end # module Exceptions
+end # module LibPath
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/form.rb

@@ -0,0 +1,42 @@
+
+require 'libpath/internal_/platform'
+
+if ::LibPath::Internal_::Platform::Constants::PLATFORM_IS_WINDOWS then
+
+	require 'libpath/form/windows'
+else
+
+	require 'libpath/form/unix'
+end
+
+module LibPath # :nodoc:
+module Form # :nodoc:
+
+	if ::LibPath::Internal_::Platform::Constants::PLATFORM_IS_WINDOWS then
+
+		extend ::LibPath::Form::Windows
+		include ::LibPath::Form::Windows
+	else
+
+		extend ::LibPath::Form::Unix
+		include ::LibPath::Form::Unix
+	end
+
+	# @!visibility private
+	def self.extended receiver # :nodoc:
+
+		$stderr.puts "#{receiver} extended by #{self}" if $DEBUG
+	end
+
+	# @!visibility private
+	def self.included receiver # :nodoc:
+
+		$stderr.puts "#{receiver} included #{self}" if $DEBUG
+	end
+
+end # module Form
+end # module LibPath
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/form/unix.rb

@@ -0,0 +1,215 @@
+
+# ######################################################################## #
+# File:         libpath/form/unix.rb
+#
+# Purpose:      LibPath::Form::Unix module
+#
+# Created:      8th January 2019
+# Updated:      16th April 2019
+#
+# Home:         http://github.com/synesissoftware/libpath.Ruby
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2019, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# * Neither the names of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+
+=begin
+=end
+
+require 'libpath/constants/unix'
+require 'libpath/diagnostics'
+
+module LibPath # :nodoc:
+module Form # :nodoc:
+module Unix # :nodoc:
+
+# Module defining instance functions that will be included and extended into
+# any class or module including/extending module LibPath::Form::Unix
+module LibPath_Form_Unix_Methods
+
+	# Classifies a path
+	#
+	# === Return
+	#
+	# One of +:absolute+, +:homed+, +:relative+, for
+	# any paths that match precisely those classifications, or +nil+ if the
+	# path is empty
+	def classify_path path
+
+		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+
+		return nil if path.nil? || path.empty?
+
+		return :homed if path_is_homed? path
+
+		return :absolute if path_is_absolute? path
+
+		:relative
+	end
+
+	# Evaluates whether the given name is malformed
+	#
+	# === Signature
+	#
+	# * *Options:*
+	#  - +:reject_path_name_separators+:: (boolean) Reject the path
+	#     separator character(s): +'/'+
+	#  - +:reject_path_separators+:: (boolean) Reject the path separator
+	#     character(s): +':'+
+	#  - +:reject_shell_characters+:: (boolean) Reject the shell
+	#     character(s): +'*'+, +'?'+, +'|'+
+	def name_is_malformed? name, **options
+
+		_Constants	=	::LibPath::Constants::Unix
+
+		if name
+
+			if options[:reject_path_name_separators]
+
+				return true if name =~ _Constants::InvalidCharacters::PathNameSeparators::RE
+			end
+
+			if options[:reject_path_separators]
+
+				return true if name =~ _Constants::InvalidCharacters::PathSeparators::RE
+			end
+
+			if options[:reject_shell_characters]
+
+				return true if name =~ _Constants::InvalidCharacters::Shell::RE
+			end
+
+			return true if name =~ _Constants::InvalidCharacters::Innate::RE
+
+			false
+		else
+
+			true
+		end
+	end
+
+	# Evaluates whether the given path is absolute, which means it is either
+	# rooted (begins with '/') or is homed (is '~' or begins with '~/')
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +path+:: (String) The path to be evaluated. May not be +nil+
+	def path_is_absolute? path
+
+		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+
+		case path[0]
+		when '/'
+
+			true
+		when '~'
+
+			1 == path.size || '/' == path[1]
+		else
+
+			false
+		end
+	end
+
+	# Evaluates whether the given path is homed, which means it is '~' or
+	# begins with '~/'
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +path+:: (String) The path to be evaluated. May not be +nil+
+	def path_is_homed? path
+
+		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+
+		return false unless '~' == path[0]
+
+		if path.size > 1
+
+			return '/' == path[1]
+		end
+
+		true
+	end
+
+	# Evalutes whether the given path is rooted, which means it begins with
+	# '/'
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +path+:: (String) The path to be evaluated. May not be +nil+
+	def path_is_rooted? path
+
+		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+
+		'/' == path[0]
+	end
+
+end # module LibPath_Form_Unix_Methods
+
+# @!visibility private
+def self.extended receiver # :nodoc:
+
+	receiver.class_eval do
+
+		extend LibPath_Form_Unix_Methods
+	end
+
+	$stderr.puts "#{receiver} extended by #{LibPath_Form_Unix_Methods}" if $DEBUG
+end
+
+# @!visibility private
+def self.included receiver # :nodoc:
+
+	receiver.class_eval do
+
+		include LibPath_Form_Unix_Methods
+	end
+
+	$stderr.puts "#{receiver} included #{LibPath_Form_Unix_Methods}" if $DEBUG
+end
+
+extend LibPath_Form_Unix_Methods
+include LibPath_Form_Unix_Methods
+
+end # module Unix
+end # module Form
+end # module LibPath
+
+# ############################## end of file ############################# #
+
+