/usr/share/doc/ruby-filepath/README.md is in ruby-filepath 0.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | 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 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.
Features and examples
---------------------
The main purpose of FilePath is to able to write
require __FILE__.as_path / 'spec' / 'tasks'
instad of cumbersome code like
require File.join(File.dirname(__FILE__), ['spec', 'tasks'])
The main features of FilePath are…
### Path concatenation
oauth_conf = ENV['HOME'].as_path / '.config' / 'myapp' / 'oauth.ini'
oauth_conf.to_s #=> "/home/gioele/.config/myapp/oauth.ini"
joe_home = ENV['HOME'].as_path / '..' / 'joe'
joe_home.to_raw_string #=> "/home/gioele/../joe"
joe_home.to_s #=> "/home/joe"
rel1 = oauth_conf.relative_to(joe_home)
rel1.to_s #=> "../gioele/.config/myapp/oauth.ini"
rel2 = joe_home.relative_to(oauth_conf)
rel2.to_s #=> "../../../joe"
### Path manipulation
image = ENV['HOME'].as_path / 'Documents' / 'images' / 'cat.png'
image.parent_dir.to_s #=> "/home/gioele/Documents/images"
image.filename.to_s #=> "cat.png"
image.extension #=> "png"
converted_img = image.replace_extension("jpeg")
converted_img.to_s #=> "/home/gioele/Documents/images/cat.jpeg"
convert(image, converted_img)
### Path traversal
file_dir = FilePath.new("/srv/example.org/web/html/")
file_dir.descend do |path|
is = path.readable? ? "is" : "is not!"
puts "#{path} #{is} readable"
end
produces
/ is readable
/srv is readable
/srv/example.org is readable
/srv/example.org/web is not! readable
/srv/example.org/web/html is not! redable
### Shortcuts for file and directory operations
home_dir = ENV['HOME']
files = home_dir.files
files.count #=> 3
files.each { |path| puts path.filename.to_s }
produces
# .bashrc
# .vimrc
# TODO.txt
Similarly,
dirs = home_dir.directories
dirs.count #=> 2
dirs.each { |path| puts path.filename.to_s + "/"}
produces
# .ssh/
# Documents/
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.
Installation
------------
gem install filepath
Authors
-------
* Gioele Barabucci <http://svario.it/gioele> (initial author)
Development
-----------
Code
: <https://github.com/gioele/filepath>
Report issues
: <https://github.com/gioele/filepath/issues>
Documentation
: <http://rubydoc.info/gems/filepath>
License
-------
This is free software released into the public domain (CC0 license).
See the `COPYING` file or <http://creativecommons.org/publicdomain/zero/1.0/>
for more details.
|