libpath-ruby 0.2.1

data/lib/libpath/internal_/platform.rb

@@ -0,0 +1,53 @@
+
+# :stopdoc:
+
+module LibPath # :nodoc:
+# @!visibility private
+module Internal_ # :nodoc: all
+
+# @!visibility private
+module Platform # :nodoc: all
+
+	# @!visibility private
+	module OS_Internal_ # :nodoc: all
+
+		# @!visibility private
+		def self.win_platform_? # :nodoc:
+
+			return true if 'Windows_NT' == ENV['OS']
+
+			[
+				'bccwin',
+				'cygwin',
+				'djgpp',
+				'mingw',
+				'mswin',
+				'wince',
+			].each do |os_name|
+
+				return true if /#{os_name}/i =~ RUBY_PLATFORM
+			end
+
+			false
+		end
+
+	end # module OS_Internal_
+
+	# @!visibility private
+	module Constants # :nodoc: all
+
+		# @!visibility private
+		PLATFORM_IS_WINDOWS	=	OS_Internal_.win_platform_? # :nodoc:
+
+	end # module Constants
+
+end # module Platform
+
+end # module Internal_
+end # module LibPath
+
+# :startdoc:
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/internal_/string.rb

@@ -0,0 +1,33 @@
+
+module LibPath # :nodoc:
+# @!visibility private
+module Internal_ # :nodoc: all
+
+module String # :nodoc:
+
+	# @!visibility private
+	def self.rindex2(s, c1, c2) # :nodoc:
+
+		ri_1	=	s.rindex(c1)
+		ri_2	=	s.rindex(c2)
+
+		if ri_1
+
+			if ri_2
+
+				ri_1 < ri_2 ? ri_2 : ri_1
+			else
+
+				ri_1
+			end
+		else
+
+			ri_2
+		end
+	end
+
+end
+
+end
+end
+

data/lib/libpath/internal_/unix/form.rb

@@ -0,0 +1,160 @@
+
+module LibPath # :nodoc:
+# @!visibility private
+module Internal_ # :nodoc: all
+module Unix # :nodoc:
+
+module Form # :nodoc:
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.char_is_path_name_separator? c # :nodoc:
+
+		'/' == c
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.append_trailing_slash s # :nodoc:
+
+		return s if '/' == s[-1]
+
+		s + '/'
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.get_trailing_slash s # :nodoc:
+
+		'/' == s[-1] ? '/' : nil
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.has_trailing_slash? s # :nodoc:
+
+		'/' == s[-1]
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.trim_trailing_slash s # :nodoc:
+
+		return s unless '/' == s[-1]
+
+		s.chop
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.elide_redundant_path_name_separators s # :nodoc:
+
+		s.gsub(/\/\/+/, '/')
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.elide_redundant_path_name_separators! s # :nodoc:
+
+		s.gsub!(/\/\/+/, '/')
+
+		s
+	end
+
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# Returns tuple of:
+	#
+	# 0. source path (with redundant path name separators elided)
+	# 1. Windows volume (which is always nil)
+	# 2. Directory
+	# 3. Basename
+	# 4. Stem
+	# 5. Extension
+	# 6. Directory parts
+	# 7. Directory path parts
+	#
+	# @!visibility private
+	def self.split_path s, **options # :nodoc:
+
+		f2_directory	=	nil
+		f3_basename		=	nil
+		f4_stem			=	nil
+		f5_extension	=	nil
+		f6_dir_parts	=	[]
+
+		s				=	self.elide_redundant_path_name_separators s
+
+		ri_slash		=	s.rindex('/')
+
+		if ri_slash
+
+			f2_directory	=	s[0..ri_slash]
+			f3_basename		=	s[(1 + ri_slash)..-1]
+		else
+
+			f2_directory	=	nil
+			f3_basename		=	s
+		end
+
+		case f3_basename
+		when '.', '..'
+
+			f4_stem			=	f3_basename
+			f5_extension	=	nil
+		else
+
+			ri_dot			=	f3_basename.rindex('.')
+
+			if ri_dot
+
+				f4_stem			=	f3_basename[0...ri_dot]
+				f5_extension	=	f3_basename[ri_dot..-1]
+			else
+
+				f4_stem			=	f3_basename
+				f5_extension	=	nil
+			end
+		end
+
+		unless options[:suppress_parts]
+
+			case f2_directory
+			when nil
+
+				;
+			when '/'
+
+				f6_dir_parts	=	[ '/' ]
+			else
+
+				f6_dir_parts	=	f2_directory.split('/').reject { |v| v.empty? }.map { |v| v + '/' }
+				f6_dir_parts.unshift('/') if '/' == f2_directory[0]
+			end
+		end
+
+
+		[ s, nil, f2_directory, f3_basename, f4_stem, f5_extension, f6_dir_parts, f6_dir_parts ].map { |v| ::String === v && v.empty? ? nil : v }
+	end
+end # module Form
+
+end # module Unix
+end # module Internal_
+end # module LibPath
+

