filepath 0.4 → 0.5

data/.yardoc/checksums

@@ -0,0 +1,5 @@
+lib/filepath/filepathlist.rb 335c103f2ff2f3f0ac8002e6572efec06bc6a39f
+lib/filepath.rb b4eb1e60d85d4eec7fcc37bb64429918d7750887
+lib/filepath/filepath.rb 0c95f278feab4f64cd5535d1c994338b5c2c2638
+lib/filepath/core_ext/array.rb b774c4cbf988b1cd154222454dbc36730d4f5fe7
+lib/filepath/core_ext/string.rb 75d10671a6f439286f1c7d4f81d03eb84c3796f6

data/Rakefile

@@ -13,7 +13,7 @@ Bones {
 	email    'gioele@svario.it'
 	url      'http://github.com/gioele/filepath'
 
-	version  '0.4'
+	version  '0.5'
 
 	ignore_file  '.gitignore'
 

data/lib/filepath/filepath.rb

@@ -68,8 +68,6 @@ class FilePath
 		return FilePath.join(self, *extra_paths)
 	end
 
-	alias :append :join
-
 
 	# An alias for {FilePath#/}.
 	#
@@ -165,8 +163,8 @@ class FilePath
 	#
 	#     tmp_dir.relative_to_file(rc_file) #=> <../../tmp>
 	#
-	# @param [FilePath, String] base the file to use as base for the
-	#                                relative path
+	# @param [FilePath, String] base_file the file to use as base for the
+	#                                     relative path
 	#
 	# @return [FilePath] the relative path
 	#
@@ -185,11 +183,13 @@ class FilePath
 	# @return [FilePath] the filename
 
 	def filename
-		if self.root?
+		segs = self.normalized_segments
+
+		if self.root? || segs.empty?
 			return ''.as_path
 		end
 
-		filename = self.normalized_segments.last
+		filename = segs.last
 		return filename.as_path
 	end
 
@@ -210,7 +210,7 @@ class FilePath
 	# @example
 	#
 	#     post = "posts/2012-02-16-hello-world/index.md".as_path
-	#     style = post.replace_filename("style.css")
+	#     style = post.with_filename("style.css")
 	#     style.to_s #=> "posts/2012-02-16-hello-world/style.css"
 	#
 	# @param [FilePath, String] new_path the path to be put in place of
@@ -220,14 +220,16 @@ class FilePath
 	#                    current filename
 	#
 	# @see #filename
-	# @see #replace_extension
+	# @see #with_extension
 
-	def replace_filename(new_path)
+	def with_filename(new_path)
 		dir = self.parent_dir
 		return dir / new_path
 	end
 
-	alias :replace_basename :replace_filename
+	alias :with_basename :with_filename
+	alias :replace_filename :with_filename
+	alias :replace_basename :with_filename
 
 
 	# The extension of the file.
@@ -289,44 +291,44 @@ class FilePath
 	#
 	# @see #extension
 	# @see #extension?
-	# @see #remove_extension
-	# @see #replace_filename
+	# @see #without_extension
+	# @see #with_filename
 	#
-	# @overload replace_extension(new_ext)
+	# @overload with_extension(new_ext)
 	#     Replaces the file extension with the supplied one. If the file
 	#     has no extension it is added to the file name together with a dot.
 	#
 	#     @example Extension replacement
 	#
 	#         src_path = "pages/about.markdown".as_path
-	#         html_path = src_path.replace_extension("html")
+	#         html_path = src_path.with_extension("html")
 	#         html_path.to_s #=> "pages/about.html"
 	#
 	#     @example Extension addition
 	#
 	#         base = "style/main-style".as_path
-	#         sass_style = base.replace_extension("sass")
+	#         sass_style = base.with_extension("sass")
 	#         sass_style.to_s #=> "style/main-style.sass"
 	#
 	#     @param [String] new_ext the new extension
 	#
 	#     @return [FilePath] a new path with the replaced extension
 	#
-	# @overload replace_extension
+	# @overload with_extension
 	#     Removes the file extension if present.
 	#
-	#     The {#remove_extension} method provides the same functionality
+	#     The {#without_extension} method provides the same functionality
 	#     but has a more meaningful name.
 	#
 	#     @example
 	#
 	#         post_file = "post/welcome.html"
-	#         post_url = post_file.replace_extension(nil)
+	#         post_url = post_file.with_extension(nil)
 	#         post_url.to_s #=> "post/welcome"
 	#
 	#     @return [FilePath] a new path without the extension
 
-	def replace_extension(new_ext) # FIXME: accept block
+	def with_extension(new_ext) # FIXME: accept block
 		orig_filename = filename.to_s
 
 		if !self.extension?
@@ -351,8 +353,9 @@ class FilePath
 		return FilePath.new(segs)
 	end
 
-	alias :replace_ext :replace_extension
-	alias :sub_ext :replace_extension
+	alias :replace_extension :with_extension
+	alias :replace_ext :with_extension
+	alias :sub_ext :with_extension
 
 
 	# Removes the file extension if present.
@@ -360,18 +363,19 @@ class FilePath
 	# @example
 	#
 	#     post_file = "post/welcome.html"
-	#     post_url = post_file.remove_extension
+	#     post_url = post_file.without_extension
 	#     post_url.to_s #=> "post/welcome"
 	#
 	# @return [FilePath] a new path without the extension
 	#
-	# @see #replace_extension
+	# @see #with_extension
 
-	def remove_extension
-		return replace_ext(nil)
+	def without_extension
+		return with_extension(nil)
 	end
 
-	alias :remove_ext :remove_extension
+	alias :remove_ext :without_extension
+	alias :remove_extension :without_extension
 
 
 	# Matches a pattern against this path.
@@ -460,6 +464,36 @@ class FilePath
 
 	alias :normalised :normalized
 
+	# Iterates over all the path segments, from the leftmost to the
+	# rightmost.
+	#
+	# @example
+	#
+	#     web_dir = "/srv/example.org/web/html".as_path
+	#     web_dir.each_segment do |seg|
+	#         puts seg
+	#     end
+	#
+	#     # produces
+	#     #
+	#     # /
+	#     # srv
+	#     # example.org
+	#     # web
+	#     # html
+	#
+	# @yield [path] TODO
+	#
+	# @return [FilePath] the path itself.
+	#
+	# @see #ascend
+	# @see #descend
+
+	def each_segment(&block)
+		@segments.each(&block)
+		return self
+	end
+
 
 	# Iterates over all the path directories, from the current path to
 	# the root.
@@ -488,6 +522,7 @@ class FilePath
 	#
 	# @return [FilePath] the path itself.
 	#
+	# @see #each_segment
 	# @see #descend
 
 	def ascend(max_depth = nil, &block)
@@ -521,6 +556,7 @@ class FilePath
 	#
 	# @return [FilePath] the path itself.
 	#
+	# @see #each_segment
 	# @see #ascend
 
 	def descend(max_depth = nil, &block)
@@ -626,6 +662,11 @@ class FilePath
 		return @segments == other.segments
 	end
 
+	# @private
+	def <=>(other)
+		return self.normalized_segments <=> other.normalized_segments
+	end
+
 	# @private
 	def hash
 		return @segments.hash
@@ -655,9 +696,6 @@ class FilePath
 	def normalized_relative_segs(orig_segs)
 		segs = orig_segs.dup
 
-		# remove "current dir" markers
-		segs.delete('.')
-
 		i = 0
 		while (i < segs.length)
 			if segs[i] == '..' && segs[i-1] == SEPARATOR
@@ -669,6 +707,10 @@ class FilePath
 				segs.delete_at(i)
 				segs.delete_at(i-1)
 				i -= 2
+			elsif segs[i] == '.'
+				# remove "current dir" markers
+				segs.delete_at(i)
+				i -= 1
 			end
 			i += 1
 		end
@@ -683,36 +725,69 @@ class FilePath
 		return segs.join(SEPARATOR).sub(%r{^//}, SEPARATOR).sub(/\A\Z/, '.')
 	end
 
-	module PathResolution
-		def absolute_path(base_dir = Dir.pwd) # FIXME: rename to `#absolute`?
-			if self.absolute?
-				return self
+	module MethodDelegation
+		# @private
+		def define_io_method(filepath_method, io_method = nil)
+			io_method ||= filepath_method
+			define_method(filepath_method) do |*args, &block|
+				return File.send(io_method, self, *args, &block)
 			end
-
-			return base_dir.as_path / self
-		end
-
-		def real_path(base_dir = Dir.pwd)
-			path = absolute_path(base_dir)
-
-			return path.resolve_link
 		end
 
-		alias :realpath :real_path
-
-		def resolve_link
-			return File.readlink(self).as_path
+		# @private
+		def define_file_method(filepath_method, file_method = nil)
+			file_method ||= filepath_method
+			define_method(filepath_method) do |*args|
+				all_args = args + [self]
+				return File.send(file_method, *all_args)
+			end
 		end
-	end
 
-	module FileInfo
 		# @private
-		def self.define_filetest_method(filepath_method, filetest_method = nil)
+		def define_filetest_method(filepath_method, filetest_method = nil)
 			filetest_method ||= filepath_method
 			define_method(filepath_method) do
 				return FileTest.send(filetest_method, self)
 			end
 		end
+	end
+
+	module MetadataInfo
+		extend MethodDelegation
+
+		define_file_method :stat
+
+		define_file_method :lstat
+
+		define_file_method :atime
+
+		define_file_method :ctime
+
+		define_file_method :mtime
+	end
+
+	module MetadataChanges
+		extend MethodDelegation
+
+		# utime(atime, mtime)
+		define_file_method :utime
+		alias :chtime :utime
+
+		# chmod(mode)
+		define_file_method :chmod
+
+		# lchmod(mode)
+		define_file_method :lchmod
+
+		# chown(owner_id, group_id)
+		define_file_method :chown
+
+		# lchown(owner_id, group_id)
+		define_file_method :lchown
+	end
+
+	module MetadataTests
+		extend MethodDelegation
 
 		define_filetest_method :file?
 
@@ -721,6 +796,14 @@ class FilePath
 
 		define_filetest_method :directory?
 
+		define_filetest_method :pipe?
+
+		define_filetest_method :socket?
+
+		define_filetest_method :blockdev?
+
+		define_filetest_method :chardev?
+
 		define_filetest_method :exists?
 		alias :exist? :exists?
 
@@ -734,26 +817,108 @@ class FilePath
 
 		define_filetest_method :setuid?
 
-		define_filetest_method :empty?, :zero?
-		alias :zero? :empty?
+		define_filetest_method :sticky?
 
 		def hidden?
 			@segments.last.start_with?('.') # FIXME: windows, mac
 		end
 	end
 
-	module FileManipulationMethods
-		def open(*args, &block)
-			File.open(self, *args, &block)
+	module FilesystemInfo
+		def absolute_path(base_dir = Dir.pwd) # FIXME: rename to `#absolute`?
+			if self.absolute?
+				return self
+			end
+
+			return base_dir.as_path / self
+		end
+
+		def real_path(base_dir = Dir.pwd)
+			path = absolute_path(base_dir)
+
+			return path.resolve_link
 		end
 
+		alias :realpath :real_path
+
+		def resolve_link
+			return File.readlink(self).as_path
+		end
+	end
+
+	module FilesystemChanges
 		def touch
 			self.open('a') do ; end
 			File.utime(File.atime(self), Time.now, self)
 		end
 	end
 
-	module DirectoryMethods
+	module FilesystemTests
+		def mountpoint?
+			if !directory? || !exists?
+				return false
+			end
+
+			if root?
+				return true
+			end
+
+			return self.lstat.dev != parent_dir.lstat.dev
+		end
+	end
+
+	module ContentInfo
+		extend MethodDelegation
+
+		define_io_method :read
+
+		if IO.respond_to? :binread
+			define_io_method :binread
+		else
+			alias :binread :read
+		end
+
+		define_io_method :readlines
+
+		define_io_method :size
+	end
+
+	module ContentChanges
+		extend MethodDelegation
+
+		define_io_method :open
+
+		def write(content)
+			open('w') do |file|
+				file.write(content)
+			end
+		end
+
+		def append(content)
+			open('a') do |file|
+				file.write(content)
+			end
+		end
+
+		define_io_method :file_truncate, :truncate
+
+		def truncate(*args)
+			if args.empty?
+				args << 0
+			end
+
+			file_truncate(*args)
+		end
+	end
+
+	module ContentTests
+		extend MethodDelegation
+
+		define_file_method :empty?, :zero?
+		alias :zero? :empty?
+	end
+
+	module SearchMethods
 		def entries(pattern = '*', recursive = false)
 			if !self.directory?
 				raise Errno::ENOTDIR.new(self)
@@ -770,9 +935,9 @@ class FilePath
 		end
 		alias :glob :entries
 
-		def find(pattern = nil, &block)
-			if pattern.respond_to? :to_str
-				return entries(pattern, true)
+		def find(pattern = nil, recursive = true, &block)
+			if !pattern.nil? && pattern.respond_to?(:to_str)
+				return entries(pattern, recursive)
 			end
 
 			if !block_given?
@@ -795,8 +960,23 @@ class FilePath
 		end
 	end
 
-	include PathResolution
-	include FileInfo
-	include FileManipulationMethods
-	include DirectoryMethods
+	module EnvironmentInfo
+		def FilePath.getwd
+			return Dir.getwd.as_path
+		end
+	end
+
+	include MetadataInfo
+	include MetadataChanges
+	include MetadataTests
+
+	include FilesystemInfo
+	include FilesystemChanges
+	include FilesystemTests
+
+	include ContentInfo
+	include ContentChanges
+	include ContentTests
+
+	include SearchMethods
 end