gitdocs 0.5.0 → 0.6.0

data/lib/gitdocs/settings_app.rb

@@ -10,18 +10,20 @@ module Gitdocs
     get('/') do
       haml(
         :settings,
-        locals: { conf: settings.manager, nav_state: 'settings' }
+        locals: { nav_state: 'settings' }
       )
     end
 
     post('/') do
-      settings.manager.update_all(request.POST)
+      Configuration.update(request.POST['config'])
+      Share.update_all(request.POST['share'])
+      Manager.restart_synchronization
       redirect to('/')
     end
 
     delete('/:id') do
       id = params[:id].to_i
-      halt(404) unless settings.manager.remove_by_id(id)
+      halt(404) unless Share.remove_by_id(id)
       redirect to('/')
     end
   end

data/lib/gitdocs/share.rb

@@ -0,0 +1,64 @@
+# -*- encoding : utf-8 -*-
+
+require 'active_record'
+
+module Gitdocs
+  class Share < ActiveRecord::Base
+    # @return [Array<String>]
+    def self.paths
+      all.map(&:path)
+    end
+
+    # @param [#to_i] index
+    #
+    # @return [Share]
+    def self.at(index)
+      all[index.to_i]
+    end
+
+    # @param [String] path
+    #
+    # @return [Share]
+    def self.find_by_path(path)
+      where(path: File.expand_path(path)).first
+    end
+
+    # @param [String] path
+    def self.create_by_path!(path)
+      new(path: File.expand_path(path)).save!
+    end
+
+    # @param [Hash] updated_shares
+    # @return [void]
+    def self.update_all(updated_shares)
+      updated_shares.each do |index, share_config|
+        # Skip the share update if there is no path specified.
+        next unless share_config['path'] && !share_config['path'].empty?
+
+        # Split the remote_branch into remote and branch
+        remote_branch = share_config.delete('remote_branch')
+        share_config['remote_name'], share_config['branch_name'] =
+          remote_branch.split('/', 2) if remote_branch
+
+        at(index).update_attributes(share_config)
+      end
+    end
+
+    # @param [Integer] id of the share to remove
+    #
+    # @return [true] share was deleted
+    # @return [false] share does not exist
+    def self.remove_by_id(id)
+      find(id).destroy
+      true
+    rescue ActiveRecord::RecordNotFound
+      false
+    end
+
+    # @param [String] path of the share to remove
+    # @return [void]
+    def self.remove_by_path(path)
+      where(path: File.expand_path(path)).destroy_all
+    end
+  end
+end

data/lib/gitdocs/synchronizer.rb

@@ -0,0 +1,40 @@
+# -*- encoding : utf-8 -*-
+
+module Gitdocs
+  class Synchronizer
+    include Celluloid
+    finalizer :stop_timers
+
+    # @param [Gitdocs::Share] share
+    def initialize(share)
+      @git_notifier = GitNotifier.new(share.path, share.notification)
+      @repository   = Repository.new(share)
+      @sync_type    = share.sync_type
+
+      # Always to an initial synchronization when beginning.
+      synchronize
+
+      @timer = every(share.polling_interval) { synchronize }
+    end
+
+    # @return [void]
+    def stop_timers
+      return unless @timer
+      @timer.cancel
+    end
+
+    # @return [void]
+    def synchronize
+      return unless @repository.valid?
+
+      result = @repository.synchronize(@sync_type)
+      @git_notifier.for_merge(result[:merge])
+      @git_notifier.for_push(result[:push])
+    rescue => e
+      # Rescue any standard exceptions which come from the push related
+      # commands. This will prevent problems on a single share from killing
+      # the entire daemon.
+      @git_notifier.on_error(e)
+    end
+  end
+end

data/lib/gitdocs/version.rb

@@ -1,3 +1,3 @@
 module Gitdocs
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'.freeze
 end

data/lib/gitdocs/views/_header.haml

@@ -3,7 +3,7 @@
 - if file
   %ul.tabs
     %li
-      %a{ href: "#{request.path}" } View
+      %a{ href: request.path } View
     %li
       %a{ href: '?mode=raw' } Raw
     %li
@@ -11,6 +11,6 @@
     %li
       %a{ href: '?mode=revisions' } Revisions
     %li
-      %form{ method: 'POST', :'data-confirm-submit' => 'Are you sure?' }
+      %form{ method: 'POST', 'data-confirm-submit' => 'Are you sure?' }
         %input{ name: '_method', type: 'hidden', value: 'delete' }
         %input.btn.danger{ type: 'submit', value: 'Delete' }

data/lib/gitdocs/views/dir.haml

@@ -1,9 +1,9 @@
 - @title = root
 
-= haml(:_header, locals: { file: false, idx: idx })
+= haml(:_header, locals: { file: false })
 
 - if contents && contents.any?
-  %table#fileListing.condensed-table.zebra-striped
+  %table.condensed-table.zebra-striped#fileListing
     %thead
       %tr
         %th File
@@ -34,7 +34,7 @@
   .span8
     %form.add{ method: 'POST' }
       %p Add new file or directory
-      %input{ type: 'text',   name: 'filename', placeholder: 'somefile.md or somedir' }
+      %input{ type: 'text', name: 'filename', placeholder: 'somefile.md or somedir' }
       %input.btn.secondary{ type: 'submit', name: 'new_file', value: 'New file' }
       %input.btn.secondary{ type: 'submit', name: 'new_directory', value: 'New directory' }
 

data/lib/gitdocs/views/edit.haml

@@ -1,6 +1,6 @@
 - @title = root
 
-= haml(:_header, locals: { file: true, idx: idx })
+= haml(:_header, locals: { file: true })
 
 %form.edit{ method: 'POST', style: 'display:none;' }
   #editor

data/lib/gitdocs/views/file.haml

@@ -1,6 +1,6 @@
 - @title = root
 
-= haml(:_header, locals: { file: true, idx: idx })
+= haml(:_header, locals: { file: true })
 
 .contents
   = preserve contents

data/lib/gitdocs/views/home.haml

@@ -3,8 +3,8 @@
 %p Select a share to browse:
 
 %table#shares
-  - shares.each_with_index do |share, idx|
+  - Gitdocs::Share.all.each do |share|
     %tr
       %td
-        %a{ href: "/#{idx}" }
-          = share.root
+        %a{ href: "/#{share.id}" }
+          = share.path

data/lib/gitdocs/views/layout.haml

@@ -3,29 +3,29 @@
   %head
     %meta{ 'http-equiv' => 'content-type', content: 'text/html; charset=UTF-8' }
     %title Gitdocs #{Gitdocs::VERSION}
-    %link{ href: '/css/bootstrap.css', rel: 'stylesheet'}
-    %link{ href: '/css/app.css',       rel: 'stylesheet' }
-    %link{ href: '/css/tilt.css',      rel: 'stylesheet' }
-    %link{ href: '/css/coderay.css',   rel: 'stylesheet' }
-    %script{ src: '/js/util.js',               type: 'text/javascript', charset: 'utf-8' }
-    %script{ src: '/js/jquery.js',             type: 'text/javascript', charset: 'utf-8' }
+    %link{ href: '/css/bootstrap.css', rel: 'stylesheet' }
+    %link{ href: '/css/app.css', rel: 'stylesheet' }
+    %link{ href: '/css/tilt.css', rel: 'stylesheet' }
+    %link{ href: '/css/coderay.css', rel: 'stylesheet' }
+    %script{ src: '/js/util.js', type: 'text/javascript', charset: 'utf-8' }
+    %script{ src: '/js/jquery.js', type: 'text/javascript', charset: 'utf-8' }
     %script{ src: '/js/jquery.tablesorter.js', type: 'text/javascript', charset: 'utf-8' }
-    %script{ src: '/js/bootstrap-alerts.js',   type: 'text/javascript', charset: 'utf-8' }
-    %script{ src: '/js/app.js',                type: 'text/javascript', charset: 'utf-8' }
+    %script{ src: '/js/bootstrap-alerts.js', type: 'text/javascript', charset: 'utf-8' }
+    %script{ src: '/js/app.js', type: 'text/javascript', charset: 'utf-8' }
   %body
-    #nav.topbar
+    .topbar#nav
       .fill
         .container
-          %a.brand{ href: '/'} Gitdocs
+          %a.brand{ href: '/' } Gitdocs
           %ul.nav
             %li{ class: ('active' if nav_state == 'home') }
-              %a(href = "/") Home
+              %a{ href: '/' } Home
             %li{ class: ('active' if nav_state == 'settings') }
-              %a(href = "/settings") Settings
+              %a{ href: '/settings' } Settings
           %form.pull-left{ action: '/search', method: 'GET' }
             %input{ type: 'text', placeholder: 'Search', name: 'q' }
 
-    #main.container
+    .container#main
       .content
         - if @title
           .page-header

data/lib/gitdocs/views/revisions.haml

@@ -1,9 +1,9 @@
 - @title = root
 
-= haml(:_header, locals: { file: true, idx: idx })
+= haml(:_header, locals: { file: true })
 
 - if revisions && revisions.any?
-  %table#revisions.condensed-table.zebra-striped
+  %table.condensed-table.zebra-striped#revisions
     %thead
       %tr
         %th Commit
@@ -22,7 +22,7 @@
           %td.author= r[:author]
           %td.date.reldate= r[:date].iso8601
           %td.revert
-            %form{ method: 'POST', :'data-confirm-submit' => 'Are you sure?' }
+            %form{ method: 'POST', 'data-confirm-submit' => 'Are you sure?' }
               %input{ name: '_method', type: 'hidden', value: 'put' }
               %input.btn{ type: 'submit', name: 'revision', value: r[:commit] }
 - if revisions.empty?

data/lib/gitdocs/views/search.haml

@@ -10,7 +10,7 @@
       %dl
         - search_results.each do |res|
           %dt
-            %a{href: "/#{repo.index}/#{res.file}"}
+            %a{ href: "/#{repo.index}/#{res.file}" }
               = "/#{res.file}"
           %dd
             = res.context

data/lib/gitdocs/views/settings.haml

@@ -3,13 +3,13 @@
 
 %form#settings{ method: 'POST', action: url('/') }
   %h2 Gitdocs
-  #config.field.config
+  .field.config#config
     %dl
       %dt Web Frontend Port
       %dd
-        %input{ type: 'input', name: 'config[web_frontend_port]', value: conf.web_frontend_port }
+        %input{ type: 'input', name: 'config[web_frontend_port]', value: Gitdocs::Configuration.web_frontend_port }
   %h2 Shares
-  - conf.shares.each_with_index do |share, idx|
+  - Gitdocs::Share.all.each_with_index do |share, idx|
     .share{ id: "share-#{idx}", class: idx.even? ? 'even' : 'odd' }
       %dl
         %dt Path
@@ -23,7 +23,7 @@
         %dt Sync Type
         %dd
           %select{ name: "share[#{idx}][sync_type]" }
-            %option{ value: 'full',  selected: (share.sync_type == 'full' ? 'selected' : nil) }
+            %option{ value: 'full', selected: (share.sync_type == 'full' ? 'selected' : nil) }
               Full
             %option{ value: 'fetch', selected: (share.sync_type == 'fetch' ? 'selected' : nil) }
               Fetch only
@@ -47,11 +47,11 @@
           %dd
             %input{ name: "share[#{idx}][branch_name]", value: share.branch_name }
       .notify.field
-        %input{ type: 'hidden',   value: '0', name: "share[#{idx}][notification]"}
+        %input{ type: 'hidden', value: '0', name: "share[#{idx}][notification]" }
         %input{ type: 'checkbox', value: '1', name: "share[#{idx}][notification]", checked: share.notification ? 'checked' : nil }
         %span Notifications?
       .delete
-        %a.remote_share.btn.danger{ href: url("/#{share.id}"), :'data-method' => 'delete' }
+        %a.remote_share.btn.danger{ href: url("/#{share.id}"), 'data-method' => 'delete' }
           Delete
 
   %input.btn.primary{ value: 'Save', type: 'submit' }

data/test/integration/cli/full_sync_test.rb

