filepath 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62dfbcf4f1dce1088fa0b8f2e34e90ef413007fd
-  data.tar.gz: 5381ef6ee7a5ceb721ed6e72fc604cf4b6f9441c
+  metadata.gz: dc328ecf3eaa82d60d03442bf30115d7a7e94633
+  data.tar.gz: fdcaf08efd0cb19c50e4e6df08f29ca337c32841
 SHA512:
-  metadata.gz: 007539ed47d49ffa9e9147eb0a8e3f8bee3dfc0196cf074fab7528dcf34e6f78536e8736c4d84cc223efacc31fbab7aeb8cd970544503df16d7e30dcdacb5fcf
-  data.tar.gz: 4bac91223e32bfd5618a30b2e77ad5420f29b27cb21505805ae75aede7d99d2468303f43005f77b838817abb90f7aed02c18099bd560594f946bb8b78d850493
+  metadata.gz: 655944ebb17b86931f7b3a8503560189b85cc89f4847e5b01251344135d730e2bc6a6702e41a2f8faec9a94268e470113ccfd2520bbb339c206ff01691a1bac9
+  data.tar.gz: 2ea72768cf531ab78de1faec911041dc9306b38a8a1617548de67de1eb752df468012d7237f0bf2b6ea7eb0961b91e453a676cc3be176b6e51efed4c6b308c48

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - "1.8.7"
   - "1.9.3"
-  - "2.0.0"
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-19mode
+  - "2.1.5"
+  - "2.3.0"
+  - "2.3.3"
+  - jruby-9.1.9.0
+sudo: false

data/README.md

@@ -1,28 +1,28 @@
-FilePath
+filepath
 ========
 
-filepath is a small library that helps dealing with files, directories and
-paths in general; a modern replacement for the standard Pathname.
+filepath is a small library to manipulate paths; a modern replacement
+for the standard Pathname.
 
-filepath is built around two main classes: `FilePath`, that represents paths,
-and `FilePathList`, lists of paths. The instances of these classes are
-immutable objects with dozens of convience methods for common operations such
-as calculating relative paths, concatenating paths, finding all the files in
-a directory or modifing all the extensions of a list of file names at once.
+filepath is built around two main classes: `Filepath`, that represents paths,
+and `FilepathList`, lists of paths. These classes provide immutable objects
+with dozens of convenience methods for common operations such as calculating
+relative paths, concatenating paths, finding all the files in a directory or
+modifying all the extensions of a list of filenames at once.
 
 
 Features and examples
 ---------------------
 
-The main purpose of FilePath is to able to write
+The main purpose of Filepath is to able to write
 
     require __FILE__.as_path / 'spec' / 'tasks'
 
-instad of cumbersome code like
+instead of cumbersome code like
 
     require File.join(File.dirname(__FILE__), ['spec', 'tasks'])
 
-The main features of FilePath are…
+The main features of Filepath are…
 
 ### Path concatenation
 
@@ -52,7 +52,7 @@ The main features of FilePath are…
 
 ### Path traversal
 
-    file_dir = FilePath.new("/srv/example.org/web/html/")
+    file_dir = Filepath.new("/srv/example.org/web/html/")
     file_dir.descend do |path|
         is = path.readable? ? "is" : "is not!"
 
@@ -100,8 +100,8 @@ Requirements
 The `filepath` library does not require any external library: it relies
 complitely on functionalities available in the Ruby's core classes.
 
-The `filepath` library has been tested and found compatible with Ruby 1.8.7,
-Ruby 1.9.3 and JRuby 1.6.
+The `filepath` library has been tested and found compatible with Ruby 1.9.3,
+Ruby 2.3 and JRuby 9.1.x.x.
 
 
 Installation

data/filepath.gemspec

@@ -5,19 +5,16 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
 	spec.name          = "filepath"
-	spec.version       = "0.6"
+	spec.version       = "0.7"
 	spec.authors       = ["Gioele Barabucci"]
 	spec.email         = ["gioele@svario.it"]
-	spec.summary       = "filepath is a small library that helps dealing with files, " +
-	                     "directories and paths in general; a modern replacement for " +
-			     "the standard Pathname."
-	spec.description   = "filepath is built around two main classes: `FilePath`, that " +
-	                     "represents paths, and `FilePathList`, lists of paths. The " +
-			     "instances of these classes are immutable objects with dozens " +
-			     "of convience methods for common operations such as calculating " +
+	spec.summary       = "A small library to manipulate paths; a modern replacement " +
+			     "for the standard Pathname."
+	spec.description   = "The Filepath class provides immutable objects with dozens " +
+			     "of convenience methods for common operations such as calculating " +
 			     "relative paths, concatenating paths, finding all the files in " +
-			     "a directory or modifing all the extensions of a list of file "
-			     "names at once."
+			     "a directory or modifying all the extensions of a list of " +
+			     "filenames at once."
 	spec.homepage      = "http://github.com/gioele/filepath"
 	spec.license       = "CC0"
 
@@ -29,4 +26,5 @@ Gem::Specification.new do |spec|
 	spec.add_development_dependency "bundler", "~> 1.3"
 	spec.add_development_dependency "rake"
 	spec.add_development_dependency "rspec"
+	spec.add_development_dependency "rspec-collection_matchers"
 end

data/lib/filepath/core_ext/array.rb

@@ -4,25 +4,25 @@
 class Array
 	# Generates a path using the elements of an array as path segments.
 	#
-	# `[a, b, c].as_path` is equivalent to `FilePath.join(a, b, c)`.
+	# `[a, b, c].as_path` is equivalent to `Filepath.join(a, b, c)`.
 	#
-	# @example FilePath from an array of strings
+	# @example Filepath from an array of strings
 	#
 	#     ["/", "foo", "bar"].as_path #=> </foo/bar>
 	#
-	# @example FilePath from an array of strings and other FilePaths
+	# @example Filepath from an array of strings and other Filepaths
 	#
 	#     server_dir = config["root_dir"] / "server"
 	#     ["..", config_dir, "secret"].as_path #=> <../config/server/secret>
 	#
-	# @return [FilePath] a new path generated using the element as path
+	# @return [Filepath] a new path generated using the element as path
 	#         segments
 	#
 	# @note FIXME: `#as_path` should be `#to_path` but that method name
 	#       is already used
 
 	def as_path
-		FilePath.join(self)
+		Filepath.join(self)
 	end
 
 
@@ -30,16 +30,16 @@ class Array
 	#
 	# The elements of the array must respond to `#as_path`.
 	#
-	# `ary.as_path` is equivalent to `FilePathList.new(ary)`.
+	# `ary.as_path` is equivalent to `FilepathList.new(ary)`.
 	#
-	# @return [FilePathList] a new path list containing the elements of
-	#                        the array as FilePaths
+	# @return [FilepathList] a new path list containing the elements of
+	#                        the array as Filepaths
 	#
 	# @see String#as_path
 	# @see Array#as_path
-	# @see FilePath#as_path
+	# @see Filepath#as_path
 
 	def as_path_list
-		FilePathList.new(self)
+		FilepathList.new(self)
 	end
 end

data/lib/filepath/core_ext/string.rb

@@ -4,18 +4,18 @@
 class String
 	# Generates a path from a String.
 	#
-	# `"/a/b/c".as_path` is equivalent to `FilePath.new("/a/b/c")`.
+	# `"/a/b/c".as_path` is equivalent to `Filepath.new("/a/b/c")`.
 	#
-	# @example FilePath from a string
+	# @example Filepath from a string
 	#
 	#     "/etc/ssl/certs".as_path #=> </etc/ssl/certs>
 	#
-	# @return [FilePath] a new path generated from the string
+	# @return [Filepath] a new path generated from the string
 	#
 	# @note FIXME: `#as_path` should be `#to_path` but that method name
 	#       is already used
 
 	def as_path
-		FilePath.new(self)
+		Filepath.new(self)
 	end
 end

data/lib/filepath/filepath.rb

@@ -1,11 +1,11 @@
 # This is free software released into the public domain (CC0 license).
 
 
-class FilePath
+class Filepath
 	SEPARATOR = '/'.freeze
 
 	def initialize(path)
-		if path.is_a? FilePath
+		if path.is_a? Filepath
 			@segments = path.segments
 		elsif path.is_a? Array
 			@segments = path
