libpath-ruby 0.2.2 → 0.2.2.2

data/lib/libpath/util/unix.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         libpath/util/unix.rb
+# File:     libpath/util/unix.rb
 #
-# Purpose:      LibPath::Util::Unix module
+# Purpose:  LibPath::Util::Unix module
 #
-# Created:      14th January 2019
-# Updated:      16th April 2019
+# Created:  14th January 2019
+# Updated:  7th April 2024
 #
-# Home:         http://github.com/synesissoftware/libpath.Ruby
+# Home:     http://github.com/synesissoftware/libpath.Ruby
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -44,371 +45,370 @@
 # ######################################################################## #
 
 
-
 =begin
 =end
 
-
 require 'libpath/diagnostics'
 require 'libpath/form/unix'
 require 'libpath/internal_/array'
 require 'libpath/internal_/unix/form'
 
-module LibPath # :nodoc:
-module Util # :nodoc:
-module Unix # :nodoc:
 
-# Module defining instance functions that will be included and extended into
-# any class or module including/extending module LibPath::Util::Unix
-module LibPath_Util_Unix_Methods
+module LibPath
+module Util
+module Unix
+
+  # Module defining instance functions that will be included and extended into
+  # any class or module including/extending module LibPath::Util::Unix
+  module LibPath_Util_Unix_Methods
 
-	# Combines a number of path parts into a single path, ignoring any parts
-	# that are preceded by an absolute part
-	#
-	# NOTE: The behaviour of this method is undefined if any of the parts
-	# are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
-	def combine_paths *args, **options
+    # Combines a number of path parts into a single path, ignoring any parts
+    # that are preceded by an absolute part
+    #
+    # NOTE: The behaviour of this method is undefined if any of the parts
+    # are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
+    def combine_paths *args, **options
 
-		_Form_Unix			=	Form::Unix
-		_Internal_Unix_Form	=	Internal_::Unix::Form
+      _Form_Unix          = Form::Unix
+      _Internal_Unix_Form = Internal_::Unix::Form
 
-		args.each_with_index { |arg, index| Diagnostics.check_string_parameter(arg, "arg#{index}", allow_nil: true) } if $DEBUG
+      args.each_with_index { |arg, index| Diagnostics.check_string_parameter(arg, "arg#{index}", allow_nil: true) } if $DEBUG
 
-		if options[:elide_single_dots]
+      if options[:elide_single_dots]
 
-			args	=	args.map do |arg|
+        args = args.map do |arg|
 
-				case arg
-				when '.', './'
+          case arg
+          when '.', './'
 
-					nil
-				else
+            nil
+          else
 
-					arg
-				end
-			end
-		end
+            arg
+          end
+        end
+      end
 
-		args	=	args.reject { |arg| arg.nil? || arg.empty? }
+      args = args.reject { |arg| arg.nil? || arg.empty? }
 
-		case args.size
-		when 0
+      case args.size
+      when 0
 
-			''
-		when 1
+        ''
+      when 1
 
-			args[0]
-		else
+        args[0]
+      else
 
-			rix	=	args.rindex { |arg| arg && _Form_Unix.path_is_absolute?(arg) }
-			rix	||=	0
+        rix =   args.rindex { |arg| arg && _Form_Unix.path_is_absolute?(arg) }
+        rix ||= 0
 
-			els	=	args[rix..-1]
+        els = args[rix..-1]
 
-			File.join(*els)
-		end
-	end
+        File.join(*els)
+      end
+    end
 
-	# Obtains the form of the given +path+ relative to the given +origin+
-	#
-	# NOTE: The behaviour of this method is undefined if any of the parts
-	# are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
-	#
-	# === Signature
-	#
-	# * *Options:*
-	#  +:home+:: (String)
-	#  +:locator+:: (boolean)
-	#  +:pwd+:: (String)
-	def derive_relative_path origin, path, **options
+    # Obtains the form of the given +path+ relative to the given +origin+
+    #
+    # NOTE: The behaviour of this method is undefined if any of the parts
+    # are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
+    #
+    # === Signature
+    #
+    # * *Options:*
+    #  +:home+:: (String)
+    #  +:locator+:: (boolean)
+    #  +:pwd+:: (String)
+    def derive_relative_path origin, path, **options
 
-		return path if origin.nil? || origin.empty?
-		return path if path.nil? || path.empty?
+      return path if origin.nil? || origin.empty?
+      return path if path.nil? || path.empty?
 
