Class: FakeFS::File

Inherits:
StringIO
  • Object
show all
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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, mode = READ_ONLY, _perm = nil) ⇒ File

Returns a new instance of File.



483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/fakefs/file.rb', line 483

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.



634
635
636
 
# File 'lib/fakefs/file.rb', line 634

def autoclose
  @autoclose
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



481
482
483
 
# File 'lib/fakefs/file.rb', line 481

def path
  @path
end

Class Method Details

.absolute_path(file_name, dir_name = Dir.getwd) ⇒ Object 



630
631
632
 
# File 'lib/fakefs/file.rb', line 630

def self.absolute_path(file_name, dir_name = Dir.getwd)
  RealFile.absolute_path(file_name, dir_name)
end

.atime(path) ⇒ Object 



88
89
90
91
92
93
94
 
# File 'lib/fakefs/file.rb', line 88

def self.atime(path)
  if exists?(path)
    FileSystem.find(path).atime
  else
    raise Errno::ENOENT
  end
end

.basename(*args) ⇒ Object 



169
170
171
 
# File 'lib/fakefs/file.rb', line 169

def self.basename(*args)
  RealFile.basename(*args)
end

.binread(file, length = nil, offset = 0) ⇒ Object 



323
324
325
 
# File 'lib/fakefs/file.rb', line 323

def self.binread(file, length = nil, offset = 0)
  File.read(file, length, offset, mode: 'rb:ASCII-8BIT')
end

.birthtime(path) ⇒ Object 



679
680
681
682
683
684
685
 
# File 'lib/fakefs/file.rb', line 679

def self.birthtime(path)
  if exists?(path)
    FileSystem.find(path).birthtime
  else
    raise Errno::ENOENT
  end
end

.chmod(new_mode, filename) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/fakefs/file.rb', line 286

def self.chmod(new_mode, filename)
  # chmod's mode can either be passed in in absolute mode, or symbolic mode
  # for reference: https://ruby-doc.org/stdlib-2.2.2/libdoc/fileutils/rdoc/FileUtils.html#method-c-chmod
  # if the mode is passed in symbolic mode we must convert it to absolute mode
  is_absolute_mode = new_mode.is_a? Numeric
  unless is_absolute_mode
    current_mode = FileSystem.find(filename).mode
    new_mode = convert_symbolic_chmod_to_absolute(new_mode, current_mode)
  end
  FileSystem.find(filename).mode = 0o100000 + new_mode
end

.chown(owner_int, group_int, filename) ⇒ Object 



306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/fakefs/file.rb', line 306

def self.chown(owner_int, group_int, filename)
  file = FileSystem.find(filename)

  if owner_int && owner_int != -1
    owner_int.is_a?(Integer) || raise(TypeError, "can't convert String into Integer")
    file.uid = owner_int
  end
  if group_int && group_int != -1
    group_int.is_a?(Integer) || raise(TypeError, "can't convert String into Integer")
    file.gid = group_int
  end
end

.const_missing(name) ⇒ Object 



131
132
133
 
# File 'lib/fakefs/file.rb', line 131

def self.const_missing(name)
  RealFile.const_get(name)
end

.ctime(path) ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/fakefs/file.rb', line 80

def self.ctime(path)
  if exists?(path)
    FileSystem.find(path).ctime
  else
    raise Errno::ENOENT
  end
end

.delete(*file_names) ⇒ Object Also known as: unlink 



256
257
258
259
260
261
262
263
264
 
# File 'lib/fakefs/file.rb', line 256

def self.delete(*file_names)
  file_names.each do |file_name|
    raise Errno::ENOENT, file_name.to_s unless exists?(file_name)

    FileUtils.rm(file_name)
  end

  file_names.size
end

.directory?(path) ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
138
139
140
141
142
 
# File 'lib/fakefs/file.rb', line 135

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 



173
174
175
 
# File 'lib/fakefs/file.rb', line 173

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.

Returns:

  • (Boolean) 


300
301
302
303
304
 
# File 'lib/fakefs/file.rb', line 300

def self.executable?(filename)
  file = FileSystem.find(filename)
  return false unless file
  (file.mode - 0o100000) & 0o100 != 0
end

.exist?(path) ⇒ Boolean Also known as: exists?

Returns:

  • (Boolean) 


44
45
46
47
48
49
50
51
 
# File 'lib/fakefs/file.rb', line 44

def self.exist?(path)
  if File.symlink?(path)
    referent = File.expand_path(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 



165
166
167
 
# File 'lib/fakefs/file.rb', line 165

def self.expand_path(file_name, dir_string = FileSystem.current_dir.to_s)
  RealFile.expand_path(file_name, RealFile.expand_path(dir_string, Dir.pwd))
end

.extname(path) ⇒ Object 



32
33
34
 
# File 'lib/fakefs/file.rb', line 32

def self.extname(path)
  RealFile.extname(path)
end

.file?(path) ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
155
156
157
158
159
 
# File 'lib/fakefs/file.rb', line 152

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

Returns:

  • (Boolean) 


327
328
329
 
# File 'lib/fakefs/file.rb', line 327

def self.fnmatch?(pattern, path, flags = 0)
  RealFile.fnmatch?(pattern, path, flags)
end

.foreach(path, *args, &block) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/fakefs/file.rb', line 206

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
    raise Errno::ENOENT
  end
end

.ftype(filename) ⇒ Object 



161
162
163
 
# File 'lib/fakefs/file.rb', line 161

def self.ftype(filename)
  File.lstat(filename).ftype
end

.join(*parts) ⇒ Object 



36
37
38
 
# File 'lib/fakefs/file.rb', line 36

def self.join(*parts)
  RealFile.join(parts)
end

.link(source, dest) ⇒ Object

Raises:

  • (Errno::EPERM) 


244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/fakefs/file.rb', line 244

def self.link(source, dest)
  raise Errno::EPERM, "#{source} or #{dest}" if directory?(source)
  raise Errno::ENOENT, "#{source} or #{dest}" unless exists?(source)
  raise 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 



278
279
280
 
# File 'lib/fakefs/file.rb', line 278

def self.lstat(file)
  File::Stat.new(file, true)
end

.mtime(path) ⇒ Object 



72
73
74
75
76
77
78
 
# File 'lib/fakefs/file.rb', line 72

def self.mtime(path)
  if exists?(path)
    FileSystem.find(path).mtime
  else
    raise Errno::ENOENT
  end
end

.path(file) ⇒ Object 



40
41
42
 
# File 'lib/fakefs/file.rb', line 40

def self.path(file)
  RealFile.path(file)
end

.read(path, *args) ⇒ Object

Raises:

  • (Errno::ENOENT) 


182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/fakefs/file.rb', line 182

def self.read(path, *args)
  options = args[-1].is_a?(Hash) ? args.pop : {}
  length = args.empty? ? nil : args.shift
  offset = args.empty? ? 0 : args.shift
  file = new(path, options)

  raise Errno::ENOENT unless file.exists?
  raise Errno::EISDIR, path.to_s if directory?(path)

  FileSystem.find(path).atime = Time.now
  file.seek(offset)
  file.read(length)
end

.readable?(path) ⇒ Boolean

Returns:

  • (Boolean) 


62
63
64
65
 
# File 'lib/fakefs/file.rb', line 62

def self.readable?(path)
  return false unless exist? path
  File.lstat(path).readable?
end

.readlines(path) ⇒ Object 



196
197
198
199
200
201
202
203
204
 
# File 'lib/fakefs/file.rb', line 196

def self.readlines(path)
  file = new(path)
  if file.exists?
    FileSystem.find(path).atime = Time.now
    file.readlines
  else
    raise Errno::ENOENT
  end
end

.readlink(path) ⇒ Object 



177
178
179
180
 
# File 'lib/fakefs/file.rb', line 177

def self.readlink(path)
  symlink = FileSystem.find(path)
  symlink.target
end

.realdirpath(*args) ⇒ Object 



646
647
648
 
# File 'lib/fakefs/file.rb', line 646

def self.realdirpath(*args)
  RealFile.realdirpath(*args)
end

.realpath(*args) ⇒ Object 



610
611
612
 
# File 'lib/fakefs/file.rb', line 610

def self.realpath(*args)
  RealFile.realpath(*args)
end

.rename(source, dest) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/fakefs/file.rb', line 220

def self.rename(source, dest)
  if directory?(source) && file?(dest)
    raise Errno::ENOTDIR, "#{source} or #{dest}"
  elsif file?(source) && directory?(dest)
    raise Errno::EISDIR, "#{source} or #{dest}"
  elsif !exist?(dirname(dest))
    raise 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
    raise Errno::ENOENT, "#{source} or #{dest}"
  end

  0
end

.size(path) ⇒ Object 



109
110
111
112
113
114
115
 
# File 'lib/fakefs/file.rb', line 109

def self.size(path)
  if directory?(path)
    64 + (32 * FileSystem.find(path).entries.size)
  else
    read(path).bytesize
  end
end

.size?(path) ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/fakefs/file.rb', line 117

def self.size?(path)
  size(path) if exists?(path) && !size(path).zero?
end

.split(path) ⇒ Object 



282
283
284
 
# File 'lib/fakefs/file.rb', line 282

def self.split(path)
  RealFile.split(path)
end

.stat(file) ⇒ Object 



274
275
276
 
# File 'lib/fakefs/file.rb', line 274

def self.stat(file)
  File::Stat.new(file)
end

.sticky?(_path) ⇒ Boolean

Assume nothing is sticky.

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/fakefs/file.rb', line 57

def sticky?(_path)
  false
end

.symlink(source, dest) ⇒ Object 



270
271
272
 
# File 'lib/fakefs/file.rb', line 270

def self.symlink(source, dest)
  FileUtils.ln_s(source, dest)
end

.symlink?(path) ⇒ Boolean

Returns:

  • (Boolean) 


144
145
146
147
148
149
150
 
# File 'lib/fakefs/file.rb', line 144

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 



319
320
321
 
# File 'lib/fakefs/file.rb', line 319

def self.umask(*args)
  RealFile.umask(*args)
end

.utime(atime, mtime, *paths) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/fakefs/file.rb', line 96

def self.utime(atime, mtime, *paths)
  paths.each do |path|
    if exists?(path)
      FileSystem.find(path).atime = atime
      FileSystem.find(path).mtime = mtime
    else
      raise Errno::ENOENT
    end
  end

  paths.size
end

.writable?(path) ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
70
 
# File 'lib/fakefs/file.rb', line 67

def self.writable?(path)
  return false unless exist? path
  File.lstat(path).writable?
end

.write(filename, contents, offset = nil, open_args = {}) ⇒ Object 



652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/fakefs/file.rb', line 652

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.any?
    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| # rubocop:disable Security/Open
      f.seek(offset)
      f.write(contents)
    end
  else
    open(*args) do |f| # rubocop:disable Security/Open
      f << contents
    end
  end

  contents.length
end

.zero?(path) ⇒ Boolean Also known as: empty?

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/fakefs/file.rb', line 121

def self.zero?(path)
  exists?(path) && size(path) == 0
end

Instance Method Details

#advise(_advice, _offset = 0, _len = 0) ⇒ Object 



650
 
# File 'lib/fakefs/file.rb', line 650

def advise(_advice, _offset = 0, _len = 0); end

#atime ⇒ Object 



568
569
570
 
# File 'lib/fakefs/file.rb', line 568

def atime
  self.class.atime(@path)
end

#autoclose? ⇒ Boolean

Returns:

  • (Boolean) 


636
637
638
 
# File 'lib/fakefs/file.rb', line 636

def autoclose?
  @autoclose ? true : false
end

#binmode? ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


614
615
616
 
# File 'lib/fakefs/file.rb', line 614

def binmode?
  raise NotImplementedError
end

#birthtime ⇒ Object 



687
688
689
 
# File 'lib/fakefs/file.rb', line 687

def birthtime
  self.class.birthtime(@path)
end

#chmod(new_mode) ⇒ Object 



584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/fakefs/file.rb', line 584

def chmod(new_mode)
  # chmod's mode can either be passed in in absolute mode, or symbolic mode
  # for reference: https://ruby-doc.org/stdlib-2.2.2/libdoc/fileutils/rdoc/FileUtils.html#method-c-chmod
  # if the mode is passed in symbolic mode we must convert it to absolute mode
  is_absolute_mode = new_mode.is_a? Numeric
  unless is_absolute_mode
    current_mode = @file.mode
    new_mode = convert_symbolic_chmod_to_absolute(new_mode, current_mode)
  end
  @file.mode = 0o100000 + new_mode
end

#chown(owner_int, group_int) ⇒ Object 



596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/fakefs/file.rb', line 596

def chown(owner_int, group_int)
  return unless group_int && group_int != -1

  owner_int.is_a?(Integer) || raise(
    TypeError, "can't convert String into Integer"
  )
  @file.uid = owner_int

  group_int.is_a?(Integer) || raise(
    TypeError, "can't convert String into Integer"
  )
  @file.gid = group_int
end

#close_on_exec=(_bool) ⇒ Object

Raises:

  • (NotImplementedError) 


618
619
620
 
# File 'lib/fakefs/file.rb', line 618

def close_on_exec=(_bool)
  raise NotImplementedError
end

#close_on_exec? ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


622
623
624
 
# File 'lib/fakefs/file.rb', line 622

def close_on_exec?
  raise NotImplementedError
end

#ctime ⇒ Object 



572
573
574
 
# File 'lib/fakefs/file.rb', line 572

def ctime
  self.class.ctime(@path)
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


496
497
498
 
# File 'lib/fakefs/file.rb', line 496

def exists?
  true
end

#flock ⇒ Object

Raises:

  • (NotImplementedError) 


576
577
578
 
# File 'lib/fakefs/file.rb', line 576

def flock(*)
  raise NotImplementedError
end

#ioctl ⇒ Object

Raises:

  • (NotImplementedError) 


533
534
535
 
# File 'lib/fakefs/file.rb', line 533

def ioctl(*)
  raise NotImplementedError
end

#is_a?(klass) ⇒ Boolean

Returns:

  • (Boolean) 


525
526
527
 
# File 'lib/fakefs/file.rb', line 525

def is_a?(klass)
  RealFile.allocate.is_a?(klass)
end

#lstat ⇒ Object 



545
546
547
 
# File 'lib/fakefs/file.rb', line 545

def lstat
  self.class.lstat(@path)
end

#mtime ⇒ Object 



580
581
582
 
# File 'lib/fakefs/file.rb', line 580

def mtime
  self.class.mtime(@path)
end

#read(length = nil, buf = '') ⇒ Object 



691
692
693
694
695
 
# File 'lib/fakefs/file.rb', line 691

def read(length = nil, buf = '')
  read_buf = super(length, buf)
  read_buf&.force_encoding('ASCII-8BIT') if binary_mode?
  read_buf
end

#read_nonblock ⇒ Object

Raises:

  • (NotImplementedError) 


537
538
539
 
# File 'lib/fakefs/file.rb', line 537

def read_nonblock
  raise NotImplementedError
end

#readpartial ⇒ Object

Raises:

  • (NotImplementedError) 


564
565
566
 
# File 'lib/fakefs/file.rb', line 564

def readpartial(*)
  raise NotImplementedError
end

#size ⇒ Object 



642
643
644
 
# File 'lib/fakefs/file.rb', line 642

def size
  File.size(@path)
end

#stat ⇒ Object 



541
542
543
 
# File 'lib/fakefs/file.rb', line 541

def stat
  self.class.stat(@path)
end

#string ⇒ Object 



529
530
531
 
# File 'lib/fakefs/file.rb', line 529

def string
  gets(nil)
end

#sysread ⇒ Object 



507
 
# File 'lib/fakefs/file.rb', line 507

alias sysread read

#sysseek(position, whence = SEEK_SET) ⇒ Object 



549
550
551
552
 
# File 'lib/fakefs/file.rb', line 549

def sysseek(position, whence = SEEK_SET)
  seek(position, whence)
  pos
end

#syswrite ⇒ Object 



508
509
510
511
512
 
# File 'lib/fakefs/file.rb', line 508

def write(str)
  val = super(str)
  @file.mtime = Time.now
  val
end

#to_io ⇒ Object 



556
557
558
 
# File 'lib/fakefs/file.rb', line 556

def to_io
  self
end

#to_path ⇒ Object 



626
627
628
 
# File 'lib/fakefs/file.rb', line 626

def to_path
  @path
end

#write(str) ⇒ Object 



500
501
502
503
504
 
# File 'lib/fakefs/file.rb', line 500

def write(str)
  val = super(str)
  @file.mtime = Time.now
  val
end

#write_nonblock ⇒ Object

Raises:

  • (NotImplementedError) 


560
561
562
 
# File 'lib/fakefs/file.rb', line 560

def write_nonblock(*)
  raise NotImplementedError
end