Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 3.54 KB

README.md

File metadata and controls

69 lines (50 loc) · 3.54 KB
Raw

Pathname for Crystal

Crystal implementation of Ruby's Pathname object.

Versions

Latest version is 0.1.6 .

Show CHANGELOG.md for more details.

Installation

Add this to your application's shard.yml:

dependencies:
  pathname:
    github: arcage/crystal-pathname

Usage

require "pathname"

Pathname.new("foo/bar")  + "baz"    # => #<Pathname:foo/bar/baz>
Pathname.new("foo/bar/") + "baz"    # => #<Pathname:foo/bar/baz>
Pathname.new("foo/bar")  + "/baz"   # => #<Pathname:/baz>
Pathname.new("foo/bar")  + "../baz" # => #<Pathname:foo/baz>

Pathname.new("foo/bar")        <=> Pathname.new("foo/bar") #=>  0
Pathname.new("foo/../foo/bar") <=> Pathname.new("foo/bar") #=> -1
Pathname.new("foo/foo/../bar") <=> Pathname.new("foo/bar") #=>  1

Pathname.new("foo/bar")        ==  Pathname.new("foo/bar") #=> true
Pathname.new("foo/../foo/bar") ==  Pathname.new("foo/bar") #=> false
Pathname.new("foo/../foo/bar") === Pathname.new("foo/bar") #=> true

Pathname.new("/foo/bar").relative_path_from("/foo/buz") #=> #<Pathname:../bar>

Available Methods

Class methods

.cwd, .glob, new

Instance methods

#+, #/, #<=>, #==, #===, #absolute?, #ascend, #atime, #basename, #blockdev?, #chardev?, #children, #cleanpath, #ctime, #delete, #descend, #directory?, #dirname, #each_child(with block), #each_entry, #each_filename, #each_line(with block), #entries, #executable?, #exists?, #expand_path, #extname, #file?, #join, #lstat, #make_link, #make_symlink?, #mkdir, #mkdir_p, #open, #opendir, #parent, #read, #readable?, #real_path, #relative?, #relative_path_from, #rename, #rmdir, #root?, #setgid?, #setuid?, #size, #size?, #socket?, #split, #stat, #sticky?, #sub, #sub_ext, #symlink, #truncate, #utime, #world_readable?, #world_writable?, #writable?, #write, #zero?

Core library extension

When calling the following methods, you can use Pathname object as filename(or dirname/pathname) parameter.

File class

File.basename, File.delete, File.directory?, File.dirname, File.each_line, File.executable?, File.exists?, File.expand_path, File.extname, File.file?, File.link, File.lstat, File.new, File.open, File.read, File.read_lines, File.readable?, File.real_path, File.rename, File.size, File.stat, File.symlink, File.writable?, File.write

Dir class

Dir.cd, Dir.entries, Dir.exists?, Dir.foreach, Dir.mkdir, Dir.mkdir_p, Dir.new, Dir.open, Dir.rmdir

Differences from Ruby's one.

  • Consecutive File::SEPARATORs (ex: "//") in a path string are always normalized in #initilize.
  • #===(other : Pathname) returns true when #cleanpath results of self and other are same.
  • Class method .getwd and .pwd are integrated to into .cwd.
  • #world_readable? and #world_writable? return Bool value instead of (Int32|Nil).
  • Some method names are changed to conform with Crystal's File class.
    • #exist? -> #exists?
    • #mkpath -> #mkdir_p
    • #realpath -> #real_path
  • Following methods are unavailable(at this version).
    • top level method Pathname()
    • instance methods #binread, #binwrite, #birthtime, #chmod, #chown, #each_child(without block), #each_line(without block), #find, #fnmatch, #fnmatch?, #ftype, #grpowned?, #lchmod, #lchown, #mountpoint?, #pipe?, #owned?, #readable_real?, #readlink, #realdirpath, #rmtree, #sysopen, #to_path