libpath-ruby 0.2.2 → 0.2.2.2

data/lib/libpath/constants/windows.rb

@@ -1,15 +1,16 @@
 # ######################################################################## #
-# File:         libpath/constants/windows.rb
+# File:     libpath/constants/windows.rb
 #
-# Purpose:      LibPath::Constants::Windows module
+# Purpose:  LibPath::Constants::Windows module
 #
-# Created:      29th January 2019
-# Updated:      16th April 2019
+# Created:  29th 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.
 #
@@ -43,105 +44,104 @@
 # ######################################################################## #
 
 
-
 =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
-	end
+      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
+    end
 
-	$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
 end # module LibPath
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/libpath/constants.rb

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

data/lib/libpath/diagnostics/parameter_checking.rb

@@ -1,46 +1,47 @@
 
-module LibPath # :nodoc:
+module LibPath
+# @!visibility private
 module Diagnostics # :nodoc:
 
-	# @!visibility private
-	def self.check_string_parameter param_value, param_name, **options # :nodoc:
+  # @!visibility private
+  def self.check_string_parameter param_value, param_name, **options # :nodoc:
 
-		case param_value
-		when nil
+    case param_value
+    when nil
 
-			unless options[:allow_nil]
+      unless options[:allow_nil]
 
-				raise ::ArgumentError, "parameter '#{param_name}' may not be nil"
-			end
+        raise ::ArgumentError, "parameter '#{param_name}' may not be nil"
+      end
 
-			;
-		when ::String
+      ;
+    when ::String
 
-			;
-		else
+      ;
+    else
 
-			unless param_value.respond_to?(:to_str)
+      unless param_value.respond_to?(:to_str)
 
-				raise ::TypeError, "parameter '#{param_name}' must be instance of #{::String} or respond to #to_str()"
-			end
-		end
-	end
+        raise ::TypeError, "parameter '#{param_name}' must be instance of #{::String} or respond to #to_str()"
+      end
+    end
+  end
 
-	# @!visibility private
-	def self.check_options h, *args, **options # :nodoc:
+  # @!visibility private
+  def self.check_options h, *args, **options # :nodoc:
 
-		if known = options[:known] then
+    if known = options[:known] then
 
-			h.each_key do |k|
+      h.each_key do |k|
 
-				raise ::ArgumentError, "unknown key '#{k}'" unless known.include?(k)
-			end
-		end
+        raise ::ArgumentError, "unknown key '#{k}'" unless known.include?(k)
+      end
+    end
 
-	end
+  end
 end # module Diagnostics
 end # module LibPath
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/libpath/diagnostics.rb

@@ -1,6 +1,6 @@
 
 require 'libpath/diagnostics/parameter_checking'
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/libpath/exceptions/libpath_base_exception.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         libpath/exceptions/libpath_base_exception.rb
+# File:     libpath/exceptions/libpath_base_exception.rb
 #
-# Purpose:      LibPathBaseException class
+# Purpose:  LibPathBaseException class
 #
-# Created:      30th January 2019
-# Updated:      16th April 2019
+# Created:  30th 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,34 +45,32 @@
 # ######################################################################## #
 
 
-
 =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
-
-		raise NoMethodError, "private method `new' called for #{self}:Class" if self == LibPathBaseException
+    def self.new *args
 
-		super
-	end
-end
+      raise NoMethodError, "private method `new' called for #{self}:Class" if self == LibPathBaseException
 
+      super
+    end
+  end
 end # module Exceptions
 end # module LibPath
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/libpath/exceptions/malformed_name_exception.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         libpath/exceptions/malformed_name_exception.rb
+# File:     libpath/exceptions/malformed_name_exception.rb
 #
-# Purpose:      MalformedNameException class
+# Purpose:  MalformedNameException class
 #
-# Created:      30th January 2019
-# Updated:      16th April 2019
+# Created:  30th 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,42 +45,41 @@
 # ######################################################################## #
 
 
-
 =begin
 =end
 
 require 'libpath/exceptions/libpath_base_exception'
 
-module LibPath # :nodoc:
-module Exceptions # :nodoc:
 
-# Exception thrown when a malformed name is encountered
-class MalformedNameException < LibPathBaseException
+module LibPath
+module Exceptions
 
-	# 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}'"
+      end
 
-		@name	=	name
-	end
+      super message
 
-	# (String) The name that is malformed
-	attr_reader :name
-end
+      @name = name
+    end
 
+    # (String) The name that is malformed
+    attr_reader :name
+  end
 end # module Exceptions
 end # module LibPath
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #
 

data/lib/libpath/exceptions.rb

@@ -2,6 +2,6 @@
 require 'libpath/exceptions/libpath_base_exception'
 require 'libpath/exceptions/malformed_name_exception'
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #