gitdocs 0.5.0 → 0.6.0

data/test/unit/configuration_test.rb

@@ -2,81 +2,19 @@
 
 require File.expand_path('../test_helper', __FILE__)
 
-describe 'gitdocs configuration' do
+describe Gitdocs::Configuration do
   before do
-    ENV['TEST'] = 'true'
-    ShellTools.capture { @config = Gitdocs::Configuration.new('/tmp/gitdocs') }
+    ShellTools.capture { Gitdocs::Initializer.initialize_database }
   end
 
-  it 'has sensible default config root' do
-    assert_equal '/tmp/gitdocs', @config.config_root
-  end
-
-  it 'can retrieve empty shares' do
-    assert_equal [], @config.shares
-  end
-
-  it 'can have a path added' do
-    @config.add_path('/my/../my/path') # normalized test
-    assert_equal '/my/path', @config.shares.first.path
-    assert_equal 15.0, @config.shares.first.polling_interval
-  end
-
-  it 'can have a path removed' do
-    @config.add_path('/my/path')
-    @config.add_path('/my/path/2')
-    @config.remove_path('/my/../my/path/2') # normalized test
-    assert_equal ['/my/path'], @config.shares.map(&:path)
-  end
-
-  it 'can have a share removed by id' do
-    @config.add_path('/my/path')
-    @config.add_path('/my/path/2')
-
-    # Delete an index which exists
-    @config.remove_by_id(2).must_equal(true) # normalized test
-    assert_equal ['/my/path'], @config.shares.map(&:path)
-
-    # Try to delete an index which does not exist
-    @config.remove_by_id(5).must_equal(false) # normalized test
-    assert_equal ['/my/path'], @config.shares.map(&:path)
-  end
-
-  it 'can clear paths' do
-    @config.add_path('/my/path')
-    @config.add_path('/my/path/2')
-    @config.clear
-    assert_equal [], @config.shares.map(&:path)
-  end
-
-  describe '#update_all' do
+  describe 'Config.update' do
     before do
-      @config.add_path('/my/path')
-      @config.add_path('/my/path/2')
-      @config.add_path('/my/path/3')
-      @config.add_path('/my/path/4')
-      @config.add_path('/my/path/5')
-      @config.update_all(
-        'config' => { 'start_web_frontend' => false, 'web_frontend_port' => 9999 },
-        'share'  => {
-          '0' => { 'path' => '/my/path',    'polling_interval' => 42 },
-          '1' => { 'path' => '/my/path/2',  'polling_interval' => 66 },
-          '2' => { 'path' => '/my/path/3a', 'polling_interval' => 77 },
-          '3' => { 'path' => '',            'polling_interval' => 88 },
-          '4' => {                          'polling_interval' => 99 }
-        }
+      Gitdocs::Configuration.update(
+        'start_web_frontend' => false, 'web_frontend_port' => 9999
       )
     end
-    it { @config.shares.size.must_equal(5) }
-    it { @config.shares[0].path.must_equal('/my/path') }
-    it { @config.shares[0].polling_interval.must_equal(42) }
-    it { @config.shares[1].path.must_equal('/my/path/2') }
-    it { @config.shares[1].polling_interval.must_equal(66) }
-    it { @config.shares[2].path.must_equal('/my/path/3a') }
-    it { @config.shares[2].polling_interval.must_equal(77) }
-    it { @config.shares[3].path.must_equal('/my/path/4') }
-    it { @config.shares[3].polling_interval.must_equal(15) }
-    it { @config.shares[4].path.must_equal('/my/path/5') }
-    it { @config.shares[4].polling_interval.must_equal(15) }
+
+    it { Gitdocs::Configuration.start_web_frontend.must_equal(false) }
+    it { Gitdocs::Configuration.web_frontend_port.must_equal(9999) }
   end
 end

data/test/unit/git_notifier_test.rb

@@ -0,0 +1,116 @@
+# -*- encoding : utf-8 -*-
+require File.expand_path('../test_helper', __FILE__)
+
+describe Gitdocs::GitNotifier do
+  let(:git_notifier) { Gitdocs::GitNotifier.new(:root, :show_notifications) }
+
+  describe '.for_merge' do
+    subject { git_notifier.for_merge(result) }
+
+    describe 'with no changes' do
+      before do
+        # Ensure that the notification methods are not called.
+        Gitdocs::Notifier.stubs(:warn).raises
+        Gitdocs::Notifier.stubs(:info).raises
+        Gitdocs::Notifier.stubs(:error).raises
+      end
+      describe('with nil')        { let(:result) { nil }        ; it { subject } }
+      describe('with no_remote')  { let(:result) { :no_remote } ; it { subject } }
+      describe('with no changes') { let(:result) { {} }         ; it { subject } }
+    end
+
+    describe 'with changes' do
+      let(:result) { { 'Alice' => 1, 'Bob' => 3 } }
+      before do
+        Gitdocs::Notifier.expects(:info).with(
+          'Updated with 4 changes',
+          "In root:\n* Alice (1 change)\n* Bob (3 changes)",
+          :show_notifications
+        )
+      end
+      it { subject }
+    end
+
+    describe 'with conflicts' do
+      let(:result) { ['file'] }
+      before do
+        Gitdocs::Notifier.expects(:warn).with(
+          'There were some conflicts',
+          '* file',
+          :show_notifications
+        )
+      end
+      it { subject }
+    end
+
+    describe 'with anything else' do
+      let(:result) { 'error' }
+      before do
+        Gitdocs::Notifier.expects(:error).with(
+          'There was a problem synchronizing this gitdoc',
+          "A problem occurred in root:\nerror",
+          :show_notifications
+        )
+      end
+      it { subject }
+    end
+  end
+
+  describe '.for_push' do
+    subject { git_notifier.for_push(result) }
+
+    describe 'with no changes' do
+      before do
+        # Ensure that the notification methods are not called.
+        Gitdocs::Notifier.stubs(:warn).raises
+        Gitdocs::Notifier.stubs(:info).raises
+        Gitdocs::Notifier.stubs(:error).raises
+      end
+      describe('with nil')       { let(:result) { nil }        ; it { subject } }
+      describe('with no_remote') { let(:result) { :no_remote } ; it { subject } }
+      describe('with nothing')   { let(:result) { :nothing }   ; it { subject } }
+    end
+
+    describe 'with changes' do
+      let(:result) { { 'Alice' => 1, 'Bob' => 3 } }
+      before do
+        Gitdocs::Notifier.expects(:info).with(
+          'Pushed 4 changes', 'root has been pushed', :show_notifications
+        )
+      end
+      it { subject }
+    end
+
+    describe 'with conflict' do
+      let(:result) { :conflict }
+      before do
+        Gitdocs::Notifier.expects(:warn).with(
+          'There was a conflict in root, retrying', '', :show_notifications
+        )
+      end
+      it { subject }
+    end
+
+    describe 'with anything else' do
+      let(:result) { 'error' }
+      before do
+        Gitdocs::Notifier.expects(:error).with(
+          'BAD Could not push changes in root', 'error', :show_notifications
+        )
+      end
+      it { subject }
+    end
+  end
+
+  describe '.on_error' do
+    subject { git_notifier.on_error(:exception) }
+    before do
+      Gitdocs::Notifier.expects(:error).with(
+        'Unexpected error when fetching/pushing in root',
+        'exception',
+        :show_notifications
+      )
+    end
+    it { subject }
+  end
+end

data/test/unit/gitdocs_test.rb

@@ -0,0 +1,90 @@
+# -*- encoding : utf-8 -*-
+
+require File.expand_path('../test_helper', __FILE__)
+
+describe 'Gitdocs' do
+  describe '.log_path' do
+    subject { Gitdocs.log_path }
+    before do
+      Gitdocs::Initializer.stubs(:root_dirname).returns(:root_dirname)
+      File.stubs(:expand_path).with('log', :root_dirname).returns(:result)
+    end
+    it { subject.must_equal(:result) }
+  end
+
+  describe 'log wrappers' do
+    let(:logger) { stubs('Logger') }
+
+    before do
+      Gitdocs::Initializer.stubs(:foreground).returns(foreground)
+      Gitdocs::Initializer.stubs(:verbose).returns(verbose)
+      Gitdocs.stubs(:log_path).returns(:log_path)
+
+      Gitdocs.instance_variable_set(:@initialized, nil)
+      Logger.stubs(:new).with(expected_path).returns(logger)
+      logger.expects(:level=).with(expected_level)
+    end
+
+    describe 'background and non-verbose' do
+      let(:foreground)     { false }
+      let(:verbose)        { false }
+      let(:expected_path)  { :log_path }
+      let(:expected_level) { Logger::INFO }
+
+      describe '.log_debug' do
+        subject { Gitdocs.log_debug(:message) }
+        before { logger.expects(:debug).with(:message) }
+        it { subject }
+      end
+
+      describe '.log_info' do
+        subject { Gitdocs.log_info(:message) }
+        before { logger.expects(:info).with(:message) }
+        it { subject }
+      end
+
+      describe '.log_warn' do
+        subject { Gitdocs.log_warn(:message) }
+        before { logger.expects(:warn).with(:message) }
+        it { subject }
+      end
+
+      describe '.log_error' do
+        subject { Gitdocs.log_error(:message) }
+        before { logger.expects(:error).with(:message) }
+        it { subject }
+      end
+    end
+
+    describe 'foreground and verborse' do
+      let(:foreground)     { true }
+      let(:verbose)        { true }
+      let(:expected_path)  { STDOUT }
+      let(:expected_level) { Logger::DEBUG }
+
+      describe '.log_debug' do
+        subject { Gitdocs.log_debug(:message) }
+        before { logger.expects(:debug).with(:message) }
+        it { subject }
+      end
+
+      describe '.log_info' do
+        subject { Gitdocs.log_info(:message) }
+        before { logger.expects(:info).with(:message) }
+        it { subject }
+      end
+
+      describe '.log_warn' do
+        subject { Gitdocs.log_warn(:message) }
+        before { logger.expects(:warn).with(:message) }
+        it { subject }
+      end
+
+      describe '.log_error' do
+        subject { Gitdocs.log_error(:message) }
+        before { logger.expects(:error).with(:message) }
+        it { subject }
+      end
+    end
+  end
+end

data/test/unit/manager_test.rb

@@ -0,0 +1,36 @@
+# -*- encoding : utf-8 -*-
+
+require File.expand_path('../test_helper', __FILE__)
+
+describe 'Gitdocs::Manager' do
+  describe '.start' do
+    subject { Gitdocs::Manager.start(:web_port) }
+
+    before do
+      Gitdocs::Manager.stubs(:new).returns(manager = stub)
+      manager.expects(:start).with(:web_port)
+    end
+
+    it { subject }
+  end
+
+  # TODO: describe '.restart_synchronization' do
+
+  describe '.listen_method' do
+    subject { Gitdocs::Manager.listen_method }
+
+    before { Listen::Adapter.stubs(:select).returns(listen_adapter) }
+
+    describe 'polling' do
+      let(:listen_adapter) { Listen::Adapter::Polling }
+      it { subject.must_equal :polling }
+    end
+
+    describe 'notification' do
+      let(:listen_adapter) { :not_polling }
+      it { subject.must_equal :notification }
+    end
+  end
+
+  # TODO: describe '.start'
+end

data/test/unit/notifier_test.rb

@@ -2,164 +2,100 @@
 require File.expand_path('../test_helper', __FILE__)
 
 describe Gitdocs::Notifier do
-  let(:notifier) { Gitdocs::Notifier.new(show_notifications) }
+  describe 'public methods' do
+    let(:notifier) { mock }
+    before { Gitdocs::Notifier.stubs(:instance).returns(notifier) }
 
-  describe '#error' do
-    subject { Gitdocs::Notifier.error(:title, :message) }
-    before do
-      Gitdocs::Notifier.expects(:new).with(true).returns(notifier = mock)
-      notifier.expects(:error).with(:title, :message)
-    end
-    it { subject }
-  end
+    describe '.info' do
+      subject { Gitdocs::Notifier.info('title', 'message', show_notification) }
 
-  describe '#info' do
-    subject { notifier.info('title', 'message') }
+      before { Gitdocs.expects(:log_info).with('title: message') }
 
-    describe 'without notifications' do
-      let(:show_notifications) { false }
-      before { notifier.expects(:puts).with('title: message') }
-      it { subject }
-    end
+      describe 'without notifications' do
+        let(:show_notification) { false }
+        before { Gitdocs::Notifier.expects(:puts).with('title: message') }
+        it { subject }
+      end
 
-    describe 'with notifications' do
-      let(:show_notifications) { true }
-      before do
-        Guard::Notifier.expects(:turn_on)
-        Guard::Notifier.expects(:notify)
-          .with(
-            'message',
-            title: 'title',
-            image: File.expand_path('../../../lib/img/icon.png', __FILE__)
-          )
+      describe 'with notifications' do
+        let(:show_notification) { true }
+        before { notifier.expects(:notify).with('title', 'message', :success) }
+        it { subject }
       end
-      it { subject }
     end
-  end
 
-  describe '#warn' do
-    subject { notifier.warn('title', 'message') }
+    describe '.warn' do
+      subject { Gitdocs::Notifier.warn('title', 'message', show_notification) }
 
-    describe 'without notifications' do
-      let(:show_notifications) { false }
-      before { Kernel.expects(:warn).with('title: message') }
-      it { subject }
-    end
+      before { Gitdocs.expects(:log_warn).with('title: message') }
 
-    describe 'with notifications' do
-      let(:show_notifications) { true }
-      before do
-        Guard::Notifier.expects(:turn_on)
-        Guard::Notifier.expects(:notify).with('message', title: 'title')
+      describe 'without notifications' do
+        let(:show_notification) { false }
+        before { Kernel.expects(:warn).with('title: message') }
+        it { subject }
       end
-      it { subject }
-    end
-  end
-
-  describe '#error' do
-    subject { notifier.error('title', 'message') }
 
-    describe 'without notifications' do
-      let(:show_notifications) { false }
-      before { Kernel.expects(:warn).with('title: message') }
-      it { subject }
-    end
-
-    describe 'with notifications' do
-      let(:show_notifications) { true }
-      before do
-        Guard::Notifier.expects(:turn_on)
-        Guard::Notifier.expects(:notify).with('message', title: 'title', image: :failure)
+      describe 'with notifications' do
+        let(:show_notification) { true }
+        before { notifier.expects(:notify).with('title', 'message', :pending) }
+        it { subject }
       end
-      it { subject }
     end
-  end
-
-  describe '#merge_notification' do
-    subject { notifier.merge_notification(result, 'root_path') }
 
-    let(:show_notifications) { false }
+    describe '.error' do
+      subject { Gitdocs::Notifier.error('title', 'message', show_notification) }
 
-    describe 'with no changes' do
-      before do
-        # Ensure that the notification methods are not called.
-        notifier.stubs(:warn).raises
-        notifier.stubs(:info).raises
-        notifier.stubs(:error).raises
-      end
-      describe('with nil')        { let(:result) { nil }        ; it { subject } }
-      describe('with no_remote')  { let(:result) { :no_remote } ; it { subject } }
-      describe('with no changes') { let(:result) { {} }         ; it { subject } }
-    end
+      before { Gitdocs.expects(:log_error).with('title: message') }
 
-    describe 'with changes' do
-      let(:result)  { { 'Alice' => 1, 'Bob' => 3 } }
-      before do
-        notifier.expects(:info).with(
-          'Updated with 4 changes',
-          "In root_path:\n* Alice (1 change)\n* Bob (3 changes)"
-        )
+      describe 'without notifications' do
+        let(:show_notification) { false }
+        before { Kernel.expects(:warn).with('title: message') }
+        it { subject }
       end
-      it { subject }
-    end
 
-    describe 'with conflicts' do
-      let(:result)  { ['file'] }
-      before do
-        notifier.expects(:warn).with(
-          'There were some conflicts',
-          '* file'
-        )
+      describe 'with notifications' do
+        let(:show_notification) { true }
+        before { notifier.expects(:notify).with('title', 'message', :failed) }
+        it { subject }
       end
-      it { subject }
     end
 
-    describe 'with anything else' do
-      let(:result) { 'error' }
-      before do
-        notifier.expects(:error).with(
-          'There was a problem synchronizing this gitdoc',
-          "A problem occurred in root_path:\nerror"
-        )
-      end
+    describe '.disconnect' do
+      subject { Gitdocs::Notifier.disconnect }
+      before { notifier.expects(:disconnect) }
       it { subject }
     end
   end
 
-  describe '#push_notification' do
-    subject { notifier.push_notification(result, 'root_path') }
-
-    let(:show_notifications) { false }
+  describe 'private-ish instance methods' do
+    let(:notifier)  { Gitdocs::Notifier.send(:new) }
+    let(:notiffany) { mock }
 
-    describe('with nil')       { let(:result) { nil }        ; it { subject } }
-    describe('with no_remote') { let(:result) { :no_remote } ; it { subject } }
-    describe('with nothing')   { let(:result) { :nothing }   ; it { subject } }
-
-    describe 'with changes' do
-      let(:result)  { { 'Alice' => 1, 'Bob' => 3 } }
+    describe '#notify' do
+      subject { notifier.notify(:title, :message, :type) }
       before do
-        notifier.expects(:info)
-          .with('Pushed 4 changes', 'root_path has been pushed')
+        Notiffany.expects(:connect).returns(notiffany)
+        notiffany.expects(:notify).with(:message, title: :title, image: :type)
       end
       it { subject }
     end
 
-    describe 'with conflict' do
-      let(:result) { :conflict }
-      before do
-        notifier.expects(:warn)
-          .with('There was a conflict in root_path, retrying', '')
+    describe '#disconnect' do
+      subject { notifier.disconnect }
+
+      describe 'not connected' do
+        before { subject }
+        it { notifier.instance_variable_get(:@notifier).must_equal(nil) }
       end
-      it { subject }
-    end
 
-    describe 'with anything else' do
-      let(:result) { 'error' }
-      before do
-        notifier.expects(:error)
-          .with('BAD Could not push changes in root_path', 'error')
+      describe 'connect' do
+        before do
+          notifier.instance_variable_set(:@notifier, notiffany)
+          notiffany.expects(:disconnect)
+          subject
+        end
+        it { notifier.instance_variable_get(:@notifier).must_equal(nil) }
       end
-      it { subject }
     end
   end
 end