memfs 1.0.0 → 2.0.0

data/spec/memfs/file/stat_spec.rb

@@ -3,16 +3,16 @@ require 'spec_helper'
 module MemFs
   ::RSpec.describe File::Stat do
     let(:file_stat) { described_class.new('/test-file') }
-    let(:dereferenced_file_stat) { described_class.new('/test-file', true) }
+    let(:dereferenced_file_stat) { described_class.new('/test-file', dereference: true) }
 
     let(:dir_link_stat) { described_class.new('/test-dir-link') }
-    let(:dereferenced_dir_link_stat) { described_class.new('/test-dir-link', true) }
+    let(:dereferenced_dir_link_stat) { described_class.new('/test-dir-link', dereference: true) }
 
     let(:link_stat) { described_class.new('/test-link') }
-    let(:dereferenced_link_stat) { described_class.new('/test-link', true) }
+    let(:dereferenced_link_stat) { described_class.new('/test-link', dereference: true) }
 
     let(:dir_stat) { described_class.new('/test-dir') }
-    let(:dereferenced_dir_stat) { described_class.new('/test-dir', true) }
+    let(:dereferenced_dir_stat) { described_class.new('/test-dir', dereference: true) }
 
     let(:entry) { _fs.find!('/test-file') }
 
@@ -29,7 +29,7 @@ module MemFs
         context 'when the last target of the link chain does not exist' do
           it 'raises an exception' do
             expect {
-              described_class.new('/test-no-file-link', true)
+              described_class.new('/test-no-file-link', dereference: true)
             }.to raise_error(Errno::ENOENT)
           end
         end
@@ -373,6 +373,18 @@ module MemFs
       end
     end
 
+    describe '#nlink' do
+      context 'when the entry is a regular file' do
+        it "returns expected nlinks for a file" do
+          expect(file_stat.nlink).to eq(1)
+        end
+
+        it "returns expected nlinks for a directory" do
+          expect(dir_stat.nlink).to eq(2)
+        end
+      end
+    end
+
     describe '#ftype' do
       context 'when the entry is a regular file' do
         it "returns 'file'" do
@@ -441,7 +453,7 @@ module MemFs
 
       context 'when the effective user group does not own of the file' do
         it 'returns false' do
-          _fs.chown(0, 0, '/test-file')
+          _fs.chown(9999, 9999, '/test-file')
           expect(file_stat.grpowned?).to be false
         end
       end
@@ -455,8 +467,8 @@ module MemFs
 
     describe '#mode' do
       it 'returns an integer representing the permission bits of stat' do
-        _fs.chmod(0777, '/test-file')
-        expect(file_stat.mode).to be(0100777)
+        _fs.chmod(0o777, '/test-file')
+        expect(file_stat.mode).to be(0o100777)
       end
     end
 
@@ -470,7 +482,7 @@ module MemFs
 
       context 'when the effective user does not own of the file' do
         it 'returns false' do
-          _fs.chown(0, 0, '/test-file')
+          _fs.chown(9999, 9999, '/test-file')
           expect(file_stat.owned?).to be false
         end
       end
@@ -599,14 +611,14 @@ module MemFs
     describe '#setgid?' do
       context 'when the file has the setgid bit set' do
         it 'returns true' do
-          _fs.chmod(02000, '/test-file')
+          _fs.chmod(0o2000, '/test-file')
           expect(file_stat.setgid?).to be true
         end
       end
 
       context 'when the file does not have the setgid bit set' do
         it 'returns false' do
-          _fs.chmod(0644, '/test-file')
+          _fs.chmod(0o644, '/test-file')
           expect(file_stat.setgid?).to be false
         end
       end
@@ -615,14 +627,14 @@ module MemFs
     describe '#setuid?' do
       context 'when the file has the setuid bit set' do
         it 'returns true' do
-          _fs.chmod(04000, '/test-file')
+          _fs.chmod(0o4000, '/test-file')
           expect(file_stat.setuid?).to be true
         end
       end
 
       context 'when the file does not have the setuid bit set' do
         it 'returns false' do
-          _fs.chmod(0644, '/test-file')
+          _fs.chmod(0o644, '/test-file')
           expect(file_stat.setuid?).to be false
         end
       end
@@ -640,12 +652,12 @@ module MemFs
 
     describe '#sticky?' do
       it 'returns true if the named file has the sticky bit set' do
-        _fs.chmod(01777, '/test-file')
+        _fs.chmod(0o1777, '/test-file')
         expect(file_stat.sticky?).to be true
       end
 
       it "returns false if the named file hasn't' the sticky bit set" do
-        _fs.chmod(0666, '/test-file')
+        _fs.chmod(0o666, '/test-file')
         expect(file_stat.sticky?).to be false
       end
     end

data/spec/memfs/file_spec.rb

@@ -26,6 +26,10 @@ module MemFs
         expect(MemFs::File::SEPARATOR).to eq '/'
       end
 
+      it 'exposes PATH_SEPARATOR' do
+        expect(MemFs::File::PATH_SEPARATOR).to eq '/'
+      end
+
       it 'expose ALT_SEPARATOR' do
         expect(MemFs::File::ALT_SEPARATOR).to be_nil
       end
@@ -36,20 +40,20 @@ module MemFs
 
       it 'converts a pathname to an absolute pathname' do
         path = described_class.absolute_path('./test-file')
-        expect(path).to eq '/test-dir/test-file'
+        expect(path).to eq expected_path('/test-dir/test-file')
       end
 
       context 'when +dir_string+ is given' do
         it 'uses it as the starting point' do
           path = described_class.absolute_path('./test-file', '/no-dir')
-          expect(path).to eq '/no-dir/test-file'
+          expect(path).to eq expected_path('/no-dir/test-file')
         end
       end
 
       context "when the given pathname starts with a '~'" do
         it 'does not expanded' do
           path = described_class.absolute_path('~/test-file')
-          expect(path).to eq '/test-dir/~/test-file'
+          expect(path).to eq expected_path('/test-dir/~/test-file')
         end
       end
     end
@@ -75,6 +79,27 @@ module MemFs
       end
     end
 
+    describe '.birthtime' do
+      it 'returns creation time for the named file as a Time object' do
+        expect(described_class.birthtime('/test-file')).to be_a Time
+      end
+
+      it 'raises an error if the entry does not exist' do
+        expect { described_class.birthtime('/no-file') }.to raise_error Errno::ENOENT
+      end
+
+      context 'when the entry is a symlink' do
+        let(:time) { Time.now - 500_000 }
+
+        it 'returns the creation time of the last target of the link chain' do
+          _fs.find!('/test-file').birthtime = time
+          described_class.symlink '/test-link', '/test-link2'
+
+          expect(described_class.birthtime('/test-link2')).to eq time
+        end
+      end
+    end
+
     describe '.blockdev?' do
       context 'when the name file exists' do
         context 'and it is a block device' do
@@ -151,17 +176,17 @@ module MemFs
 
     describe '.chmod' do
       it 'changes permission bits on the named file' do
-        described_class.chmod 0777, '/test-file'
+        described_class.chmod 0o777, '/test-file'
 
         mode = described_class.stat('/test-file').mode
-        expect(mode).to be 0100777
+        expect(mode).to be 0o100777
       end
 
       it 'changes permission bits on the named files (in list)' do
-        described_class.chmod 0777, '/test-file', '/test-file2'
+        described_class.chmod 0o777, '/test-file', '/test-file2'
 
         mode = described_class.stat('/test-file2').mode
-        expect(mode).to be 0100777
+        expect(mode).to be 0o100777
       end
     end
 
@@ -304,6 +329,12 @@ module MemFs
       end
     end
 
+    describe '.empty?' do
+      subject { described_class }
+
+      it_behaves_like 'aliased method', :empty?, :zero?
+    end
+
     describe '.executable?' do
       let(:access) { 0 }
       let(:gid) { 0 }
@@ -459,20 +490,20 @@ module MemFs
         _fs.chdir '/'
 
         expanded_path = described_class.expand_path('test-file')
-        expect(expanded_path).to eq '/test-file'
+        expect(expanded_path).to eq expected_path('/test-file')
       end
 
       it 'references path from the current working directory' do
         _fs.chdir '/test-dir'
 
         expanded_path = described_class.expand_path('test-file')
-        expect(expanded_path).to eq '/test-dir/test-file'
+        expect(expanded_path).to eq expected_path('/test-dir/test-file')
       end
 
       context 'when +dir_string+ is provided' do
         it 'uses +dir_string+ as the stating point' do
           expanded_path = described_class.expand_path('test-file', '/test')
-          expect(expanded_path).to eq '/test/test-file'
+          expect(expanded_path).to eq expected_path('/test/test-file')
         end
       end
     end
@@ -500,9 +531,16 @@ module MemFs
       end
 
       context 'when the period is the last character in path' do
-        it 'returns an empty string' do
-          extname = described_class.extname('test-subject.')
-          expect(extname).to eq ''
+        if MemFs.ruby_version_gte?('2.7') && !MemFs.windows?
+          it 'returns a period' do
+            extname = described_class.extname('test-subject.')
+            expect(extname).to eq '.'
+          end
+        else
+          it 'returns an empty string' do
+            extname = described_class.extname('test-subject.')
+            expect(extname).to eq ''
+          end
         end
       end
     end
@@ -624,7 +662,7 @@ module MemFs
 
         context 'and the effective user group does not own of the file' do
           it 'returns false' do
-            described_class.chown 0, 0, '/test-file'
+            described_class.chown 9999, 9999, '/test-file'
 
             grpowned = File.grpowned?('/test-file')
             expect(grpowned).to be false
@@ -701,6 +739,30 @@ module MemFs
           end
         end
       end
+
+      context 'when given a File object instead of a path' do
+        it 'returns true when the File object refers to the same file' do
+          file = described_class.new('/test-file', 'r')
+          expect(described_class.identical?(file, '/test-file')).to be true
+          file.close
+        end
+
+        it 'returns true when both arguments are File objects for the same file' do
+          file1 = described_class.new('/test-file', 'r')
+          file2 = described_class.new('/test-file', 'r')
+          expect(described_class.identical?(file1, file2)).to be true
+          file1.close
+          file2.close
+        end
+
+        it 'returns false when both File objects refer to different files' do
+          file1 = described_class.new('/test-file', 'r')
+          file2 = described_class.new('/test-file2', 'r')
+          expect(described_class.identical?(file1, file2)).to be false
+          file1.close
+          file2.close
+        end
+      end
     end
 
     describe '.join' do
@@ -713,24 +775,24 @@ module MemFs
     describe '.lchmod' do
       context 'when the named file is a regular file' do
         it 'acts like chmod' do
-          described_class.lchmod 0777, '/test-file'
+          described_class.lchmod 0o777, '/test-file'
 
           mode = described_class.stat('/test-file').mode
-          expect(mode).to be 0100777
+          expect(mode).to be 0o100777
         end
       end
 
       context 'when the named file is a symlink' do
         it 'changes permission bits on the symlink' do
-          described_class.lchmod 0777, '/test-link'
+          described_class.lchmod 0o777, '/test-link'
 
           mode = described_class.lstat('/test-link').mode
-          expect(mode).to be 0100777
+          expect(mode).to be 0o100777
         end
 
         it 'does not change permission bits on the link’s target' do
           old_mode = described_class.stat('/test-file').mode
-          described_class.lchmod 0777, '/test-link'
+          described_class.lchmod 0o777, '/test-link'
 
           mode = described_class.stat('/test-file').mode
           expect(mode).to eq old_mode
@@ -880,6 +942,16 @@ module MemFs
             expect(subject.send(:opening_mode)).to eq File::RDONLY
           end
 
+          it 'handles the :utf-8 option' do
+            subject = described_class.new('/test-file', 'r:utf-8')
+            expect(subject.send(:opening_mode)).to eq File::RDONLY
+          end
+
+          it 'handles the :UTF-8 option' do
+            subject = described_class.new('/test-file', 'r:UTF-8')
+            expect(subject.send(:opening_mode)).to eq File::RDONLY
+          end
+
           it 'handles the |utf-8 option' do
             subject = described_class.new('/test-file', 'r|utf-8')
             expect(subject.send(:opening_mode)).to eq File::RDONLY
@@ -941,7 +1013,7 @@ module MemFs
 
         context 'and the effective user does not own of the file' do
           it 'returns false' do
-            described_class.chown 0, 0, '/test-file'
+            described_class.chown 9999, 9999, '/test-file'
 
             owned = File.owned?('/test-file')
             expect(owned).to be false
@@ -1025,7 +1097,7 @@ module MemFs
         it 'passes the contained options to +open+' do
           expect(described_class).to \
             receive(:open)
-            .with('/test-file', File::RDONLY, encoding: 'UTF-8')
+            .with('/test-file', File::RDONLY, { encoding: 'UTF-8' })
             .and_return(subject)
 
           described_class.read '/test-file', encoding: 'UTF-8'
@@ -1186,7 +1258,7 @@ module MemFs
       context 'when the path does not contain any symlink or useless dots' do
         it 'returns the path itself' do
           path = described_class.realdirpath('/test-file')
-          expect(path).to eq '/test-file'
+          expect(path).to eq expected_path('/test-file')
         end
       end
 
@@ -1194,14 +1266,14 @@ module MemFs
         context 'and the symlink is a middle part' do
           it 'returns the path with the symlink dereferrenced' do
             path = described_class.realdirpath('/test-dir/sub-dir-link/test-file')
-            expect(path).to eq '/test-dir/sub-dir/test-file'
+            expect(path).to eq expected_path('/test-dir/sub-dir/test-file')
           end
         end
 
         context 'and the symlink is the last part' do
           it 'returns the path with the symlink dereferrenced' do
             path = described_class.realdirpath('/test-dir/sub-dir-link')
-            expect(path).to eq '/test-dir/sub-dir'
+            expect(path).to eq expected_path('/test-dir/sub-dir')
           end
         end
       end
@@ -1209,7 +1281,7 @@ module MemFs
       context 'when the path contains useless dots' do
         it 'returns the path with the useless dots interpolated' do
           path = described_class.realdirpath('/test-dir/../test-dir/./sub-dir/test-file')
-          expect(path).to eq '/test-dir/sub-dir/test-file'
+          expect(path).to eq expected_path('/test-dir/sub-dir/test-file')
         end
       end
 
@@ -1218,14 +1290,14 @@ module MemFs
           it 'uses the current working directory has base directory' do
             _fs.chdir '/test-dir'
             path = described_class.realdirpath('../test-dir/./sub-dir/test-file')
-            expect(path).to eq '/test-dir/sub-dir/test-file'
+            expect(path).to eq expected_path('/test-dir/sub-dir/test-file')
           end
         end
 
         context 'and +dir_string+ is provided' do
           it 'uses the given directory has base directory' do
             path = described_class.realdirpath('../test-dir/./sub-dir/test-file', '/test-dir')
-            expect(path).to eq '/test-dir/sub-dir/test-file'
+            expect(path).to eq expected_path('/test-dir/sub-dir/test-file')
           end
         end
       end
@@ -1238,7 +1310,7 @@ module MemFs
 
           it 'uses the name of the target in the resulting path' do
             path = described_class.realdirpath('/test-dir/sub-dir/test-link')
-            expect(path).to eq '/test-dir/sub-dir/test'
+            expect(path).to eq expected_path('/test-dir/sub-dir/test')
           end
         end
       end
@@ -1246,7 +1318,7 @@ module MemFs
       context 'when the last part of the given path does not exist' do
         it 'uses its name in the resulting path' do
           path = described_class.realdirpath('/test-dir/sub-dir/test')
-          expect(path).to eq '/test-dir/sub-dir/test'
+          expect(path).to eq expected_path('/test-dir/sub-dir/test')
         end
       end
 
@@ -1269,7 +1341,7 @@ module MemFs
       context 'when the path does not contain any symlink or useless dots' do
         it 'returns the path itself' do
           path = described_class.realpath('/test-file')
-          expect(path).to eq '/test-file'
+          expect(path).to eq expected_path('/test-file')
         end
       end
 
@@ -1277,14 +1349,14 @@ module MemFs
         context 'and the symlink is a middle part' do
           it 'returns the path with the symlink dereferrenced' do
             path = described_class.realpath('/test-dir/sub-dir-link/test-file')
-            expect(path).to eq '/test-dir/sub-dir/test-file'
+            expect(path).to eq expected_path('/test-dir/sub-dir/test-file')
           end
         end
 
         context 'and the symlink is the last part' do
           it 'returns the path with the symlink dereferrenced' do
             path = described_class.realpath('/test-dir/sub-dir-link')
-            expect(path).to eq '/test-dir/sub-dir'
+            expect(path).to eq expected_path('/test-dir/sub-dir')
           end
         end
       end
@@ -1292,7 +1364,7 @@ module MemFs
       context 'when the path contains useless dots' do
         it 'returns the path with the useless dots interpolated' do
           path = described_class.realpath('/test-dir/../test-dir/./sub-dir/test-file')
-          expect(path).to eq '/test-dir/sub-dir/test-file'
+          expect(path).to eq expected_path('/test-dir/sub-dir/test-file')
         end
       end
 
@@ -1302,14 +1374,14 @@ module MemFs
             _fs.chdir '/test-dir'
 
             path = described_class.realpath('../test-dir/./sub-dir/test-file')
-            expect(path).to eq '/test-dir/sub-dir/test-file'
+            expect(path).to eq expected_path('/test-dir/sub-dir/test-file')
           end
         end
 
         context 'and +dir_string+ is provided' do
           it 'uses the given directory has base directory' do
             path = described_class.realpath('../test-dir/./sub-dir/test-file', '/test-dir')
-            expect(path).to eq '/test-dir/sub-dir/test-file'
+            expect(path).to eq expected_path('/test-dir/sub-dir/test-file')
           end
         end
       end
@@ -1341,7 +1413,7 @@ module MemFs
       context 'when the named file exists' do
         context 'and the named file has the setgid bit set' do
           it 'returns true' do
-            _fs.chmod 02000, '/test-file'
+            _fs.chmod 0o2000, '/test-file'
 
             setgid = File.setgid?('/test-file')
             expect(setgid).to be true
@@ -1350,7 +1422,7 @@ module MemFs
 
         context 'and the named file does not have the setgid bit set' do
           it 'returns false' do
-            _fs.chmod 0644, '/test-file'
+            _fs.chmod 0o644, '/test-file'
 
             setgid = File.setgid?('/test-file')
             expect(setgid).not_to be true
@@ -1370,7 +1442,7 @@ module MemFs
       context 'when the named file exists' do
         context 'and the named file has the setuid bit set' do
           it 'returns true' do
-            _fs.chmod 04000, '/test-file'
+            _fs.chmod 0o4000, '/test-file'
 
             setuid = File.setuid?('/test-file')
             expect(setuid).to be true
@@ -1379,7 +1451,7 @@ module MemFs
 
         context 'and the named file does not have the setuid bit set' do
           it 'returns false' do
-            _fs.chmod 0644, '/test-file'
+            _fs.chmod 0o644, '/test-file'
 
             setuid = File.setuid?('/test-file')
             expect(setuid).not_to be true
@@ -1490,7 +1562,7 @@ module MemFs
       context 'when the named file exists' do
         it 'returns true if the named file has the sticky bit set' do
           _fs.touch '/test-file'
-          _fs.chmod 01777, '/test-file'
+          _fs.chmod 0o1777, '/test-file'
 
           sticky = File.sticky?('/test-file')
           expect(sticky).to be true
@@ -1498,7 +1570,7 @@ module MemFs
 
         it 'returns false if the named file hasn’t the sticky bit set' do
           _fs.touch '/test-file'
-          _fs.chmod 0666, '/test-file'
+          _fs.chmod 0o666, '/test-file'
 
           sticky = File.sticky?('/test-file')
           expect(sticky).to be false
@@ -1595,21 +1667,21 @@ module MemFs
     end
 
     describe '.umask' do
-      before { described_class.umask 0022 }
+      before { described_class.umask 0o022 }
 
       it 'returns the current umask value for this process' do
-        expect(described_class.umask).to be 0022
+        expect(described_class.umask).to be 0o022
       end
 
       context 'when the optional argument is given' do
         it 'sets the umask to that value' do
-          described_class.umask 0777
-          expect(described_class.umask).to be 0777
+          described_class.umask 0o777
+          expect(described_class.umask).to be 0o777
         end
 
         it 'return the previous value' do
-          previous_umask = described_class.umask(0777)
-          expect(previous_umask).to be 0022
+          previous_umask = described_class.umask(0o777)
+          expect(previous_umask).to be 0o022
         end
       end
     end
@@ -2051,6 +2123,12 @@ module MemFs
       end
     end
 
+    describe '#birthtime' do
+      it 'returns a Time object' do
+        expect(subject.birthtime).to be_a Time
+      end
+    end
+
     describe '#bytes' do
       it_behaves_like 'aliased method', :bytes, :each_byte
     end
@@ -2061,14 +2139,14 @@ module MemFs
 
     describe '#chmod' do
       it 'changes permission bits on the file' do
-        subject.chmod 0777
+        subject.chmod 0o777
 
         mode = subject.stat.mode
-        expect(mode).to be 0100777
+        expect(mode).to be 0o100777
       end
 
       it 'returns zero' do
-        returned_value = subject.chmod(0777)
+        returned_value = subject.chmod(0o777)
         expect(returned_value).to be_zero
       end
     end
@@ -2404,6 +2482,12 @@ module MemFs
       end
     end
 
+    describe '#fileno' do
+      it 'raises an exception' do
+        expect { subject.fileno }.to raise_exception(NotImplementedError)
+      end
+    end
+
     describe '#flock' do
       it 'returns zero' do
         returned_value = subject.flock(File::LOCK_EX)
@@ -2645,7 +2729,7 @@ module MemFs
 
       context 'when a buffer is given' do
         it 'fills the buffer with the read content' do
-          buffer = String.new
+          buffer = +''
           subject.read 2, buffer
 
           expect(buffer).to eq random_string[0, 2]