Class: Pathname

Inherits:
Object
  • Object
show all
Defined in:
lib/pathname.rb,
lib/pathname.rb,
lib/pathname.rb,
pathname.c

Overview

  • FileUtils *

Constant Summary collapse

TO_PATH =

to_path is implemented so Pathname objects are usable with File.open, etc.

:to_path
SAME_PATHS = 
if File::FNM_SYSCASE.nonzero?
  # Avoid #zero? here because #casecmp can return nil.
  proc {|a, b| a.casecmp(b) == 0}
else
  proc {|a, b| a == b}
end
SEPARATOR_LIST = 
"#{Regexp.quote File::SEPARATOR}"
SEPARATOR_PAT = 
/#{Regexp.quote File::SEPARATOR}/

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arg) ⇒ Object

Create a Pathname object from the given String (or String-like object). If path contains a NULL character (\0), an ArgumentError is raised.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'pathname.c', line 27

static VALUE
path_initialize(VALUE self, VALUE arg)
{
    VALUE str;
    if (RB_TYPE_P(arg, T_STRING)) {
        str = arg;
    }
    else {
        str = rb_check_funcall(arg, id_to_path, 0, NULL);
        if (str == Qundef)
            str = arg;
        StringValue(str);
    }
    if (memchr(RSTRING_PTR(str), '\0', RSTRING_LEN(str)))
        rb_raise(rb_eArgError, "pathname contains null byte");
    str = rb_obj_dup(str);

    set_strpath(self, str);
    OBJ_INFECT(self, str);
    return self;
}

Class Method Details

.getwd ⇒ Object

Returns the current working directory as a Pathname.

Pathname.getwd

#=> #<Pathname:/home/zzak/projects/ruby>

See Dir.getwd.



1035
1036
1037
1038
1039
1040
1041
 
# File 'pathname.c', line 1035

static VALUE
path_s_getwd(VALUE klass)
{
    VALUE str;
    str = rb_funcall(rb_cDir, rb_intern("getwd"), 0);
    return rb_class_new_instance(1, &str, klass);
}

.glob(*args) ⇒ Object

Returns or yields Pathname objects.

Pathname.glob("config/" "*.rb")

#=> [#<Pathname:config/environment.rb>, #<Pathname:config/routes.rb>, ..]

See Dir.glob.



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'pathname.c', line 1003

static VALUE
path_s_glob(int argc, VALUE *argv, VALUE klass)
{
    VALUE args[2];
    int n;

    n = rb_scan_args(argc, argv, "11", &args[0], &args[1]);
    if (rb_block_given_p()) {
        return rb_block_call(rb_cDir, rb_intern("glob"), n, args, glob_i, klass);
    }
    else {
        VALUE ary;
        long i;
        ary = rb_funcall2(rb_cDir, rb_intern("glob"), n, args);
        ary = rb_convert_type(ary, T_ARRAY, "Array", "to_ary");
        for (i = 0; i < RARRAY_LEN(ary); i++) {
            VALUE elt = RARRAY_AREF(ary, i);
            elt = rb_class_new_instance(1, &elt, klass);
            rb_ary_store(ary, i, elt);
        }
        return ary;
    }
}

.pwd ⇒ Object

Returns the current working directory as a Pathname.

Pathname.getwd

#=> #<Pathname:/home/zzak/projects/ruby>

See Dir.getwd.



1035
1036
1037
1038
1039
1040
1041
 
# File 'pathname.c', line 1035

static VALUE
path_s_getwd(VALUE klass)
{
    VALUE str;
    str = rb_funcall(rb_cDir, rb_intern("getwd"), 0);
    return rb_class_new_instance(1, &str, klass);
}

Instance Method Details

#+(other) ⇒ Object Also known as: /

Appends a pathname fragment to self to produce a new Pathname object.

p1 = Pathname.new("/usr")      # Pathname:/usr
p2 = p1 + "bin/ruby"           # Pathname:/usr/bin/ruby
p3 = p1 + "/etc/passwd"        # Pathname:/etc/passwd

# / is aliased to +.
p4 = p1 / "bin/ruby"           # Pathname:/usr/bin/ruby
p5 = p1 / "/etc/passwd"        # Pathname:/etc/passwd

This method doesn’t access the file system; it is pure string manipulation.



348
349
350
351
 
# File 'lib/pathname.rb', line 348

def +(other)
  other = Pathname.new(other) unless Pathname === other
  Pathname.new(plus(@path, other.to_s))
end

#<=>(other) ⇒ Object

Provides a case-sensitive comparison operator for pathnames.

Pathname.new(‘/usr’) <=> Pathname.new(‘/usr/bin’)

#=> -1

Pathname.new(‘/usr/bin’) <=> Pathname.new(‘/usr/bin’)

#=> 0

Pathname.new(‘/usr/bin’) <=> Pathname.new(‘/USR/BIN’)

#=> 1

It will return -1, 0 or 1 depending on the value of the left argument relative to the right argument. Or it will return nil if the arguments are not comparable.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'pathname.c', line 124

static VALUE
path_cmp(VALUE self, VALUE other)
{
    VALUE s1, s2;
    char *p1, *p2;
    char *e1, *e2;
    if (!rb_obj_is_kind_of(other, rb_cPathname))
        return Qnil;
    s1 = get_strpath(self);
    s2 = get_strpath(other);
    p1 = RSTRING_PTR(s1);
    p2 = RSTRING_PTR(s2);
    e1 = p1 + RSTRING_LEN(s1);
    e2 = p2 + RSTRING_LEN(s2);
    while (p1 < e1 && p2 < e2) {
        int c1, c2;
        c1 = (unsigned char)*p1++;
        c2 = (unsigned char)*p2++;
        if (c1 == '/') c1 = '\0';
        if (c2 == '/') c2 = '\0';
        if (c1 != c2) {
            if (c1 < c2)
                return INT2FIX(-1);
            else
                return INT2FIX(1);
        }
    }
    if (p1 < e1)
        return INT2FIX(1);
    if (p2 < e2)
        return INT2FIX(-1);
    return INT2FIX(0);
}

#==(other) ⇒ Object

Compare this pathname with other. The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file.



102
103
104
105
106
107
108
 
# File 'pathname.c', line 102

static VALUE
path_eq(VALUE self, VALUE other)
{
    if (!rb_obj_is_kind_of(other, rb_cPathname))
        return Qfalse;
    return rb_str_equal(get_strpath(self), get_strpath(other));
}

#===(other) ⇒ Object

Compare this pathname with other. The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file.



102
103
104
105
106
107
108
 
# File 'pathname.c', line 102

static VALUE
path_eq(VALUE self, VALUE other)
{
    if (!rb_obj_is_kind_of(other, rb_cPathname))
        return Qfalse;
    return rb_str_equal(get_strpath(self), get_strpath(other));
}

#absolute? ⇒ Boolean

Predicate method for testing whether a path is absolute.

It returns true if the pathname begins with a slash.

p = Pathname.new('/im/sure')
p.absolute?
    #=> true

p = Pathname.new('not/so/sure')
p.absolute?
    #=> false

Returns:

  • (Boolean) 


223
224
225
 
# File 'lib/pathname.rb', line 223

def absolute?
  !relative?
end

#ascend {|_self| ... } ⇒ Object

Iterates over and yields a new Pathname object for each element in the given path in ascending order.

Pathname.new('/path/to/some/file.rb').ascend {|v| p v}
   #<Pathname:/path/to/some/file.rb>
   #<Pathname:/path/to/some>
   #<Pathname:/path/to>
   #<Pathname:/path>
   #<Pathname:/>

Pathname.new('path/to/some/file.rb').ascend {|v| p v}
   #<Pathname:path/to/some/file.rb>
   #<Pathname:path/to/some>
   #<Pathname:path/to>
   #<Pathname:path>

Returns an Enumerator if no block was given.

enum = Pathname.new("/usr/bin/ruby").ascend
  # ... do stuff ...
enum.each { |e| ... }
  # yields Pathnames /usr/bin/ruby, /usr/bin, /usr, and /.

It doesn’t access the filesystem.

Yields:

  • (_self)

Yield Parameters:

  • _self (Pathname) —

    the object that the method was called on



324
325
326
327
328
329
330
331
332
333
 
# File 'lib/pathname.rb', line 324

def ascend
  return to_enum(__method__) unless block_given?
  path = @path
  yield self
  while r = chop_basename(path)
    path, = r
    break if path.empty?
    yield self.class.new(del_trailing_separator(path))
  end
end

#- ⇒ Object

Returns the last access time for the file.

See File.atime.



437
438
439
440
441
 
# File 'pathname.c', line 437

static VALUE
path_atime(VALUE self)
{
    return rb_funcall(rb_cFile, rb_intern("atime"), 1, get_strpath(self));
}

#basename(*args) ⇒ Object

Returns the last component of the path.

See File.basename.



700
701
702
703
704
705
706
707
708
709
710
 
# File 'pathname.c', line 700

static VALUE
path_basename(int argc, VALUE *argv, VALUE self)
{
    VALUE str = get_strpath(self);
    VALUE fext;
    if (rb_scan_args(argc, argv, "01", &fext) == 0)
        str = rb_funcall(rb_cFile, rb_intern("basename"), 1, str);
    else
        str = rb_funcall(rb_cFile, rb_intern("basename"), 2, str, fext);
    return rb_class_new_instance(1, &str, rb_obj_class(self));
}

#binread([length [, offset]]) ⇒ String

Returns all the bytes from the file, or the first N if specified.

See IO.binread.

Returns:

  • (String) 


336
337
338
339
340
341
342
343
344
345
 
# File 'pathname.c', line 336

static VALUE
path_binread(int argc, VALUE *argv, VALUE self)
{
    VALUE args[3];
    int n;

    args[0] = get_strpath(self);
    n = rb_scan_args(argc, argv, "02", &args[1], &args[2]);
    return rb_funcall2(rb_cIO, rb_intern("binread"), 1+n, args);
}

#binwrite(string, [offset]) ⇒ Fixnum #binwrite(string, [offset], open_args) ⇒ Fixnum

Writes contents to the file, opening it in binary mode.

See IO.binwrite.

Overloads:

  • #binwrite(string, [offset]) ⇒ Fixnum

    Returns:

    • (Fixnum)
  • #binwrite(string, [offset], open_args) ⇒ Fixnum

    Returns:

    • (Fixnum) 


378
379
380
381
382
383
384
385
386
387
 
# File 'pathname.c', line 378

static VALUE
path_binwrite(int argc, VALUE *argv, VALUE self)
{
    VALUE args[4];
    int n;

    args[0] = get_strpath(self);
    n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]);
    return rb_funcall2(rb_cIO, rb_intern("binwrite"), 1+n, args);
}

#- ⇒ Object

Returns the birth time for the file. If the platform doesn’t have birthtime, raises NotImplementedError.

See File.birthtime.



453
454
455
456
457
 
# File 'pathname.c', line 453

static VALUE
path_birthtime(VALUE self)
{
    return rb_funcall(rb_cFile, rb_intern("birthtime"), 1, get_strpath(self));
}

#blockdev? ⇒ Boolean

See FileTest.blockdev?.

Returns:

  • (Boolean) 


776
777
778
779
780
 
# File 'pathname.c', line 776

static VALUE
path_blockdev_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("blockdev?"), 1, get_strpath(self));
}

#chardev? ⇒ Boolean

See FileTest.chardev?.

Returns:

  • (Boolean) 


785
786
787
788
789
 
# File 'pathname.c', line 785

static VALUE
path_chardev_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("chardev?"), 1, get_strpath(self));
}

#children(with_directory = true) ⇒ Object

Returns the children of the directory (files and subdirectories, not recursive) as an array of Pathname objects.

By default, the returned pathnames will have enough information to access the files. If you set with_directory to false, then the returned pathnames will contain the filename only.

For example:

pn = Pathname("/usr/lib/ruby/1.8")
pn.children
    # -> [ Pathname:/usr/lib/ruby/1.8/English.rb,
           Pathname:/usr/lib/ruby/1.8/Env.rb,
           Pathname:/usr/lib/ruby/1.8/abbrev.rb, ... ]
pn.children(false)
    # -> [ Pathname:English.rb, Pathname:Env.rb, Pathname:abbrev.rb, ... ]

Note that the results never contain the entries . and .. in the directory because they are not children.



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/pathname.rb', line 439

def children(with_directory=true)
  with_directory = false if @path == '.'
  result = []
  Dir.foreach(@path) {|e|
    next if e == '.' || e == '..'
    if with_directory
      result << self.class.new(File.join(@path, e))
    else
      result << self.class.new(e)
    end
  }
  result
end

#- ⇒ Object

Changes file permissions.

See File.chmod.



498
499
500
501
502
 
# File 'pathname.c', line 498

static VALUE
path_chmod(VALUE self, VALUE mode)
{
    return rb_funcall(rb_cFile, rb_intern("chmod"), 2, mode, get_strpath(self));
}

#- ⇒ Object

Change owner and group of the file.

See File.chown.



526
527
528
529
530
 
# File 'pathname.c', line 526

static VALUE
path_chown(VALUE self, VALUE owner, VALUE group)
{
    return rb_funcall(rb_cFile, rb_intern("chown"), 3, owner, group, get_strpath(self));
}

#cleanpath(consider_symlink = false) ⇒ Object

Returns clean pathname of self with consecutive slashes and useless dots removed. The filesystem is not accessed.

If consider_symlink is true, then a more conservative algorithm is used to avoid breaking symbolic linkages. This may retain more .. entries than absolutely necessary, but without accessing the filesystem, this can’t be avoided.

See Pathname#realpath.



83
84
85
86
87
88
89
 
# File 'lib/pathname.rb', line 83

def cleanpath(consider_symlink=false)
  if consider_symlink
    cleanpath_conservative
  else
    cleanpath_aggressive
  end
end

#- ⇒ Object

Returns the last change time, using directory information, not the file itself.

See File.ctime.



470
471
472
473
474
 
# File 'pathname.c', line 470

static VALUE
path_ctime(VALUE self)
{
    return rb_funcall(rb_cFile, rb_intern("ctime"), 1, get_strpath(self));
}

#delete ⇒ Object

Removes a file or directory, using File.unlink if self is a file, or Dir.unlink as necessary.



1162
1163
1164
1165
1166
1167
1168
 
# File 'pathname.c', line 1162

static VALUE
path_unlink(VALUE self)
{
    VALUE eENOTDIR = rb_const_get_at(rb_mErrno, rb_intern("ENOTDIR"));
    VALUE str = get_strpath(self);
    return rb_rescue2(unlink_body, str, unlink_rescue, str, eENOTDIR, (VALUE)0);
}

#descend ⇒ Object

Iterates over and yields a new Pathname object for each element in the given path in descending order.

Pathname.new('/path/to/some/file.rb').descend {|v| p v}
   #<Pathname:/>
   #<Pathname:/path>
   #<Pathname:/path/to>
   #<Pathname:/path/to/some>
   #<Pathname:/path/to/some/file.rb>

Pathname.new('path/to/some/file.rb').descend {|v| p v}
   #<Pathname:path>
   #<Pathname:path/to>
   #<Pathname:path/to/some>
   #<Pathname:path/to/some/file.rb>

Returns an Enumerator if no block was given.

enum = Pathname.new("/usr/bin/ruby").descend
  # ... do stuff ...
enum.each { |e| ... }
  # yields Pathnames /, /usr, /usr/bin, and /usr/bin/ruby.

It doesn’t access the filesystem.



291
292
293
294
295
296
297
 
# File 'lib/pathname.rb', line 291

def descend
  return to_enum(__method__) unless block_given?
  vs = []
  ascend {|v| vs << v }
  vs.reverse_each {|v| yield v }
  nil
end

#directory? ⇒ Boolean

See FileTest.directory?.

Returns:

  • (Boolean) 


830
831
832
833
834
 
# File 'pathname.c', line 830

static VALUE
path_directory_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("directory?"), 1, get_strpath(self));
}

#dirname ⇒ Object

Returns all but the last component of the path.

See File.dirname.



717
718
719
720
721
722
723
 
# File 'pathname.c', line 717

static VALUE
path_dirname(VALUE self)
{
    VALUE str = get_strpath(self);
    str = rb_funcall(rb_cFile, rb_intern("dirname"), 1, str);
    return rb_class_new_instance(1, &str, rb_obj_class(self));
}

#each_child(with_directory = true, &b) ⇒ Object

Iterates over the children of the directory (files and subdirectories, not recursive).

It yields Pathname object for each child.

By default, the yielded pathnames will have enough information to access the files.

If you set with_directory to false, then the returned pathnames will contain the filename only.

Pathname("/usr/local").each_child {|f| p f }
#=> #<Pathname:/usr/local/share>
#   #<Pathname:/usr/local/bin>
#   #<Pathname:/usr/local/games>
#   #<Pathname:/usr/local/lib>
#   #<Pathname:/usr/local/include>
#   #<Pathname:/usr/local/sbin>
#   #<Pathname:/usr/local/src>
#   #<Pathname:/usr/local/man>

Pathname("/usr/local").each_child(false) {|f| p f }
#=> #<Pathname:share>
#   #<Pathname:bin>
#   #<Pathname:games>
#   #<Pathname:lib>
#   #<Pathname:include>
#   #<Pathname:sbin>
#   #<Pathname:src>
#   #<Pathname:man>

Note that the results never contain the entries . and .. in the directory because they are not children.

See Pathname#children



489
490
491
 
# File 'lib/pathname.rb', line 489

def each_child(with_directory=true, &b)
  children(with_directory).each(&b)
end

#each_entry ⇒ Object

Iterates over the entries (files and subdirectories) in the directory, yielding a Pathname object for each entry.



1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'pathname.c', line 1137

static VALUE
path_each_entry(VALUE self)
{
    VALUE args[1];

    args[0] = get_strpath(self);
    return rb_block_call(rb_cDir, rb_intern("foreach"), 1, args, each_entry_i, rb_obj_class(self));
}

#each_filename ⇒ Object

Iterates over each component of the path.

Pathname.new("/usr/bin/ruby").each_filename {|filename| ... }
  # yields "usr", "bin", and "ruby".

Returns an Enumerator if no block was given.

enum = Pathname.new("/usr/bin/ruby").each_filename
  # ... do stuff ...
enum.each { |e| ... }
  # yields "usr", "bin", and "ruby".



259
260
261
262
263
264
 
# File 'lib/pathname.rb', line 259

def each_filename # :yield: filename
  return to_enum(__method__) unless block_given?
  _, names = split_names(@path)
  names.each {|filename| yield filename }
  nil
end

#each_line {|line| ... } ⇒ Object #each_line(sep = $/[, open_args]) {|line| ... } ⇒ nil #each_line(limit[, open_args]) {|line| ... } ⇒ nil #each_line(sep, limit[, open_args]) {|line| ... } ⇒ nil #each_line(...) ⇒ Object

Iterates over each line in the file and yields a String object for each.

Overloads:

  • #each_line {|line| ... } ⇒ Object

    Yields:

    • (line)
  • #each_line(sep = $/[, open_args]) {|line| ... } ⇒ nil

    Yields:

    • (line)

    Returns:

    • (nil)
  • #each_line(limit[, open_args]) {|line| ... } ⇒ nil

    Yields:

    • (line)

    Returns:

    • (nil)
  • #each_line(sep, limit[, open_args]) {|line| ... } ⇒ nil

    Yields:

    • (line)

    Returns:

    • (nil) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'pathname.c', line 290

static VALUE
path_each_line(int argc, VALUE *argv, VALUE self)
{
    VALUE args[4];
    int n;

    args[0] = get_strpath(self);
    n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]);
    if (rb_block_given_p()) {
        return rb_block_call(rb_cIO, rb_intern("foreach"), 1+n, args, 0, 0);
    }
    else {
        return rb_funcall2(rb_cIO, rb_intern("foreach"), 1+n, args);
    }
}

#entries ⇒ Object

Return the entries (files and subdirectories) in the directory, each as a Pathname object.

The results contains just the names in the directory, without any trailing slashes or recursive look-up.

pp Pathname.new('/usr/local').entries
#=> [#<Pathname:share>,
#    #<Pathname:lib>,
#    #<Pathname:..>,
#    #<Pathname:include>,
#    #<Pathname:etc>,
#    #<Pathname:bin>,
#    #<Pathname:man>,
#    #<Pathname:games>,
#    #<Pathname:.>,
#    #<Pathname:sbin>,
#    #<Pathname:src>]

The result may contain the current directory #<Pathname:.> and the parent directory #<Pathname:..>.

If you don’t want . and .. and want directories, consider Pathname#children.



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'pathname.c', line 1069

static VALUE
path_entries(VALUE self)
{
    VALUE klass, str, ary;
    long i;
    klass = rb_obj_class(self);
    str = get_strpath(self);
    ary = rb_funcall(rb_cDir, rb_intern("entries"), 1, str);
    ary = rb_convert_type(ary, T_ARRAY, "Array", "to_ary");
    for (i = 0; i < RARRAY_LEN(ary); i++) {
	VALUE elt = RARRAY_AREF(ary, i);
        elt = rb_class_new_instance(1, &elt, klass);
        rb_ary_store(ary, i, elt);
    }
    return ary;
}

#eql?(other) ⇒ Boolean

Compare this pathname with other. The comparison is string-based. Be aware that two different paths (foo.txt and ./foo.txt) can refer to the same file.

Returns:

  • (Boolean) 


102
103
104
105
106
107
108
 
# File 'pathname.c', line 102

static VALUE
path_eq(VALUE self, VALUE other)
{
    if (!rb_obj_is_kind_of(other, rb_cPathname))
        return Qfalse;
    return rb_str_equal(get_strpath(self), get_strpath(other));
}

#executable? ⇒ Boolean

See FileTest.executable?.

Returns:

  • (Boolean) 


794
795
796
797
798
 
# File 'pathname.c', line 794

static VALUE
path_executable_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("executable?"), 1, get_strpath(self));
}

#executable_real? ⇒ Boolean

See FileTest.executable_real?.

Returns:

  • (Boolean) 


803
804
805
806
807
 
# File 'pathname.c', line 803

static VALUE
path_executable_real_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("executable_real?"), 1, get_strpath(self));
}

#exist? ⇒ Boolean

See FileTest.exist?.

Returns:

  • (Boolean) 


812
813
814
815
816
 
# File 'pathname.c', line 812

static VALUE
path_exist_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("exist?"), 1, get_strpath(self));
}

#expand_path(*args) ⇒ Object

Returns the absolute path for the file.

See File.expand_path.



742
743
744
745
746
747
748
749
750
751
752
 
# File 'pathname.c', line 742

static VALUE
path_expand_path(int argc, VALUE *argv, VALUE self)
{
    VALUE str = get_strpath(self);
    VALUE dname;
    if (rb_scan_args(argc, argv, "01", &dname) == 0)
        str = rb_funcall(rb_cFile, rb_intern("expand_path"), 1, str);
    else
        str = rb_funcall(rb_cFile, rb_intern("expand_path"), 2, str, dname);
    return rb_class_new_instance(1, &str, rb_obj_class(self));
}

#extname ⇒ Object

Returns the file’s extension.

See File.extname.



730
731
732
733
734
735
 
# File 'pathname.c', line 730

static VALUE
path_extname(VALUE self)
{
    VALUE str = get_strpath(self);
    return rb_funcall(rb_cFile, rb_intern("extname"), 1, str);
}

#file? ⇒ Boolean

See FileTest.file?.

Returns:

  • (Boolean) 


839
840
841
842
843
 
# File 'pathname.c', line 839

static VALUE
path_file_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("file?"), 1, get_strpath(self));
}

#find(ignore_error: true) ⇒ Object

Iterates over the directory tree in a depth first manner, yielding a Pathname for each file under “this” directory.

Returns an Enumerator if no block is given.

Since it is implemented by the standard library module Find, Find.prune can be used to control the traversal.

If self is ., yielded pathnames begin with a filename in the current directory, not ./.

See Find.find



557
558
559
560
561
562
563
564
565
 
# File 'lib/pathname.rb', line 557

def find(ignore_error: true) # :yield: pathname
  return to_enum(__method__, ignore_error: ignore_error) unless block_given?
  require 'find'
  if @path == '.'
    Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f.sub(%r{\A\./}, '')) }
  else
    Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f) }
  end
end

#fnmatch(pattern, [flags]) ⇒ String #fnmatch?(pattern, [flags]) ⇒ String

Return true if the receiver matches the given pattern.

See File.fnmatch.

Overloads:

  • #fnmatch(pattern, [flags]) ⇒ String

    Returns:

    • (String)
  • #fnmatch?(pattern, [flags]) ⇒ String

    Returns:

    • (String) 


555
556
557
558
559
560
561
562
563
564
 
# File 'pathname.c', line 555

