memfs 1.0.0 → 2.0.0

data/spec/fileutils_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 RSpec.describe FileUtils do
   before :each do
-    MemFs::File.umask(0020)
+    MemFs::File.umask(0o020)
     MemFs.activate!
 
     described_class.mkdir '/test'
@@ -17,11 +17,17 @@ RSpec.describe FileUtils do
   describe '.cd' do
     it 'changes the current working directory' do
       described_class.cd '/test'
-      expect(described_class.pwd).to eq('/test')
+      expect(described_class.pwd).to eq(expected_path('/test'))
     end
 
-    it 'returns nil' do
-      expect(described_class.cd('/test')).to be_nil
+    if MemFs.ruby_version_gte?('2.6')
+      it 'returns 0' do
+        expect(described_class.cd('/test')).to eq 0
+      end
+    else
+      it 'returns nil' do
+        expect(described_class.cd('/test')).to be_nil
+      end
     end
 
     it "raises an error when the given path doesn't exist" do
@@ -36,7 +42,7 @@ RSpec.describe FileUtils do
     context 'when called with a block' do
       it 'changes current working directory for the block execution' do
         described_class.cd '/test' do
-          expect(described_class.pwd).to eq('/test')
+          expect(described_class.pwd).to eq(expected_path('/test'))
         end
       end
 
@@ -53,7 +59,7 @@ RSpec.describe FileUtils do
 
       it 'changes directory to the last target of the link chain' do
         described_class.cd('/test-link')
-        expect(described_class.pwd).to eq('/test')
+        expect(described_class.pwd).to eq(expected_path('/test'))
       end
 
       it "raises an error if the last target of the link chain doesn't exist" do
@@ -65,24 +71,24 @@ RSpec.describe FileUtils do
   describe '.chmod' do
     it 'changes permission bits on the named file to the bit pattern represented by mode' do
       described_class.touch '/test-file'
-      described_class.chmod 0777, '/test-file'
-      expect(File.stat('/test-file').mode).to eq(0100777)
+      described_class.chmod 0o777, '/test-file'
+      expect(File.stat('/test-file').mode).to eq(0o100777)
     end
 
     it 'changes permission bits on the named files (in list) to the bit pattern represented by mode' do
       described_class.touch ['/test-file', '/test-file2']
-      described_class.chmod 0777, ['/test-file', '/test-file2']
-      expect(File.stat('/test-file2').mode).to eq(0100777)
+      described_class.chmod 0o777, ['/test-file', '/test-file2']
+      expect(File.stat('/test-file2').mode).to eq(0o100777)
     end
 
     it 'returns an array containing the file names' do
       file_names = %w[/test-file /test-file2]
       described_class.touch file_names
-      expect(described_class.chmod(0777, file_names)).to eq(file_names)
+      expect(described_class.chmod(0o777, file_names)).to eq(file_names)
     end
 
     it 'raises an error if an entry does not exist' do
-      expect { described_class.chmod(0777, '/test-file') }.to raise_error(Errno::ENOENT)
+      expect { described_class.chmod(0o777, '/test-file') }.to raise_error(Errno::ENOENT)
     end
 
     context 'when the named file is a symlink' do
@@ -93,13 +99,13 @@ RSpec.describe FileUtils do
 
       context 'when File responds to lchmod' do
         it 'changes the mode on the link' do
-          described_class.chmod(0777, '/test-link')
-          expect(File.lstat('/test-link').mode).to eq(0100777)
+          described_class.chmod(0o777, '/test-link')
+          expect(File.lstat('/test-link').mode).to eq(0o100777)
         end
 
         it "doesn't change the mode of the link's target" do
           mode = File.lstat('/test-file').mode
-          described_class.chmod(0777, '/test-link')
+          described_class.chmod(0o777, '/test-link')
           expect(File.lstat('/test-file').mode).to eq(mode)
         end
       end
@@ -109,7 +115,7 @@ RSpec.describe FileUtils do
           allow_any_instance_of(described_class::Entry_).to \
             receive_messages(have_lchmod?: false)
           mode = File.lstat('/test-link').mode
-          described_class.chmod(0777, '/test-link')
+          described_class.chmod(0o777, '/test-link')
           expect(File.lstat('/test-link').mode).to eq(mode)
         end
       end
@@ -122,18 +128,18 @@ RSpec.describe FileUtils do
     end
 
     it 'changes the permission bits on the named entry' do
