libpath-ruby 0.2.2 → 0.2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fe0a20249532b1b80f937b9749c2b2962838d24e927bc1a58effe869a6217fc
-  data.tar.gz: 13dde5b56de3ebedd606a32b10a4b000b975e831d5d425afca8963327f3642a9
+  metadata.gz: d8d3cc14d04488f50a0709403ba13a04673f5436cf2193c329ca213d632098f1
+  data.tar.gz: 19d2d08adfe48b6461ec32a4e4b4d40dfd4eb6c4c3e8852f92926f2aad9c744c
 SHA512:
-  metadata.gz: 810ed5ade6eb98faef307849b2d5c8a737bb2f0573105711e9535e299ab07bdee9d4f18f98748537e1a9e5f5bad2a9a27b30dd6837bd90fa8522c096a3915829
-  data.tar.gz: '0947a2e281a14f61eb4aa815600e1ea4e31a7719ec38ab0121a3a4b38561e993b12ebd6cec83c9c0487cef7f5e694aee2d25bfbc1596ddb7953bd26d742df871'
+  metadata.gz: e08138e7acbdf52e0d8e2ceac3bc3d71eb7b421cf79c92258a6091659f02e8ed9c23754549c15b51daf8ffbb229392aff47413d022a9c1bb02c1eb034e3aa90a
+  data.tar.gz: b7ce9f16572ee000607d5844bd6268b00744ea2739ff531ddcefb167a6b795756f18d0224680e2f127eb3fec8639c2085a4e5cbca149cebe77604a56b5497956

data/LICENSE

@@ -0,0 +1,33 @@
+libpath.Ruby - BSD 3-Clause License
+
+Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
+Copyright (c) 2019, Matthew Wilson and Synesis Software
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -1,26 +1,34 @@
-# libpath.Ruby
+# libpath.Ruby <!-- omit in toc -->
+
 **libpath**, for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/libpath-ruby.svg)](https://badge.fury.io/rb/libpath-ruby)
 
-## Table of Contents
 
-1. [Introduction](#introduction)
-2. [Installation](#installation)
-3. [Components](#components)
-4. [Examples](#examples)
-5. [Project Information](#project-information)
+## Table of Contents <!-- omit in toc -->
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Components](#components)
+- [Examples](#examples)
+- [Project Information](#project-information)
+  - [Where to get help](#where-to-get-help)
+  - [Contribution guidelines](#contribution-guidelines)
+  - [Related projects](#related-projects)
+  - [License](#license)
+
 
 ## Introduction
 
 **libpath** is a path-parsing and utility library. It is concerned entirely with paths, as opposed to file-system entities.
 
+
 ## Installation
 
 Install via **gem** as in:
 
 ```
-	gem install libpath-ruby
+gem install libpath-ruby
 ```
 
 or add it to your `Gemfile`.
@@ -35,27 +43,36 @@ require 'libpath'
 
 T.B.C.
 
+
 ## Examples
 
 Examples are provided in the ```examples``` directory, along with a markdown description for each. A detailed list TOC of them is provided in [EXAMPLES.md](./EXAMPLES.md).
 
+
 ## Project Information
 
+
 ### Where to get help
 
 [GitHub Page](https://github.com/synesissoftware/libpath.Ruby "GitHub Page")
 
+
 ### Contribution guidelines
 
 Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/libpath.Ruby.
 
+
 ### Related projects
 
 **libpath.Ruby** is based on the [C/C++ libpath library](https://github.com/synesissoftware/libpath), which itself was prompted by a request on the [STLSoft](https://github.com/synesissoftware/STLSoft-1.10) project by my friend and esteemed programmer [Adi Shavit](https://github.com/adishavit).
 
 **libpath.Ruby** will be used in **version 3+** of the **[recls.Ruby](https://github.com/synesissoftware/recls.Ruby)** library, which currently has its own path-parsing logic.
 
+
 ### License
 
 **libpath.Ruby** is released under the 3-clause BSD license. See LICENSE for details.
 
+
+<!-- ########################### end of file ########################### -->
+

data/examples/path_from_arg0.md

@@ -16,23 +16,23 @@ require 'libpath/path'
 
 PATH_ATTRIBUTES = %i{
 
-	given_path
-	absolute_path
-	compare_path
-	directory
-	directory_path
-	dirname
-	directory_parts
-	file_full_name
-	basename
-	file_name_only
-	stem
-	file_extension
-	extension
-	search_directory
-	search_relative_path
-	search_relative_directory_path
-	search_relative_directory_parts
+  given_path
+  absolute_path
+  compare_path
+  directory
+  directory_path
+  dirname
+  directory_parts
+  file_full_name
+  basename
+  file_name_only
+  stem
+  file_extension
+  extension
+  search_directory
+  search_relative_path
+  search_relative_directory_path
+  search_relative_directory_parts
 }
 
 
@@ -49,16 +49,16 @@ puts
 
 puts "\tall attributes:"
 
-max_name_len	=	PATH_ATTRIBUTES.map { |sym| sym.to_s.size }.max_by { |s| s }
-max_type_len	=	PATH_ATTRIBUTES.map { |sym| path.send(sym).class.to_s.size }.max_by { |s| s }
+max_name_len = PATH_ATTRIBUTES.map { |sym| sym.to_s.size }.max_by { |s| s }
+max_type_len = PATH_ATTRIBUTES.map { |sym| path.send(sym).class.to_s.size }.max_by { |s| s }
 
 PATH_ATTRIBUTES.each do |attr|
 
-	name	=	attr.to_s
-	value	=	path.send(attr)
-	type	=	value.class
+  name  = attr.to_s
+  value = path.send(attr)
+  type  = value.class
 
-	puts "\t\t#{name.to_s.rjust(max_name_len)} (#{type.to_s.rjust(max_type_len)}) : #{value}"
+  puts "\t\t#{name.to_s.rjust(max_name_len)} (#{type.to_s.rjust(max_type_len)}) : #{value}"
 end
 ```
 
@@ -75,25 +75,25 @@ The output is:
 ```
 path obtained from '.gitignore' (with search directory '../../../CLASP/CLASP.Ruby/trunk'):
 
-	path: /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/.gitignore
-
-	all attributes:
-		                     given_path (  String) : .gitignore
-		                  absolute_path (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/.gitignore
-		                   compare_path (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/.gitignore
-		                      directory (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/
-		                 directory_path (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/
-		                        dirname (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/
-		                directory_parts (   Array) : ["/", "Users/", "matthewwilson/", "dev/", "freelibs/", "libpath/", "libpath.Ruby/", "trunk/"]
-		                 file_full_name (  String) : .gitignore
-		                       basename (  String) : .gitignore
-		                 file_name_only (NilClass) : 
-		                           stem (NilClass) : 
-		                 file_extension (  String) : .gitignore
-		                      extension (  String) : .gitignore
-		               search_directory (  String) : /Users/matthewwilson/dev/freelibs/CLASP/CLASP.Ruby/trunk/
-		           search_relative_path (  String) : ../../../libpath/libpath.Ruby/trunk/.gitignore
-		 search_relative_directory_path (  String) : ../../../libpath/libpath.Ruby/trunk/
-		search_relative_directory_parts (   Array) : ["../", "../", "../", "libpath/", "libpath.Ruby/", "trunk/"]
+  path: /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/.gitignore
+
+  all attributes:
+                        given_path (  String) : .gitignore
+                      absolute_path (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/.gitignore
+                      compare_path (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/.gitignore
+                          directory (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/
+                    directory_path (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/
+                            dirname (  String) : /Users/matthewwilson/dev/freelibs/libpath/libpath.Ruby/trunk/
+                    directory_parts (   Array) : ["/", "Users/", "matthewwilson/", "dev/", "freelibs/", "libpath/", "libpath.Ruby/", "trunk/"]
+                    file_full_name (  String) : .gitignore
+                          basename (  String) : .gitignore
+                    file_name_only (NilClass) :
+                              stem (NilClass) :
+                    file_extension (  String) : .gitignore
+                          extension (  String) : .gitignore
+                  search_directory (  String) : /Users/matthewwilson/dev/freelibs/CLASP/CLASP.Ruby/trunk/
+              search_relative_path (  String) : ../../../libpath/libpath.Ruby/trunk/.gitignore
+    search_relative_directory_path (  String) : ../../../libpath/libpath.Ruby/trunk/
+    search_relative_directory_parts (   Array) : ["../", "../", "../", "libpath/", "libpath.Ruby/", "trunk/"]
 ```
 

data/examples/path_from_arg0.rb

@@ -7,23 +7,23 @@ require 'libpath/path'
 
 PATH_ATTRIBUTES = %i{
 
-	given_path
-	absolute_path
-	compare_path
-	directory
-	directory_path
-	dirname
-	directory_parts
-	file_full_name
-	basename
-	file_name_only
-	stem
-	file_extension
-	extension
-	search_directory
-	search_relative_path
-	search_relative_directory_path
-	search_relative_directory_parts
+  given_path
+  absolute_path
+  compare_path
+  directory
+  directory_path
+  dirname
+  directory_parts
+  file_full_name
+  basename
+  file_name_only
+  stem
+  file_extension
+  extension
+  search_directory
+  search_relative_path
+  search_relative_directory_path
+  search_relative_directory_parts
 }
 
 
@@ -40,16 +40,18 @@ puts
 
 puts "\tall attributes:"
 
-max_name_len	=	PATH_ATTRIBUTES.map { |sym| sym.to_s.size }.max_by { |s| s }
-max_type_len	=	PATH_ATTRIBUTES.map { |sym| path.send(sym).class.to_s.size }.max_by { |s| s }
+max_name_len = PATH_ATTRIBUTES.map { |sym| sym.to_s.size }.max_by { |s| s }
+max_type_len = PATH_ATTRIBUTES.map { |sym| path.send(sym).class.to_s.size }.max_by { |s| s }
 
 PATH_ATTRIBUTES.each do |attr|
 
-	name	=	attr.to_s
-	value	=	path.send(attr)
-	type	=	value.class
+  name  = attr.to_s
+  value = path.send(attr)
+  type  = value.class
 
-	puts "\t\t#{name.to_s.rjust(max_name_len)} (#{type.to_s.rjust(max_type_len)}) : #{value}"
+  puts "\t\t#{name.to_s.rjust(max_name_len)} (#{type.to_s.rjust(max_type_len)}) : #{value}"
 end
 
 
+# ############################## end of file ############################# #
+

data/lib/libpath/constants/unix.rb

@@ -1,15 +1,16 @@
 # ######################################################################## #
-# File:         libpath/constants/unix.rb
+# File:     libpath/constants/unix.rb
 #
-# Purpose:      LibPath::Constants::Unix module
+# Purpose:  LibPath::Constants::Unix 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,104 +44,103 @@
 # ######################################################################## #
 
 
-
 =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
-	end
+      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
+    end
 
-	$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
 end # module LibPath
 
-# ############################## end of file ############################# #
 
+# ############################## end of file ############################# #