gitdocs 0.5.0.pre6 → 0.5.0.pre7

data/lib/gitdocs/manager.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 module Gitdocs
   Restart = Class.new(RuntimeError)
 
@@ -14,44 +16,27 @@ module Gitdocs
     def start(web_port = nil)
       log("Starting Gitdocs v#{VERSION}...")
       log("Using configuration root: '#{config.config_root}'")
-      log("Shares: (#{config.shares.length}) #{config.shares.map(&:inspect).join(', ')}")
+      log("Shares: (#{shares.length}) #{shares.map(&:inspect).join(', ')}")
 
-      restarting = false
       begin
         EM.run do
           log('Starting EM loop...')
 
-          @runners = Runner.start_all(config.shares)
-
-          # Start the web front-end
-          if config.global.start_web_frontend
-            web_port ||= config.global.web_frontend_port
-            repositories = config.shares.map { |x| Repository.new(x) }
-            web_server = Server.new(self, web_port, repositories)
-            web_server.start
-            web_server.wait_for_start_and_open(restarting)
-          end
+          @runners = Runner.start_all(shares)
+          repositories = shares.map { |x| Repository.new(x) }
+          Server.start_and_wait(self, web_port, repositories)
         end
       rescue Restart
-        restarting = true
         retry
       end
-    rescue Exception => e # Report all errors in log
-      log(e.class.inspect + ' - ' + e.inspect + ' - ' + e.message.inspect, :error)
+    rescue Exception => e # rubocop:disable RescueException
+      # Report all errors in log
+      log("#{e.class.inspect} - #{e.inspect} - #{e.message.inspect}", :error)
       log(e.backtrace.join("\n"), :error)
-
-      # HACK: duplicating the error notification code from the Runner
-      begin
-        title = 'Unexpected exit'
-        msg   = 'Something went wrong. Please see the log for details.'
-
-        Guard::Notifier.notify(msg, title: title, image: :failure)
-        Kernel.warn("#{title}: #{msg}")
-      rescue
-        # do nothing, This contain any exceptions which might be thrown by
-        # the notification.
-      end
-
+      Gitdocs::Notifier.error(
+        'Unexpected exit',
+        'Something went wrong. Please see the log for details.'
+      )
       raise
     ensure
       log("Gitdocs is terminating...goodbye\n\n")
@@ -74,5 +59,28 @@ module Gitdocs
     def log(msg, level = :info)
       @debug ? puts(msg) : @logger.send(level, msg)
     end
+
+    def start_web_frontend
+      config.start_web_frontend
+    end
+
+    def web_frontend_port
+      config.web_frontend_port
+    end
+
+    def shares
+      config.shares
+    end
+
+    # @see Gitdocs::Configuration#update_all
+    def update_all(new_config)
+      config.update_all(new_config)
+      EM.add_timer(0.1) { restart }
+    end
+
+    # @see Gitdocs::Configuration#remove_by_id
+    def remove_by_id(id)
+      config.remove_by_id(id)
+    end
   end
 end

data/lib/gitdocs/migration/001_create_shares.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 class CreateShares < ActiveRecord::Migration
   def self.up
     create_table :shares do |t|

data/lib/gitdocs/migration/002_add_remote_branch.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 class AddRemoteBranch < ActiveRecord::Migration
   def self.up
     add_column :shares, :remote_name, :string, default: 'origin'

data/lib/gitdocs/migration/003_create_configs.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 class CreateConfigs < ActiveRecord::Migration
   def self.up
     create_table :configs do |t|

data/lib/gitdocs/migration/004_add_index_for_path.rb

@@ -1,3 +1,7 @@
+# -*- encoding : utf-8 -*-
+
+# rubocop:disable all
+
 class AddIndexForPath < ActiveRecord::Migration
   def self.up
     shares = Gitdocs::Configuration::Share.all.reduce(Hash.new { |h, k| h[k] = [] }) { |h, s| h[s.path] << s; h }

data/lib/gitdocs/migration/005_add_start_web_frontend.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 class AddStartWebFrontend < ActiveRecord::Migration
   def self.up
     add_column :configs, :start_web_frontend, :boolean, default: true

data/lib/gitdocs/migration/006_add_web_port_to_config.rb

@@ -1,3 +1,5 @@
+# -*- encoding : utf-8 -*-
+
 class AddWebPortToConfig < ActiveRecord::Migration
   def self.up
     add_column :configs, :web_frontend_port, :integer, default: 8888

data/lib/gitdocs/migration/007_add_sync_type.rb

@@ -0,0 +1,11 @@
+# -*- encoding : utf-8 -*-
+
+class AddSyncType < ActiveRecord::Migration
+  def self.up
+    add_column :shares, :sync_type, :string, default: 'full'
+  end
+
+  def self.down
+    fail
+  end
+end

data/lib/gitdocs/notifier.rb

