libpath-ruby 0.2.1 → 0.2.2.1

data/lib/libpath/form/windows.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         libpath/form/windows.rb
+# File:     libpath/form/windows.rb
 #
-# Purpose:      LibPath::Form::Windows module
+# Purpose:  LibPath::Form::Windows module
 #
-# Created:      8th January 2019
-# Updated:      16th April 2019
+# Created:  8th January 2019
+# Updated:  6th 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,7 +45,6 @@
 # ######################################################################## #
 
 
-
 =begin
 =end
 
@@ -53,6 +53,7 @@ require 'libpath/diagnostics'
 require 'libpath/internal_/windows/drive'
 require 'libpath/internal_/windows/form'
 
+
 module LibPath # :nodoc:
 module Form # :nodoc:
 module Windows # :nodoc:
@@ -61,289 +62,289 @@ module Windows # :nodoc:
 # any class or module including/extending module LibPath::Form::Windows
 module LibPath_Form_Windows_Methods
 
-	# Classifies a path
-	#
-	# === Return
-	#
-	# One of +:absolute+, +:drived+, +:homed+, +:relative+, +:rooted+, for
-	# any paths that match precisely those classifications, or +nil+ if the
-	# path is empty
-	def classify_path path
+  # Classifies a path
+  #
+  # === Return
+  #
+  # One of +:absolute+, +:drived+, +:homed+, +:relative+, +:rooted+, 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
+    Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-		return nil if path.nil? || path.empty?
+    return nil if path.nil? || path.empty?
 
-		return :homed if path_is_homed? path
+    return :homed if path_is_homed? path
 
-		vol, rem, _ = Internal_::Windows::Form.get_windows_volume(path)
+    vol, rem, _ = Internal_::Windows::Form.get_windows_volume(path)
 
-		rooted	=	Internal_::Windows::Form.char_is_path_name_separator? rem[0]
+    rooted = Internal_::Windows::Form.char_is_path_name_separator? rem[0]
 
-		if rooted
+    if rooted
 
-			if vol
+      if vol
 
-				return :absolute
-			else
+        return :absolute
+      else
 
-				return :rooted
-			end
-		else
+        return :rooted
+      end
+    else
 
-			if vol
+      if vol
 
-				return :drived
-			else
+        return :drived
+      else
 
-				return :relative
-			end
-		end
+        return :relative
+      end
+    end
 
-	end
+  end
 
-	# Evaluates whether the given name is malformed, according to the given
-	# options.
-	#
-	# If no options are specified, the only invalid character(s) are: +'\0'+
-	#
-	# === Signature
-	#
-	# * *Options:*
-	#  - +:reject_path_name_separators+:: (boolean) Reject the path
-	#     separator character(s): +'\\'+ and +'/'+
-	#  - +: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
+  # Evaluates whether the given name is malformed, according to the given
+  # options.
+  #
+  # If no options are specified, the only invalid character(s) are: +'\0'+
+  #
+  # === Signature
+  #
+  # * *Options:*
+  #  - +:reject_path_name_separators+:: (boolean) Reject the path
+  #     separator character(s): +'\\'+ and +'/'+
+  #  - +: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::Windows
+    _Constants = ::LibPath::Constants::Windows
 
-		if name
+    if name
 
-			if options[:reject_shell_characters]
+      if options[:reject_shell_characters]
 
-				return true if name =~ _Constants::InvalidCharacters::Shell::RE
-			end
+        return true if name =~ _Constants::InvalidCharacters::Shell::RE
+      end
 
-			if options[:reject_path_separators]
+      if options[:reject_path_separators]
 
-				return true if name =~ _Constants::InvalidCharacters::PathSeparators::RE
-			end
+        return true if name =~ _Constants::InvalidCharacters::PathSeparators::RE
+      end
 
-			if options[:reject_path_name_separators]
+      if options[:reject_path_name_separators]
 
-				return true if name =~ _Constants::InvalidCharacters::PathNameSeparators::RE
-			end
+        return true if name =~ _Constants::InvalidCharacters::PathNameSeparators::RE
+      end
 
-			return true if name =~ _Constants::InvalidCharacters::Innate::RE
+      return true if name =~ _Constants::InvalidCharacters::Innate::RE
 
-			if '\\' == name[0] && '\\' == name[1]
+      if '\\' == name[0] && '\\' == name[1]
 
-				return true if name !~ /^\\\\[^\\]+\\[^\\]+/
-			end
+        return true if name !~ /^\\\\[^\\]+\\[^\\]+/
+      end
 
-			false
-		else
+      false
+    else
 
-			true
-		end
-	end
+      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
+  # 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
+    Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-		return true if path_is_homed? path
+    return true if path_is_homed? path
 
-		vol, rem, _ = Internal_::Windows::Form.get_windows_volume(path)
+    vol, rem, _ = Internal_::Windows::Form.get_windows_volume(path)
 
-		return false unless vol
-		return false unless rem
+    return false unless vol
+    return false unless rem
 
-		Internal_::Windows::Form.char_is_path_name_separator? rem[0]
-	end
+    Internal_::Windows::Form.char_is_path_name_separator? rem[0]
+  end
 
-	# Evaluates whether the given path is "letter drived", which means that
-	# it contains a drive specification. Given the two letter sequence 'X:'
-	# representing any ASCII letter (a-zA-Z) and a colon, this function
-	# recognises six sequences: +'X:'+, +'X:\'+, +'X:/'+, +'\\?\X:'+,
-	# +'\\?\X:\'+, +'\\?\X:/'+
-	#
-	# === Return
-	#  - +nil+:: if it is not "drived";
-	#  - 2:: it begins with the form +'X:'+
-	#  - 3:: it begins with the form +'X:\'+ or +'X:/'+
-	#  - 6:: it begins with the form +'\\?\X:'+
-	#  - 7:: it begins with the form +'\\?\X:\'+ or +'\\?\X:/'+
-	def path_is_letter_drived? path
+  # Evaluates whether the given path is "letter drived", which means that
+  # it contains a drive specification. Given the two letter sequence 'X:'
+  # representing any ASCII letter (a-zA-Z) and a colon, this function
+  # recognises six sequences: +'X:'+, +'X:\'+, +'X:/'+, +'\\?\X:'+,
+  # +'\\?\X:\'+, +'\\?\X:/'+
+  #
+  # === Return
+  #  - +nil+:: if it is not "drived";
+  #  - 2:: it begins with the form +'X:'+
+  #  - 3:: it begins with the form +'X:\'+ or +'X:/'+
+  #  - 6:: it begins with the form +'\\?\X:'+
+  #  - 7:: it begins with the form +'\\?\X:\'+ or +'\\?\X:/'+
+  def path_is_letter_drived? path
 
-		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+    Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-		if path.size >= 2
+    if path.size >= 2
 
-			base_index	=	0
+      base_index = 0
 
-			if '\\' == path[0]
+      if '\\' == path[0]
 
-				if '\\' == path[1]
+        if '\\' == path[1]
 
-					if '?' == path[2]
+          if '?' == path[2]
 
-						if '\\' == path[3]
+            if '\\' == path[3]
 
-							base_index = 4
-						end
-					end
-				end
-			end
+              base_index = 4
+            end
+          end
+        end
+      end
 
-			if ':' == path[base_index + 1]
+      if ':' == path[base_index + 1]
 
-				if Internal_::Windows::Drive.character_is_drive_letter? path[base_index + 0]
+        if Internal_::Windows::Drive.character_is_drive_letter? path[base_index + 0]
 
-					if Internal_::Windows::Form.char_is_path_name_separator? path[base_index + 2]
+          if Internal_::Windows::Form.char_is_path_name_separator? path[base_index + 2]
 
-						return 4 == base_index ? 7 : 3
-					else
+            return 4 == base_index ? 7 : 3
+          else
 
-						return 4 == base_index ? 6 : 2
-					end
-				end
-			end
-		end
+            return 4 == base_index ? 6 : 2
+          end
+        end
+      end
+    end
 
-		nil
-	end
+    nil
+  end
 
-	# Evaluates whether the given path is homed, which means it is '~' or
-	# begins with '~/' or '~\'
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +path+:: (String) The path to be evaluated. May not be +nil+
-	def path_is_homed? path
+  # Evaluates whether the given path is homed, which means it is '~' or
+  # begins with '~/' or '~\'
+  #
+  # === 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
+    Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-		return false unless '~' == path[0]
+    return false unless '~' == path[0]
 
-		if path.size > 1
+    if path.size > 1
 
-			return Internal_::Windows::Form.char_is_path_name_separator? path[1]
-		end
+      return Internal_::Windows::Form.char_is_path_name_separator? path[1]
+    end
 
-		true
-	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
+  # 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
+    Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-		case path[0]
-		when '/'
+    case path[0]
+    when '/'
 
-			true
-		when '\\'
+      true
+    when '\\'
 
-			case path[1]
-			when '\\'
+      case path[1]
+      when '\\'
 
-				vol, rem, _ = Internal_::Windows::Form.get_windows_volume(path)
+        vol, rem, _ = Internal_::Windows::Form.get_windows_volume(path)
 
-				return false unless vol
+        return false unless vol
 
-				if rem && Internal_::Windows::Form.char_is_path_name_separator?(rem[0])
+        if rem && Internal_::Windows::Form.char_is_path_name_separator?(rem[0])
 
-					true
-				else
+          true
+        else
 
-					false
-				end
-			else
+          false
+        end
+      else
 
-				true
-			end
-		else
+        true
+      end
+    else
 
-			if path.size > 2
+      if path.size > 2
 
-				if ':' == path[1]
+        if ':' == path[1]
 
-					if Internal_::Windows::Drive.character_is_drive_letter? path[0]
+          if Internal_::Windows::Drive.character_is_drive_letter? path[0]
 
-						return Internal_::Windows::Form.char_is_path_name_separator? path[2]
-					end
-				end
-			end
+            return Internal_::Windows::Form.char_is_path_name_separator? path[2]
+          end
+        end
+      end
 
-			false
-		end
-	end
+      false
+    end
+  end
 
-	# Evalutes whether the given path is UNC
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +path+:: (String) The path to be evaluated. May not be +nil+
-	def path_is_UNC? path
+  # Evalutes whether the given path is UNC
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +path+:: (String) The path to be evaluated. May not be +nil+
+  def path_is_UNC? path
 
-		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+    Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-		return false unless '\\' == path[0]
-		return false unless '\\' == path[1]
+    return false unless '\\' == path[0]
+    return false unless '\\' == path[1]
 
-		_, _, frm = Internal_::Windows::Form.get_windows_volume(path)
+    _, _, frm = Internal_::Windows::Form.get_windows_volume(path)
 
-		case frm
-		when :form_2, :form_3, :form_4, :form_5, :form_6
+    case frm
+    when :form_2, :form_3, :form_4, :form_5, :form_6
 
-			true
-		else
+      true
+    else
 
-			false
-		end
-	end
+      false
+    end
+  end
 
 end # module LibPath_Form_Windows_Methods
 
 # @!visibility private
 def self.extended receiver # :nodoc:
 
-	receiver.class_eval do
+  receiver.class_eval do
 
-		extend LibPath_Form_Windows_Methods
-	end
+    extend LibPath_Form_Windows_Methods
+  end
 
-	$stderr.puts "#{receiver} extended by #{LibPath_Form_Windows_Methods}" if $DEBUG
+  $stderr.puts "#{receiver} extended by #{LibPath_Form_Windows_Methods}" if $DEBUG
 end
 
 # @!visibility private
 def self.included receiver # :nodoc:
 
-	receiver.class_eval do
+  receiver.class_eval do
 
-		include LibPath_Form_Windows_Methods
-	end
+    include LibPath_Form_Windows_Methods
+  end
 
-	$stderr.puts "#{receiver} included #{LibPath_Form_Windows_Methods}" if $DEBUG
+  $stderr.puts "#{receiver} included #{LibPath_Form_Windows_Methods}" if $DEBUG
 end
 
 extend LibPath_Form_Windows_Methods
@@ -353,6 +354,6 @@ end # module Windows
 end # module Form
 end # module LibPath
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/libpath/form.rb

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