@@ -18,11 +18,11 @@ class FilePath
 	attr_reader :segments
 
 
-	# Creates a FilePath joining the given segments.
+	# Creates a Filepath joining the given segments.
 	#
-	# @return [FilePath] a FilePath created joining the given segments
+	# @return [Filepath] a Filepath created joining the given segments
 
-	def FilePath.join(*raw_paths)
+	def Filepath.join(*raw_paths)
 		if (raw_paths.count == 1) && (raw_paths.first.is_a? Array)
 			raw_paths = raw_paths.first
 		end
@@ -32,7 +32,7 @@ class FilePath
 		segs = []
 		paths.each { |path| segs += path.segments }
 
-		return FilePath.new(segs)
+		return Filepath.new(segs)
 	end
 
 
@@ -42,40 +42,40 @@ class FilePath
 	#
 	#    "a/b".as_path / "c" #=> <a/b/c>
 	#
-	# @example Append another FilePath
+	# @example Append another Filepath
 	#
 	#    home = (ENV["HOME"] || "/root").as_path
 	#    conf_dir = '.config'.as_path
 	#
 	#    home / conf_dir #=> </home/user/.config>
 	#
-	# @param [FilePath, String] extra_path the path to be appended to the
+	# @param [Filepath, String] extra_path the path to be appended to the
 	#                                      current path
 	#
-	# @return [FilePath] a new path with the given path appended
+	# @return [Filepath] a new path with the given path appended
 
 	def /(extra_path)
-		return FilePath.join(self, extra_path)
+		return Filepath.join(self, extra_path)
 	end
 
 
 	# Append multiple paths to the current path.
 	#
-	# @return [FilePath] a new path with all the paths appended
+	# @return [Filepath] a new path with all the paths appended
 
 	def join(*extra_paths)
-		return FilePath.join(self, *extra_paths)
+		return Filepath.join(self, *extra_paths)
 	end
 
 
-	# An alias for {FilePath#/}.
+	# An alias for {Filepath#/}.
 	#
-	# @deprecated Use the {FilePath#/} (slash) method instead. This method
+	# @deprecated Use the {Filepath#/} (slash) method instead. This method
 	#             does not show clearly if a path is being added or if a
 	#             string should be added to the filename
 
 	def +(extra_path)
-		warn "FilePath#+ is deprecated, use FilePath#/ instead."
+		warn "Filepath#+ is deprecated, use Filepath#/ instead."
 		return self / extra_path
 	end
 
@@ -102,10 +102,10 @@ class FilePath
 	#
 	#     tmp_dir.relative_to(home_dir) #=> <../../tmp>
 	#
-	# @param [FilePath, String] base the directory to use as base for the
+	# @param [Filepath, String] base the directory to use as base for the
 	#                                relative path
 	#
-	# @return [FilePath] the relative path
+	# @return [Filepath] the relative path
 	#
 	# @note this method operates on the normalized paths
 	#
@@ -140,7 +140,7 @@ class FilePath
 		segs = [".."] * num_parent_dirs + left_in_self
 		normalized_segs = normalized_relative_segs(segs)
 
-		return FilePath.join(normalized_segs)
+		return Filepath.join(normalized_segs)
 	end
 
 	# Calculates the relative path from a given file.
@@ -162,10 +162,10 @@ class FilePath
 	#
 	#     tmp_dir.relative_to_file(rc_file) #=> <../../tmp>
 	#
-	# @param [FilePath, String] base_file the file to use as base for the
+	# @param [Filepath, String] base_file the file to use as base for the
 	#                                     relative path
 	#
-	# @return [FilePath] the relative path
+	# @return [Filepath] the relative path
 	#
 	# @see #relative_to
 
@@ -179,7 +179,7 @@ class FilePath
 	# The filename is the component of a path that appears after the last
 	# path separator.
 	#
-	# @return [FilePath] the filename
+	# @return [Filepath] the filename
 
 	def filename
 		segs = self.normalized_segments
@@ -197,7 +197,7 @@ class FilePath
 
 	# The dir that contains the file
 	#
-	# @return [FilePath] the path of the parent dir
+	# @return [Filepath] the path of the parent dir
 
 	def parent_dir
 		return self / '..'
