libpath-ruby 0.2.2.1 → 0.2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb00e0cfae7c3f659f2b1db1a0d65491b8458be3d129861815427a00ca6b85a2
-  data.tar.gz: '09132f8eb4d1adb3fea11cca8eb2d8beaa824e25861387f2939a3e348eb6555b'
+  metadata.gz: 8996094361fb92d0b95118bea46f4e1652000d3ed54e5008895df5a7260bbd00
+  data.tar.gz: 613922a5a2d51de42327585ce3f23a0ebcb6f3d19d1b1066e3c9a54832412af9
 SHA512:
-  metadata.gz: e0642b21c266ce97a09b1cca3c4b5e79eefa197a95398ab57dc6022ec8c1262a40592b4a1a350255551402a49f8d2a7596de4a78131bb1e8600f443eadbb9439
-  data.tar.gz: a5ff1452f28d8e78bfe6c01333e1f94af191734ef795fbf6d63d753dfb5af2dcfdf0f3f135b3cf776686c831bdc93be57584a04c5bacd71532531da194a34f72
+  metadata.gz: ab2efbb8ace8b969c0d2f79bc42058a512aa6633d710e8fa3108f3400fbffc8b5d10bd76e30cb64234815524c9d32b3e4dac50aa6702b8175803764da204efd4
+  data.tar.gz: 227a0622eab1ea0da0d0d27ee7913fc7114c4ae00fcbd2ffc872eafcfd6017759d9b97a9597f59029223d63610ace45205c240db4a0f9d59dc988653d3333421

data/README.md

@@ -28,7 +28,7 @@
 Install via **gem** as in:
 
 ```
-  gem install libpath-ruby
+gem install libpath-ruby
 ```
 
 or add it to your `Gemfile`.

data/lib/libpath/constants/unix.rb

@@ -4,7 +4,7 @@
 # Purpose:  LibPath::Constants::Unix module
 #
 # Created:  29th January 2019
-# Updated:  6th April 2024
+# Updated:  7th April 2024
 #
 # Home:     http://github.com/synesissoftware/libpath.Ruby
 #
@@ -47,95 +47,95 @@
 =begin
 =end
 
-module LibPath # :nodoc:
-module Constants # :nodoc:
-module Unix # :nodoc:
+module LibPath
+module Constants
+module Unix
 
-# Module defining instance functions that will be included and extended into
-# any class or module including/extending module LibPath::Constants::Unix
-module LibPath_Constants_Unix_Methods
+  # Module defining instance functions that will be included and extended into
+  # any class or module including/extending module LibPath::Constants::Unix
+  module LibPath_Constants_Unix_Methods
 
-  # Defines invalid characters
-  module InvalidCharacters
+    # Defines invalid characters
+    module InvalidCharacters
 
-    # Innately invalid characters
-    module Innate
+      # Innately invalid characters
+      module Innate
 
-      # The list of characters
-      LIST = [
+        # The list of characters
+        LIST = [
 
-        "\0",
-      ]
-      # The regular expression
-      RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
-    end # module Innate
+          "\0",
+        ]
+        # The regular expression
+        RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
+      end # module Innate
 
-    # Valid path name separator characters
-    module PathNameSeparators
+      # Valid path name separator characters
+      module PathNameSeparators
 
-      # The list of characters
-      LIST = [
+        # The list of characters
+        LIST = [
 
-        '/',
-      ]
-      # The regular expression
-      RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
-    end # module PathNameSeparators
+          '/',
+        ]
+        # The regular expression
+        RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
+      end # module PathNameSeparators
 
-    # Valid path separator characters
-    module PathSeparators
+      # Valid path separator characters
+      module PathSeparators
 
-      # The list of characters
-      LIST = [
+        # The list of characters
+        LIST = [
 
-        ':',
-      ]
-      # The regular expression
-      RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
-    end # module PathSeparators
+          ':',
+        ]
+        # The regular expression
+        RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
+      end # module PathSeparators
 
-    # Invalid shell characters
-    module Shell
+      # Invalid shell characters
+      module Shell
 
-      # The list of characters
-      LIST = [
+        # The list of characters
+        LIST = [
 
-        '*',
-        '<',
-        '>',
-        '?',
-        '|',
-      ]
-      # The regular expression
-      RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
-    end # module Shell
-  end # module InvalidCharacters
-end # module LibPath_Constants_Unix_Methods
+          '*',
+          '<',
+          '>',
+          '?',
+          '|',
+        ]
+        # The regular expression
+        RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
+      end # module Shell
+    end # module InvalidCharacters
+  end # module LibPath_Constants_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_Constants_Unix_Methods
+      extend LibPath_Constants_Unix_Methods
+    end
+
+    $stderr.puts "#{receiver} extended by #{LibPath_Constants_Unix_Methods}" if $DEBUG
   end
 
-  $stderr.puts "#{receiver} extended by #{LibPath_Constants_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_Constants_Unix_Methods
+    end
 
-    include LibPath_Constants_Unix_Methods
+    $stderr.puts "#{receiver} included #{LibPath_Constants_Unix_Methods}" if $DEBUG
   end
 
-  $stderr.puts "#{receiver} included #{LibPath_Constants_Unix_Methods}" if $DEBUG
-end
-
-extend LibPath_Constants_Unix_Methods
-include LibPath_Constants_Unix_Methods
+  extend LibPath_Constants_Unix_Methods
+  include LibPath_Constants_Unix_Methods
 
 end # module Unix
 end # module Constants

data/lib/libpath/constants/windows.rb

@@ -4,7 +4,7 @@
 # Purpose:  LibPath::Constants::Windows module
 #
 # Created:  29th January 2019
-# Updated:  6th April 2024
+# Updated:  7th April 2024
 #
 # Home:     http://github.com/synesissoftware/libpath.Ruby
 #
@@ -47,96 +47,96 @@
 =begin
 =end
 
-module LibPath # :nodoc:
-module Constants # :nodoc:
-module Windows # :nodoc:
+module LibPath
+module Constants
+module Windows
 
-# Module defining instance functions that will be included and extended into
-# any class or module including/extending module LibPath::Constants::Windows
-module LibPath_Constants_Windows_Details
+  # Module defining instance functions that will be included and extended into
+  # any class or module including/extending module LibPath::Constants::Windows
+  module LibPath_Constants_Windows_Details
 
-  # Defines invalid characters
-  module InvalidCharacters
+    # Defines invalid characters
+    module InvalidCharacters
 
-    # Innately invalid characters
-    module Innate
+      # Innately invalid characters
+      module Innate
 
-      # The list of characters
-      LIST = [
+        # The list of characters
+        LIST = [
 
-        "\0",
-      ]
-      # The regular expression
-      RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
-    end # module Innate
+          "\0",
+        ]
+        # The regular expression
+        RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
+      end # module Innate
 
-    # Valid path name separator characters
-    module PathNameSeparators
+      # Valid path name separator characters
+      module PathNameSeparators
 
-      # The list of characters
-      LIST = [
+        # The list of characters
+        LIST = [
 
-        "\\",
-        '/',
-      ]
-      # The regular expression
-      RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
-    end # module PathNameSeparators
+          "\\",
+          '/',
+        ]
+        # The regular expression
+        RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
+      end # module PathNameSeparators
 
-    # Valid path separator characters
-    module PathSeparators
+      # Valid path separator characters
+      module PathSeparators
 
-      # The list of characters
-      LIST = [
+        # The list of characters
+        LIST = [
 
-        ';',
-      ]
-      # The regular expression
-      RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
-    end # module PathSeparators
+          ';',
+        ]
+        # The regular expression
+        RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
+      end # module PathSeparators
 
-    # Invalid shell characters
-    module Shell
+      # Invalid shell characters
+      module Shell
 
-      # The list of characters
-      LIST = [
+        # The list of characters
+        LIST = [
 
-        '*',
-        '<',
-        '>',
-        '?',
-        '|',
-      ]
-      # The regular expression
-      RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
-    end # module Shell
-  end # module InvalidCharacters
-end # module LibPath_Constants_Windows_Details
+          '*',
+          '<',
+          '>',
+          '?',
+          '|',
+        ]
+        # The regular expression
+        RE = /[#{LIST.map { |m| Regexp.escape m }.join}]/
+      end # module Shell
+    end # module InvalidCharacters
+  end # module LibPath_Constants_Windows_Details
 
-# @!visibility private
-def self.extended receiver # :nodoc:
+  # @!visibility private
+  def self.extended receiver # :nodoc:
 
-  receiver.class_eval do
+    receiver.class_eval do
 
-    extend LibPath_Constants_Windows_Details
+      extend LibPath_Constants_Windows_Details
+    end
+
+    $stderr.puts "#{receiver} extended by #{LibPath_Constants_Windows_Details}" if $DEBUG
   end
 
-  $stderr.puts "#{receiver} extended by #{LibPath_Constants_Windows_Details}" 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_Constants_Windows_Details
+    end
 
-    include LibPath_Constants_Windows_Details
+    $stderr.puts "#{receiver} included #{LibPath_Constants_Windows_Details}" if $DEBUG
   end
 
-  $stderr.puts "#{receiver} included #{LibPath_Constants_Windows_Details}" if $DEBUG
-end
-
-extend LibPath_Constants_Windows_Details
-include LibPath_Constants_Windows_Details
+  extend LibPath_Constants_Windows_Details
+  include LibPath_Constants_Windows_Details
 
 end # module Windows
 end # module Constants

data/lib/libpath/constants.rb

@@ -9,8 +9,9 @@ else
   require 'libpath/constants/unix'
 end
 
-module LibPath # :nodoc:
-module Constants # :nodoc:
+
+module LibPath
+module Constants
 
   if ::LibPath::Internal_::Platform::Constants::PLATFORM_IS_WINDOWS then
 

data/lib/libpath/diagnostics/parameter_checking.rb

@@ -1,5 +1,6 @@
 
-module LibPath # :nodoc:
+module LibPath
+# @!visibility private
 module Diagnostics # :nodoc:
 
   # @!visibility private

data/lib/libpath/exceptions/libpath_base_exception.rb

@@ -5,7 +5,7 @@
 # Purpose:  LibPathBaseException class
 #
 # Created:  30th January 2019
-# Updated:  6th April 2024
+# Updated:  7th April 2024
 #
 # Home:     http://github.com/synesissoftware/libpath.Ruby
 #
@@ -48,27 +48,26 @@
 =begin
 =end
 
-module LibPath # :nodoc:
-module Exceptions # :nodoc:
+module LibPath
+module Exceptions
 
-# Root exception for all LibPath exceptions
-#
-# NOTE: this class is abstract
-class LibPathBaseException < StandardError
+  # Root exception for all LibPath exceptions
+  #
+  # NOTE: this class is abstract
+  class LibPathBaseException < StandardError
 
 =begin
 
-  # TODO include Xqsr3's WithCause
+    # TODO include Xqsr3's WithCause
 =end
 
-  def self.new *args
+    def self.new *args
 
-    raise NoMethodError, "private method `new' called for #{self}:Class" if self == LibPathBaseException
+      raise NoMethodError, "private method `new' called for #{self}:Class" if self == LibPathBaseException
 
-    super
+      super
+    end
   end
-end
-
 end # module Exceptions
 end # module LibPath
 

data/lib/libpath/exceptions/malformed_name_exception.rb

@@ -5,7 +5,7 @@
 # Purpose:  MalformedNameException class
 #
 # Created:  30th January 2019
-# Updated:  6th April 2024
+# Updated:  13th April 2024
 #
 # Home:     http://github.com/synesissoftware/libpath.Ruby
 #
@@ -45,39 +45,38 @@
 # ######################################################################## #
 
 
+require 'libpath/exceptions/libpath_base_exception'
+
+
 =begin
 =end
 
-require 'libpath/exceptions/libpath_base_exception'
+module LibPath
+module Exceptions
 
+  # Exception thrown when a malformed name is encountered
+  class MalformedNameException < LibPathBaseException
 
-module LibPath # :nodoc:
-module Exceptions # :nodoc:
+    # 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
 
-# Exception thrown when a malformed name is encountered
-class MalformedNameException < LibPathBaseException
+      unless message
 
-  # 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
+        message = "malformed name '#{name}'"
+      end
 
-    unless message
+      super message
 
-      message = "malformed name '#{name}'"
+      @name = name
     end
 
-    super message
-
-    @name = name
+    # (String) The name that is malformed
+    attr_reader :name
   end
-
-  # (String) The name that is malformed
-  attr_reader :name
-end
-
 end # module Exceptions
 end # module LibPath