libpath-ruby 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6dd88bc30d1032ce6d4a4b279bb0692fbc0669205be981d9182abd7b6adbf7b9
+  data.tar.gz: 778b9b33864a813d2ab4ff67b8685f6ee193c0eeeb9b4632647a655ca4ff6ab5
+SHA512:
+  metadata.gz: 02f1f20771f342c7df0945a887a3611fe1357e06e7a22c182382901711c837aef4fe6ec12e7c3ade63d9e86ee52697b30957eec7544271d998192ba3d633b9a3
+  data.tar.gz: 3a1bcce47edcfdee2f20a05fa7d42b4929d5a7abce60fec405e8d89e5141597825cf4cfd4dee0c74f057540f4e167bc44ce556891345aacb7a4ee690fbd8d33f

data/README.md

@@ -0,0 +1,61 @@
+# libpath.Ruby
+**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)
+
+## 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
+```
+
+or add it to your `Gemfile`.
+
+Use via **require**, as in:
+
+```Ruby
+require 'libpath'
+```
+
+## Components
+
+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.
+

data/examples/path_from_arg0.md

@@ -0,0 +1,99 @@
+# libpath.Ruby Example - **path_from_arg0**
+
+## Summary
+
+Simple example illustrating creation of an instance of ``LibPath::Path::ParsedPath``, and obtaining from it its attributes
+
+## Source
+
+```ruby
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+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
+}
+
+
+arg0 = ARGV[0] or abort "USAGE: <name> [<search-dir>]"
+arg1 = ARGV[1]
+
+path = LibPath::Path::ParsedPath.new arg0, arg1
+
+puts "path obtained from '#{arg0}'" + (arg1 ? " (with search directory '#{arg1}')" : '') + ':'
+puts
+
+puts "\tpath: #{path}"
+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 }
+
+PATH_ATTRIBUTES.each do |attr|
+
+	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}"
+end
+```
+
+## Usage
+
+When executed with the following command-line (on my machine):
+
+```
+./examples/path_from_arg0.rb .gitignore ../../../CLASP/CLASP.Ruby/trunk
+```
+
+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/"]
+```
+

data/examples/path_from_arg0.rb

@@ -0,0 +1,55 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+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
+}
+
+
+arg0 = ARGV[0] or abort "USAGE: <name> [<search-dir>]"
+arg1 = ARGV[1]
+
+path = LibPath::Path::ParsedPath.new arg0, arg1
+
+puts "path obtained from '#{arg0}'" + (arg1 ? " (with search directory '#{arg1}')" : '') + ':'
+puts
+
+puts "\tpath: #{path}"
+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 }
+
+PATH_ATTRIBUTES.each do |attr|
+
+	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}"
+end
+
+

data/lib/libpath.rb

@@ -0,0 +1,12 @@
+
+require 'libpath/libpath'
+
+require 'libpath/form'
+require 'libpath/path'
+require 'libpath/util'
+
+require 'libpath/version'
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/constants.rb

@@ -0,0 +1,42 @@
+
+require 'libpath/internal_/platform'
+
+if ::LibPath::Internal_::Platform::Constants::PLATFORM_IS_WINDOWS then
+
+	require 'libpath/constants/windows'
+else
+
+	require 'libpath/constants/unix'
+end
+
+module LibPath # :nodoc:
+module Constants # :nodoc:
+
+	if ::LibPath::Internal_::Platform::Constants::PLATFORM_IS_WINDOWS then
+
+		extend ::LibPath::Constants::Windows
+		include ::LibPath::Constants::Windows
+	else
+
+		extend ::LibPath::Constants::Unix
+		include ::LibPath::Constants::Unix
+	end
+
+	# @!visibility private
+	def self.extended receiver # :nodoc:
+
+		$stderr.puts "#{receiver} extended by #{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 ############################# #
+
+

data/lib/libpath/constants/unix.rb

@@ -0,0 +1,146 @@
+# ######################################################################## #
+# File:         libpath/constants/unix.rb
+#
+# Purpose:      LibPath::Constants::Unix module
+#
+# Created:      29th January 2019
+# Updated:      16th April 2019
+#
+# Home:         http://github.com/synesissoftware/libpath.Ruby
+#
+# Author:       Matthew Wilson
+#
+# 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:
+#
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+# * 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.
+#
+# * Neither the names 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.
+#
+# ######################################################################## #
+
+
+
+=begin
+=end
+
+module LibPath # :nodoc:
+module Constants # :nodoc:
+module Unix # :nodoc:
+
+# 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
+
+		# Innately invalid characters
+		module Innate
+
+			# The list of characters
+			LIST	=	[
+
+				"\0",
+			]
+			# The regular expression
+			RE		=	/[#{LIST.map { |m| Regexp.escape m }.join}]/
+		end # module Innate
+
+		# Valid path name separator characters
+		module PathNameSeparators
+
+			# The list of characters
+			LIST	=	[
+
+				'/',
+			]
+			# The regular expression
+			RE		=	/[#{LIST.map { |m| Regexp.escape m }.join}]/
+		end # module PathNameSeparators
+
+		# Valid path separator characters
+		module PathSeparators
+
+			# The list of characters
+			LIST	=	[
+
+				':',
+			]
+			# The regular expression
+			RE		=	/[#{LIST.map { |m| Regexp.escape m }.join}]/
+		end # module PathSeparators
+
+		# Invalid shell characters
+		module Shell
+
+			# 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
+
+# @!visibility private
+def self.extended receiver # :nodoc:
+
+	receiver.class_eval do
+
+		extend LibPath_Constants_Unix_Methods
+	end
+
+	$stderr.puts "#{receiver} extended by #{LibPath_Constants_Unix_Methods}" if $DEBUG
+end
+
+# @!visibility private
+def self.included receiver # :nodoc:
+
+	receiver.class_eval do
+
+		include LibPath_Constants_Unix_Methods
+	end
+
+	$stderr.puts "#{receiver} included #{LibPath_Constants_Unix_Methods}" if $DEBUG
+end
+
+extend LibPath_Constants_Unix_Methods
+include LibPath_Constants_Unix_Methods
+
+end # module Unix
+end # module Constants
+end # module LibPath
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/constants/windows.rb

@@ -0,0 +1,147 @@
+# ######################################################################## #
+# File:         libpath/constants/windows.rb
+#
+# Purpose:      LibPath::Constants::Windows module
+#
+# Created:      29th January 2019
+# Updated:      16th April 2019
+#
+# Home:         http://github.com/synesissoftware/libpath.Ruby
+#
+# Author:       Matthew Wilson
+#
+# 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:
+#
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+# * 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.
+#
+# * Neither the names 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.
+#
+# ######################################################################## #
+
+
+
+=begin
+=end
+
+module LibPath # :nodoc:
+module Constants # :nodoc:
+module Windows # :nodoc:
+
+# 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
+
+		# Innately invalid characters
+		module Innate
+
+			# The list of characters
+			LIST	=	[
+
+				"\0",
+			]
+			# The regular expression
+			RE		=	/[#{LIST.map { |m| Regexp.escape m }.join}]/
+		end # module Innate
+
+		# Valid path name separator characters
+		module PathNameSeparators
+
+			# The list of characters
+			LIST	=	[
+
+				"\\",
+				'/',
+			]
+			# The regular expression
+			RE		=	/[#{LIST.map { |m| Regexp.escape m }.join}]/
+		end # module PathNameSeparators
+
+		# Valid path separator characters
+		module PathSeparators
+
+			# The list of characters
+			LIST	=	[
+
+				';',
+			]
+			# The regular expression
+			RE		=	/[#{LIST.map { |m| Regexp.escape m }.join}]/
+		end # module PathSeparators
+
+		# Invalid shell characters
+		module Shell
+
+			# 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
+
+# @!visibility private
+def self.extended receiver # :nodoc:
+
+	receiver.class_eval do
+
+		extend LibPath_Constants_Windows_Details
+	end
+
+	$stderr.puts "#{receiver} extended by #{LibPath_Constants_Windows_Details}" if $DEBUG
+end
+
+# @!visibility private
+def self.included receiver # :nodoc:
+
+	receiver.class_eval do
+
+		include LibPath_Constants_Windows_Details
+	end
+
+	$stderr.puts "#{receiver} included #{LibPath_Constants_Windows_Details}" if $DEBUG
+end
+
+extend LibPath_Constants_Windows_Details
+include LibPath_Constants_Windows_Details
+
+end # module Windows
+end # module Constants
+end # module LibPath
+
+# ############################## end of file ############################# #
+
+