gitdocs 0.5.0 → 0.6.0

data/test/unit/repository_committer_test.rb

@@ -0,0 +1,111 @@
+# -*- encoding : utf-8 -*-
+require File.expand_path('../test_helper', __FILE__)
+
+describe Gitdocs::Repository::Committer do
+  before do
+    FileUtils.rm_rf('tmp/unit')
+    GitFactory.init(:local)
+  end
+
+  let(:root_dirname) { GitFactory.expand_path(:local) }
+  let(:committer)    { Gitdocs::Repository::Committer.new(root_dirname) }
+
+  describe 'initialize' do
+    subject { committer }
+
+    describe 'when directory missing' do
+      let(:root_dirname) { GitFactory.expand_path(:missing) }
+      it { assert_raises(Gitdocs::Repository::InvalidError) { subject } }
+    end
+
+    describe 'when not a repository' do
+      let(:root_dirname) { GitFactory.expand_path(:not_a_repo) }
+      before { FileUtils.mkdir_p(root_dirname) }
+      it { assert_raises(Gitdocs::Repository::InvalidError) { subject } }
+    end
+
+    describe 'when valid repository' do
+      it { subject.must_be_kind_of Gitdocs::Repository::Committer }
+    end
+  end
+
+  describe '#commit' do
+    subject { committer.commit }
+
+    before { Gitdocs.stubs(:log_debug) }
+
+    # TODO: should test the paths which use the message file
+
+    describe 'no previous commits' do
+      describe 'nothing to commit' do
+        it { subject.must_equal false }
+      end
+
+      describe 'changes to commit' do
+        before do
+          GitFactory.write(:local, 'file1', 'foobar')
+          GitFactory.mkdir(:local, 'directory')
+        end
+        it { subject.must_equal true }
+
+        describe 'side effects' do
+          before { subject }
+          it { GitInspector.file_exist?(:local, 'directory/.gitignore').must_equal true }
+          it { GitInspector.commit_count(:local).must_equal 1 }
+          it { GitInspector.last_message(:local).must_equal "Auto-commit from gitdocs\n" }
+          it { GitInspector.clean?(:local).must_equal true }
+        end
+      end
+    end
+
+    describe 'previous commits' do
+      before do
+        GitFactory.commit(:local, 'file1', 'foobar')
+        GitFactory.commit(:local, 'file2', 'deadbeef')
+      end
+
+      describe 'nothing to commit' do
+        it { subject.must_equal false }
+      end
+
+      describe 'changes to commit' do
+        before do
+          GitFactory.write(:local, 'file1', 'foobar')
+          GitFactory.rm(:local, 'file2')
+          GitFactory.write(:local, 'file3', 'foobar')
+          GitFactory.mkdir(:local, 'directory')
+        end
+        it { subject.must_equal true }
+
+        describe 'side effects' do
+          before { subject }
+          it { GitInspector.file_exist?(:local, 'directory/.gitignore').must_equal true }
+          it { GitInspector.commit_count(:local).must_equal 3 }
+          it { GitInspector.last_message(:local).must_equal "Auto-commit from gitdocs\n" }
+          it { GitInspector.clean?(:local).must_equal true }
+        end
+      end
+    end
+  end
+
+  describe '#write_commit_message' do
+    subject { committer.write_commit_message(commit_message) }
+
+    before { subject }
+
+    describe 'with no message' do
+      let(:commit_message) { nil }
+      it { GitInspector.file_exist?(:local, '.gitmessage~').must_equal(false) }
+    end
+
+    describe 'with empty message' do
+      let(:commit_message) { '' }
+      it { GitInspector.file_exist?(:local, '.gitmessage~').must_equal(false) }
+    end
+
+    describe 'with message' do
+      let(:commit_message) { 'foobar' }
+      it { GitInspector.file_content(:local, '.gitmessage~').must_equal('foobar') }
+    end
+  end
+end

data/test/unit/repository_path_test.rb

@@ -2,46 +2,63 @@
 require File.expand_path('../test_helper', __FILE__)
 
 describe Gitdocs::Repository::Path do
-  let(:path) { Gitdocs::Repository::Path.new(repository, relative_path) }
-  let(:repository) { stub(root: local_repo_path) }
-  let(:local_repo_path) { 'tmp/unit/local' }
-
+  let(:path) { Gitdocs::Repository::Path.new(repository, "/#{relative_path}") }
+  let(:repository) { stub(root: GitFactory.expand_path(:local)) }
   let(:relative_path) { 'directory/file' }
 
   before do
     FileUtils.rm_rf('tmp/unit')
+    GitFactory.init(:local)
+  end
+
+  describe '#relative_dirname' do
+    subject { path.relative_dirname }
+
+    describe 'root' do
+      let(:relative_path) { '' }
+      it { subject.must_equal('') }
+    end
+
+    describe 'root filename' do
+      let(:relative_path) { 'directory' }
+      it { subject.must_equal('') }
+    end
+
+    describe 'non-root filename' do
+      let(:relative_path) { 'directory1/directory2/file' }
+      it { subject.must_equal('directory1/directory2') }
+    end
   end
 
   describe '#join' do
     subject { path.join('new_file') }
     before { subject }
-    it { path.relative_path.must_equal('directory/file/new_file') }
-    it { path.absolute_path.must_equal(absolute_local_path('new_file')) }
+    it { path.relative_path.must_equal(File.join(relative_path, 'new_file')) }
+    it { path.absolute_path.must_equal(GitFactory.expand_path(:local, relative_path, 'new_file')) }
   end
 
   describe '#write' do
-    subject { path.write('foobar', :message) }
-    before { repository.expects(:write_commit_message).with(:message) }
+    subject { path.write('foobar') }
 
     describe 'directory missing' do
       before { subject }
-      it { local_file_content.must_equal "foobar\n" }
+      it { GitInspector.file_content(:local, relative_path).must_equal "foobar\n" }
     end
 
     describe 'directory exists' do
       before do
-        mkdir('directory')
+        mkdir(File.dirname(relative_path))
         subject
       end
-      it { local_file_content.must_equal "foobar\n" }
+      it { GitInspector.file_content(:local, relative_path).must_equal "foobar\n" }
     end
 
     describe 'file exists' do
       before do
-        write('directory/file', 'deadbeef')
+        write(relative_path, 'deadbeef')
         subject
       end
-      it { local_file_content.must_equal "foobar\n" }
+      it { GitInspector.file_content(:local, relative_path).must_equal "foobar\n" }
     end
   end
 
@@ -50,23 +67,23 @@ describe Gitdocs::Repository::Path do
 
     describe 'when directory does not exist' do
       before { subject }
-      it { local_file_content.must_equal '' }
+      it { GitInspector.file_content(:local, relative_path).must_equal '' }
     end
 
     describe 'when directory already exists' do
       before do
-        mkdir('directory')
+        mkdir(File.dirname(relative_path))
         subject
       end
-      it { local_file_content.must_equal '' }
+      it { GitInspector.file_content(:local, relative_path).must_equal '' }
     end
 
     describe 'when file already exists' do
       before do
-        write('directory/file', 'test')
+        write(relative_path, 'test')
         subject
       end
-      it { local_file_content.must_equal 'test' }
+      it { GitInspector.file_content(:local, relative_path).must_equal 'test' }
     end
   end
 
@@ -75,23 +92,35 @@ describe Gitdocs::Repository::Path do
 
     describe 'directory does not exist' do
       before { subject }
-      it { File.directory?(File.join(local_repo_path, 'directory', 'file')) }
+      it { File.directory?(GitFactory.expand_path(:local, relative_path)) }
     end
 
     describe 'directory does exist' do
       before do
-        mkdir('directory/file')
+        mkdir(relative_path)
         subject
       end
-      it { File.directory?(File.join(local_repo_path, 'directory', 'file')) }
+      it { File.directory?(GitFactory.expand_path(:local, relative_path)) }
     end
 
     describe 'already exists as a file' do
-      before { write('directory/file', 'foobar') }
+      before { write(relative_path, 'foobar') }
       it { assert_raises(Errno::EEXIST) { subject } }
     end
   end
 
+  describe '#mv' do
+    subject { path.mv(source_filename) }
+    let(:source_filename) { File.join(GitFactory.working_directory, 'move_me') }
+    before do
+      FileUtils.mkdir_p(File.dirname(source_filename))
+      File.write(source_filename, 'foobar')
+
+      subject
+    end
+    it { GitInspector.file_content(:local, relative_path).must_equal('foobar') }
+  end
+
   describe '#remove' do
     subject { path.remove }
 
@@ -100,16 +129,16 @@ describe Gitdocs::Repository::Path do
     end
 
     describe 'directory' do
-      before { mkdir('directory/file') }
+      before { mkdir(relative_path) }
       it { subject.must_be_nil }
     end
 
     describe 'file' do
       before do
-        write('directory/file', 'foobar')
+        write(relative_path, 'foobar')
         subject
       end
-      it { local_file_exist?.must_equal false }
+      it { GitInspector.file_exist?(:local, relative_path).must_equal false }
     end
   end
 
@@ -121,22 +150,22 @@ describe Gitdocs::Repository::Path do
     end
 
     describe 'directory' do
-      before { mkdir('directory/file') }
+      before { mkdir(relative_path) }
       it { subject.must_equal false }
     end
 
     describe 'not a text file' do
-      let(:relative_path) { 'directory/file.png' }
+      let(:relative_path) { 'file.png' }
       it { subject.must_equal false }
     end
 
     describe 'empty file' do
-      before { write('directory/file', '') }
+      before { write(relative_path, '') }
       it { subject.must_equal true }
     end
 
     describe 'text file' do
-      before { write('directory/file', 'foobar') }
+      before { write(relative_path, 'foobar') }
       it { subject.must_equal true }
     end
   end
@@ -148,27 +177,27 @@ describe Gitdocs::Repository::Path do
     end
 
     describe 'when missing' do
-      let(:commit)        { nil }
+      let(:commit) { nil }
       it { assert_raises(RuntimeError) { subject } }
     end
 
-    describe 'on a 'do
+    describe 'on a ' do
       let(:commit) { stub(author: { name: :name, time: :time }) }
       before do
-        write('directory0/file0', '')
-        write('directory/file1', 'foo')
-        write('directory/file2', 'bar')
+        write(File.join(%w(directory0 file0)), '')
+        write(File.join(%w(directory file1)), 'foo')
+        write(File.join(%w(directory file2)), 'bar')
       end
 
       describe 'file size 0' do
-        let(:relative_path) { 'directory0/file0' }
+        let(:relative_path) { File.join(%w(directory0 file0)) }
         it { subject[:author].must_equal :name }
         it { subject[:size].must_equal(-1) }
         it { subject[:modified].must_equal :time }
       end
 
       describe 'file non-zero size' do
-        let(:relative_path) { 'directory/file1' }
+        let(:relative_path) { File.join(%w(directory file1)) }
         it { subject[:author].must_equal :name }
         it { subject[:size].must_equal(3) }
         it { subject[:modified].must_equal :time }
@@ -198,12 +227,12 @@ describe Gitdocs::Repository::Path do
     end
 
     describe 'directory' do
-      before { mkdir('directory/file') }
+      before { mkdir(relative_path) }
       it { subject.must_equal true }
     end
 
     describe 'file' do
-      before { write('directory/file', 'foobar') }
+      before { write(relative_path, 'foobar') }
       it { subject.must_equal true }
     end
   end
@@ -216,12 +245,12 @@ describe Gitdocs::Repository::Path do
     end
 
     describe 'directory' do
-      before { mkdir('directory/file') }
+      before { mkdir(relative_path) }
       it { subject.must_equal true }
     end
 
     describe 'file' do
-      before { write('directory/file', 'foobar') }
+      before { write(relative_path, 'foobar') }
       it { subject.must_equal false }
     end
   end
@@ -231,7 +260,7 @@ describe Gitdocs::Repository::Path do
 
     describe 'no revision' do
       let(:ref) { nil }
-      it { subject.must_equal absolute_local_path }
+      it { subject.must_equal GitFactory.expand_path(:local, relative_path) }
     end
 
     describe 'with revision' do
@@ -258,13 +287,13 @@ describe Gitdocs::Repository::Path do
     end
 
     describe 'no README' do
-      before { mkdir('directory/file') }
+      before { mkdir(relative_path) }
       it { subject.must_be_nil }
     end
 
     describe 'with README.md' do
-      before { write('directory/file/README.md', 'foobar') }
-      it { subject.must_equal absolute_local_path('README.md') }
+      before { write(File.join(relative_path, 'README.md'), 'foobar') }
+      it { subject.must_equal GitFactory.expand_path(:local, relative_path, 'README.md') }
     end
   end
 
@@ -276,21 +305,20 @@ describe Gitdocs::Repository::Path do
     end
 
     describe 'file' do
-      before { write('directory/file', 'foobar') }
+      before { write(relative_path, 'foobar') }
       it { subject.must_be_nil }
     end
 
     describe 'directory' do
       before do
-        write('directory/file/.hidden', 'beef')
-        mkdir('directory/file/dir1')
-        write('directory/file/file1', 'foo')
-        write('directory/file/file2', 'bar')
+        write(File.join(relative_path, '.hidden'), 'beef')
+        mkdir(File.join(relative_path, 'dir1'))
+        write(File.join(relative_path, 'file1'), 'foo')
+        write(File.join(relative_path, 'file2'), 'bar')
 
         # Paths which should not be included
-        write('directory/file/.git', 'test')
-        write('directory/file/.gitignore', 'test')
-        write('directory/file/.gitmessage~', 'test')
+        write(File.join(relative_path, '.gitignore'), 'test')
+        write(File.join(relative_path, '.gitmessage~'), 'test')
       end
 
       it { subject.size.must_equal 4 }
@@ -307,12 +335,12 @@ describe Gitdocs::Repository::Path do
     end
 
     describe 'directory' do
-      before { mkdir('directory/file') }
+      before { mkdir(relative_path) }
       it { subject.must_be_nil }
     end
 
     describe 'file' do
-      before { write('directory/file', 'foobar') }
+      before { write(relative_path, 'foobar') }
       it { subject.must_equal 'foobar' }
     end
   end
@@ -321,10 +349,12 @@ describe Gitdocs::Repository::Path do
     subject { path.revisions }
 
     before do
-      repository.stubs(:commits_for).returns([
-        stub(oid: '1234567890', message: "short1\nlong", author: { name: :name1, time: :time1 }),
-        stub(oid: '0987654321', message: "short2\nlong", author: { name: :name2, time: :time2 })
-      ])
+      repository.stubs(:commits_for).returns(
+        [
+          stub(oid: '1234567890', message: "short1\nlong", author: { name: :name1, time: :time1 }),
+          stub(oid: '0987654321', message: "short2\nlong", author: { name: :name2, time: :time2 })
+        ]
+      )
     end
     it { subject.size.must_equal(2) }
     it { subject[0].must_equal(commit: '1234567', subject: 'short1', author: :name1, date: :time1) }
@@ -342,7 +372,7 @@ describe Gitdocs::Repository::Path do
 
     describe 'blob present' do
       let(:blob) { stub(text: 'deadbeef') }
-      before { path.expects(:write).with('deadbeef', "Reverting '#{relative_path}' to ref") }
+      before { path.expects(:write).with('deadbeef') }
       it { subject }
     end
   end
@@ -352,24 +382,10 @@ describe Gitdocs::Repository::Path do
   private
 
   def write(filename, content)
-    mkdir(File.dirname(filename))
-    File.write(File.join(local_repo_path, filename), content)
-  end
-
-  def mkdir(*path)
-    FileUtils.mkdir_p(File.join(local_repo_path, *path))
-  end
-
-  def local_file_exist?
-    File.exist?(File.join(local_repo_path, relative_path))
-  end
-
-  def local_file_content
-    return nil unless local_file_exist?
-    File.read(File.join(local_repo_path, relative_path))
+    GitFactory.write(:local, filename, content)
   end
 
-  def absolute_local_path(*path_elements)
-    File.join(File.absolute_path(local_repo_path), relative_path, *path_elements)
+  def mkdir(path)
+    GitFactory.mkdir(:local, path)
   end
 end