memfs 0.5.0 → 2.0.0

data/spec/memfs/dir_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require 'pathname'
 
 module MemFs
-  describe Dir do
+  ::RSpec.describe Dir do
     subject { described_class.new('/test') }
 
     before { described_class.mkdir '/test' }
@@ -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,11 +54,26 @@ 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) }
 
       it "changes the process's idea of the file system root" do
-
         described_class.mkdir('/test/subdir')
         described_class.chroot('/test')
 
@@ -97,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 }
@@ -146,7 +193,9 @@ module MemFs
 
         context "and the directory doesn't exist" do
           it 'raises an exception' do
-            expect { described_class.foreach('/no-dir') {} }.to raise_error
+            expect {
+              described_class.foreach('/no-dir') {}
+            }.to raise_error Errno::ENOENT
           end
         end
 
@@ -154,7 +203,7 @@ module MemFs
           it 'raises an exception' do
             expect {
               described_class.foreach('/test/test-file') {}
-            }.to raise_error
+            }.to raise_error Errno::ENOTDIR
           end
         end
       end
@@ -201,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
 
@@ -215,6 +265,8 @@ module MemFs
       it_behaves_like 'returning matching filenames', '/test?', %w[/test0 /test1 /test2]
       it_behaves_like 'returning matching filenames', '/test[01]', %w[/test0 /test1]
       it_behaves_like 'returning matching filenames', '/test[^2]', %w[/test0 /test1]
+      it_behaves_like 'returning matching filenames', Pathname.new('/'), %w[/]
+      it_behaves_like 'returning matching filenames', Pathname.new('/*'), %w[/tmp /test0 /test1 /test2]
 
       if defined?(File::FNM_EXTGLOB)
         it_behaves_like 'returning matching filenames', '/test{1,2}', %w[/test1 /test2]
@@ -223,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
@@ -240,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
@@ -264,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
 
@@ -308,7 +362,9 @@ module MemFs
 
       context "when the given directory doesn't exist" do
         it 'raises an exception' do
-          expect { described_class.open('/no-dir') }.to raise_error
+          expect {
+            described_class.open('/no-dir')
+          }.to raise_error Errno::ENOENT
         end
       end
 
@@ -316,7 +372,9 @@ module MemFs
         before { _fs.touch('/test/test-file') }
 
         it 'raises an exception' do
-          expect { described_class.open('/test/test-file') }.to raise_error
+          expect {
+            described_class.open('/test/test-file')
+          }.to raise_error Errno::ENOTDIR
         end
       end
     end
@@ -324,7 +382,9 @@ module MemFs
     describe '.new' do
       context "when the given directory doesn't exist" do
         it 'raises an exception' do
-          expect { described_class.new('/no-dir') }.to raise_error
+          expect {
+            described_class.new('/no-dir')
+          }.to raise_error Errno::ENOENT
         end
       end
 
@@ -332,7 +392,9 @@ module MemFs
         before { _fs.touch('/test/test-file') }
 
         it 'raises an exception' do
-          expect { described_class.new('/test/test-file') }.to raise_error
+          expect {
+            described_class.new('/test/test-file')
+          }.to raise_error Errno::ENOTDIR
         end
       end
     end
@@ -360,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
 
@@ -397,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
 
@@ -510,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

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module MemFs
   module Fake
-    describe Directory do
+    ::RSpec.describe Directory do
       subject(:directory) { described_class.new('test') }
 
       describe '.new' do
@@ -70,6 +70,10 @@ module MemFs
         it 'should remove any leading / in the path' do
           expect(directory.find('/sub_dir/file')).to be(file)
         end
+
+        it 'should remove any trailing / in the path' do
+          expect(directory.find('sub_dir/file/')).to be(file)
+        end
       end
 
       describe '#parent=' do
@@ -87,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

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module MemFs
   module Fake
-    describe Entry do
+    ::RSpec.describe Entry do
       let(:entry) { described_class.new('test') }
       let(:parent) { Directory.new('parent') }
       let(:time) { Time.now - 5000 }
@@ -13,11 +13,11 @@ module MemFs
       end
 
       shared_examples 'it has accessors for' do |attribute|
-        let(:expected) { value }
+        let(:expected_value) { defined?(expected) ? expected : value }
 
         it attribute do
           entry.send(:"#{attribute}=", value)
-          expect(entry.public_send(attribute)).to eq(expected)
+          expect(entry.public_send(attribute)).to eq(expected_value)
         end
       end
 
@@ -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
 
@@ -125,25 +131,25 @@ module MemFs
 
       describe '#dev' do
         it 'returns an integer representing the device on which the entry resides' do
-          expect(entry.dev).to be_a(Fixnum)
+          expect(entry.dev).to be_a(Integer)
         end
       end
 
       describe '#ino' do
         it 'Returns the inode number for the entry' do
-          expect(entry.ino).to be_a(Fixnum)
+          expect(entry.ino).to be_a(Integer)
         end
       end
 
       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/file/content_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 module MemFs
   module Fake
-    describe File::Content do
+    ::RSpec.describe File::Content do
       describe '#<<' do
         it 'writes the given string to the contained string' do
           subject << 'test'

data/spec/memfs/fake/file_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module MemFs
   module Fake
-    describe File do
+    ::RSpec.describe File do
       let(:file) { _fs.find!('/test-file') }
 
       before do

data/spec/memfs/fake/symlink_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module MemFs
   module Fake
-    describe Symlink do
+    ::RSpec.describe Symlink do
       describe '#content' do
         it "returns the target's content" do
           MemFs::File.open('/test-file', 'w') { |f| f.puts 'test' }
@@ -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
 
@@ -63,7 +63,7 @@ module MemFs
             symlink = described_class.new('/test-link', '/no-file')
             expect {
               symlink.dereferenced_path
-            }.to raise_exception
+            }.to raise_error Errno::ENOENT
           end
         end
       end

data/spec/memfs/file/stat_spec.rb

@@ -1,18 +1,18 @@
 require 'spec_helper'
 
 module MemFs
-  describe File::Stat do
+  ::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
@@ -131,7 +131,7 @@ module MemFs
 
     describe '#dev' do
       it 'returns an integer representing the device on which stat resides' do
-        expect(file_stat.dev).to be_a(Fixnum)
+        expect(file_stat.dev).to be_a(Integer)
       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
@@ -449,14 +461,14 @@ module MemFs
 
     describe '#ino' do
       it 'returns the inode number for stat.' do
-        expect(file_stat.ino).to be_a(Fixnum)
+        expect(file_stat.ino).to be_a(Integer)
       end
     end
 
     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,13 +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(0o644, '/test-file')
           expect(file_stat.setgid?).to be false
         end
       end
@@ -614,13 +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(0o644, '/test-file')
           expect(file_stat.setuid?).to be false
         end
       end
@@ -638,11 +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(0o666, '/test-file')
         expect(file_stat.sticky?).to be false
       end
     end