data/lib/libpath/internal_/windows/drive.rb

@@ -0,0 +1,84 @@
+
+module LibPath # :nodoc:
+# @!visibility private
+module Internal_ # :nodoc: all
+module Windows # :nodoc:
+module Drive # :nodoc:
+
+module Constants # :nodoc:
+
+	DRIVE_LETTERS = [
+
+		'C',
+		'D',
+		'E',
+		'F',
+		'G',
+		'H',
+		'I',
+		'J',
+		'K',
+		'L',
+		'M',
+		'N',
+		'P',
+		'Q',
+		'R',
+		'S',
+		'T',
+		'U',
+		'V',
+		'W',
+		'I',
+		'X',
+		'Y',
+		'Z',
+
+		'c',
+		'd',
+		'e',
+		'f',
+		'g',
+		'h',
+		'i',
+		'j',
+		'k',
+		'l',
+		'm',
+		'n',
+		'p',
+		'q',
+		'r',
+		's',
+		't',
+		'u',
+		'v',
+		'w',
+		'i',
+		'x',
+		'y',
+		'z',
+
+		'A',
+		'B',
+
+		'a',
+		'b',
+
+	]
+end # module Constants
+
+	# @!visibility private
+	def self.character_is_drive_letter? ch # :nodoc:
+
+		::LibPath::Internal_::Windows::Drive::Constants::DRIVE_LETTERS.include? ch
+	end
+
+end # module Drive
+end # module Windows
+end # module Internal_
+end # module LibPath
+
+# ############################## end of file ############################# #
+
+

data/lib/libpath/internal_/windows/form.rb