@@ -0,0 +1,83 @@
+# -*- encoding : utf-8 -*-
+
+require File.expand_path('../../test_helper', __FILE__)
+
+describe 'fully synchronizing repositories' do
+  before do
+    gitdocs_create_from_remote('clone1', 'clone2', 'clone3')
+    gitdocs_start
+  end
+
+  it 'should sync new files' do
+    GitFactory.write(:clone1, 'newfile', 'testing')
+    assert_clean(:clone1)
+
+    assert_file_content(:clone1, 'newfile', 'testing')
+    assert_file_content(:clone2, 'newfile', 'testing')
+    assert_file_content(:clone3, 'newfile', 'testing')
+  end
+
+  it 'should sync changes to an existing file' do
+    GitFactory.write(:clone1, 'file', 'testing')
+    assert_clean(:clone1)
+
+    assert_file_content(:clone3, 'file', 'testing')
+    GitFactory.append(:clone3, 'file', "\nfoobar")
+    assert_clean(:clone3)
+
+    assert_file_content(:clone1, 'file', "testing\nfoobar")
+    assert_file_content(:clone2, 'file', "testing\nfoobar")
+    assert_file_content(:clone3, 'file', "testing\nfoobar")
+  end
+
+  it 'should sync empty directories' do
+    GitFactory.mkdir(:clone1, 'empty_dir')
+    assert_clean(:clone1)
+
+    assert_file_exist(:clone1, 'empty_dir')
+    assert_file_exist(:clone2, 'empty_dir')
+    assert_file_exist(:clone3, 'empty_dir')
+  end
+
+  it 'should mark unresolvable conflicts' do
+    # HACK: This scenario is so dependent upon timing, that is does not run
+    # reliably on TravisCI, even when it is passing locally.
+    # So skip it.
+    next if ENV['TRAVIS']
+
+    GitFactory.write(:clone1, 'file', 'testing')
+    assert_clean(:clone1)
+
+    GitFactory.append(:clone2, 'file', 'foobar')
+    GitFactory.append(:clone3, 'file', 'deadbeef')
+    assert_clean(:clone2)
+    assert_clean(:clone3)
+
+    %w(clone2 clone3 clone1).each do |repo_name|
+      assert_file_exist(repo_name, 'file (9a2c773)')
+      assert_file_exist(repo_name, 'file (f6ea049)')
+      assert_file_exist(repo_name, 'file (e8b5f82)')
+    end
+  end
+end
+
+################################################################################
+
+# @param (see GitInspector.clean?)
+def assert_clean(repo_name)
+  wait_for_assert { GitInspector.clean?(repo_name).must_equal(true) }
+end
+
+# @param [#to_s] repo_name
+# @param [String] filename
+# @param [String] content
+def assert_file_content(repo_name, filename, content)
+  wait_for_assert do
+    GitInspector.file_content(repo_name, filename).must_equal(content)
+  end
+end
+
+# @param (see GitInspector.file_exist?)
+def assert_file_exist(repo_name, filename)
+  wait_for_assert { GitInspector.file_exist?(repo_name, filename).must_equal(true) }
+end

data/test/integration/cli/share_management_test.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+
+require File.expand_path('../../test_helper', __FILE__)
+
+describe 'Manage which shares are being watched' do
+  it 'should add a local repository' do
+    gitdocs_add('local')
+    gitdocs_assert_status_contains('local')
+  end
+
+  it 'should add a remote repository' do
+    gitdocs_create_from_remote('local')
+  end
+
+  describe 'remove a share' do
+    before { gitdocs_add('local') }
+    it do
+      gitdocs_command('rm', 'local', 'Removed path local from doc list')
+      gitdocs_assert_status_not_contain('local')
+    end
+  end
+
+  it 'should clear all existing shares' do
+    %w(local1 local2 local3).each { |x| gitdocs_add(x) }
+
+    gitdocs_command('clear', '', 'Cleared paths from gitdocs')
+    gitdocs_assert_status_not_contain('local1', 'local2', 'local3')
+  end
+end

data/test/integration/cli/status_test.rb

@@ -0,0 +1,14 @@
+# -*- encoding : utf-8 -*-
+
+require File.expand_path('../../test_helper', __FILE__)
+
+describe 'CLI with display daemon and share status' do
+  it 'should display information about the daemon' do
+    gitdocs_assert_status_contains('Running: false')
+  end
+
+  it 'should display information about the shares' do
+    gitdocs_create_from_remote('clone1', 'clone2', 'clone3')
+    gitdocs_assert_status_contains('clone1', 'clone2', 'clone3')
+  end
+end