@@ -4,35 +4,118 @@
 class Gitdocs::Notifier
   INFO_ICON = File.expand_path('../../img/icon.png', __FILE__)
 
+  # Wrapper around #error for a single call to the notifier.
+  # @param (see #error)
+  def self.error(title, message)
+    Gitdocs::Notifier.new(true).error(title, message)
+  end
+
+  # @param [Boolean] show_notifications
   def initialize(show_notifications)
     @show_notifications = show_notifications
     Guard::Notifier.turn_on if @show_notifications
   end
 
+  # @param [String] title
+  # @param [String] message
   def info(title, message)
     if @show_notifications
       Guard::Notifier.notify(message, title: title, image: INFO_ICON)
     else
       puts("#{title}: #{message}")
     end
-  rescue # Prevent StandardErrors from stopping the daemon.
+  rescue # rubocop:disable Lint/HandleExceptions
+    # Prevent StandardErrors from stopping the daemon.
   end
 
-  def warn(title, msg)
+  # @param [String] title
+  # @param [String] message
+  def warn(title, message)
     if @show_notifications
-      Guard::Notifier.notify(msg, title: title)
+      Guard::Notifier.notify(message, title: title)
     else
-      Kernel.warn("#{title}: #{msg}")
+      Kernel.warn("#{title}: #{message}")
     end
-  rescue # Prevent StandardErrors from stopping the daemon.
+  rescue # rubocop:disable Lint/HandleExceptions
+    # Prevent StandardErrors from stopping the daemon.
   end
 
+  # @param [String] title
+  # @param [String] message
   def error(title, message)
     if @show_notifications
       Guard::Notifier.notify(message, title: title, image: :failure)
     else
       Kernel.warn("#{title}: #{message}")
     end
-  rescue # Prevent StandardErrors from stopping the daemon.
+  rescue # rubocop:disable Lint/HandleExceptions
+    # Prevent StandardErrors from stopping the daemon.
+  end
+
+  # @param [nil, Symbol, Array<String>, Hash<String => Integer>, #to_s] result
+  # @param [String] root
+  def merge_notification(result, root)
+    return if result.nil?
+    return if result == :no_remote
+    return if result == :ok
+    return if result == {}
+
+    if result.is_a?(Array)
+      warn(
+        'There were some conflicts',
+        result.map { |f| "* #{f}" }.join("\n")
+      )
+    elsif result.is_a?(Hash)
+      info(
+        "Updated with #{change_to_s(result)}",
+        "In #{root}:\n#{author_list(result)}"
+      )
+    else
+      error(
+        'There was a problem synchronizing this gitdoc',
+        "A problem occurred in #{root}:\n#{result}"
+      )
+    end
+  end
+
+  # @param [nil, Symbol, Hash<String => Integer>, #to_s] result push operation
+  # @param [String] root
+  def push_notification(result, root)
+    return if result.nil?
+    return if result == :no_remote
+    return if result == :nothing
+
+    if result == :conflict
+      warn("There was a conflict in #{root}, retrying", '')
+    elsif result.is_a?(Hash)
+      info("Pushed #{change_to_s(result)}", "#{root} has been pushed")
+    else
+      error("BAD Could not push changes in #{root}", result.to_s)
+    end
+  end
+
+  ##############################################################################
+
+  private
+
+  # @param [Hash<String => Integer>] changes
+  # @return [String]
+  def author_list(changes)
+    changes
+      .map { |author, count| "* #{author} (#{change_to_s(count)})" }
+      .join("\n")
+  end
+
+  # @param [Integer, Hash<String => Integer>] count_or_hash
+  # @return [String]
+  def change_to_s(count_or_hash)
+    count =
+      if count_or_hash.respond_to?(:values)
+        count_or_hash.values.reduce(:+)
+      else
+        count_or_hash
+      end
+
+    "#{count} change#{count == 1 ? '' : 's'}"
   end
 end

data/lib/gitdocs/public/js/app.js