@@ -0,0 +1,281 @@
+
+require 'libpath/internal_/string'
+require 'libpath/internal_/windows/drive'
+
+module LibPath # :nodoc:
+# @!visibility private
+module Internal_ # :nodoc: all
+module Windows # :nodoc:
+
+module Form # :nodoc:
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.char_is_path_name_separator? c # :nodoc:
+
+		'/' == c || '\\' == c
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.append_trailing_slash s # :nodoc:
+
+		return s if self.char_is_path_name_separator?(s[-1])
+
+		s + '\\'
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.get_trailing_slash s # :nodoc:
+
+		last = s[-1]
+
+		self.char_is_path_name_separator?(last) ? last : nil
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.has_trailing_slash? s # :nodoc:
+
+		self.char_is_path_name_separator?(s[-1])
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.trim_trailing_slash s # :nodoc:
+
+		return s unless self.char_is_path_name_separator?(s[-1])
+
+		s.chop
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.elide_redundant_path_name_separators s # :nodoc:
+
+		s.gsub(/[\\\/]{2,}/, '\\')
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# @!visibility private
+	def self.elide_redundant_path_name_separators! s # :nodoc:
+
+		s.gsub!(/[\\\/]{2,}/, '\\')
+
+		s
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#  - +s+ (String)
+	#
+	# === Return
+	# A 3-element array, consisting of [ volume, remainder, form ]
+	#
+	# @!visibility private
+	def self.get_windows_volume s # :nodoc:
+
+		# 0. not matched
+		# 1. X:
+		# 2. \\server\share
+		# 3. \\?\X:
+		# 4. \\?\server\share
+		# 5. \\?\UNC\server\share
+		# 6. \\.\device
+
+		if '\\' == s[0]
+
+			if '\\' == s[1]
+
+				case s[2]
+				when '?'
+
+					if '\\' == s[3]
+
+						if ':' == s[5] && ::LibPath::Internal_::Windows::Drive.character_is_drive_letter?(s[4])
+
+							# 3. \\?\X:
+
+							return [ s[0..5], s[6..-1], :form_3 ]
+						end
+
+						if 'U' == s[4] && 'N' == s[5] && 'C' == s[6]
+
+							# 5. \\?\UNC\server\share
+
+							if s =~ /^\\\\\?\\UNC\\[^\\]+\\[^\\\/]+/
+
+								return [ $&, $', :form_5 ]
+							end
+						else
+
+							if s =~ /^\\\\\?\\[^\\]+\\[^\\\/]+/
+
+								# 4. \\?\server\share
+
+								return [ $&, $', :form_4 ]
+							end
+						end
+
+						return [ s, '', :malformed ]
+					end
+				when '.'
+
+					if s =~ /^\\\\\.\\[^\\]+/
+
+						# 6. \\.\device
+
+						return [ $&, $', :form_6 ]
+					end
+				else
+
+						if s =~ /^\\\\[^\\]+\\[^\\\/]+/
+
+							# 2. \\server\share
+
+							return [ $&, $', :form_2 ]
+						end
+				end
+			else
+
+			end
+		elsif ':' == s[1] && ::LibPath::Internal_::Windows::Drive.character_is_drive_letter?(s[0])
+
+			# 1. X:
+
+			return [ s[0..1], s[2..-1], :form_1 ]
+		end
+
+		# 0. not matched
+
+		[ nil, s, :form_0 ]
+	end
+
+	# [INTERNAL] This function is undocumented, and subject to change at any
+	# time
+	#
+	# Returns tuple of:
+	#
+	# 0. source path (with redundant path name separators elided)
+	# 1. Windows volume (which is always nil)
+	# 2. Directory
+	# 3. Basename
+	# 4. Stem
+	# 5. Extension
+	# 6. Directory parts
+	# 7. Directory path parts
+	#
+	# @!visibility private
+	def self.split_path s # :nodoc:
+
+		f1_volume		=	nil
+		f2_directory	=	nil
+		f3_basename		=	nil
+		f4_stem			=	nil
+		f5_extension	=	nil
+		f6_dir_parts	=	[]
+		f7_all_parts	=	[]
+
+		f1_volume, rem, frm	=	self.get_windows_volume s
+
+		self.elide_redundant_path_name_separators! rem
+
+		f1_volume.define_singleton_method(:form) { frm } if f1_volume
+
+		if :malformed == frm
+
+			return [ s, f1_volume, nil, nil, nil, nil, [], [] ]
+		end
+
+		unless rem.empty?
+
+			ri_slash		=	::LibPath::Internal_::String.rindex2(rem, '/', '\\')
+
+			if ri_slash
+
+				f2_directory	=	rem[0..ri_slash]
+				f3_basename		=	rem[(1 + ri_slash)..-1]
+			else
+
+				f2_directory	=	nil
+				f3_basename		=	rem
+			end
+
+			case f3_basename
+			when '.', '..'
+
+				f4_stem			=	f3_basename
+				f5_extension	=	nil
+			else
+
+				ri_dot			=	f3_basename.rindex('.')
+
+				if ri_dot
+
+					f4_stem			=	f3_basename[0...ri_dot]
+					f5_extension	=	f3_basename[ri_dot..-1]
+				else
+
+					f4_stem			=	f3_basename
+					f5_extension	=	nil
+				end
+			end
+
+			case f2_directory
+			when nil
+
+				;
+			when '\\', '/'
+
+				f6_dir_parts		=	[ f2_directory ]
+			else
+
+				parts				=	f2_directory.split(/([\\\/])/)
+
+				f6_dir_parts		=	[]
+
+				(0...(parts.size / 2)).each do |ix|
+
+					f6_dir_parts	<<	parts[2 * ix + 0] + parts[2 * ix + 1]
+				end
+			end
+
+			if f1_volume
+
+				f7_all_parts		=	f6_dir_parts.dup
+
+				f7_all_parts[0]		=	f1_volume + f7_all_parts[0].to_s
+			else
+
+				f7_all_parts		=	f6_dir_parts
+			end
+		end
+
+
+		[ "#{f1_volume}#{rem}", f1_volume, f2_directory, f3_basename, f4_stem, f5_extension, f6_dir_parts, f7_all_parts ].map { |v| ::String === v && v.empty? ? nil : v }
+	end
+end # module Form
+
+end # module Windows
+end # module Internal_
+end # module LibPath
+