-      described_class.chmod_R(0777, '/test')
-      expect(File.stat('/test').mode).to eq(0100777)
+      described_class.chmod_R(0o777, '/test')
+      expect(File.stat('/test').mode).to eq(0o100777)
     end
 
     it 'changes the permission bits on any sub-directory of the named entry' do
-      described_class.chmod_R(0777, '/')
-      expect(File.stat('/test').mode).to eq(0100777)
+      described_class.chmod_R(0o777, '/')
+      expect(File.stat('/test').mode).to eq(0o100777)
     end
 
     it 'changes the permission bits on any descendant file of the named entry' do
-      described_class.chmod_R(0777, '/')
-      expect(File.stat('/test/test-file').mode).to eq(0100777)
+      described_class.chmod_R(0o777, '/')
+      expect(File.stat('/test/test-file').mode).to eq(0o100777)
     end
   end
 
@@ -311,7 +317,7 @@ RSpec.describe FileUtils do
       before :each do
         described_class.touch('/test-file')
         described_class.chown(1042, 1042, '/test-file')
-        described_class.chmod(0777, '/test-file')
+        described_class.chmod(0o777, '/test-file')
         _fs.find('/test-file').mtime = time
         described_class.copy_entry('/test-file', '/test-copy', true)
       end
@@ -325,7 +331,7 @@ RSpec.describe FileUtils do
       end
 
       it 'preserves permissions' do
-        expect(File.stat('/test-copy').mode).to eq(0100777)
+        expect(File.stat('/test-copy').mode).to eq(0o100777)
       end
 
       it 'preserves modified time' do
@@ -468,8 +474,8 @@ RSpec.describe FileUtils do
 
     context 'when +:mode+ is set' do
       it 'changes the permission mode to +mode+' do
-        expect(File).to receive(:chmod).with(0777, '/test-file2')
-        described_class.install('/test-file', '/test-file2', mode: 0777)
+        expect(File).to receive(:chmod).with(0o777, '/test-file2')
+        described_class.install('/test-file', '/test-file2', mode: 0o777)
       end
     end
 
@@ -656,9 +662,9 @@ RSpec.describe FileUtils do
     context 'when passing options' do
       context 'when passing mode parameter' do
         it 'creates directory with specified permissions' do
-          described_class.mkdir('/test-dir', mode: 0654)
+          described_class.mkdir('/test-dir', mode: 0o654)
           expect(File.exist?('/test-dir')).to be true
-          expect(File.stat('/test-dir').mode).to eq(0100654)
+          expect(File.stat('/test-dir').mode).to eq(0o100654)
         end
       end
 
@@ -698,9 +704,9 @@ RSpec.describe FileUtils do
     context 'when passing options' do
       context 'when passing mode parameter' do
         it 'creates directory with specified permissions' do
-          described_class.mkdir_p('/test-dir', mode: 0654)
+          described_class.mkdir_p('/test-dir', mode: 0o654)
           expect(File.exist?('/test-dir')).to be true
-          expect(File.stat('/test-dir').mode).to eq(0100654)
+          expect(File.stat('/test-dir').mode).to eq(0o100654)
         end
       end
 
@@ -759,7 +765,7 @@ RSpec.describe FileUtils do
   describe '.pwd' do
     it 'returns the name of the current directory' do
       described_class.cd '/test'
-      expect(described_class.pwd).to eq('/test')
+      expect(described_class.pwd).to eq(expected_path('/test'))
     end
   end
 
@@ -809,28 +815,28 @@ RSpec.describe FileUtils do
     end
 
     it 'removes a file system entry +path+' do
-      described_class.chmod(0755, '/')
+      described_class.chmod(0o755, '/')
       described_class.remove_entry_secure('/test-dir')
       expect(Dir.exist?('/test-dir')).to be false
     end
 
     context 'when +path+ is a directory' do
       it 'removes it recursively' do
-        described_class.chmod(0755, '/')
+        described_class.chmod(0o755, '/')
         described_class.remove_entry_secure('/test-dir')
         expect(Dir.exist?('/test-dir/test-sub-dir')).to be false
       end
 
       context 'and is word writable' do
         it 'calls chown(2) on it' do
-          described_class.chmod(01777, '/')
+          described_class.chmod(0o1777, '/')
           directory = _fs.find('/test-dir')
           expect(directory).to receive(:uid=).at_least(:once)
           described_class.remove_entry_secure('/test-dir')
         end
 
         it 'calls chmod(2) on all sub directories' do
-          described_class.chmod(01777, '/')
+          described_class.chmod(0o1777, '/')
           directory = _fs.find('/test-dir')
           expect(directory).to receive(:mode=).at_least(:once)
           described_class.remove_entry_secure('/test-dir')
@@ -947,13 +953,30 @@ RSpec.describe FileUtils do
         described_class.touch('/test-dir/test-file')
       end
 
-      it 'ignores errors' do
-        expect { described_class.rmdir('/test-dir') }.not_to raise_error
-      end
+      if RUBY_VERSION >= '2.5.0'
+        it 'raises an error' do
+          expect { described_class.rmdir('/test-dir') }
+            .to raise_error(Errno::ENOTEMPTY)
+        end
 
-      it "doesn't remove the directory" do
-        described_class.rmdir('/test-dir')
-        expect(Dir.exist?('/test-dir')).to be true
+        it 'doesn’t remove the directory' do
+          begin
+            described_class.rmdir('/test-dir')
+          rescue Errno::ENOTEMPTY
+            # noop
+          end
+
+          expect(Dir.exist?('/test-dir')).to be true
+        end
+      else
+        it 'ignores errors' do
+          expect { described_class.rmdir('/test-dir') }.not_to raise_error
+        end
+
+        it 'doesn’t remove the directory' do
+          described_class.rmdir('/test-dir')
+          expect(Dir.exist?('/test-dir')).to be true
+        end
       end
     end
   end

data/spec/memfs/dir_spec.rb

@@ -13,13 +13,13 @@ module MemFs
     describe '[]' do
       context 'when a string is given' do
         it 'acts like calling glob' do
-          expect(described_class['/*']).to eq %w[/tmp /test]
+          expect(described_class['/*']).to eq [expected_path('/tmp'), expected_path('/test')]
         end
       end
 
       context 'when a list of strings is given' do
         it 'acts like calling glob' do
-          expect(described_class['/tm*', '/te*']).to eq %w[/tmp /test]
+          expect(described_class['/tm*', '/te*']).to eq [expected_path('/tmp'), expected_path('/test')]
         end
       end
     end
@@ -27,7 +27,7 @@ module MemFs
     describe '.chdir' do
       it 'changes the current working directory' do
         described_class.chdir '/test'
-        expect(described_class.getwd).to eq('/test')
+        expect(described_class.getwd).to eq(expected_path('/test'))
       end
 
       it 'returns zero' do
@@ -41,7 +41,7 @@ module MemFs
       context 'when a block is given' do
         it 'changes current working directory for the block' do
           described_class.chdir '/test' do
-            expect(described_class.pwd).to eq('/test')
+            expect(described_class.pwd).to eq(expected_path('/test'))
           end
         end
 
@@ -54,6 +54,22 @@ module MemFs
       end
     end
 
+    if MemFs.ruby_version_gte?('2.6')
+      describe '.children' do
+        it 'returns an array containing all of the filenames except for "." and ".." in this directory.' do
+          %w[/test/dir1 /test/dir2].each { |dir| described_class.mkdir dir }
+          _fs.touch '/test/file1', '/test/file2'
+          expect(described_class.children('/test')).to eq(%w[dir1 dir2 file1 file2])
+        end
+      end
+    else
+      describe '.children' do
+        it 'raises an error' do
+          expect { described_class.children('/test') }.to raise_error(NoMethodError)
+        end
+      end
+    end
+
     describe '.chroot' do
       before { allow(Process).to receive_messages(uid: 0) }
 
@@ -96,6 +112,38 @@ module MemFs
       it_behaves_like 'aliased method', :delete, :rmdir
     end
 
+    describe '.empty?' do
+      context 'when the given directory is empty' do
+        it 'returns true' do
+          expect(described_class.empty?('/test')).to be true
+        end
+      end
+
+      context 'when the given directory is non-empty' do
+        before { Dir.mkdir('/test/sub-dir') }
+
+        it 'returns false' do
+          expect(described_class.empty?('/test')).to be false
+        end
+      end
+
+      context 'when the given directory does not exist' do
+        it 'raises an exception' do
+          expect {
+            described_class.empty?('/nothing')
+          }.to raise_exception(Errno::ENOENT)
+        end
+      end
+
+      context 'when the given entry is not a directory' do
+        before { _fs.touch '/test/file1' }
+
+        it 'returns false' do
+          expect(described_class.empty?('/test/file1')).to be false
+        end
+      end
+    end
+
     describe '.entries' do
       it 'returns an array containing all of the filenames in the given directory' do
         %w[/test/dir1 /test/dir2].each { |dir| described_class.mkdir dir }
@@ -202,7 +250,8 @@ module MemFs
 
       shared_examples 'returning matching filenames' do |pattern, filenames|
         it "with #{pattern}" do
-          expect(described_class.glob(pattern)).to eq filenames
+          expected = filenames.map { |f| expected_path(f) }
+          expect(described_class.glob(pattern)).to eq expected
         end
       end
 
@@ -226,14 +275,14 @@ module MemFs
       context 'when a flag is given' do
         it 'uses it to compare filenames' do
           expect(described_class.glob('/TEST*', File::FNM_CASEFOLD)).to eq \
-            %w[/test0 /test1 /test2]
+            [expected_path('/test0'), expected_path('/test1'), expected_path('/test2')]
         end
       end
 
       context 'when a block is given' do
         it 'calls the block with every matching filenames' do
           expect { |blk| described_class.glob('/test*', &blk) }.to \
-            yield_successive_args('/test0', '/test1', '/test2')
+            yield_successive_args(expected_path('/test0'), expected_path('/test1'), expected_path('/test2'))
         end
 
         it 'returns nil' do
@@ -243,20 +292,22 @@ module MemFs
 
       context 'when pattern is an array of patterns' do
         it 'returns the list of files matching any pattern' do
-          expect(described_class.glob(['/*0', '/*1'])).to eq %w[/test0 /test1]
+          expect(described_class.glob(['/*0', '/*1'])).to eq [expected_path('/test0'), expected_path('/test1')]
         end
       end
     end
 
     describe '.home' do
       it 'returns the home directory of the current user' do
-        expect(described_class.home).to eq ENV['HOME']
+        # Dir.home uses forward slashes; ENV['HOME'] may have backslashes on Windows
+        expect(described_class.home).to eq ENV['HOME'].tr('\\', '/')
       end
 
       context 'when a username is given' do
         it 'returns the home directory of the given user' do
-          home_dir = described_class.home(ENV['USER'])
-          expect(home_dir).to eq ENV['HOME']
+          username = ENV['USER'] || ENV['USERNAME']
+          home_dir = described_class.home(username)
+          expect(home_dir).to eq ENV['HOME'].tr('\\', '/')
         end
       end
     end
@@ -267,15 +318,15 @@ module MemFs
         expect(File.directory?('/new-folder')).to be true
       end
 
-      it 'sets directory permissions to default 0777' do
+      it 'sets directory permissions to default 0o777' do
         described_class.mkdir '/new-folder'
-        expect(File.stat('/new-folder').mode).to eq(0100777)
+        expect(File.stat('/new-folder').mode).to eq(0o100777)
       end
 
       context 'when permissions are specified' do
         it 'sets directory permissions to specified value' do
-          described_class.mkdir '/new-folder', 0644
-          expect(File.stat('/new-folder').mode).to eq(0100644)
+          described_class.mkdir '/new-folder', 0o644
+          expect(File.stat('/new-folder').mode).to eq(0o100644)
         end
       end
 
@@ -371,7 +422,87 @@ module MemFs
 
     describe '.tmpdir' do
       it 'returns /tmp' do
-        expect(described_class.tmpdir).to eq '/tmp'
+        expect(described_class.tmpdir).to eq expected_path('/tmp')
+      end
+    end
+
+    describe '::Tmpname' do
+      it 'is defined' do
+        expect(described_class.const_defined?(:Tmpname)).to be true
+      end
+
+      it 'responds to .create' do
+        expect(described_class::Tmpname).to respond_to(:create)
+      end
+    end
+
+    describe '.mktmpdir' do
+      context 'when no block is given' do
+        it 'creates a temporary directory and returns its path' do
+          path = described_class.mktmpdir
+          expect(path).to start_with(expected_path('/tmp/d'))
+          expect(described_class.exist?(path)).to be true
+        end
+
+        it 'accepts a prefix' do
+          path = described_class.mktmpdir('myprefix')
+          expect(path).to start_with(expected_path('/tmp/myprefix'))
+          expect(described_class.exist?(path)).to be true
+        end
+
+        it 'accepts a prefix and suffix as an array' do
+          path = described_class.mktmpdir(['prefix_', '_suffix'])
+          expect(path).to start_with(expected_path('/tmp/prefix_'))
+          expect(path).to end_with('_suffix')
+          expect(described_class.exist?(path)).to be true
+        end
+
+        it 'accepts a custom tmpdir' do
+          described_class.mkdir('/custom_tmp')
+          path = described_class.mktmpdir(nil, '/custom_tmp')
+          expect(path).to start_with(expected_path('/custom_tmp/d'))
+          expect(described_class.exist?(path)).to be true
+        end
+      end
+
+      context 'when a block is given' do
+        it 'creates a temporary directory, yields it, and removes it' do
+          yielded_path = nil
+          described_class.mktmpdir do |path|
+            yielded_path = path
+            expect(path).to start_with(expected_path('/tmp/d'))
+            expect(described_class.exist?(path)).to be true
+          end
+          expect(described_class.exist?(yielded_path)).to be false
+        end
+
+        it 'removes the directory even if an exception occurs' do
+          yielded_path = nil
+          expect do
+            described_class.mktmpdir do |path|
+              yielded_path = path
+              expect(described_class.exist?(path)).to be true
+              raise 'test exception'
+            end
+          end.to raise_error('test exception')
+          expect(described_class.exist?(yielded_path)).to be false
+        end
+
+        it 'works with a prefix and block' do
+          yielded_path = nil
+          described_class.mktmpdir('test_') do |path|
+            yielded_path = path
+            expect(path).to start_with(expected_path('/tmp/test_'))
+            expect(described_class.exist?(path)).to be true
+          end
+          expect(described_class.exist?(yielded_path)).to be false
+        end
+      end
+
+      it 'creates unique directory names' do
+        path1 = described_class.mktmpdir
+        path2 = described_class.mktmpdir
+        expect(path1).not_to eq(path2)
       end
     end
 
@@ -408,9 +539,15 @@ module MemFs
       end
     end
 
+    describe '#fileno' do
+      it 'raises an exception' do
+        expect { subject.fileno }.to raise_exception(NotImplementedError)
+      end
+    end
+
     describe '#path' do
       it "returns the path parameter passed to dir's constructor" do
-        expect(subject.path).to eq '/test'
+        expect(subject.path).to eq expected_path('/test')
       end
     end
 
@@ -521,7 +658,7 @@ module MemFs
 
     describe '#to_path' do
       it "returns the path parameter passed to dir's constructor" do
-        expect(subject.to_path).to eq '/test'
+        expect(subject.to_path).to eq expected_path('/test')
       end
     end
   end

data/spec/memfs/fake/directory_spec.rb

@@ -91,16 +91,16 @@ module MemFs
       end
 
       describe '#path' do
-        let(:root) { described_class.new('/') }
+        let(:root) { described_class.new(root_path) }
 
         it 'returns the directory path' do
           directory.parent = root
-          expect(directory.path).to eq('/test')
+          expect(directory.path).to eq(expected_path('/test'))
         end
 
         context 'when the directory is /' do
           it 'returns /' do
-            expect(root.path).to eq('/')
+            expect(root.path).to eq(root_path)
           end
         end
       end

data/spec/memfs/fake/entry_spec.rb

@@ -54,8 +54,8 @@ module MemFs
       end
 
       it_behaves_like 'it has accessors for', :mode do
-        let(:value) { 0777 }
-        let(:expected) { 0100777 }
+        let(:value) { 0o777 }
+        let(:expected) { 0o100777 }
       end
 
       it_behaves_like 'it has accessors for', :parent do
@@ -113,7 +113,13 @@ module MemFs
 
       describe '#dereferenced_path' do
         it 'returns the entry path' do
-          expect(entry.dereferenced_path).to eq('/parent/test')
+          expect(entry.dereferenced_path).to eq(expected_path('/parent/test'))
+        end
+      end
+
+      describe '#fileno' do
+        it 'raises an exception' do
+          expect { subject.fileno }.to raise_exception(NotImplementedError)
         end
       end
 
@@ -137,13 +143,13 @@ module MemFs
 
       describe '#path' do
         it 'returns the complete path of the entry' do
-          expect(entry.path).to eq('/parent/test')
+          expect(entry.path).to eq(expected_path('/parent/test'))
         end
       end
 
       describe 'paths' do
         it 'returns an array containing the entry path' do
-          expect(entry.paths).to eq ['/parent/test']
+          expect(entry.paths).to eq [expected_path('/parent/test')]
         end
       end
 

data/spec/memfs/fake/symlink_spec.rb

@@ -54,7 +54,7 @@ module MemFs
           it 'returns its target path' do
             _fs.touch('/test-file')
             symlink = described_class.new('/test-link', '/test-file')
-            expect(symlink.dereferenced_path).to eq('/test-file')
+            expect(symlink.dereferenced_path).to eq(expected_path('/test-file'))
           end
         end