@@ -212,10 +212,10 @@ class FilePath
 	#     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
+	# @param [Filepath, String] new_path the path to be put in place of
 	#                                    the current filename
 	#
-	# @return [FilePath] a path with the supplied path instead of the
+	# @return [Filepath] a path with the supplied path instead of the
 	#                    current filename
 	#
 	# @see #filename
@@ -311,7 +311,7 @@ class FilePath
 	#
 	#     @param [String] new_ext the new extension
 	#
-	#     @return [FilePath] a new path with the replaced extension
+	#     @return [Filepath] a new path with the replaced extension
 	#
 	# @overload with_extension
 	#     Removes the file extension if present.
@@ -325,7 +325,7 @@ class FilePath
 	#         post_url = post_file.with_extension(nil)
 	#         post_url.to_s #=> "post/welcome"
 	#
-	#     @return [FilePath] a new path without the extension
+	#     @return [Filepath] a new path without the extension
 
 	def with_extension(new_ext) # FIXME: accept block
 		orig_filename = filename.to_s
@@ -349,7 +349,7 @@ class FilePath
 		segs = @segments[0..-2]
 		segs << new_filename
 
-		return FilePath.new(segs)
+		return Filepath.new(segs)
 	end
 
 	alias :replace_extension :with_extension
@@ -365,7 +365,7 @@ class FilePath
 	#     post_url = post_file.without_extension
 	#     post_url.to_s #=> "post/welcome"
 	#
-	# @return [FilePath] a new path without the extension
+	# @return [Filepath] a new path without the extension
 	#
 	# @see #with_extension
 
@@ -454,11 +454,11 @@ class FilePath
 	#
 	# FIXME: document what normal form is.
 	#
-	# @return [FilePath] a new path that does not contain `.` or `..`
+	# @return [Filepath] a new path that does not contain `.` or `..`
 	#                    segments.
 
 	def normalized
-		return FilePath.join(self.normalized_segments)
+		return Filepath.join(self.normalized_segments)
 	end
 
 	alias :normalised :normalized
@@ -483,7 +483,7 @@ class FilePath
 	#
 	# @yield [path] TODO
 	#
-	# @return [FilePath] the path itself.
+	# @return [Filepath] the path itself.
 	#
 	# @see #ascend
 	# @see #descend
@@ -519,7 +519,7 @@ class FilePath
 	#
 	# @yield [path] TODO
 	#
-	# @return [FilePath] the path itself.
+	# @return [Filepath] the path itself.
 	#
 	# @see #each_segment
 	# @see #descend
@@ -553,7 +553,7 @@ class FilePath
 	#
 	# @yield [path] TODO
 	#
-	# @return [FilePath] the path itself.
+	# @return [Filepath] the path itself.
 	#
 	# @see #each_segment
 	# @see #ascend
@@ -568,7 +568,7 @@ class FilePath
 		max_depth ||= @segments.length
 		(1..max_depth).send(method) do |limit|
 			segs = @segments.take(limit)
-			yield FilePath.join(segs)
+			yield Filepath.join(segs)
 		end
 
 		return self
@@ -609,7 +609,7 @@ class FilePath
 	end
 
 
-	# @return [FilePath] the path itself.
+	# @return [Filepath] the path itself.
 	def as_path
 		self
 	end
@@ -639,7 +639,7 @@ class FilePath
 	#     path1 == path2.parent_dir #=> true
 	#     path1 == path3            #=> true
 	#
-	# @param [FilePath, String] other the other path to compare
+	# @param [Filepath, String] other the other path to compare
 	#
 	# @return [boolean] whether the other path is equivalent to the current path
 	#
@@ -928,7 +928,7 @@ class FilePath
 			glob /= pattern
 
 			raw_entries = Dir.glob(glob)
-			entries = FilePathList.new(raw_entries)
+			entries = FilepathList.new(raw_entries)
 
 			return entries
 		end
@@ -960,7 +960,7 @@ class FilePath
 	end
 
 	module EnvironmentInfo
-		def FilePath.getwd
+		def Filepath.getwd
 			return Dir.getwd.as_path
 		end
 	end