static VALUE
path_fnmatch(int argc, VALUE *argv, VALUE self)
{
    VALUE str = get_strpath(self);
    VALUE pattern, flags;
    if (rb_scan_args(argc, argv, "11", &pattern, &flags) == 1)
        return rb_funcall(rb_cFile, rb_intern("fnmatch"), 2, pattern, str);
    else
        return rb_funcall(rb_cFile, rb_intern("fnmatch"), 3, pattern, str, flags);
}

#fnmatch(pattern, [flags]) ⇒ String #fnmatch?(pattern, [flags]) ⇒ String

Return true if the receiver matches the given pattern.

See File.fnmatch.

Overloads:

  • #fnmatch(pattern, [flags]) ⇒ String

    Returns:

    • (String)
  • #fnmatch?(pattern, [flags]) ⇒ String

    Returns:

    • (String)

Returns:

  • (Boolean) 


555
556
557
558
559
560
561
562
563
564
 
# File 'pathname.c', line 555

static VALUE
path_fnmatch(int argc, VALUE *argv, VALUE self)
{
    VALUE str = get_strpath(self);
    VALUE pattern, flags;
    if (rb_scan_args(argc, argv, "11", &pattern, &flags) == 1)
        return rb_funcall(rb_cFile, rb_intern("fnmatch"), 2, pattern, str);
    else
        return rb_funcall(rb_cFile, rb_intern("fnmatch"), 3, pattern, str, flags);
}

#freeze ⇒ Object

Freezes this Pathname.

See Object.freeze.

Returns:

  • (Object) 


57
58
59
60
61
62
63
 
# File 'pathname.c', line 57

static VALUE
path_freeze(VALUE self)
{
    rb_call_super(0, 0);
    rb_str_freeze(get_strpath(self));
    return self;
}

#- ⇒ Object

Returns “type” of file (“file”, “directory”, etc).

See File.ftype.



574
575
576
577
578
 
# File 'pathname.c', line 574

static VALUE
path_ftype(VALUE self)
{
    return rb_funcall(rb_cFile, rb_intern("ftype"), 1, get_strpath(self));
}

#grpowned? ⇒ Boolean

See FileTest.grpowned?.

Returns:

  • (Boolean) 


821
822
823
824
825
 
# File 'pathname.c', line 821

static VALUE
path_grpowned_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("grpowned?"), 1, get_strpath(self));
}

#hash ⇒ Object

:nodoc:



159
160
161
162
163
 
# File 'pathname.c', line 159

static VALUE
path_hash(VALUE self)
{
    return INT2FIX(rb_str_hash(get_strpath(self)));
}

#inspect ⇒ Object

:nodoc:



181
182
183
184
185
186
187
 
# File 'pathname.c', line 181

static VALUE
path_inspect(VALUE self)
{
    const char *c = rb_obj_classname(self);
    VALUE str = get_strpath(self);
    return rb_sprintf("#<%s:%"PRIsVALUE">", c, str);
}

#join(*args) ⇒ Object

Joins the given pathnames onto self to create a new Pathname object.

path0 = Pathname.new("/usr")                # Pathname:/usr
path0 = path0.join("bin/ruby")              # Pathname:/usr/bin/ruby
    # is the same as
path1 = Pathname.new("/usr") + "bin/ruby"   # Pathname:/usr/bin/ruby
path0 == path1
    #=> true



406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/pathname.rb', line 406

def join(*args)
  return self if args.empty?
  result = args.pop
  result = Pathname.new(result) unless Pathname === result
  return result if result.absolute?
  args.reverse_each {|arg|
    arg = Pathname.new(arg) unless Pathname === arg
    result = arg + result
    return result if result.absolute?
  }
  self + result
end

#- ⇒ Object

Same as Pathname.chmod, but does not follow symbolic links.

See File.lchmod.



512
513
514
515
516
 
# File 'pathname.c', line 512

static VALUE
path_lchmod(VALUE self, VALUE mode)
{
    return rb_funcall(rb_cFile, rb_intern("lchmod"), 2, mode, get_strpath(self));
}

#- ⇒ Object

Same as Pathname.chown, but does not follow symbolic links.

See File.lchown.



540
541
542
543
544
 
# File 'pathname.c', line 540

static VALUE
path_lchown(VALUE self, VALUE owner, VALUE group)
{
    return rb_funcall(rb_cFile, rb_intern("lchown"), 3, owner, group, get_strpath(self));
}

#lstat ⇒ Object

See File.lstat.



653
654
655
656
657
 
# File 'pathname.c', line 653

static VALUE
path_lstat(VALUE self)
{
    return rb_funcall(rb_cFile, rb_intern("lstat"), 1, get_strpath(self));
}

#make_link(old) ⇒ Object

Creates a hard link at pathname.

See File.link.



588
589
590
591
592
 
# File 'pathname.c', line 588

static VALUE
path_make_link(VALUE self, VALUE old)
{
    return rb_funcall(rb_cFile, rb_intern("link"), 2, old, get_strpath(self));
}

#make_symlink(old) ⇒ Object

Creates a symbolic link.

See File.symlink.



667
668
669
670
671
 
# File 'pathname.c', line 667

static VALUE
path_make_symlink(VALUE self, VALUE old)
{
    return rb_funcall(rb_cFile, rb_intern("symlink"), 2, old, get_strpath(self));
}

#mkdir(*args) ⇒ Object

Create the referenced directory.

See Dir.mkdir.



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'pathname.c', line 1091

static VALUE
path_mkdir(int argc, VALUE *argv, VALUE self)
{
    VALUE str = get_strpath(self);
    VALUE vmode;
    if (rb_scan_args(argc, argv, "01", &vmode) == 0)
        return rb_funcall(rb_cDir, rb_intern("mkdir"), 1, str);
    else
        return rb_funcall(rb_cDir, rb_intern("mkdir"), 2, str, vmode);
}

#mkpath ⇒ Object

Creates a full path, including any intermediate directories that don’t yet exist.

See FileUtils.mkpath and FileUtils.mkdir_p



574
575
576
577
578
 
# File 'lib/pathname.rb', line 574

def mkpath
  require 'fileutils'
  FileUtils.mkpath(@path)
  nil
end

#mountpoint? ⇒ Boolean

Returns true if self points to a mountpoint.

Returns:

  • (Boolean) 


190
191
192
193
194
195
196
197
198
199
 
# File 'lib/pathname.rb', line 190

def mountpoint?
  begin
    stat1 = self.lstat
    stat2 = self.parent.lstat
    stat1.dev == stat2.dev && stat1.ino == stat2.ino ||
      stat1.dev != stat2.dev
  rescue Errno::ENOENT
    false
  end
end

#- ⇒ Object

Returns the last modified time of the file.

See File.mtime.



484
485
486
487
488
 
# File 'pathname.c', line 484

static VALUE
path_mtime(VALUE self)
{
    return rb_funcall(rb_cFile, rb_intern("mtime"), 1, get_strpath(self));
}

#open(*args) ⇒ Object

Opens the file for reading or writing.

See File.open.



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'pathname.c', line 599

static VALUE
path_open(int argc, VALUE *argv, VALUE self)
{
    VALUE args[4];
    int n;

    args[0] = get_strpath(self);
    n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]);
    if (rb_block_given_p()) {
        return rb_block_call(rb_cFile, rb_intern("open"), 1+n, args, 0, 0);
    }
    else {
        return rb_funcall2(rb_cFile, rb_intern("open"), 1+n, args);
    }
}

#opendir ⇒ Object

Opens the referenced directory.

See Dir.open.



1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'pathname.c', line 1118

static VALUE
path_opendir(VALUE self)
{
    VALUE args[1];

    args[0] = get_strpath(self);
    return rb_block_call(rb_cDir, rb_intern("open"), 1, args, 0, 0);
}

#owned? ⇒ Boolean

See FileTest.owned?.

Returns:

  • (Boolean) 


866
867
868
869
870
 
# File 'pathname.c', line 866

static VALUE
path_owned_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("owned?"), 1, get_strpath(self));
}

#parent ⇒ Object

Returns the parent directory.

This is same as self + '..'.



185
186
187
 
# File 'lib/pathname.rb', line 185

def parent
  self + '..'
end

#pipe? ⇒ Boolean

See FileTest.pipe?.

Returns:

  • (Boolean) 


848
849
850
851
852
 
# File 'pathname.c', line 848

static VALUE
path_pipe_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("pipe?"), 1, get_strpath(self));
}

#read([length [, offset]]) ⇒ String #read([length [, offset]], open_args) ⇒ String

Returns all data from the file, or the first N bytes if specified.

See IO.read.

Overloads:

  • #read([length [, offset]]) ⇒ String

    Returns:

    • (String)
  • #read([length [, offset]], open_args) ⇒ String

    Returns:

    • (String) 


316
317
318
319
320
321
322
323
324
325
 
# File 'pathname.c', line 316

static VALUE
path_read(int argc, VALUE *argv, VALUE self)
{
    VALUE args[4];
    int n;

    args[0] = get_strpath(self);
    n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]);
    return rb_funcall2(rb_cIO, rb_intern("read"), 1+n, args);
}

#readable? ⇒ Boolean

See FileTest.readable?.

Returns:

  • (Boolean) 


875
876
877
878
879
 
# File 'pathname.c', line 875

static VALUE
path_readable_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("readable?"), 1, get_strpath(self));
}

#readable_real? ⇒ Boolean

See FileTest.readable_real?.

Returns:

  • (Boolean) 


893
894
895
896
897
 
# File 'pathname.c', line 893

static VALUE
path_readable_real_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("readable_real?"), 1, get_strpath(self));
}

#readlines(sep = $/[, open_args]) ⇒ Array #readlines(limit[, open_args]) ⇒ Array #readlines(sep, limit[, open_args]) ⇒ Array

Returns all the lines from the file.

See IO.readlines.

Overloads:

  • #readlines(sep = $/[, open_args]) ⇒ Array

    Returns:

    • (Array)
  • #readlines(limit[, open_args]) ⇒ Array

    Returns:

    • (Array)
  • #readlines(sep, limit[, open_args]) ⇒ Array

    Returns:

    • (Array) 


400
401
402
403
404
405
406
407
408
409
 
# File 'pathname.c', line 400

static VALUE
path_readlines(int argc, VALUE *argv, VALUE self)
{
    VALUE args[4];
    int n;

    args[0] = get_strpath(self);
    n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]);
    return rb_funcall2(rb_cIO, rb_intern("readlines"), 1+n, args);
}

#readlink ⇒ Object

Read symbolic link.

See File.readlink.



620
621
622
623
624
625
626
 
# File 'pathname.c', line 620

static VALUE
path_readlink(VALUE self)
{
    VALUE str;
    str = rb_funcall(rb_cFile, rb_intern("readlink"), 1, get_strpath(self));
    return rb_class_new_instance(1, &str, rb_obj_class(self));
}

#realdirpath(*args) ⇒ Object

Returns the real (absolute) pathname of self in the actual filesystem.

Does not contain symlinks or useless dots, .. and ..

The last component of the real pathname can be nonexistent.



271
272
273
274
275
276
277
278
 
# File 'pathname.c', line 271

static VALUE
path_realdirpath(int argc, VALUE *argv, VALUE self)
{
    VALUE basedir, str;
    rb_scan_args(argc, argv, "01", &basedir);
    str = rb_funcall(rb_cFile, rb_intern("realdirpath"), 2, get_strpath(self), basedir);
    return rb_class_new_instance(1, &str, rb_obj_class(self));
}

#realpath(*args) ⇒ Object

Returns the real (absolute) pathname for self in the actual filesystem.

Does not contain symlinks or useless dots, .. and ..

All components of the pathname must exist when this method is called.



255
256
257
258
259
260
261
262
 
# File 'pathname.c', line 255

static VALUE
path_realpath(int argc, VALUE *argv, VALUE self)
{
    VALUE basedir, str;
    rb_scan_args(argc, argv, "01", &basedir);
    str = rb_funcall(rb_cFile, rb_intern("realpath"), 2, get_strpath(self), basedir);
    return rb_class_new_instance(1, &str, rb_obj_class(self));
}

#relative? ⇒ Boolean

The opposite of Pathname#absolute?

It returns false if the pathname begins with a slash.

p = Pathname.new('/im/sure')
p.relative?
    #=> false

p = Pathname.new('not/so/sure')
p.relative?
    #=> true

Returns:

  • (Boolean) 


238
239
240
241
242
243
244
 
# File 'lib/pathname.rb', line 238

def relative?
  path = @path
  while r = chop_basename(path)
    path, = r
  end
  path == ''
end

#relative_path_from(base_directory) ⇒ Object

Returns a relative path from the given base_directory to the receiver.

If self is absolute, then base_directory must be absolute too.

If self is relative, then base_directory must be relative too.

This method doesn’t access the filesystem. It assumes no symlinks.

ArgumentError is raised when it cannot find a relative path.



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/pathname.rb', line 504

def relative_path_from(base_directory)
  dest_directory = self.cleanpath.to_s
  base_directory = base_directory.cleanpath.to_s
  dest_prefix = dest_directory
  dest_names = []
  while r = chop_basename(dest_prefix)
    dest_prefix, basename = r
    dest_names.unshift basename if basename != '.'
  end
  base_prefix = base_directory
  base_names = []
  while r = chop_basename(base_prefix)
    base_prefix, basename = r
    base_names.unshift basename if basename != '.'
  end
  unless SAME_PATHS[dest_prefix, base_prefix]
    raise ArgumentError, "different prefix: #{dest_prefix.inspect} and #{base_directory.inspect}"
  end
  while !dest_names.empty? &&
        !base_names.empty? &&
        SAME_PATHS[dest_names.first, base_names.first]
    dest_names.shift
    base_names.shift
  end
  if base_names.include? '..'
    raise ArgumentError, "base_directory has ..: #{base_directory.inspect}"
  end
  base_names.fill('..')
  relpath_names = base_names + dest_names
  if relpath_names.empty?
    Pathname.new('.')
  else
    Pathname.new(File.join(*relpath_names))
  end
end

#rename(to) ⇒ Object

Rename the file.

See File.rename.



633
634
635
636
637
 
# File 'pathname.c', line 633

static VALUE
path_rename(VALUE self, VALUE to)
{
    return rb_funcall(rb_cFile, rb_intern("rename"), 2, get_strpath(self), to);
}

#rmdir ⇒ Object

Remove the referenced directory.

See Dir.rmdir.



1107
1108
1109
1110
1111
 
# File 'pathname.c', line 1107

static VALUE
path_rmdir(VALUE self)
{
    return rb_funcall(rb_cDir, rb_intern("rmdir"), 1, get_strpath(self));
}

#rmtree ⇒ Object

Recursively deletes a directory, including all directories beneath it.

See FileUtils.rm_r



583
584
585
586
587
588
589
 
# File 'lib/pathname.rb', line 583

def rmtree
  # The name "rmtree" is borrowed from File::Path of Perl.
  # File::Path provides "mkpath" and "rmtree".
  require 'fileutils'
  FileUtils.rm_r(@path)
  nil
end

#root? ⇒ Boolean

Predicate method for root directories. Returns true if the pathname consists of consecutive slashes.

It doesn’t access the filesystem. So it may return false for some pathnames which points to roots such as /usr/...

Returns:

  • (Boolean) 


208
209
210
 
# File 'lib/pathname.rb', line 208

def root?
  !!(chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o =~ @path)
end

#setgid? ⇒ Boolean

See FileTest.setgid?.

Returns:

  • (Boolean) 


911
912
913
914
915
 
# File 'pathname.c', line 911

static VALUE
path_setgid_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("setgid?"), 1, get_strpath(self));
}

#setuid? ⇒ Boolean

See FileTest.setuid?.

Returns:

  • (Boolean) 


902
903
904
905
906
 
# File 'pathname.c', line 902

static VALUE
path_setuid_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("setuid?"), 1, get_strpath(self));
}

#size ⇒ Object

See FileTest.size.



920
921
922
923
924
 
# File 'pathname.c', line 920

static VALUE
path_size(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("size"), 1, get_strpath(self));
}

#size? ⇒ Boolean

See FileTest.size?.

Returns:

  • (Boolean) 


929
930
931
932
933
 
# File 'pathname.c', line 929

static VALUE
path_size_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("size?"), 1, get_strpath(self));
}

#socket? ⇒ Boolean

See FileTest.socket?.

Returns:

  • (Boolean) 


857
858
859
860
861
 
# File 'pathname.c', line 857

static VALUE
path_socket_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("socket?"), 1, get_strpath(self));
}

#split ⇒ Object

Returns the #dirname and the #basename in an Array.

See File.split.



759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'pathname.c', line 759

static VALUE
path_split(VALUE self)
{
    VALUE str = get_strpath(self);
    VALUE ary, dirname, basename;
    ary = rb_funcall(rb_cFile, rb_intern("split"), 1, str);
    ary = rb_check_array_type(ary);
    dirname = rb_ary_entry(ary, 0);
    basename = rb_ary_entry(ary, 1);
    dirname = rb_class_new_instance(1, &dirname, rb_obj_class(self));
    basename = rb_class_new_instance(1, &basename, rb_obj_class(self));
    return rb_ary_new3(2, dirname, basename);
}

#stat ⇒ Object

Returns a File::Stat object.

See File.stat.



644
645
646
647
648
 
# File 'pathname.c', line 644

static VALUE
path_stat(VALUE self)
{
    return rb_funcall(rb_cFile, rb_intern("stat"), 1, get_strpath(self));
}

#sticky? ⇒ Boolean

See FileTest.sticky?.

Returns:

  • (Boolean) 


938
939
940
941
942
 
# File 'pathname.c', line 938

static VALUE
path_sticky_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("sticky?"), 1, get_strpath(self));
}

#sub(*args) ⇒ Object

Return a pathname which is substituted by String#sub.

path1 = Pathname.new(‘/usr/bin/perl’) path1.sub(‘perl’, ‘ruby’)

#=> #<Pathname:/usr/bin/ruby>



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'pathname.c', line 196

static VALUE
path_sub(int argc, VALUE *argv, VALUE self)
{
    VALUE str = get_strpath(self);

    if (rb_block_given_p()) {
        str = rb_block_call(str, rb_intern("sub"), argc, argv, 0, 0);
    }
    else {
        str = rb_funcall2(str, rb_intern("sub"), argc, argv);
    }
    return rb_class_new_instance(1, &str, rb_obj_class(self));
}

#sub_ext(repl) ⇒ Object

Return a pathname with repl added as a suffix to the basename.

If self has no extension part, repl is appended.

Pathname.new(‘/usr/bin/shutdown’).sub_ext(‘.rb’)

#=> #<Pathname:/usr/bin/shutdown.rb>



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'pathname.c', line 218

static VALUE
path_sub_ext(VALUE self, VALUE repl)
{
    VALUE str = get_strpath(self);
    VALUE str2;
    long extlen;
    const char *ext;
    const char *p;

    StringValue(repl);
    p = RSTRING_PTR(str);
    extlen = RSTRING_LEN(str);
    ext = ruby_enc_find_extname(p, &extlen, rb_enc_get(str));
    if (ext == NULL) {
        ext = p + RSTRING_LEN(str);
    }
    else if (extlen <= 1) {
        ext += extlen;
    }
    str2 = rb_str_subseq(str, 0, ext-p);
    rb_str_append(str2, repl);
    OBJ_INFECT(str2, str);
    return rb_class_new_instance(1, &str2, rb_obj_class(self));
}

#symlink? ⇒ Boolean

See FileTest.symlink?.

Returns:

  • (Boolean) 


947
948
949
950
951
 
# File 'pathname.c', line 947

static VALUE
path_symlink_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("symlink?"), 1, get_strpath(self));
}

#sysopen([mode, [perm]]) ⇒ Fixnum

See IO.sysopen.

Returns:

  • (Fixnum) 


418
419
420
421
422
423
424
425
426
427
 
# File 'pathname.c', line 418

static VALUE
path_sysopen(int argc, VALUE *argv, VALUE self)
{
    VALUE args[3];
    int n;

    args[0] = get_strpath(self);
    n = rb_scan_args(argc, argv, "02", &args[1], &args[2]);
    return rb_funcall2(rb_cIO, rb_intern("sysopen"), 1+n, args);
}

#taint ⇒ Object

Taints this Pathname.

See Object.taint.

Returns:

  • (Object) 


73
74
75
76
77
78
79
 
# File 'pathname.c', line 73

static VALUE
path_taint(VALUE self)
{
    rb_call_super(0, 0);
    rb_obj_taint(get_strpath(self));
    return self;
}

#to_s ⇒ String #to_path ⇒ String

Return the path as a String.

to_path is implemented so Pathname objects are usable with File.open, etc.

Overloads:

  • #to_s ⇒ String

    Returns:

    • (String)
  • #to_path ⇒ String

    Returns:

    • (String) 


174
175
176
177
178
 
# File 'pathname.c', line 174

static VALUE
path_to_s(VALUE self)
{
    return rb_obj_dup(get_strpath(self));
}

#to_s ⇒ String #to_path ⇒ String

Return the path as a String.

to_path is implemented so Pathname objects are usable with File.open, etc.

Overloads:

  • #to_s ⇒ String

    Returns:

    • (String)
  • #to_path ⇒ String

    Returns:

    • (String) 


174
175
176
177
178
 
# File 'pathname.c', line 174

static VALUE
path_to_s(VALUE self)
{
    return rb_obj_dup(get_strpath(self));
}

#truncate(length) ⇒ Object

Truncates the file to length bytes.

See File.truncate.



678
679
680
681
682
 
# File 'pathname.c', line 678

static VALUE
path_truncate(VALUE self, VALUE length)
{
    return rb_funcall(rb_cFile, rb_intern("truncate"), 2, get_strpath(self), length);
}

#unlink ⇒ Object

Removes a file or directory, using File.unlink if self is a file, or Dir.unlink as necessary.



1162
1163
1164
1165
1166
1167
1168
 
# File 'pathname.c', line 1162

static VALUE
path_unlink(VALUE self)
{
    VALUE eENOTDIR = rb_const_get_at(rb_mErrno, rb_intern("ENOTDIR"));
    VALUE str = get_strpath(self);
    return rb_rescue2(unlink_body, str, unlink_rescue, str, eENOTDIR, (VALUE)0);
}

#untaint ⇒ Object

Untaints this Pathname.

See Object.untaint.

Returns:

  • (Object) 


89
90
91
92
93
94
95
 
# File 'pathname.c', line 89

static VALUE
path_untaint(VALUE self)
{
    rb_call_super(0, 0);
    rb_obj_untaint(get_strpath(self));
    return self;
}

#utime(atime, mtime) ⇒ Object

Update the access and modification times of the file.

See File.utime.



689
690
691
692
693
 
# File 'pathname.c', line 689

static VALUE
path_utime(VALUE self, VALUE atime, VALUE mtime)
{
    return rb_funcall(rb_cFile, rb_intern("utime"), 3, atime, mtime, get_strpath(self));
}

#world_readable? ⇒ Boolean

See FileTest.world_readable?.

Returns:

  • (Boolean) 


884
885
886
887
888
 
# File 'pathname.c', line 884

static VALUE
path_world_readable_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("world_readable?"), 1, get_strpath(self));
}

#world_writable? ⇒ Boolean

See FileTest.world_writable?.

Returns:

  • (Boolean) 


965
966
967
968
969
 
# File 'pathname.c', line 965

static VALUE
path_world_writable_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("world_writable?"), 1, get_strpath(self));
}

#writable? ⇒ Boolean

See FileTest.writable?.

Returns:

  • (Boolean) 


956
957
958
959
960
 
# File 'pathname.c', line 956

static VALUE
path_writable_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("writable?"), 1, get_strpath(self));
}

#writable_real? ⇒ Boolean

See FileTest.writable_real?.

Returns:

  • (Boolean) 


974
975
976
977
978
 
# File 'pathname.c', line 974

static VALUE
path_writable_real_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("writable_real?"), 1, get_strpath(self));
}

#write(string, [offset]) ⇒ Fixnum #write(string, [offset], open_args) ⇒ Fixnum

Writes contents to the file.

See IO.write.

Overloads:

  • #write(string, [offset]) ⇒ Fixnum

    Returns:

    • (Fixnum)
  • #write(string, [offset], open_args) ⇒ Fixnum

    Returns:

    • (Fixnum) 


357
358
359
360
361
362
363
364
365
366
 
# File 'pathname.c', line 357

static VALUE
path_write(int argc, VALUE *argv, VALUE self)
{
    VALUE args[4];
    int n;

    args[0] = get_strpath(self);
    n = rb_scan_args(argc, argv, "03", &args[1], &args[2], &args[3]);
    return rb_funcall2(rb_cIO, rb_intern("write"), 1+n, args);
}

#zero? ⇒ Boolean

See FileTest.zero?.

Returns:

  • (Boolean) 


983
984
985
986
987
 
# File 'pathname.c', line 983

static VALUE
path_zero_p(VALUE self)
{
    return rb_funcall(rb_mFileTest, rb_intern("zero?"), 1, get_strpath(self));
}