gitdocs 0.5.0.pre1 → 0.5.0.pre2

data/lib/gitdocs/runner.rb

@@ -1,9 +1,5 @@
 module Gitdocs
   class Runner
-    include ShellTools
-
-    attr_reader :root, :listener
-
     def self.start_all(shares)
       runners = shares.map { |share| Runner.new(share) }
       runners.each(&:run)
@@ -12,40 +8,23 @@ module Gitdocs
 
     def initialize(share)
       @share = share
-      @root  = share.path.sub(%r{/+$}, '') if share.path
       @polling_interval = share.polling_interval
-      @icon = File.expand_path('../../img/icon.png', __FILE__)
+      @notifier         = Gitdocs::Notifier.new(@share.notification)
+      @repository       = Gitdocs::Repository.new(share)
     end
 
-    SearchResult = Struct.new(:file, :context)
-    def search(term)
-      return [] if term.empty?
-
-      results = []
-      if result_test = sh_string("git grep -i #{ShellTools.escape(term)}")
-        result_test.scan(/(.*?):([^\n]*)/) do |(file, context)|
-          if result = results.find { |s| s.file == file }
-            result.context += ' ... ' + context
-          else
-            results << SearchResult.new(file, context)
-          end
-        end
-      end
-      results
+    def root
+      @repository.root
     end
 
     def run
-      return false unless self.valid?
+      return false unless @repository.valid?
 
-      @show_notifications = @share.notification
-      @current_remote     = @share.remote_name
-      @current_branch     = @share.branch_name
-      @current_revision   = sh_string('git rev-parse HEAD')
-      Guard::Notifier.turn_on if @show_notifications
+      @last_synced_revision = @repository.current_oid
 
       mutex = Mutex.new
 
-      info('Running gitdocs!', "Running gitdocs in `#{@root}'")
+      @notifier.info('Running gitdocs!', "Running gitdocs in '#{root}'")
 
       # Pull changes from remote repository
       syncer = proc do
@@ -61,7 +40,7 @@ module Gitdocs
       # Listen for changes in local repository
 
       EM.defer(proc do
-        listener = Guard::Listener.select_and_init(@root, watch_all_modifications: true)
+        listener = Guard::Listener.select_and_init(root, watch_all_modifications: true)
         listener.on_change do |directories|
           directories.uniq!
           directories.delete_if { |d| d =~ /\/\.git/ }
@@ -82,192 +61,90 @@ module Gitdocs
     end
 
     def sync_changes
-      out, status = sh_with_code("git fetch --all && git merge #{@current_remote}/#{@current_branch}")
-      if status.success?
-        changes = get_latest_changes
-        unless changes.empty?
-          author_list = changes.reduce(Hash.new { |h, k| h[k] = 0 }) { |h, c| h[c['author']] += 1; h }.to_a.sort { |a, b| b[1] <=> a[1] }.map { |(name, count)| "* #{name} (#{count} change#{count == 1 ? '' : 's'})" }.join("\n")
-          info("Updated with #{changes.size} change#{changes.size == 1 ? '' : 's'}", "In `#{@root}':\n#{author_list}")
-        end
-        push_changes
-      elsif out[/CONFLICT/]
-        conflicted_files = sh('git ls-files -u --full-name -z').split("\0")
-          .reduce(Hash.new { |h, k| h[k] = [] }) do|h, line|
-            parts = line.split(/\t/)
-            h[parts.last] << parts.first.split(/ /)
-            h
-          end
-        warn('There were some conflicts', "#{conflicted_files.keys.map { |f| "* #{f}" }.join("\n")}")
-        conflicted_files.each do |conflict, ids|
-          conflict_start, conflict_end = conflict.scan(/(.*?)(|\.[^\.]+)$/).first
-          ids.each do |(mode, sha, id)|
-            author =  ' original' if id == '1'
-            system("cd #{@root} && git show :#{id}:#{conflict} > '#{conflict_start} (#{sha[0..6]}#{author})#{conflict_end}'")
-          end
-          system("cd #{@root} && git rm #{conflict}") || fail
-        end
-        push_changes
-      elsif sh_string('git remote').nil? # no remote to pull from
-        # Do nothing, no remote repo yet
-      else
-        error('There was a problem synchronizing this gitdoc', "A problem occurred in #{@root}:\n#{out}")
-      end
-    end
+      result = @repository.pull
 
-    def push_changes
-      message_file = File.expand_path('.gitmessage~', @root)
-      if File.exist? message_file
-        message = File.read message_file
-        File.delete message_file
-      else
-        message = 'Auto-commit from gitdocs'
-      end
-      sh 'find . -type d -regex ``./[^.].*'' -empty -exec touch \'{}/.gitignore\' \;'
-      sh 'git add .'
-      sh "git commit -a -m #{ShellTools.escape(message)}" unless sh('git status -s').strip.empty?
-      if @current_revision.nil? || sh('git status')[/branch is ahead/]
-        out, code = sh_with_code("git push #{@current_remote} #{@current_branch}")
-        if code.success?
-          changes = get_latest_changes
-          info("Pushed #{changes.size} change#{changes.size == 1 ? '' : 's'}", "`#{@root}' has been pushed")
-        elsif @current_revision.nil?
-          # ignorable
-        elsif out[/\[rejected\]/]
-          warn("There was a conflict in #{@root}, retrying", '')
-        else
-          error("BAD Could not push changes in #{@root}", out)
-          # TODO: need to add a status on shares so that the push problem can be
-          # displayed.
-        end
-      end
-    rescue
-      # Rescue any standard exceptions which come from the push related
-      # commands. This will prevent problems on a single share from killing
-      # the entire daemon.
-      error("Unexpected error pushing changes in #{@root}")
-      # TODO: get logging and/or put the error message into a status field in the database
-    end
+      return if result.nil? || result == :no_remote
 
-    def get_latest_changes
-      if @current_revision
-        out = sh "git log #{@current_revision}.. --pretty='format:{\"commit\": \"%H\",%n  \"author\": \"%an <%ae>\",%n  \"date\": \"%ad\",%n  \"message\": \"%s\"%n}'"
-        if out.empty?
-          []
-        else
-          lines = []
-          Yajl::Parser.new.parse(out) do |obj|
-            lines << obj
-          end
-          @current_revision = sh('git rev-parse HEAD').strip
-          lines
-        end
-      else
-        []
+      if result.kind_of?(String)
+        @notifier.error(
+          'There was a problem synchronizing this gitdoc',
+          "A problem occurred in #{root}:\n#{result}"
+        )
+        return
       end
-    end
 
-    IGNORED_FILES = ['.gitignore']
-    # Returns the list of files in a given directory
-    # dir_files("some/dir") => [<Docfile>, <Docfile>]
-    def dir_files(dir_path)
-      Dir[File.join(dir_path, '*')].to_a.map { |path| Docfile.new(path) }
-    end
-
-    # Returns file meta data based on relative file path
-    # file_meta("path/to/file")
-    #  => { :author => "Nick", :size => 1000, :modified => ... }
-    def file_meta(file)
-      file = file.gsub(%r{^/}, '')
-      full_path = File.expand_path(file, @root)
-      log_result = sh_string("git log --format='%aN|%ai' -n1 #{ShellTools.escape(file)}")
-      author, modified = log_result.split('|')
-      modified = Time.parse(modified.sub(' ', 'T')).utc.iso8601
-      size = if File.directory?(full_path)
-        Dir[File.join(full_path, '**', '*')].reduce(0) do |size, file|
-          File.symlink?(file) ? size : size += File.size(file)
+      if result == :ok
+        author_change_count = latest_author_count
+        unless author_change_count.empty?
+          author_list = author_change_count.map { |author, count| "* #{author} (#{change_count(count)})" }.join("\n")
+          @notifier.info(
+            "Updated with #{change_count(author_change_count)}",
+            "In '#{root}':\n#{author_list}"
+          )
         end
       else
-        File.symlink?(full_path) ? 0 : File.size(full_path)
+        #assert result.kind_of?(Array)
+        @notifier.warn(
+          'There were some conflicts',
+          result.map { |f| "* #{f}" }.join("\n")
+        )
       end
-      size = -1 if size == 0 # A value of 0 breaks the table sort for some reason
 
-      { author: author, size: size, modified: modified }
+      push_changes
     end
 
-    # Returns the revisions available for a particular file
-    # file_revisions("README")
-    def file_revisions(file)
-      file = file.gsub(%r{^/}, '')
-      output = sh_string("git log --format='%h|%s|%aN|%ai' -n100 #{ShellTools.escape(file)}")
-      output.to_s.split("\n").map do |log_result|
-        commit, subject, author, date = log_result.split('|')
-        date = Time.parse(date.sub(' ', 'T')).utc.iso8601
-        { commit: commit, subject: subject, author: author, date: date }
+    def push_changes
+      message_file = File.expand_path('.gitmessage~', root)
+      if File.exist?(message_file)
+        message = File.read(message_file)
+        File.delete(message_file)
+      else
+        message = 'Auto-commit from gitdocs'
       end
-    end
 
-    # Returns the temporary path of a particular revision of a file
-    # file_revision_at("README", "a4c56h") => "/tmp/some/path/README"
-    def file_revision_at(file, ref)
-      file = file.gsub(%r{^/}, '')
-      content = sh_string("git show #{ref}:#{ShellTools.escape(file)}")
-      tmp_path = File.expand_path(File.basename(file), Dir.tmpdir)
-      File.open(tmp_path, 'w') { |f| f.puts content }
-      tmp_path
-    end
+      result = @repository.push(@last_synced_revision, message)
 
-    # Revert a file to a particular revision
-    def file_revert(file, ref)
-      if file_revisions(file).map { |r| r[:commit] }.include? ref
-        file = file.gsub(%r{^/}, '')
-        full_path = File.expand_path(file, @root)
-        content = File.read(file_revision_at(file, ref))
-        File.open(full_path, 'w') { |f| f.puts content }
+      return if result.nil? || result == :no_remote || result == :nothing
+      level, title, message = case result
+      when :ok       then [:info, "Pushed #{change_count(latest_author_count)}", "'#{root}' has been pushed"]
+      when :conflict then [:warn, "There was a conflict in #{root}, retrying", '']
+      else
+        # assert result.kind_of?(String)
+        [:error, "BAD Could not push changes in #{root}", result]
+        # TODO: need to add a status on shares so that the push problem can be
+        # displayed.
       end
+      @notifier.send(level, title, message)
+    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.
+      @notifier.error("Unexpected error pushing changes in #{root}", "#{e}")
+      # TODO: get logging and/or put the error message into a status field in the database
     end
 
-    def valid?
-      out, status = sh_with_code 'git status'
-      @root.present? && status.success?
-    end
+    ############################################################################
+    private
 
-    def warn(title, msg)
-      if @show_notifications
-        Guard::Notifier.notify(msg, title: title)
-      else
-        Kernel.warn("#{title}: #{msg}")
-      end
-    rescue # Prevent StandardErrors from stopping the daemon.
-    end
+    # Update the author count for the last synced changes, and then update the
+    # last synced revision id.
+    #
+    # @return [Hash<String,Int>]
+    def latest_author_count
+      last_oid = @last_synced_revision
+      @last_synced_revision = @repository.current_oid
 
-    def info(title, msg)
-      if @show_notifications
-        Guard::Notifier.notify(msg, title: title, image: @icon)
-      else
-        puts("#{title}: #{msg}")
-      end
-    rescue # Prevent StandardErrors from stopping the daemon.
+      @repository.author_count(last_oid)
     end
 
-    def error(title, msg)
-      if @show_notifications
-        Guard::Notifier.notify(msg, title: title, image: :failure)
+    def change_count(count_or_hash)
+      count = if count_or_hash.respond_to?(:values)
+        count_or_hash .values.reduce(:+)
       else
-        Kernel.warn("#{title}: #{msg}")
+        count_or_hash
       end
-    rescue # Prevent StandardErrors from stopping the daemon.
-    end
-
-    # sh_string("git config branch.`git branch | grep '^\*' | sed -e 's/\* //'`.remote", "origin")
-    def sh_string(cmd, default = nil)
-      val = sh(cmd).strip rescue nil
-      val.nil? || val.empty? ? default : val
-    end
 
-    # Run in shell, return both status and output
-    # @see #sh
-    def sh_with_code(cmd)
-      ShellTools.sh_with_code(cmd, @root)
+      "#{count} change#{count == 1 ? '' : 's'}"
     end
   end
 end

data/lib/gitdocs/server.rb

@@ -8,15 +8,15 @@ require 'launchy'
 
 module Gitdocs
   class Server
-    def initialize(manager, port = 8888, *gitdocs)
-      @manager = manager
-      @port    = port.to_i
-      @gitdocs = gitdocs
+    def initialize(manager, port = 8888, repositories)
+      @manager      = manager
+      @port         = port.to_i
+      @repositories = repositories
     end
 
     def start
-      gds     = @gitdocs
-      manager = @manager
+      repositories = @repositories
+      manager      = @manager
       Thin::Logging.debug = @manager.debug
       Thin::Server.start('127.0.0.1', @port) do
         use Rack::Static, urls: ['/css', '/js', '/img', '/doc'], root: File.expand_path('../public', __FILE__)
@@ -49,7 +49,7 @@ module Gitdocs
             end
 
             path('search').get do
-              render! 'search', layout: 'app', locals: { conf: manager.config, results: manager.search(request.GET['q']), nav_state: nil }
+              render! 'search', layout: 'app', locals: { conf: manager.config, results: Gitdocs::Repository.search(request.GET['q'], repositories), nav_state: nil }
             end
 
             path('shares') do
@@ -69,20 +69,21 @@ module Gitdocs
             end
 
             var :int do |idx|
-              gd = gds[idx]
-              halt 404 if gd.nil?
+              repository = repositories[idx]
+
+              halt 404 if repository.nil?
               file_path = URI.unescape(request.path_info)
-              expanded_path = File.expand_path(".#{file_path}", gd.root)
-              message_file = File.expand_path('.gitmessage~', gd.root)
-              halt 400 unless expanded_path[/^#{Regexp.quote(gd.root)}/]
+              expanded_path = File.expand_path(".#{file_path}", repository.root)
+              message_file = File.expand_path('.gitmessage~', repository.root)
+              halt 400 unless expanded_path[/^#{Regexp.quote(repository.root)}/]
               parent = File.dirname(file_path)
               parent = '' if parent == '/'
               parent = nil if parent == '.'
-              locals = { idx: idx, parent: parent, root: gd.root, file_path: expanded_path, nav_state: nil }
+              locals = { idx: idx, parent: parent, root: repository.root, file_path: expanded_path, nav_state: nil }
               mime = File.mime_type?(File.open(expanded_path)) if File.file?(expanded_path)
               mode = request.params['mode']
               if mode == 'meta' # Meta
-                halt 200, { 'Content-Type' => 'application/json' }, [gd.file_meta(file_path).to_json]
+                halt 200, { 'Content-Type' => 'application/json' }, [repository.file_meta(file_path).to_json]
               elsif mode == 'save' # Saving
                 File.open(expanded_path, 'w') { |f| f.print request.params['data'] }
                 File.open(message_file, 'w') { |f| f.print request.params['message'] } unless request.params['message'] == ''
@@ -100,19 +101,19 @@ module Gitdocs
                 FileUtils.mkdir_p(expanded_path)
                 redirect!  '/' + idx.to_s + file_path
               elsif File.directory?(expanded_path) # list directory
-                contents =  gd.dir_files(expanded_path)
+                contents =  Dir[File.join(expanded_path, '*')].map { |x| Docfile.new(x) }
                 rendered_readme = nil
                 if readme = Dir[File.expand_path('README.{md}', expanded_path)].first
                   rendered_readme = '<h3>' + File.basename(readme) + '</h3><div class="tilt">' + render(readme) + '</div>'
                 end
                 render! 'dir', layout: 'app', locals: locals.merge(contents: contents, rendered_readme: rendered_readme)
               elsif mode == 'revisions' # list revisions
-                revisions = gd.file_revisions(file_path)
+                revisions = repository.file_revisions(file_path)
                 render! 'revisions', layout: 'app', locals: locals.merge(revisions: revisions)
               elsif mode == 'revert' # revert file
                 if revision = request.params['revision']
                   File.open(message_file, 'w') { |f| f.print "Reverting '#{file_path}' to #{revision}" }
-                  gd.file_revert(file_path, revision)
+                  repository.file_revert(file_path, revision)
                 end
                 redirect! '/' + idx.to_s + file_path
               elsif mode == 'delete' # delete file
@@ -123,7 +124,7 @@ module Gitdocs
                 render! 'edit', layout: 'app', locals: locals.merge(contents: contents)
               elsif mode != 'raw' # render file
                 revision = request.params['revision']
-                expanded_path = gd.file_revision_at(file_path, revision) if revision
+                expanded_path = repository.file_revision_at(file_path, revision) if revision
                 begin # attempting to render file
                   contents = '<div class="tilt">' + render(expanded_path) + '</div>'
                 rescue RuntimeError # not tilt supported
@@ -135,7 +136,7 @@ module Gitdocs
                 end
                 render! 'file', layout: 'app', locals: locals.merge(contents: contents)
               else # other file
-                run! Rack::File.new(gd.root)
+                run! Rack::File.new(repository.root)
               end
             end
           end
@@ -151,9 +152,6 @@ module Gitdocs
         begin
           TCPSocket.open('127.0.0.1', @port).close
           @manager.log('Web server running!')
-          if !restarting && @manager.config.global.load_browser_on_startup
-            Launchy.open("http://localhost:#{@port}/")
-          end
         rescue Errno::ECONNREFUSED
           sleep 0.2
           i += 1

data/lib/gitdocs/version.rb

@@ -1,3 +1,3 @@
 module Gitdocs
-  VERSION = '0.5.0.pre1'
+  VERSION = '0.5.0.pre2'
 end

data/lib/gitdocs/views/settings.haml

@@ -25,12 +25,12 @@
         %dd
           %input{:name=>"share[#{idx}][polling_interval]", :value => share.polling_interval}
 
-      - if share.available_remotes
+      - if Gitdocs::Repository.new(share).available_remotes
         %dl
           %dt Remote
           %dd
             %select{:name=>"share[#{idx}][remote_branch]"}
-              - share.available_remotes.each do |remote|
+              - Gitdocs::Repository.new(share).available_remotes.each do |remote|
                 %option{:value => remote, :selected => remote == "#{share.remote_name}/#{share.branch_name}" ? 'selected' : nil}
                   = remote
       - else
@@ -52,4 +52,4 @@
           Delete
 
   %input{:value => 'Save', :type => 'submit', :class => "btn primary" }
-  %a{ :class => "btn secondary new-share", :href => "/shares", :"data-method" => "post" } Add Share
+  %a{ :class => "btn secondary new-share", :href => "/shares", :"data-method" => "post" } Add Share