-		_Form_Unix			=	Form::Unix
-		_Util_Unix			=	Util::Unix
-		_Internal_Unix_Form	=	Internal_::Unix::Form
+      _Form_Unix          = Form::Unix
+      _Util_Unix          = Util::Unix
+      _Internal_Unix_Form = Internal_::Unix::Form
 
-		_MPA_COMMON_OPTIONS	=	%i{ home locator pwd }
+      _MPA_COMMON_OPTIONS = %i{ home locator pwd }
 
-		tr_sl	=	_Internal_Unix_Form.get_trailing_slash(path)
+      tr_sl   = _Internal_Unix_Form.get_trailing_slash(path)
 
-		origin	=	_Util_Unix.make_path_canonical(origin)
-		path	=	_Util_Unix.make_path_canonical(path)
+      origin  = _Util_Unix.make_path_canonical(origin)
+      path    = _Util_Unix.make_path_canonical(path)
 
-		return '.' + tr_sl.to_s if origin == path
-		return path if '.' == origin || './' == origin
+      return '.' + tr_sl.to_s if origin == path
+      return path if '.' == origin || './' == origin
 
-		o_is_abs	=	_Form_Unix.path_is_absolute?(origin)
-		p_is_abs	=	_Form_Unix.path_is_absolute?(path)
+      o_is_abs = _Form_Unix.path_is_absolute?(origin)
+      p_is_abs = _Form_Unix.path_is_absolute?(path)
 
-		if o_is_abs != p_is_abs || './' == path
+      if o_is_abs != p_is_abs || './' == path
 
-			origin	=	_Util_Unix.make_path_absolute(origin, make_canonical: true, **options.select { |k| _MPA_COMMON_OPTIONS.include?(k) })
-			path	=	_Util_Unix.make_path_absolute(path, make_canonical: true, **options.select { |k| _MPA_COMMON_OPTIONS.include?(k) })
-		end
+        origin  = _Util_Unix.make_path_absolute(origin, make_canonical: true, **options.select { |k| _MPA_COMMON_OPTIONS.include?(k) })
+        path    = _Util_Unix.make_path_absolute(path, make_canonical: true, **options.select { |k| _MPA_COMMON_OPTIONS.include?(k) })
+      end
 
-		origin	=	_Internal_Unix_Form.trim_trailing_slash(origin) unless origin.size < 2
-		path	=	_Internal_Unix_Form.trim_trailing_slash(path) if tr_sl && path.size > 1
+      origin  = _Internal_Unix_Form.trim_trailing_slash(origin) unless origin.size < 2
+      path    = _Internal_Unix_Form.trim_trailing_slash(path) if tr_sl && path.size > 1
 
 
-		_, _, _, o3_basename, _, _, o6_parts, _	=	_Internal_Unix_Form.split_path(origin)
-		_, _, _, p3_basename, _, _, p6_parts, _	=	_Internal_Unix_Form.split_path(path)
+      _, _, _, o3_basename, _, _, o6_parts, _ = _Internal_Unix_Form.split_path(origin)
+      _, _, _, p3_basename, _, _, p6_parts, _ = _Internal_Unix_Form.split_path(path)
 
-		o_parts	=	o6_parts
-		o_parts	<<	o3_basename if o3_basename && '.' != o3_basename
+      o_parts =   o6_parts
+      o_parts <<  o3_basename if o3_basename && '.' != o3_basename
 
-		p_parts	=	p6_parts
-		p_parts	<<	p3_basename if p3_basename && '.' != p3_basename
+      p_parts =   p6_parts
+      p_parts <<  p3_basename if p3_basename && '.' != p3_basename
 
 
-		while true
+      while true
 
-			break if o_parts.empty?
-			break if p_parts.empty?
+        break if o_parts.empty?
+        break if p_parts.empty?
 
-			o_part	=	o_parts[0]
-			p_part	=	p_parts[0]
+        o_part = o_parts[0]
+        p_part = p_parts[0]
 
-			if 1 == o_parts.size || 1 == p_parts.size
+        if 1 == o_parts.size || 1 == p_parts.size
 
-				o_part	=	_Internal_Unix_Form.append_trailing_slash o_part
-				p_part	=	_Internal_Unix_Form.append_trailing_slash p_part
-			end
+          o_part = _Internal_Unix_Form.append_trailing_slash o_part
+          p_part = _Internal_Unix_Form.append_trailing_slash p_part
+        end
 
-			if o_part == p_part
+        if o_part == p_part
 
-				o_parts.shift
-				p_parts.shift
-			else
+          o_parts.shift
+          p_parts.shift
+        else
 
-				break
-			end
-		end
+          break
+        end
+      end
 
 
-		return '.' + tr_sl.to_s if 0 == (o_parts.size + p_parts.size)
+      return '.' + tr_sl.to_s if 0 == (o_parts.size + p_parts.size)
 
-		return o_parts.map { |rp| '..' }.join('/') + (tr_sl || (o_parts.size != 0 ? '/' : nil)).to_s if p_parts.empty?
+      return o_parts.map { |rp| '..' }.join('/') + (tr_sl || (o_parts.size != 0 ? '/' : nil)).to_s if p_parts.empty?
 
 
-		ar		=	[ '..' ] * o_parts.size + p_parts
-		last	=	ar.pop
-		ar		=	ar.map { |el| _Internal_Unix_Form.append_trailing_slash(el) }
+      ar    = [ '..' ] * o_parts.size + p_parts
+      last  = ar.pop
+      ar    = ar.map { |el| _Internal_Unix_Form.append_trailing_slash(el) }
 
-		ar.join + last.to_s + tr_sl.to_s
-	end
+      ar.join + last.to_s + tr_sl.to_s
+    end
 
-	# Returns a "compare path" for the given absolute path
-	#
-	# A compare path is one that would refer definitely to a given entry,
-	# regardless of such operating system-specific issues such as
-	# case-insensitivity
-	#
-	# NOTE: the function does not make +path+ absolute. That is up to the
-	# caller if required
-	#
-	# NOTE: The behaviour of this method is undefined if any of the parts
-	# are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#  - +path+:: (String) The path whose definitive equivalent is to be
-	#     obtained
-	#  - +options+:: (Hash) options
-	#
-	# * *Options:*
-	#  For reasons of compatibility (with the Windows version) no options
-	#  are currently supported; none are proscribed.
-	def make_compare_path path, **options
+    # Returns a "compare path" for the given absolute path
+    #
+    # A compare path is one that would refer definitely to a given entry,
+    # regardless of such operating system-specific issues such as
+    # case-insensitivity
+    #
+    # NOTE: the function does not make +path+ absolute. That is up to the
+    # caller if required
+    #
+    # NOTE: The behaviour of this method is undefined if any of the parts
+    # are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #  - +path+:: (String) The path whose definitive equivalent is to be
+    #     obtained
+    #  - +options+:: (Hash) options
+    #
+    # * *Options:*
+    #  For reasons of compatibility (with the Windows version) no options
+    #  are currently supported; none are proscribed.
+    def make_compare_path path, **options
 
-		path
-	end
+      path
+    end
 
-	#
-	# NOTE: The behaviour of this method is undefined if any of the parts
-	# are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +path+:: (String) The path to be evaluated. May not be +nil+
-	#   - +options+:: (Hash) Options that moderate the behaviour of the
-	#       function
-	#
-	# * *Options:*
-	#   - +:home+:: (String) A specific home to assume, which means that the
-	#       +locator+'s +home+ method will not be invoked
-	#   - +:locator+:: (object) An object that provides the methods
-	#       +pwd+ and +home+, as needed. This allows for mocking. If not
-	#       given, then the functions +Dir::pwd+ and +Dir::home+ are used
-	#   - +:make_canonical+:: (boolean) Determines whether canonicalisation
-	#       is conducted on the result
-	#   - +:pwd+:: (String) A specific directory to assume, which means that
-	#       the +locator+'s +pwd+ method will not be invoked
-	def make_path_absolute path, **options
+    #
+    # NOTE: The behaviour of this method is undefined if any of the parts
+    # are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +path+:: (String) The path to be evaluated. May not be +nil+
+    #   - +options+:: (Hash) Options that moderate the behaviour of the
+    #       function
+    #
+    # * *Options:*
+    #   - +:home+:: (String) A specific home to assume, which means that the
+    #       +locator+'s +home+ method will not be invoked
+    #   - +:locator+:: (object) An object that provides the methods
+    #       +pwd+ and +home+, as needed. This allows for mocking. If not
+    #       given, then the functions +Dir::pwd+ and +Dir::home+ are used
+    #   - +:make_canonical+:: (boolean) Determines whether canonicalisation
+    #       is conducted on the result
+    #   - +:pwd+:: (String) A specific directory to assume, which means that
+    #       the +locator+'s +pwd+ method will not be invoked
+    def make_path_absolute path, **options
 
-		Diagnostics.check_string_parameter(path, "path") if $DEBUG
-		Diagnostics.check_options(options, known: %i{ home locator make_canonical pwd }) if $DEBUG
+      Diagnostics.check_string_parameter(path, "path") if $DEBUG
+      Diagnostics.check_options(options, known: %i{ home locator make_canonical pwd }) if $DEBUG
 
-		return path if path.nil? || path.empty?
+      return path if path.nil? || path.empty?
 
-		r	=	nil
+      r = nil
 
-		case path[0]
-		when '/'
+      case path[0]
+      when '/'
 
-			r = path
-		when '~'
+        r = path
+      when '~'
 
-			case path[1]
-			when nil, '/'
+        case path[1]
+        when nil, '/'
 
-				home	=	nil
-				home	||=	options[:home]
-				home	||=	options[:locator].home if options.has_key?(:locator)
-				home	||=	Dir.home
+          home  =   nil
+          home  ||= options[:home]
+          home  ||= options[:locator].home if options.has_key?(:locator)
+          home  ||= Dir.home
 
-				r = File.join(home, path[2..-1].to_s)
-			end
-		end
+          r = File.join(home, path[2..-1].to_s)
+        end
+      end
 
-		unless r
+      unless r
 
-			pwd	=	nil
-			pwd	||=	options[:pwd]
-			pwd	||=	options[:locator].pwd if options.has_key?(:locator)
-			pwd	||=	Dir.pwd
+        pwd =   nil
+        pwd ||= options[:pwd]
+        pwd ||= options[:locator].pwd if options.has_key?(:locator)
+        pwd ||= Dir.pwd
 
-			r = File.join(pwd, path)
-		end
+        r = File.join(pwd, path)
+      end
 
-		r	||=	path
+      r ||= path
 
-		r	=	make_path_canonical r if options[:make_canonical]
+      r = make_path_canonical r if options[:make_canonical]
 
-		return r
-	end
+      return r
+    end
 
-	# Converts a path into canonical form, which is to say that all possible
-	# dots directory parts are removed:
-	#
-	# - single-dot (trailing) parts - '???/.' are converted to '???/' (where
-	#    ??? represents 0+ other characters);
-	# - single-dot parts - './' - are all removed
-	# - double-dot parts - '../' - are removed where they follow a non-dots
-	#    directory part, or where they follow the root
-	#
-	# NOTE: The behaviour of this method is undefined if any of the parts
-	# are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +path+:: (String) The path to be evaluated. May not be +nil+
-	def make_path_canonical path, **options
+    # Converts a path into canonical form, which is to say that all possible
+    # dots directory parts are removed:
+    #
+    # - single-dot (trailing) parts - '???/.' are converted to '???/' (where
+    #    ??? represents 0+ other characters);
+    # - single-dot parts - './' - are all removed
+    # - double-dot parts - '../' - are removed where they follow a non-dots
+    #    directory part, or where they follow the root
+    #
+    # NOTE: The behaviour of this method is undefined if any of the parts
+    # are malformed. See +::LibPath::Form::Windows::name_is_malformed?+
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +path+:: (String) The path to be evaluated. May not be +nil+
+    def make_path_canonical path, **options
 
-		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+      Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-		return path unless '.' == path[-1] || path.include?('./') || path.include?('//')
+      return path unless '.' == path[-1] || path.include?('./') || path.include?('//')
 
-		_Form	=	::LibPath::Internal_::Unix::Form
-		_Array	=	::LibPath::Internal_::Array
+      _Form   = ::LibPath::Internal_::Unix::Form
+      _Array  = ::LibPath::Internal_::Array
 
-		path	=	path[0...-1] if '.' == path[-1] && '/' == path[-2]
+      path = path[0...-1] if '.' == path[-1] && '/' == path[-2]
 
 
-		f0_path, _, f2_dir, f3_basename, _, _, f6_dir_parts, _ = _Form.split_path path
+      f0_path, _, f2_dir, f3_basename, _, _, f6_dir_parts, _ = _Form.split_path path
 
-		if f6_dir_parts.empty?
+      if f6_dir_parts.empty?
 
-			case f3_basename
-			when '.'
+        case f3_basename
+        when '.'
 
-				return './'
-			when '..'
+          return './'
+        when '..'
 
-				return '../'
-			else
+          return '../'
+        else
 
-				return f0_path
-			end
-		end
+          return f0_path
+        end
+      end
 
-		case f3_basename
-		when '.', '..'
+      case f3_basename
+      when '.', '..'
 
-			f6_dir_parts	<<	f3_basename + '/'
-			basename		=	nil
-		else
+        f6_dir_parts  <<  f3_basename + '/'
+        basename      =   nil
+      else
 
-			basename		=	f3_basename
-		end
+        basename = f3_basename
+      end
 
-		is_rooted	=	'/' == f2_dir[0]
+      is_rooted = '/' == f2_dir[0]
 
-		new_parts	=	f6_dir_parts.dup
-		new_parts.reject! { |p| './' == p }
-		ix_nodots	=	new_parts.index { |p| '../' != p } || new_parts.size
-		ix_2dots	=	_Array.index(new_parts, '../', ix_nodots)
+      new_parts = f6_dir_parts.dup
+      new_parts.reject! { |p| './' == p }
+      ix_nodots = new_parts.index { |p| '../' != p } || new_parts.size
+      ix_2dots  = _Array.index(new_parts, '../', ix_nodots)
 
-		return "#{new_parts.join}#{basename}" unless new_parts.size != f6_dir_parts.size || ix_2dots
+      return "#{new_parts.join}#{basename}" unless new_parts.size != f6_dir_parts.size || ix_2dots
 
-		while (ix_2dots || 0) > 0
+      while (ix_2dots || 0) > 0
 
-			new_parts.delete_at(ix_2dots - 0)
-			new_parts.delete_at(ix_2dots - 1) if ix_2dots != 1 || !is_rooted
+        new_parts.delete_at(ix_2dots - 0)
+        new_parts.delete_at(ix_2dots - 1) if ix_2dots != 1 || !is_rooted
 
-			ix_nodots	=	new_parts.index { |p| '../' != p } or break
-			ix_2dots	=	_Array.index(new_parts, '../', ix_nodots)
-		end
+        ix_nodots = new_parts.index { |p| '../' != p } or break
+        ix_2dots  = _Array.index(new_parts, '../', ix_nodots)
+      end
 
-		if new_parts.empty? && (basename || '').empty?
+      if new_parts.empty? && (basename || '').empty?
 
-			case f3_basename
-			when nil, '.', '..'
+        case f3_basename
+        when nil, '.', '..'
 
-				return './'
-			else
+          return './'
+        else
 
-				return '.'
-			end
-		end
+          return '.'
+        end
+      end
 
-		return new_parts.join('') + basename.to_s
-	end
-end # module LibPath_Util_Unix_Methods
+      return new_parts.join('') + basename.to_s
+    end
+  end # module LibPath_Util_Unix_Methods
 
-# @!visibility private
-def self.extended receiver # :nodoc:
+  # @!visibility private
+  def self.extended receiver # :nodoc:
 
-	receiver.class_eval do
+    receiver.class_eval do
 
-		extend LibPath_Util_Unix_Methods
-	end
+      extend LibPath_Util_Unix_Methods
+    end
 
-	$stderr.puts "#{receiver} extended by #{LibPath_Util_Unix_Methods}" if $DEBUG
-end
+    $stderr.puts "#{receiver} extended by #{LibPath_Util_Unix_Methods}" if $DEBUG
+  end
 
-# @!visibility private
-def self.included receiver # :nodoc:
+  # @!visibility private
+  def self.included receiver # :nodoc:
 
-	receiver.class_eval do
+    receiver.class_eval do
 
-		include LibPath_Util_Unix_Methods
-	end
+      include LibPath_Util_Unix_Methods
+    end
 
-	$stderr.puts "#{receiver} included #{LibPath_Util_Unix_Methods}" if $DEBUG
-end
+    $stderr.puts "#{receiver} included #{LibPath_Util_Unix_Methods}" if $DEBUG
+  end
 
-extend LibPath_Util_Unix_Methods
-include LibPath_Util_Unix_Methods
+  extend LibPath_Util_Unix_Methods
+  include LibPath_Util_Unix_Methods
 
 end # module Unix
 end # module Util
 end # module LibPath
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #