libpath-ruby 0.2.2 → 0.2.2.2

data/lib/libpath/form/unix.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         libpath/form/unix.rb
+# File:    libpath/form/unix.rb
 #
-# Purpose:      LibPath::Form::Unix module
+# Purpose: LibPath::Form::Unix module
 #
-# Created:      8th January 2019
-# Updated:      16th April 2019
+# Created: 8th 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,172 +45,171 @@
 # ######################################################################## #
 
 
-
 =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
+module LibPath
+module Form
+module Unix
 
-	# 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
+  # 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
 
-		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+    # 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
 
-		return nil if path.nil? || path.empty?
+      Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-		return :homed if path_is_homed? path
+      return nil if path.nil? || path.empty?
 
-		return :absolute if path_is_absolute? path
+      return :homed if path_is_homed? path
 
-		:relative
-	end
+      return :absolute if path_is_absolute? path
 
-	# 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
+      :relative
+    end
 
-		_Constants	=	::LibPath::Constants::Unix
+    # 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
 
-		if name
+      _Constants = ::LibPath::Constants::Unix
 
-			if options[:reject_path_name_separators]
+      if name
 
-				return true if name =~ _Constants::InvalidCharacters::PathNameSeparators::RE
-			end
+        if options[:reject_path_name_separators]
 
-			if options[:reject_path_separators]
+          return true if name =~ _Constants::InvalidCharacters::PathNameSeparators::RE
+        end
 
-				return true if name =~ _Constants::InvalidCharacters::PathSeparators::RE
-			end
+        if options[:reject_path_separators]
 
-			if options[:reject_shell_characters]
+          return true if name =~ _Constants::InvalidCharacters::PathSeparators::RE
+        end
 
-				return true if name =~ _Constants::InvalidCharacters::Shell::RE
-			end
+        if options[:reject_shell_characters]
 
-			return true if name =~ _Constants::InvalidCharacters::Innate::RE
+          return true if name =~ _Constants::InvalidCharacters::Shell::RE
+        end
 
-			false
-		else
+        return true if name =~ _Constants::InvalidCharacters::Innate::RE
 
-			true
-		end
-	end
+        false
+      else
 
-	# 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
+        true
+      end
+    end
 
-		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+    # 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
 
-		case path[0]
-		when '/'
+      Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-			true
-		when '~'
+      case path[0]
+      when '/'
 
-			1 == path.size || '/' == path[1]
-		else
+        true
+      when '~'
 
-			false
-		end
-	end
+        1 == path.size || '/' == path[1]
+      else
 
-	# 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
+        false
+      end
+    end
 
-		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+    # 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
 
-		return false unless '~' == path[0]
+      Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-		if path.size > 1
+      return false unless '~' == path[0]
 
-			return '/' == path[1]
-		end
+      if path.size > 1
 
-		true
-	end
+        return '/' == path[1]
+      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
+      true
+    end
 
-		Diagnostics.check_string_parameter(path, "path") if $DEBUG
+    # 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
 
-		'/' == path[0]
-	end
+      Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-end # module LibPath_Form_Unix_Methods
+      '/' == path[0]
+    end
+  end # module LibPath_Form_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_Form_Unix_Methods
-	end
+      extend LibPath_Form_Unix_Methods
+    end
 
-	$stderr.puts "#{receiver} extended by #{LibPath_Form_Unix_Methods}" if $DEBUG
-end
+    $stderr.puts "#{receiver} extended by #{LibPath_Form_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_Form_Unix_Methods
-	end
+      include LibPath_Form_Unix_Methods
+    end
 
-	$stderr.puts "#{receiver} included #{LibPath_Form_Unix_Methods}" if $DEBUG
-end
+    $stderr.puts "#{receiver} included #{LibPath_Form_Unix_Methods}" if $DEBUG
+  end
 
-extend LibPath_Form_Unix_Methods
-include LibPath_Form_Unix_Methods
+  extend LibPath_Form_Unix_Methods
+  include LibPath_Form_Unix_Methods
 
 end # module Unix
 end # module Form
 end # module LibPath
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #