rubypath 0.1.0

data/spec/rubypath/file_operations_spec.rb

@@ -0,0 +1,385 @@
+require 'spec_helper'
+
+describe Path do
+  describe 'File Operations' do
+    with_backends :mock, :sys do
+      let(:path) { Path('/path/to/file.txt') }
+
+      describe_method :name, aliases: [:basename] do
+        subject { path.send described_method }
+
+        it 'should return file name' do
+          should eq 'file.txt'
+        end
+      end
+
+      describe_method :touch do
+        let(:path) { Path '/rubypath' }
+        let(:args) { Array.new }
+        let(:expected_path) { path }
+        subject { path.touch(*args) }
+        before { expect(path).to_not be_existent }
+
+        shared_examples '#touch' do
+          it 'should create file' do
+            subject
+            expect(expected_path).to be_existent
+          end
+
+          it 'should update modification time' do
+            subject
+            expect(expected_path.mtime).to be_within(1).of(Time.now)
+          end
+        end
+
+        shared_examples '#touch with existing file' do
+          before do
+            expected_path.write 'ABC'
+            expected_path.mtime = Time.now - 3600
+          end
+          before { expect(expected_path.mtime).to be < (Time.now - 30) }
+
+          it_behaves_like '#touch'
+
+          it 'should not change content' do
+            subject
+            expect(expected_path.read).to eq 'ABC'
+          end
+        end
+
+        it_behaves_like '#touch with existing file'
+
+        context 'with args' do
+          let(:args) { '../file' }
+          let(:expected_path) { Path '/file' }
+
+          it_behaves_like '#touch with existing file'
+        end
+
+        context 'with existing file in path' do
+          let(:path) { super().join('file') }
+          before { path.parent.write 'ABC' }
+
+          it 'should raise ENOTDIR error' do
+            expect{ subject }.to raise_error(
+              Errno::ENOTDIR, 'Not a directory - /rubypath/file')
+          end
+        end
+
+        context 'with existing directory' do
+          before do
+            path.mkdir
+            path.mtime = Time.now - 3600
+          end
+          before { expect(path).to be_directory }
+          before { expect(path.mtime).to be < (Time.now - 30) }
+
+          it 'should should update modification time' do
+            subject
+            expect(path.mtime).to be_within(1).of(Time.now)
+          end
+        end
+
+        context 'with file in non-existent directory' do
+          let(:path) { Path '/dir/file' }
+
+          it 'should raise ENOENT error' do
+            expect{ subject }.to raise_error(
+              Errno::ENOENT, 'No such file or directory - /dir/file')
+          end
+        end
+      end
+
+      describe_method :mkfile do
+        let(:path) { Path '/path/to/file.txt' }
+        let(:args) { Array.new }
+        let(:expected_path) { path.dup }
+        subject { path.send described_method, *args }
+
+        shared_examples '#mkfile' do
+          it 'should create all missing directories' do
+            expect{ subject }.to change{ expected_path.parent.directory? }
+              .from(false).to(true)
+          end
+
+          it 'should create file' do
+            expect{ subject }.to change{ expected_path.file? }
+              .from(false).to(true)
+          end
+        end
+
+        it_behaves_like '#mkfile'
+
+        context 'with args' do
+          let(:args) { %w(sub file) }
+          let(:expected_path) { Path '/path/to/file.txt/sub/file' }
+
+          it_behaves_like '#mkfile'
+        end
+
+        context 'with existing directory' do
+          before { path.mkpath }
+
+          it 'should raise ENOENT error' do
+            expect{ subject }.to raise_error(
+              Errno::ENOENT, 'No such file or directory - /path/to/file.txt')
+          end
+        end
+
+        context 'with existing file in path' do
+          before do
+            path.parent.parent.mkpath
+            path.parent.touch
+          end
+
+          it 'should raise EISDIR error' do
+            expect{ subject }.to raise_error(
+              Errno::ENOTDIR, 'Not a directory - /path/to/file.txt')
+          end
+        end
+
+        context 'with absolute root dir as path' do
+          let(:path) { Path '/' }
+
+          it 'should raise EISDIR error' do
+            expect{ subject }.to raise_error(
+              Errno::ENOENT, 'No such file or directory - /')
+          end
+        end
+      end
+
+      describe_method :lookup do
+        let(:path) { Path('~') }
+        before do
+          Path.mock do |r|
+            path.mkpath 'a/b/c/d'
+            path.touch 'a/test.txt'
+            path.touch 'a/b/c/config.yaml'
+            path.touch 'a/b/.config.yml'
+            path.touch 'a/config.yml'
+          end
+        end
+        before { expect(path.join('a/b/c/d')).to be_directory }
+
+        context 'with filename' do
+          it 'should find file in current directory' do
+            expect(path.join('a').send(described_method, 'test.txt'))
+              .to eq path.join('a/test.txt').expand
+          end
+
+          it 'should find file in parent directory' do
+            expect(path.join(%w(a b)).send(described_method, 'test.txt'))
+              .to eq path.join('a/test.txt').expand
+          end
+
+          it 'should find file in ancestor directory' do
+            expect(path.join('a/b/c/d').send(described_method, 'test.txt'))
+              .to eq path.join('a/test.txt').expand
+          end
+
+          it 'should find first file in ancestor directory' do
+            expect(path.join('a/b/c/d').send(described_method, 'config.yaml'))
+              .to eq path.join('a/b/c/config.yaml').expand
+          end
+        end
+
+        context 'with glob' do
+          it 'should find file in current directory' do
+            expect(path.join('a').send(described_method, 'test.*'))
+              .to eq path.join('a/test.txt').expand
+          end
+
+          it 'should find file in parent directory' do
+            expect(path.join('a/b').send(described_method, 'test.*'))
+              .to eq path.join('a/test.txt').expand
+          end
+
+          it 'should find file in ancestor directory' do
+            expect(path.join('a/b/c/d').send(described_method, 'test.*'))
+              .to eq path.join('a/test.txt').expand
+          end
+
+          it 'should find first file in ancestor directory' do
+            expect(path.join('a/b/c/d').send(described_method, 'config.*'))
+              .to eq path.join('a/b/c/config.yaml').expand
+          end
+
+          it 'should find first file that match (I)' do
+            expect(path.join('a/b').send(described_method, '*.yml'))
+              .to eq path.join('a/config.yml').expand
+          end
+
+          it 'should find first file that match (II)' do
+            expect(path.join('a/b')
+              .send(described_method, 'config.{yml,yaml}'))
+              .to eq path.join('a/config.yml').expand
+          end
+
+          it 'should find first file that dotmatch' do
+            expect(path.join('a/b')
+              .send(described_method, '*.yml', ::File::FNM_DOTMATCH))
+              .to eq path.join('a/b/.config.yml').expand
+          end
+        end
+
+        context 'with regexp' do
+          it 'should find file in current directory' do
+            expect(path.join('a').send(described_method, /^test\.txt$/))
+              .to eq path.join('a/test.txt').expand
+          end
+
+          it 'should find file in parent directory' do
+            expect(path.join('a/b').send(described_method, /^test\.txt$/))
+              .to eq path.join('a/test.txt').expand
+          end
+
+          it 'should find file in ancestor directory' do
+            expect(path.join('a/b/c/d').send(described_method, /^test\.txt$/))
+              .to eq path.join('a/test.txt').expand
+          end
+
+          it 'should find first file in ancestor directory' do
+            expect(path.join('a/b/c/d')
+              .send(described_method, /^config\.yaml$/))
+              .to eq path.join('a/b/c/config.yaml').expand
+          end
+
+          it 'should find first file that match' do
+            expect(path.join('a/b').send(described_method, /^config\.ya?ml$/))
+              .to eq path.join('a/config.yml').expand
+          end
+        end
+      end
+
+      describe_method :mtime do
+        let(:path) { Path '/file.txt' }
+        before { path.touch }
+        subject { path.send described_method }
+
+        it 'should return file modification time' do
+          should be_within(0.1).of(Time.now)
+        end
+
+        context 'with modification time changed' do
+          before { path.mtime = Time.new(2175, 12, 24, 18, 00, 30) }
+
+          it 'should return file modification time' do
+            should eq Time.new(2175, 12, 24, 18, 00, 30)
+          end
+        end
+      end
+
+      describe_method :mtime= do
+        let(:path) { Path '/file.txt' }
+        before { path.touch }
+        subject { path.send described_method, Time.new(2175, 12, 24, 18, 00, 30) }
+
+        it 'should change file modification time' do
+          expect{ subject }.to change{ path.mtime }.to Time.new(2175, 12, 24, 18, 00, 30)
+        end
+      end
+
+      describe_method :atime do
+        let(:path) { Path '/file.txt' }
+        subject { path.send described_method }
+
+        context 'new create file' do
+          before { path.touch }
+
+          it { should be_within(0.1).of(Time.now) }
+        end
+
+        context 'with existing file' do
+          before { path.touch }
+
+          context 'older file' do
+            before { path.touch }
+            before { sleep 0.3 }
+
+            it { should be_within(0.1).of(Time.now - 0.3) }
+          end
+
+          context 'and changed access time' do
+            before { path.atime = Time.new(2175, 12, 24, 18, 00, 30) }
+
+            it 'should return file access time' do
+              should eq Time.new(2175, 12, 24, 18, 00, 30)
+            end
+          end
+        end
+      end
+
+      describe_method :atime= do
+        let(:path) { Path '/file.txt' }
+        before { path.touch }
+        subject { path.send described_method, Time.new(2175, 12, 24, 18, 00, 30) }
+
+        it 'should change file access time' do
+          expect{ subject }.to change{ path.atime }.to Time.new(2175, 12, 24, 18, 00, 30)
+        end
+      end
+
+      describe_method :mode do
+        let(:path) { Path '/file' }
+        subject { path.send described_method }
+
+        context 'with file' do
+          before { path.touch }
+          it { should eq 0666 - Path.umask }
+        end
+
+        context 'with directory' do
+          before { path.mkpath }
+          it { should eq 0777 - Path.umask }
+        end
+      end
+    end
+
+    describe 'umask' do
+      shared_examples 'umask setter' do
+        with_backend :sys do
+          it 'should set umask' do
+            subject
+            expect(File.umask).to eq 0077
+          end
+        end
+
+        with_backend :mock do
+          it 'should set umask' do
+            expect{ subject }.to change{ Path.umask }.from(0022).to(0077)
+          end
+        end
+      end
+
+      describe_method :umask do
+        let(:args) { Array.new }
+        subject { Path.send described_method, *args }
+
+        context 'as getter' do
+          with_backend :sys do
+            it 'should return umask' do
+              should eq File.umask
+            end
+          end
+
+          with_backend :mock do
+            it 'should return umask' do
+              should eq 0022
+            end
+          end
+        end
+
+        context 'as setter' do
+          let(:args) { [0077] }
+          it_behaves_like 'umask setter'
+        end
+      end
+
+      describe_method :umask= do
+        let(:args) { [0077] }
+        subject { Path.send described_method, *args }
+        it_behaves_like 'umask setter'
+      end
+    end
+  end
+end

data/spec/rubypath/file_predicates_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Path do
+  describe 'File Predicates' do
+    with_backends :mock, :sys do
+      describe_method :file? do
+        let(:path) { Path '/file.txt' }
+        before { expect(path).to_not be_existent }
+        subject { path.send(described_method) }
+
+        context 'with existing file' do
+          before { path.touch }
+          it { should eq true }
+        end
+
+        context 'with existing but wrong node (dir)' do
+          before { path.mkdir }
+          it { should eq false }
+        end
+
+        context 'with not existent file' do
+          it { should eq false }
+        end
+      end
+
+      describe_method :directory? do
+        let(:dir) { Path '/dir' }
+        before { expect(dir).to_not be_existent }
+        subject { dir.send(described_method) }
+
+        context 'with existing directory' do
+          before { dir.mkdir }
+          it { should eq true }
+        end
+
+        context 'with existing but wrong node (file)' do
+          before { dir.touch }
+          it { should eq false }
+        end
+
+        context 'with not existent directory' do
+          it { should eq false }
+        end
+      end
+
+      describe_method :exists?, aliases: [:exist?, :existent?] do
+        let(:path) { Path '/file' }
+        subject { path.send described_method }
+
+        context 'with existing directory' do
+          before { path.mkdir }
+          it { should eq true }
+        end
+
+        context 'with existing file' do
+          before { path.touch }
+          it { should eq true }
+        end
+
+        context 'with non-existing node' do
+          it { should eq false }
+        end
+      end
+    end
+  end
+end

data/spec/rubypath/identity_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Path do
+  describe 'Identity' do
+    let(:str)  { '/path/to/file' }
+    let(:args) { [str] }
+    let(:path) { described_class.new *args }
+    subject { path }
+
+    describe_method :path, aliases: [:to_path, :to_str, :to_s] do
+      subject { path.send described_method }
+
+      it { should eq str }
+
+      # Should not return same object as internal variable
+      # to avoid in-place modifications like
+      # `Path.new('/abc').path.delete!('abc')`
+      it { should_not equal path.send(:instance_variable_get, :@path) }
+    end
+  end
+end

data/spec/rubypath/io_operations_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe Path do
+  describe 'IO Operations' do
+    with_backends :mock, :sys do
+
+      describe_method :read do
+        let(:path) { Path '/file' }
+        let(:args) { Array.new }
+        subject { path.send described_method, *args }
+
+        context 'with existing file' do
+          before { path.write 'CONTENT' }
+          before { path.mtime = Time.new(1970) }
+          before { path.atime = Time.new(1970) }
+
+          it { should eq 'CONTENT' }
+
+          it 'should update access time' do
+            subject
+            expect(path.atime).to be_within(0.1).of(Time.now)
+          end
+
+          context 'with read length and offset' do
+            let(:args) { [4, 2] }
+
+            it { should eq 'NTEN' }
+
+            context 'with oversized length' do
+              let(:args) { [10, 2] }
+              it { should eq 'NTENT' }
+            end
+
+            context 'with oversized offset' do
+              let(:args) { [10, 10] }
+              it { should eq nil }
+            end
+          end
+        end
+
+        context 'with existing directory' do
+          before { path.mkdir }
+
+          it 'should raise EISDIR error' do
+            expect { subject }.to raise_error(Errno::EISDIR, "Is a directory - /file")
+          end
+        end
+
+        context 'with non-existent file' do
+          before { expect(path).to_not be_existent }
+
+          it 'should raise ENOENT error' do
+            expect { subject }.to raise_error(Errno::ENOENT, "No such file or directory - /file")
+          end
+        end
+      end
+
+      describe_method :write do
+        let(:path) { Path '/file' }
+        let(:args) { Array.new }
+        subject { path.send described_method, 'CONTENT', *args }
+
+        shared_examples '#write' do
+          it 'should write content' do
+            subject
+            expect(path.read).to eq expected_content
+          end
+
+          it { should be_a Path }
+          it { expect(subject.path).to eq path.path}
+        end
+
+        context 'with existing file' do
+          before { path.touch }
+          before { path.mtime = Time.new(1970) }
+          before { path.atime = Time.new(1970) }
+          let(:expected_content) { 'CONTENT' }
+
+          it_behaves_like '#write'
+
+          it 'should update mtime' do
+            expect{ subject }.to change{ path.mtime }
+            expect(path.mtime).to be_within(0.1).of(Time.now)
+          end
+
+          it 'should not update atime' do
+            expect{ subject }.to_not change{ path.atime }
+          end
+
+          context 'with offset' do
+            before { path.write '12345678901234567890' }
+            let(:args) { [4] }
+            let(:expected_content) { '1234CONTENT234567890' }
+
+            it_behaves_like '#write'
+          end
+        end
+
+        context 'with existing directory' do
+          before { path.mkdir }
+
+          it 'should write content' do
+            expect{ subject }.to raise_error(Errno::EISDIR, "Is a directory - /file")
+          end
+        end
+
+        context 'with non-existing file' do
+          before { expect(path).to_not be_existent }
+          let(:expected_content) { 'CONTENT' }
+
+          it_behaves_like '#write'
+
+          it 'should set mtime' do
+            subject
+            expect(path.mtime).to be_within(0.1).of(Time.now)
+          end
+
+          it 'should set atime' do
+            subject
+            expect(path.atime).to be_within(0.1).of(Time.now)
+          end
+        end
+      end
+    end
+  end
+end