@@ -2,9 +2,9 @@ GitDocs = {
   // Links all breadcrumb options in the explored path
   linkBreadcrumbs : function() {
     var fullPath = $('span.path').text().replace(/\/+/g, '/').replace(/\/$/, '');
-    if (fullPath.length == 0) { return; }
+    if (fullPath.length === 0) { return; }
     var docIdx = window.location.pathname.match(/\/(\d+)/);
-    if (!docIdx) return false;
+    if (!docIdx) { return false; }
     var paths = fullPath.split("/");
     $(paths).each(function(idx, subpath) {
       var relPath = paths.slice(0, idx+1).join("/");
@@ -17,7 +17,7 @@ GitDocs = {
   fillDirMeta : function(){
     $('table#fileListing tbody tr').each(function(i, e) {
       var file = $(e).find('a').attr('href');
-      var fileListingBody = $('table#fileListing tbody')
+      var fileListingBody = $('table#fileListing tbody');
       $.getJSON(file + "?mode=meta", function(data) {
         $(e).addClass('loaded').find('td.author').html(data.author);
         $(e).find('td.modified').html(RelativeDate.time_ago_in_words(data.modified));
@@ -31,22 +31,26 @@ GitDocs = {
   // Fire when the page is finished loading
   pageLoaded : function() {
     // Enable table sorter
-    var extractor = function(e) { return $(e).data('val') || $(e).text() }
+    var extractor = function(e) { return $(e).data('val') || $(e).text(); };
     $("table#fileListing").tablesorter({ textExtraction : extractor, sortList: [[0,0]] });
   },
   // Displays a closeable alert within the content pane
   // Gitdocs.showAlert('This is the message', 'success')
   showAlert : function(body, result) {
-    if (result == null) result = 'info';
+    if (result === null) { result = 'info'; }
     $('.content div.alert-message').remove();
-    var el = $('.content').prepend('<div class="alert-message ' + result +
-      '"><a class="close" href="#">×</a>' + body + '</div>');
+    var el = $('.content').prepend(
+      '<div class="alert-message ' + result + '">'
+      + '<a class="close" href="#">×</a>'
+      + body
+      + '</div>'
+    );
     $('div.alert-message').alert();
   },
   // converts iso8601 dates tagged with .reldate to relative
   convertRelativeTimes : function() {
     $('.reldate').each(function(ind, el) {
-      if ($(el).data("iso")) return;
+      if ($(el).data("iso")) { return; }
       var iso = $(el).text();
       $(el).data("iso", iso);
       $(el).text(RelativeDate.time_ago_in_words(iso));
@@ -54,7 +58,8 @@ GitDocs = {
   },
   activateTabs : function() {
     $('ul.tabs li a').each(function() {
-      if (($(this).attr('href') == location.pathname && location.search == '') || $(this).attr('href') == location.search) {
+      var href = $(this).attr('href');
+      if ((href === location.pathname && location.search === '') || href === location.search) {
         $(this).parent().addClass('active');
       }
     });
@@ -76,7 +81,7 @@ $('form.add').live('submit', function(e){
 
 $('form.add input.file').live('click', function(e) {
   var docIdx = window.location.pathname.match(/\/(\d+)/);
-  if (!docIdx) return false;
+  if (!docIdx) { return false; }
   var fullPath = $('span.path').text();
   var newPath = "/" + docIdx[1] + (fullPath == "/" ? "/" : fullPath + "/") + $(this).parents('form').find('input.edit').val();
   window.location = newPath;
@@ -85,7 +90,7 @@ $('form.add input.file').live('click', function(e) {
 
 $('form.add input.directory').live('click', function(e) {
   var docIdx = window.location.pathname.match(/\/(\d+)/);
-  if (!docIdx) return false;
+  if (!docIdx) { return false; }
   var fullPath = $('span.path').text();
   var newPath = "/" + docIdx[1] + (fullPath == "/" ? "/" : fullPath + "/") + $(this).parents('form').find('input.edit').val() + '?dir=true';
   window.location = newPath;
@@ -105,3 +110,13 @@ $('a[data-method]').live('click', function(e) {
   form.hide().append(metadata_input).appendTo('body');
   form.submit();
 });
+
+// Deletion tab
+$('ul.tabs a.delete').live('click', function(e) {
+  return confirm('Are you sure?')
+});
+
+// Revert a revision from the revision table
+$('#revisions td.revert a').live('click', function(e) {
+  return confirm('Are you sure?')
+});

data/lib/gitdocs/public/js/edit.js

@@ -21,10 +21,10 @@ $(document).ready(function() {
 
   // Apply code highlighting mode based on map
   $.each(langMap, function(ext, name) {
-    if (filename.match(ext)) { editor.getSession().setMode(new langMode[name]); }
+    if (filename.match(ext)) { editor.getSession().setMode(new langMode[name]()); }
   });
 
   // Display ace editor
   $('form.edit').show().find('#editor').show();
-  editor.focus()
-});
+  editor.focus();
+});

data/lib/gitdocs/public/js/settings.js

@@ -6,13 +6,16 @@ GitDocs.settings = {
       $.ajax({
         type: 'POST', url: this.action, data: $(this).serialize(),
         success: function() {
-          GitDocs.showAlert('<p><strong>Settings saved!</strong> Gitdocs has been restarted with your new settings.</p>', 'success')
+          GitDocs.showAlert(
+            '<p><strong>Settings saved!</strong> Gitdocs has been restarted with your new settings.</p>',
+            'success'
+          );
         }
       });
       return false;
     });
   }
-}
+};
 
 $(document).ready(function() {
   GitDocs.settings.observeSettingsForm();
@@ -20,6 +23,6 @@ $(document).ready(function() {
 
 // Handle delete for settings form
 $('input.remove_share').live('click', function(e){
-  $(this).siblings("input[type=hidden]").val("true")
-  $(this).parents("form").submit()
-});
+  $(this).siblings("input[type=hidden]").val("true");
+  $(this).parents("form").submit();
+});

data/lib/gitdocs/public/js/util.js

@@ -16,7 +16,7 @@ Utils = {
   },
   // humanizeBytes(1234)
   humanizeBytes : function(filesize) {
-    if (filesize == null || filesize <= 0 || filesize == "") { return "&mdash;" }
+    if (filesize === null || filesize <= 0 || filesize === "") { return "&mdash;"; }
     if (filesize >= 1073741824) {
          filesize = Utils.number_format(filesize / 1073741824, 2, '.', '') + ' Gb';
     } else {
@@ -27,16 +27,16 @@ Utils = {
           filesize = Utils.number_format(filesize / 1024, 0) + ' Kb';
         } else {
           filesize = Utils.number_format(filesize, 0) + ' bytes';
-        };
-      };
-    };
+        }
+      }
+    }
     return filesize;
   },
   number_format : function( number, decimals, dec_point, thousands_sep ) {
       var n = number, c = isNaN(decimals = Math.abs(decimals)) ? 2 : decimals;
-      var d = dec_point == undefined ? "," : dec_point;
-      var t = thousands_sep == undefined ? "." : thousands_sep, s = n < 0 ? "-" : "";
-      var i = parseInt(n = Math.abs(+n || 0).toFixed(c)) + "", j = (j = i.length) > 3 ? j % 3 : 0;
+      var d = dec_point === undefined ? "," : dec_point;
+      var t = thousands_sep === undefined ? "." : thousands_sep, s = n < 0 ? "-" : "";
+      var i = parseInt(n = Math.abs(+n || 0).toFixed(c), 10) + "", j = (j = i.length) > 3 ? j % 3 : 0;
       return s + (j ? i.substr(0, j) + t : "") + i.substr(j).replace(/(\d{3})(?=\d)/g, "$1" + t) + (c ? d + Math.abs(n - i).toFixed(c).slice(2) : "");
   }
 };
@@ -62,7 +62,7 @@ StringFormatter = {
 // RelativeDate.time_ago_in_words(date)
 var RelativeDate = {
   time_ago_in_words: function(from) {
-          return RelativeDate.distance_of_time_in_words(new Date, RelativeDate.parseISO8601(from));
+          return RelativeDate.distance_of_time_in_words(new Date(), RelativeDate.parseISO8601(from));
 
   },
   distance_of_time_in_words: function(to, from) {
@@ -91,7 +91,7 @@ var RelativeDate = {
    timeSubParts = timeParts[0].split(':'),
    timeSecParts = timeSubParts[2].split('.'),
    timeHours = Number(timeSubParts[0]),
-   _date = new Date;
+   _date = new Date();
 
    _date.setUTCFullYear(Number(dateParts[0]));
    _date.setUTCMonth(Number(dateParts[1])-1);
@@ -99,41 +99,42 @@ var RelativeDate = {
    _date.setUTCHours(Number(timeHours));
    _date.setUTCMinutes(Number(timeSubParts[1]));
    _date.setUTCSeconds(Number(timeSecParts[0]));
-   if (timeSecParts[1]) _date.setUTCMilliseconds(Number(timeSecParts[1]));
+   if (timeSecParts[1]) { _date.setUTCMilliseconds(Number(timeSecParts[1])); }
 
    // by using setUTC methods the date has already been converted to local time(?)
    return _date;
   },
   humanize : function(str, shortened) {
-    var parts = str.split('T')[0].split('-')
-    var humDate = new Date;
+    var parts = str.split('T')[0].split('-');
+    var humDate = new Date();
 
     humDate.setFullYear(Number(parts[0]));
     humDate.setMonth(Number(parts[1])-1);
     humDate.setDate(Number(parts[2]));
 
+    var day = "";
     switch(humDate.getDay())
     {
     case 0:
-      var day = "Sunday";
+      day = "Sunday";
       break;
     case 1:
-      var day = "Monday";
+      day = "Monday";
       break;
     case 2:
-      var day = "Tuesday";
+      day = "Tuesday";
       break;
     case 3:
-      var day = "Wednesday";
+      day = "Wednesday";
       break;
     case 4:
-      var day = "Thursday";
+      day = "Thursday";
       break;
     case 5:
-      var day = "Friday";
+      day = "Friday";
       break;
     case 6:
-      var day = "Saturday";
+      day = "Saturday";
       break;
     }
     if(shortened) {
@@ -142,4 +143,4 @@ var RelativeDate = {
       return day + ', ' + humDate.toLocaleDateString();
     }
   }
-};
+};