Path - a Path manipulation library

Path is a library to manage paths.
It is similar to Pathname, but has some extra goodness.
The method names are intended to be short and explicit, and avoid too much duplication like having 'name' or 'path' in the method name.

I believe the object-oriented approach to manipulate paths is very elegant and useful.
Paths are naturally the subject of their methods and even if they are simple Strings behind, they carry way much more information and deserve a first-class status.

With Path, there is no need to remember in which class the functionality is implemented, everything is in one place (if not, please open an issue!).

This is the second version of Path, which tries to respect even more the standard library names and the principle of least surprise. For the first version, see the branch 1.3.x.

gem install path

• GitHub
• YARD Documentation
• Changelog

See the Path class documentation for details.

All the useful methods of File (and so IO) and Dir should be included.
Most methods of FileUtils should be there too.

Path.new('/usr/bin')
Path['/usr/bin']
Path('/usr/bin')

Path.new('~myuser/path') # expanded if it begins with ~

# Separators are replaced by / on systems having File::ALT_SEPARATOR
Path.new('win\sepa\rator') # => #<Path win/sepa/rator>

Path.new('/usr', 'bin')
%w[foo bar].map(&Path) # => [Path('foo'), Path('bar')]

Path.file           # == Path(__FILE__).expand
Path.dir            # == Path(File.dirname(__FILE__)).expand
Path.relative(path) # == Path(File.expand_path("../#{path}", __FILE__))
Path.home or Path.~ # == Path(File.expand_path('~'))
Path.~(user)        # == Path(File.expand_path("~#{user}"))

Path.tmpfile
Path.tmpdir

• expand => expand_path
• relative_to => relative_path_from

A path can be split in two or three parts:

   dir      base
 _______   ______
/       \ /      \
/some/dir/file.ext
\_______/ \__/\__/
   dir    stem ext

path = dir "/" base = dir "/" stem ext

All of these are methods of Path:

• dir: "/some/dir"
• base: "file.ext"
• ext: ".ext"
• stem: "file"

• join(*parts)
• /: join paths (as Pathname#+)

Path('/usr')/'bin'

• add_ext / add_extension
• rm_ext / without_extension
• sub_ext(new_ext) / replace_extension(new_ext)

• children: files under self, without . and ..
• glob: relative glob to self, yield absolute paths

• parent: parent directory (don't use #dirname more than once, use #parent instead)
• ascend, ancestors: self and all the parent directories
• descend: in the reverse order
• backfind: ascends the parents until it finds the given path

# Path.backfind is Path.dir.backfind
Path.backfind('lib') # => Path's lib folder

# It accepts XPath-like context
Path.backfind('.[.git]') # => the root of this repository

• read
• write(contents)
• append(contents)

• mkdir
• mkdir_p
• rm_rf

• Path.require_tree: require all .rb files recursively (in alphabetic order)

from = Path('pictures')
to   = Path('output/public/thumbnails')
earth = Path('pictures/nature/earth.jpg')

earth.relocate(from, to, '.png') { |rel| "#{rel}-200" }
# => #<Path output/public/thumbnails/nature/earth-200.png>

One aim of Path is to help the user make the transition coming from String (not using a path library), Pathname, or another library.

To this intent, Path.configure allows to configure the behavior of Path#+.

Coming from String, one should use Path.configure(:+ => :string), and run ruby with the verbose option (-w), which will show where + is used as String concatenation.

Coming from a path library using + as #join, one should just use the default (Path.configure(:+ => :warning)), which will show where + is used.

A couple methods changed since 1.x, all mentioned in the ChangeLog.

One of the easiest way is to grep for the changed methods. Here is a list of each with a direct replacement.

• Path.here => Path.file
• Path#base => Path#stem
• Path#ext => Path#pure_ext (it now returns a leading dot)

This is still in the early development stage, you should expect many additions and some changes.

Benoit Daloze - eregon

Bernard Lambeau - blambeau
Ravil Bayramgalin - brainopia