Class: FakeFS::File
- Inherits:
-
StringIO
- Object
- StringIO
- FakeFS::File
- Defined in:
- lib/fakefs/file.rb
Overview
FakeFS File class inherit StringIO
Defined Under Namespace
Classes: Stat
Constant Summary collapse
- MODES =
[ READ_ONLY = 'r'.freeze, READ_WRITE = 'r+'.freeze, WRITE_ONLY = 'w'.freeze, READ_WRITE_TRUNCATE = 'w+'.freeze, APPEND_WRITE_ONLY = 'a'.freeze, APPEND_READ_WRITE = 'a+'.freeze ].freeze
- FILE_CREATION_MODES =
(MODES - [READ_ONLY, READ_WRITE]).freeze
- MODE_BITMASK =
RealFile::RDONLY | RealFile::WRONLY | RealFile::RDWR | RealFile::APPEND | RealFile::CREAT | RealFile::EXCL | RealFile::NONBLOCK | RealFile::TRUNC | (RealFile.const_defined?(:NOCTTY) ? RealFile::NOCTTY : 0) | (RealFile.const_defined?(:SYNC) ? RealFile::SYNC : 0)
- FILE_CREATION_BITMASK =
RealFile::CREAT
Instance Attribute Summary collapse
-
#autoclose ⇒ Object
Returns the value of attribute autoclose.
-
#path ⇒ Object
readonly
Returns the value of attribute path.
Class Method Summary collapse
- .absolute_path(file_name, dir_name = Dir.getwd) ⇒ Object
- .atime(path) ⇒ Object
- .basename(*args) ⇒ Object
- .binread(file, length = nil, offset = 0) ⇒ Object
- .birthtime(path) ⇒ Object
- .chmod(mode_int, filename) ⇒ Object
- .chown(owner_int, group_int, filename) ⇒ Object
- .const_missing(name) ⇒ Object
- .ctime(path) ⇒ Object
- .delete(*file_names) ⇒ Object (also: unlink)
- .directory?(path) ⇒ Boolean
- .dirname(path) ⇒ Object
-
.executable?(filename) ⇒ Boolean
Not exactly right, returns true if the file is chmod +x for owner.
- .exist?(path) ⇒ Boolean (also: exists?, readable?, writable?)
- .expand_path(file_name, dir_string = FileSystem.current_dir.to_s) ⇒ Object
- .extname(path) ⇒ Object
- .file?(path) ⇒ Boolean
- .fnmatch?(pattern, path, flags = 0) ⇒ Boolean (also: fnmatch)
- .foreach(path, *args, &block) ⇒ Object
- .ftype(filename) ⇒ Object
- .join(*parts) ⇒ Object
- .link(source, dest) ⇒ Object
- .lstat(file) ⇒ Object
- .mtime(path) ⇒ Object
- .path(file) ⇒ Object
- .read(path, *args) ⇒ Object
- .readlines(path) ⇒ Object
- .readlink(path) ⇒ Object
- .realdirpath(*args) ⇒ Object
- .realpath(*args) ⇒ Object
- .rename(source, dest) ⇒ Object
- .size(path) ⇒ Object
- .size?(path) ⇒ Boolean
- .split(path) ⇒ Object
- .stat(file) ⇒ Object
-
.sticky?(_path) ⇒ Boolean
Assume nothing is sticky.
- .symlink(source, dest) ⇒ Object
- .symlink?(path) ⇒ Boolean
- .umask(*args) ⇒ Object
- .utime(atime, mtime, *paths) ⇒ Object
- .write(filename, contents, offset = nil, open_args = {}) ⇒ Object
- .zero?(path) ⇒ Boolean
Instance Method Summary collapse
- #advise(_advice, _offset = 0, _len = 0) ⇒ Object
- #atime ⇒ Object
- #autoclose? ⇒ Boolean
- #binmode? ⇒ Boolean
- #birthtime ⇒ Object
- #chmod(mode_int) ⇒ Object
- #chown(owner_int, group_int) ⇒ Object
- #close_on_exec=(_bool) ⇒ Object
- #close_on_exec? ⇒ Boolean
- #ctime ⇒ Object
- #exists? ⇒ Boolean
- #flock ⇒ Object
-
#initialize(path, mode = READ_ONLY, _perm = nil) ⇒ File
constructor
A new instance of File.
- #ioctl ⇒ Object
- #is_a?(klass) ⇒ Boolean
- #lstat ⇒ Object
- #mtime ⇒ Object
- #read(length = nil, buf = '') ⇒ Object
- #read_nonblock ⇒ Object
- #readpartial ⇒ Object
- #size ⇒ Object
- #stat ⇒ Object
- #sysread ⇒ Object
- #sysseek(position, whence = SEEK_SET) ⇒ Object
- #syswrite ⇒ Object
- #to_io ⇒ Object
- #to_path ⇒ Object
- #write(str) ⇒ Object
- #write_nonblock ⇒ Object
Constructor Details
#initialize(path, mode = READ_ONLY, _perm = nil) ⇒ File
Returns a new instance of File.
402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'lib/fakefs/file.rb', line 402 def initialize(path, mode = READ_ONLY, _perm = nil) @path = path @mode = mode.is_a?(Hash) ? (mode[:mode] || READ_ONLY) : mode @file = FileSystem.find(path) @autoclose = true check_modes! file_creation_mode? ? create_missing_file : check_file_existence! super(@file.content, @mode) end |
Instance Attribute Details
#autoclose ⇒ Object
Returns the value of attribute autoclose.
541 542 543 |
# File 'lib/fakefs/file.rb', line 541 def autoclose @autoclose end |
#path ⇒ Object (readonly)
Returns the value of attribute path.
400 401 402 |
# File 'lib/fakefs/file.rb', line 400 def path @path end |
Class Method Details
.absolute_path(file_name, dir_name = Dir.getwd) ⇒ Object
535 536 537 |
# File 'lib/fakefs/file.rb', line 535 def self.absolute_path(file_name, dir_name = Dir.getwd) RealFile.absolute_path(file_name, dir_name) end |
.atime(path) ⇒ Object
80 81 82 83 84 85 86 |
# File 'lib/fakefs/file.rb', line 80 def self.atime(path) if exists?(path) FileSystem.find(path).atime else fail Errno::ENOENT end end |
.basename(*args) ⇒ Object
151 152 153 |
# File 'lib/fakefs/file.rb', line 151 def self.basename(*args) RealFile.basename(*args) end |
.binread(file, length = nil, offset = 0) ⇒ Object
298 299 300 |
# File 'lib/fakefs/file.rb', line 298 def self.binread(file, length = nil, offset = 0) File.read(file, length, offset, mode: 'rb:ASCII-8BIT') end |
.birthtime(path) ⇒ Object
591 592 593 594 595 596 597 |
# File 'lib/fakefs/file.rb', line 591 def self.birthtime(path) if exists?(path) FileSystem.find(path).birthtime else fail Errno::ENOENT end end |
.chmod(mode_int, filename) ⇒ Object
268 269 270 |
# File 'lib/fakefs/file.rb', line 268 def self.chmod(mode_int, filename) FileSystem.find(filename).mode = 0100000 + mode_int end |
.chown(owner_int, group_int, filename) ⇒ Object
280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/fakefs/file.rb', line 280 def self.chown(owner_int, group_int, filename) file = FileSystem.find(filename) if owner_int && owner_int != -1 owner_int.is_a?(Fixnum) || fail(TypeError, "can't convert String into Integer") file.uid = owner_int end if group_int && group_int != -1 group_int.is_a?(Fixnum) || fail(TypeError, "can't convert String into Integer") file.gid = group_int end end |
.const_missing(name) ⇒ Object
113 114 115 |
# File 'lib/fakefs/file.rb', line 113 def self.const_missing(name) RealFile.const_get(name) end |
.ctime(path) ⇒ Object
72 73 74 75 76 77 78 |
# File 'lib/fakefs/file.rb', line 72 def self.ctime(path) if exists?(path) FileSystem.find(path).ctime else fail Errno::ENOENT end end |
.delete(*file_names) ⇒ Object Also known as: unlink
238 239 240 241 242 243 244 245 246 |
# File 'lib/fakefs/file.rb', line 238 def self.delete(*file_names) file_names.each do |file_name| fail Errno::ENOENT, file_name unless exists?(file_name) FileUtils.rm(file_name) end file_names.size end |
.directory?(path) ⇒ Boolean
117 118 119 120 121 122 123 124 |
# File 'lib/fakefs/file.rb', line 117 def self.directory?(path) if path.respond_to? :entry path.entry.is_a? FakeDir else result = FileSystem.find(path) result ? result.entry.is_a?(FakeDir) : false end end |
.dirname(path) ⇒ Object
155 156 157 |
# File 'lib/fakefs/file.rb', line 155 def self.dirname(path) RealFile.dirname(path) end |
.executable?(filename) ⇒ Boolean
Not exactly right, returns true if the file is chmod +x for owner. In the context of when you would use fakefs, this is usually what you want.
274 275 276 277 278 |
# File 'lib/fakefs/file.rb', line 274 def self.executable?(filename) file = FileSystem.find(filename) return false unless file (file.mode - 0100000) & 0100 != 0 end |
.exist?(path) ⇒ Boolean Also known as: exists?, readable?, writable?
42 43 44 45 46 47 48 49 |
# File 'lib/fakefs/file.rb', line 42 def self.exist?(path) if File.symlink?(path) referent = File.(File.readlink(path), File.dirname(path)) exist?(referent) else !FileSystem.find(path).nil? end end |
.expand_path(file_name, dir_string = FileSystem.current_dir.to_s) ⇒ Object
147 148 149 |
# File 'lib/fakefs/file.rb', line 147 def self.(file_name, dir_string = FileSystem.current_dir.to_s) RealFile.(file_name, RealFile.(dir_string, Dir.pwd)) end |
.extname(path) ⇒ Object
30 31 32 |
# File 'lib/fakefs/file.rb', line 30 def self.extname(path) RealFile.extname(path) end |
.file?(path) ⇒ Boolean
134 135 136 137 138 139 140 141 |
# File 'lib/fakefs/file.rb', line 134 def self.file?(path) if path.respond_to? :entry path.entry.is_a? FakeFile else result = FileSystem.find(path) result ? result.entry.is_a?(FakeFile) : false end end |
.fnmatch?(pattern, path, flags = 0) ⇒ Boolean Also known as: fnmatch
302 303 304 |
# File 'lib/fakefs/file.rb', line 302 def self.fnmatch?(pattern, path, flags = 0) RealFile.fnmatch?(pattern, path, flags) end |
.foreach(path, *args, &block) ⇒ Object
188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/fakefs/file.rb', line 188 def self.foreach(path, *args, &block) file = new(path) if file.exists? FileSystem.find(path).atime = Time.now if block_given? file.each_line(*args, &block) else file.each_line(*args) end else fail Errno::ENOENT end end |
.ftype(filename) ⇒ Object
143 144 145 |
# File 'lib/fakefs/file.rb', line 143 def self.ftype(filename) File.lstat(filename).ftype end |
.join(*parts) ⇒ Object
34 35 36 |
# File 'lib/fakefs/file.rb', line 34 def self.join(*parts) RealFile.join(parts) end |
.link(source, dest) ⇒ Object
226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/fakefs/file.rb', line 226 def self.link(source, dest) fail Errno::EPERM, "#{source} or #{dest}" if directory?(source) fail Errno::ENOENT, "#{source} or #{dest}" unless exists?(source) fail Errno::EEXIST, "#{source} or #{dest}" if exists?(dest) source = FileSystem.find(source) dest = FileSystem.add(dest, source.entry.clone) source.link(dest) 0 end |
.lstat(file) ⇒ Object
260 261 262 |
# File 'lib/fakefs/file.rb', line 260 def self.lstat(file) File::Stat.new(file, true) end |
.mtime(path) ⇒ Object
64 65 66 67 68 69 70 |
# File 'lib/fakefs/file.rb', line 64 def self.mtime(path) if exists?(path) FileSystem.find(path).mtime else fail Errno::ENOENT end end |
.path(file) ⇒ Object
38 39 40 |
# File 'lib/fakefs/file.rb', line 38 def self.path(file) RealFile.path(file) end |
.read(path, *args) ⇒ Object
164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/fakefs/file.rb', line 164 def self.read(path, *args) = args[-1].is_a?(Hash) ? args.pop : {} length = args.size > 0 ? args.shift : nil offset = args.size > 0 ? args.shift : 0 file = new(path, ) fail Errno::ENOENT unless file.exists? fail Errno::EISDIR, path if directory?(path) FileSystem.find(path).atime = Time.now file.seek(offset) file.read(length) end |
.readlines(path) ⇒ Object
178 179 180 181 182 183 184 185 186 |
# File 'lib/fakefs/file.rb', line 178 def self.readlines(path) file = new(path) if file.exists? FileSystem.find(path).atime = Time.now file.readlines else fail Errno::ENOENT end end |
.readlink(path) ⇒ Object
159 160 161 162 |
# File 'lib/fakefs/file.rb', line 159 def self.readlink(path) symlink = FileSystem.find(path) symlink.target end |
.realdirpath(*args) ⇒ Object
553 554 555 |
# File 'lib/fakefs/file.rb', line 553 def self.realdirpath(*args) RealFile.realdirpath(*args) end |
.realpath(*args) ⇒ Object
513 514 515 |
# File 'lib/fakefs/file.rb', line 513 def self.realpath(*args) RealFile.realpath(*args) end |
.rename(source, dest) ⇒ Object
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/fakefs/file.rb', line 202 def self.rename(source, dest) if directory?(source) && file?(dest) fail Errno::ENOTDIR, "#{source} or #{dest}" elsif file?(source) && directory?(dest) fail Errno::EISDIR, "#{source} or #{dest}" elsif !exist?(dirname(dest)) fail Errno::ENOENT, "#{source} or #{dest}" end if (target = FileSystem.find(source)) if target.is_a?(FakeFS::FakeSymlink) File.symlink(target.target, dest) else FileSystem.add(dest, target.entry.clone) end FileSystem.delete(source) else fail Errno::ENOENT, "#{source} or #{dest}" end 0 end |
.size(path) ⇒ Object
101 102 103 |
# File 'lib/fakefs/file.rb', line 101 def self.size(path) read(path).bytesize end |
.size?(path) ⇒ Boolean
105 106 107 |
# File 'lib/fakefs/file.rb', line 105 def self.size?(path) size(path) if exists?(path) && !size(path).zero? end |
.split(path) ⇒ Object
264 265 266 |
# File 'lib/fakefs/file.rb', line 264 def self.split(path) RealFile.split(path) end |
.stat(file) ⇒ Object
256 257 258 |
# File 'lib/fakefs/file.rb', line 256 def self.stat(file) File::Stat.new(file) end |
.sticky?(_path) ⇒ Boolean
Assume nothing is sticky.
59 60 61 |
# File 'lib/fakefs/file.rb', line 59 def sticky?(_path) false end |
.symlink(source, dest) ⇒ Object
252 253 254 |
# File 'lib/fakefs/file.rb', line 252 def self.symlink(source, dest) FileUtils.ln_s(source, dest) end |
.symlink?(path) ⇒ Boolean
126 127 128 129 130 131 132 |
# File 'lib/fakefs/file.rb', line 126 def self.symlink?(path) if path.respond_to? :entry path.is_a? FakeSymlink else FileSystem.find(path).is_a? FakeSymlink end end |
.umask(*args) ⇒ Object
294 295 296 |
# File 'lib/fakefs/file.rb', line 294 def self.umask(*args) RealFile.umask(*args) end |
.utime(atime, mtime, *paths) ⇒ Object
88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/fakefs/file.rb', line 88 def self.utime(atime, mtime, *paths) paths.each do |path| if exists?(path) FileSystem.find(path).atime = atime FileSystem.find(path).mtime = mtime else fail Errno::ENOENT end end paths.size end |
.write(filename, contents, offset = nil, open_args = {}) ⇒ Object
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 |
# File 'lib/fakefs/file.rb', line 562 def self.write(filename, contents, offset = nil, open_args = {}) offset, open_args = nil, offset if offset.is_a?(Hash) mode = offset ? 'a' : 'w' if open_args.size > 0 if open_args[:open_args] args = [filename, *open_args[:open_args]] else mode = open_args[:mode] || mode args = [filename, mode, open_args] end else args = [filename, mode] end if offset open(*args) do |f| f.seek(offset) f.write(contents) end else open(*args) do |f| f << contents end end contents.length end |
.zero?(path) ⇒ Boolean
109 110 111 |
# File 'lib/fakefs/file.rb', line 109 def self.zero?(path) exists?(path) && size(path) == 0 end |
Instance Method Details
#advise(_advice, _offset = 0, _len = 0) ⇒ Object
559 560 |
# File 'lib/fakefs/file.rb', line 559 def advise(_advice, _offset = 0, _len = 0) end |
#atime ⇒ Object
480 481 482 |
# File 'lib/fakefs/file.rb', line 480 def atime self.class.atime(@path) end |
#autoclose? ⇒ Boolean
543 544 545 |
# File 'lib/fakefs/file.rb', line 543 def autoclose? @autoclose ? true : false end |
#binmode? ⇒ Boolean
517 518 519 |
# File 'lib/fakefs/file.rb', line 517 def binmode? fail NotImplementedError end |
#birthtime ⇒ Object
599 600 601 |
# File 'lib/fakefs/file.rb', line 599 def birthtime self.class.birthtime(@path) end |
#chmod(mode_int) ⇒ Object
496 497 498 |
# File 'lib/fakefs/file.rb', line 496 def chmod(mode_int) @file.mode = 0100000 + mode_int end |
#chown(owner_int, group_int) ⇒ Object
500 501 502 503 504 505 506 507 508 509 510 |
# File 'lib/fakefs/file.rb', line 500 def chown(owner_int, group_int) return unless group_int && group_int != -1 owner_int.is_a?(Fixnum) || fail( TypeError, "can't convert String into Integer") @file.uid = owner_int group_int.is_a?(Fixnum) || fail( TypeError, "can't convert String into Integer") @file.gid = group_int end |
#close_on_exec=(_bool) ⇒ Object
521 522 523 |
# File 'lib/fakefs/file.rb', line 521 def close_on_exec=(_bool) fail NotImplementedError end |
#close_on_exec? ⇒ Boolean
525 526 527 |
# File 'lib/fakefs/file.rb', line 525 def close_on_exec? fail NotImplementedError end |
#ctime ⇒ Object
484 485 486 |
# File 'lib/fakefs/file.rb', line 484 def ctime self.class.ctime(@path) end |
#exists? ⇒ Boolean
415 416 417 |
# File 'lib/fakefs/file.rb', line 415 def exists? true end |
#flock ⇒ Object
488 489 490 |
# File 'lib/fakefs/file.rb', line 488 def flock(*) fail NotImplementedError end |
#ioctl ⇒ Object
445 446 447 |
# File 'lib/fakefs/file.rb', line 445 def ioctl(*) fail NotImplementedError end |
#is_a?(klass) ⇒ Boolean
441 442 443 |
# File 'lib/fakefs/file.rb', line 441 def is_a?(klass) RealFile.allocate.is_a?(klass) end |
#lstat ⇒ Object
457 458 459 |
# File 'lib/fakefs/file.rb', line 457 def lstat self.class.lstat(@path) end |
#mtime ⇒ Object
492 493 494 |
# File 'lib/fakefs/file.rb', line 492 def mtime self.class.mtime(@path) end |
#read(length = nil, buf = '') ⇒ Object
604 605 606 607 608 609 610 611 |
# File 'lib/fakefs/file.rb', line 604 def read(length = nil, buf = '') read_buf = super(length, buf) # change to binary only for ruby 1.9.3 if read_buf.respond_to?(:force_encoding) && binary_mode? read_buf = read_buf.force_encoding('ASCII-8BIT') end read_buf end |
#read_nonblock ⇒ Object
449 450 451 |
# File 'lib/fakefs/file.rb', line 449 def read_nonblock fail NotImplementedError end |
#readpartial ⇒ Object
476 477 478 |
# File 'lib/fakefs/file.rb', line 476 def readpartial(*) fail NotImplementedError end |
#stat ⇒ Object
453 454 455 |
# File 'lib/fakefs/file.rb', line 453 def stat self.class.stat(@path) end |
#sysread ⇒ Object
426 |
# File 'lib/fakefs/file.rb', line 426 alias_method :sysread, :read |
#sysseek(position, whence = SEEK_SET) ⇒ Object
461 462 463 464 |
# File 'lib/fakefs/file.rb', line 461 def sysseek(position, whence = SEEK_SET) seek(position, whence) pos end |
#syswrite ⇒ Object
427 428 429 430 431 |
# File 'lib/fakefs/file.rb', line 427 def write(str) val = super(str) @file.mtime = Time.now val end |
#to_io ⇒ Object
468 469 470 |
# File 'lib/fakefs/file.rb', line 468 def to_io self end |
#to_path ⇒ Object
529 530 531 |
# File 'lib/fakefs/file.rb', line 529 def to_path @path end |
#write(str) ⇒ Object
419 420 421 422 423 |
# File 'lib/fakefs/file.rb', line 419 def write(str) val = super(str) @file.mtime = Time.now val end |
#write_nonblock ⇒ Object
472 473 474 |
# File 'lib/fakefs/file.rb', line 472 def write_nonblock(*) fail NotImplementedError end |