libpath-ruby 0.2.2.1 → 0.2.2.3

data/lib/libpath/form/windows.rb

@@ -5,7 +5,7 @@
 # Purpose:  LibPath::Form::Windows module
 #
 # Created:  8th January 2019
-# Updated:  6th April 2024
+# Updated:  13th April 2024
 #
 # Home:     http://github.com/synesissoftware/libpath.Ruby
 #
@@ -45,310 +45,323 @@
 # ######################################################################## #
 
 
-=begin
-=end
-
 require 'libpath/constants/windows'
 require 'libpath/diagnostics'
 require 'libpath/internal_/windows/drive'
 require 'libpath/internal_/windows/form'
 
 
-module LibPath # :nodoc:
-module Form # :nodoc:
-module Windows # :nodoc:
+=begin
+=end
 
-# Module defining instance functions that will be included and extended into
-# any class or module including/extending module LibPath::Form::Windows
-module LibPath_Form_Windows_Methods
+module LibPath
+module Form
+module Windows
 
-  # 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
+  # Module defining instance functions that will be included and extended into
+  # any class or module including/extending module LibPath::Form::Windows
+  module LibPath_Form_Windows_Methods
 
-    Diagnostics.check_string_parameter(path, "path") if $DEBUG
+    # 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
 
-    return nil if path.nil? || path.empty?
+      _Form = Internal_::Windows::Form
 
-    return :homed if path_is_homed? path
+      Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-    vol, rem, _ = Internal_::Windows::Form.get_windows_volume(path)
+      return nil if path.nil? || path.empty?
 
-    rooted = Internal_::Windows::Form.char_is_path_name_separator? rem[0]
+      return :homed if path_is_homed? path
 
-    if rooted
+      vol, rem, _ = _Form.get_windows_volume(path)
 
-      if vol
+      rooted = _Form.char_is_path_name_separator? rem[0]
 
-        return :absolute
-      else
+      if rooted
 
-        return :rooted
-      end
-    else
+        if vol
 
-      if vol
+          return :absolute
+        else
 
-        return :drived
+          return :rooted
+        end
       else
 
-        return :relative
+        if vol
+
+          return :drived
+        else
+
+          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
+
+      _Constants = ::LibPath::Constants::Windows
+
+      if name
+
+        if options[:reject_shell_characters]
+
+          return true if name =~ _Constants::InvalidCharacters::Shell::RE
+        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
-
-    _Constants = ::LibPath::Constants::Windows
-
-    if name
-
-      if options[:reject_shell_characters]
-
-        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
+
+        false
+      else
 
-        return true if name !~ /^\\\\[^\\]+\\[^\\]+/
+        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
+      _Form = Internal_::Windows::Form
 
-  # 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, _ = _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
+      _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
+      _Drive = Internal_::Windows::Drive
+      _Form = Internal_::Windows::Form
 
-    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
+                base_index = 4
+              end
             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 _Drive.character_is_drive_letter? path[base_index + 0]
 
-          if Internal_::Windows::Form.char_is_path_name_separator? path[base_index + 2]
+            if _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
+              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
+      _Form = Internal_::Windows::Form
 
-    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 _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
+      _Drive = Internal_::Windows::Drive
+      _Form = Internal_::Windows::Form
 
-    case path[0]
-    when '/'
+      Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-      true
-    when '\\'
+      case path[0]
+      when '/'
 
-      case path[1]
+        true
       when '\\'
 
-        vol, rem, _ = Internal_::Windows::Form.get_windows_volume(path)
+        case path[1]
+        when '\\'
 
-        return false unless vol
+          vol, rem, _ = _Form.get_windows_volume(path)
 
-        if rem && Internal_::Windows::Form.char_is_path_name_separator?(rem[0])
+          return false unless vol
 
-          true
+          if rem && _Form.char_is_path_name_separator?(rem[0])
+
+            true
+          else
+
+            false
+          end
         else
 
-          false
+          true
         end
       else
 
-        true
-      end
-    else
+        if path.size > 2
 
-      if path.size > 2
+          if ':' == path[1]
 
-        if ':' == path[1]
+            if _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]
+              return _Form.char_is_path_name_separator? path[2]
+            end
           end
         end
-      end
 
-      false
+        false
+      end
     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
+      _Form = Internal_::Windows::Form
 
-    return false unless '\\' == path[0]
-    return false unless '\\' == path[1]
+      Diagnostics.check_string_parameter(path, "path") if $DEBUG
 
-    _, _, frm = Internal_::Windows::Form.get_windows_volume(path)
+      return false unless '\\' == path[0]
+      return false unless '\\' == path[1]
 
-    case frm
-    when :form_2, :form_3, :form_4, :form_5, :form_6
+      _, _, frm = _Form.get_windows_volume(path)
 
-      true
-    else
+      case frm
+      when :form_2, :form_3, :form_4, :form_5, :form_6
 
-      false
+        true
+      else
+
+        false
+      end
     end
-  end
+  end # module LibPath_Form_Windows_Methods
 
-end # module LibPath_Form_Windows_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_Windows_Methods
+    end
 
-    extend LibPath_Form_Windows_Methods
+    $stderr.puts "#{receiver} extended by #{LibPath_Form_Windows_Methods}" if $DEBUG
   end
 
-  $stderr.puts "#{receiver} extended by #{LibPath_Form_Windows_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_Windows_Methods
+    end
 
-    include LibPath_Form_Windows_Methods
+    $stderr.puts "#{receiver} included #{LibPath_Form_Windows_Methods}" if $DEBUG
   end
 
-  $stderr.puts "#{receiver} included #{LibPath_Form_Windows_Methods}" if $DEBUG
-end
-
-extend LibPath_Form_Windows_Methods
-include LibPath_Form_Windows_Methods
+  extend LibPath_Form_Windows_Methods
+  include LibPath_Form_Windows_Methods
 
 end # module Windows
 end # module Form

data/lib/libpath/form.rb

@@ -9,8 +9,8 @@ else
   require 'libpath/form/unix'
 end
 
-module LibPath # :nodoc:
-module Form # :nodoc:
+module LibPath
+module Form
 
   if ::LibPath::Internal_::Platform::Constants::PLATFORM_IS_WINDOWS then
 
@@ -33,7 +33,6 @@ module Form # :nodoc:
 
     $stderr.puts "#{receiver} included #{self}" if $DEBUG
   end
-
 end # module Form
 end # module LibPath
 

data/lib/libpath/internal_/array.rb

@@ -1,94 +1,94 @@
 
 # :stopdoc:
 
-module LibPath # :nodoc:
-# @!visibility private
-module Internal_ # :nodoc: all
 
+module LibPath
 # @!visibility private
-module Array # :nodoc:
+module Internal_ # :nodoc: all
 
   # @!visibility private
-  def self.index(ar, v, after = nil) # :nodoc:
+  module Array # :nodoc:
 
-    if after
+    # @!visibility private
+    def self.index(ar, v, after = nil) # :nodoc:
 
-      if after < 0
+      if after
 
-        after = ar.size + after
+        if after < 0
 
-        return nil if after < 0
-      else
+          after = ar.size + after
 
-        return nil unless after < ar.size
-      end
+          return nil if after < 0
+        else
 
-      ar.each_with_index do |el, ix|
+          return nil unless after < ar.size
+        end
 
-        if ix >= after
+        ar.each_with_index do |el, ix|
 
-          if v == el
+          if ix >= after
 
-            return ix
+            if v == el
+
+              return ix
+            end
           end
         end
-      end
 
-      nil
-    else
+        nil
+      else
 
-      ar.index(v)
+        ar.index(v)
+      end
     end
-  end
 
-  # @!visibility private
-  def self.index2(ar, v1, v2, after = nil) # :nodoc:
+    # @!visibility private
+    def self.index2(ar, v1, v2, after = nil) # :nodoc:
 
-    i_1 = self.index(ar, v1, after)
-    i_2 = self.index(ar, v2, after)
+      i_1 = self.index(ar, v1, after)
+      i_2 = self.index(ar, v2, after)
 
-    if i_1
+      if i_1
 
-      if i_2
+        if i_2
 
-        i_1 < i_2 ? i_1 : i_2
+          i_1 < i_2 ? i_1 : i_2
+        else
+
+          i_1
+        end
       else
 
-        i_1
+        i_2
       end
-    else
-
-      i_2
     end
-  end
 
 
-  # @!visibility private
-  def self.rindex2(ar, v1, v2) # :nodoc:
+    # @!visibility private
+    def self.rindex2(ar, v1, v2) # :nodoc:
+
+      i_1 = ar.rindex(v1)
+      i_2 = ar.rindex(v2)
 
-    i_1 = ar.rindex(v1)
-    i_2 = ar.rindex(v2)
+      if i_1
 
-    if i_1
+        if i_2
 
-      if i_2
+          i_1 < i_2 ? i_2 : i_1
+        else
 
-        i_1 < i_2 ? i_2 : i_1
+          i_1
+        end
       else
 
-        i_1
+        i_2
       end
-    else
-
-      i_2
     end
-  end
-
-end # module Array
-
+  end # module Array
 end # module Internal_
 end # module LibPath
 
+
 # :startdoc: