gitdocs 0.5.0.pre1 → 0.5.0.pre2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MThmNzE5OWRhMDk2OThhMTdlMmU2MWQ2YzhmY2RkZjUwODM5ZmI0NQ==
+    ZWNmOThmZjU3ZTIzNGE5ODQ3ZmM3YjEzODQ0NTNiZTgyODk5ZmQ4Ng==
   data.tar.gz: !binary |-
-    NTk2ZDg1ODhiMGNhYzI4NTJjYmU2NWU4ZDM0MDBhMzE4NjQzYWI2Mg==
+    MjBjMWEzNzQ5NTA0Y2Q5MzA0M2Q3MTlhMzE1YWE2OTViZWU1YTZhNg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MmY3NzdkYjQ1NzA0MjA0NGY4ZmRkZWE2NGQ2YWM2MTYzNDg0ZjdmYWU4MzJh
-    ODc5YmEyMDI0ZGE2YjY1ZDk4ZDI0MDAzZDg0MWU1YjNiMTAwOTZhOWE5NjNj
-    NWRiNDM4YjVkNTBlOGI2ZGVhZTU4MTFhNTg3MjA5NjZjMWVjZDA=
+    ZjU3NDJjNTQ3YTU4OGE1OTQzNDU5ZmYzMWRiZjU4MGE5MDY3NjQ5ZGIzOTNl
+    YjA3MDYzNjNkNTBlNmQ2OTcwYzg1ZDRlMTA2ODUwYmU2ZGVhMzM4Mzg2NGFm
+    YmNlMWJkYWY0NzEzZTgxOThmMWM4NTdmOTEyOGZhMTc5MDdlMzM=
   data.tar.gz: !binary |-
-    NDhjOGYxOGMwMzUxMDg5ZWQwZWQwNmVhYWIyOTBiNGZmNjFhNzI1ZGE0Mjkz
-    YjVhODlmNDRlZDIwM2Q4YjJiYWZkYTFkODNmY2IwM2NjOWVjMDYyZjRmOWFh
-    ZWYyMjdlOTBmM2RhNTY2MmQyZjQ4Y2ZhYWViY2JiZDEwNzcwMzM=
+    MjExM2Y3OGU1NDg0ODdhYzA1NDY5YWIxNTU0ZmRkMjY2MDNkZWI2MTk1NzFl
+    ZjVhZWRkYTYxY2MxZDRjMjhmMzU3OTRlMzhjZjkyNDQzYzI3M2JiMDYwNTgy
+    MDdhODZjOTEwODEzOTRmYzc4YTExZDZjYjJjZmQwNDRmNDMxZDc=

data/CHANGELOG

@@ -1,7 +1,11 @@
+0.5.0.pre2 (3/9/2014)
+
+ * Convert to use rugged and Grit (@acant)
+
 0.5.0.pre1 (11/25/2013)
 
- * Upgrade thin gem to v1.5.1 (Thanks @acant)
- * Add TravisCI configuration (Thanks @acant)
+ * Upgrade thin gem to v1.5.1 (@acant)
+ * Add TravisCI configuration (@acant)
  * Rescue StandardError and better error notifications to fix crashes (@acant)
  * Reduce unexpected exists caused by repository and file system errors
  * Add notification of unexpected daemon exist

data/README.md

@@ -176,6 +176,7 @@ We also have had several contributors:
   * [Chris Kempson](https://github.com/ChrisKempson) - Encoding issues
   * [Evan Tatarka](https://github.com/evant) - Front-end style fixes
   * [Kale Worsley](https://github.com/kaleworsley) - Custom commit msgs, revert revisions, front-end cleanup
+  * [Andrew Sullivan Cant](https://github.com/acant) - Major improvements, grit support, core contributor
 
 Gitdocs is still a young project with a lot of opportunity for contributions. Patches welcome!
 

data/gitdocs.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'joshbuddy-guard', '~> 0.10.0'
   s.add_dependency 'thin', '~> 1.5.1'
   s.add_dependency 'renee', '~> 0.3.11'
-  s.add_dependency 'redcarpet', '~> 2.0.0'
+  s.add_dependency 'redcarpet', '~> 3.1.1'
   s.add_dependency 'thor', '~> 0.14.6'
   s.add_dependency 'coderay', '~> 1.0.4'
   s.add_dependency 'dante', '~> 0.1.2'
@@ -37,10 +37,12 @@ Gem::Specification.new do |s|
   s.add_dependency 'mimetype-fu', "~> 0.1.2"
   s.add_dependency 'eventmachine', '>= 1.0.3'
   s.add_dependency 'launchy', '~> 2.4.2'
+  s.add_dependency 'rugged', '~> 0.19.0'
 
   s.add_development_dependency 'minitest', "~> 5.0.8"
   s.add_development_dependency 'rake'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'fakeweb'
   s.add_development_dependency 'metric_fu'
+  s.add_development_dependency 'aruba'
 end

data/lib/gitdocs.rb

@@ -4,6 +4,8 @@ require 'dante'
 require 'socket'
 require 'shell_tools'
 require 'guard'
+require 'grit'
+require 'rugged'
 
 require 'gitdocs/version'
 require 'gitdocs/configuration'
@@ -13,6 +15,8 @@ require 'gitdocs/cli'
 require 'gitdocs/manager'
 require 'gitdocs/docfile'
 require 'gitdocs/rendering'
+require 'gitdocs/notifier'
+require 'gitdocs/repository'
 
 module Gitdocs
   DEBUG = ENV['DEBUG']

data/lib/gitdocs/cli.rb

@@ -9,6 +9,7 @@ module Gitdocs
     desc 'start', 'Starts a daemonized gitdocs process'
     method_option :debug, type: :boolean, aliases: '-D'
     method_option :port, type: :string, aliases: '-p'
+    method_option :pid, type: :string, aliases: '-P'
     def start
       unless stopped?
         say 'Gitdocs is already running, please use restart', :red
@@ -28,6 +29,7 @@ module Gitdocs
       end
     end
 
+    method_option :pid, type: :string, aliases: '-P'
     desc 'stop', 'Stops the gitdocs process'
     def stop
       unless running?
@@ -39,12 +41,14 @@ module Gitdocs
       say 'Stopped gitdocs', :red
     end
 
+    method_option :pid, type: :string, aliases: '-P'
     desc 'restart', 'Restarts the gitdocs process'
     def restart
       stop
       start
     end
 
+    method_option :pid, type: :string, aliases: '-P'
     desc 'add PATH', 'Adds a path to gitdocs'
     def add(path)
       config.add_path(path)
@@ -52,6 +56,7 @@ module Gitdocs
       restart if running?
     end
 
+    method_option :pid, type: :string, aliases: '-P'
     desc 'rm PATH', 'Removes a path from gitdocs'
     def rm(path)
       config.remove_path(path)
@@ -65,14 +70,15 @@ module Gitdocs
       say 'Cleared paths from gitdocs'
     end
 
+    method_option :pid, type: :string, aliases: '-P'
     desc 'create PATH REMOTE', 'Creates a new gitdoc root based on an existing remote'
     def create(path, remote)
-      FileUtils.mkdir_p(File.dirname(path))
-      system("git clone -q #{remote} #{ShellTools.escape(path)}") || fail("Unable to clone into #{path}")
+      Gitdocs::Repository.clone(path, remote)
       add(path)
       say "Created #{path} path for gitdoc"
     end
 
+    method_option :pid, type: :string, aliases: '-P'
     desc 'status', 'Retrieve gitdocs status'
     def status
       say "GitDoc v#{VERSION}"
@@ -95,10 +101,10 @@ module Gitdocs
       Launchy.open("http://localhost:#{web_port}/")
     end
 
-    desc 'config', 'Configuration options for gitdocs'
-    def config
-      # TODO: make this work
-    end
+    # TODO: make this work
+    #desc 'config', 'Configuration options for gitdocs'
+    #def config
+    #end
 
     desc 'help', 'Prints out the help'
     def help(task = nil, subcommand = false)
@@ -113,7 +119,7 @@ module Gitdocs
           'gitdocs',
           debug:     false,
           daemonize: true,
-          pid_path:  pid_path
+          pid_path: pid_path
         )
       end
 
@@ -130,25 +136,20 @@ module Gitdocs
       end
 
       def pid_path
-        '/tmp/gitdocs.pid'
+        options[:pid] || '/tmp/gitdocs.pid'
       end
 
       # @return [Symbol] to indicate how the file system is being watched
       def file_system_watch_method
-        if Guard::Listener.mac?
-          begin
-            return :notification if Guard::Listener::Darwin.usable?
-          rescue NameError ; end
-        elsif Guard::Listener.linux?
-          begin
-            return :notification if Guard::Listener::Linux.usable?
-          rescue NameError ; end
-        elsif Guard::Listener.windows?
-          begin
-            return :notification if Guard::Listener::Windows.usable?
-          rescue NameError ; end
+        if Guard::Listener.mac? && Guard::Darwin.usable?
+          :notification
+        elsif Guard::Listener.linux? && Guard::Linux.usable?
+          :notification
+        elsif Guard::Listener.windows? && Guard::Windows.usable?
+          :notification
+        else
+          :polling
         end
-        :polling
       end
     end
   end

data/lib/gitdocs/configuration.rb

@@ -18,20 +18,6 @@ module Gitdocs
 
     class Share < ActiveRecord::Base
       attr_accessible :polling_interval, :path, :notification, :branch_name, :remote_name
-
-      def available_remotes
-        repo = Grit::Repo.new(path)
-        repo.remotes.map { |r| r.name }
-      rescue
-        nil
-      end
-
-      def available_branches
-        repo = Grit::Repo.new(path)
-        repo.heads.map { |r| r.name }
-      rescue
-        nil
-      end
     end
 
     class Config < ActiveRecord::Base

data/lib/gitdocs/manager.rb

@@ -11,18 +11,6 @@ module Gitdocs
       yield @config if block_given?
     end
 
-    RepoDescriptor = Struct.new(:name, :index)
-
-    def search(term)
-      results = {}
-      @runners.each_with_index do |runner, index|
-        descriptor = RepoDescriptor.new(runner.root, index)
-        repo_results = runner.search(term)
-        results[descriptor] = repo_results unless repo_results.empty?
-      end
-      results
-    end
-
     def start(web_port = nil)
       log("Starting Gitdocs v#{VERSION}...")
       log("Using configuration root: '#{config.config_root}'")
@@ -38,7 +26,8 @@ module Gitdocs
           # Start the web front-end
           if config.global.start_web_frontend
             web_port ||= config.global.web_frontend_port
-            web_server = Server.new(self, web_port, *@runners)
+            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

data/lib/gitdocs/notifier.rb

@@ -0,0 +1,38 @@
+# -*- encoding : utf-8 -*-
+
+# Wrapper for the UI notifier
+class Gitdocs::Notifier
+  INFO_ICON = File.expand_path('../../img/icon.png', __FILE__)
+
+  def initialize(show_notifications)
+    @show_notifications = show_notifications
+    Guard::Notifier.turn_on if @show_notifications
+  end
+
+  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.
+  end
+
+  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
+
+  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.
+  end
+end

data/lib/gitdocs/repository.rb

@@ -0,0 +1,348 @@
+# -*- encoding : utf-8 -*-
+
+# Wrapper for accessing the shared git repositories.
+# Rugged, grit, or shell will be used in that order of preference depending
+# upon the features which are available with each option.
+#
+# @note If a repository is invalid then query methods will return nil, and
+#   command methods will raise exceptions.
+#
+class Gitdocs::Repository
+  include ShellTools
+  attr_reader :invalid_reason
+
+  # Initialize the repository on the specified path. If the path is not valid
+  # for some reason, the object will be initialized but it will be put into an
+  # invalid state.
+  # @see #valid?
+  # @see #invalid_reason
+  #
+  # @param [String, Configuration::Share] path_or_share
+  def initialize(path_or_share)
+    path = path_or_share
+    if path_or_share.respond_to?(:path)
+      path = path_or_share.path
+      @remote_name = path_or_share.remote_name
+      @branch_name = path_or_share.branch_name
+    end
+
+    @rugged         = Rugged::Repository.new(path)
+    @grit           = Grit::Repo.new(path)
+    @invalid_reason = nil
+  rescue Rugged::OSError
+    @invalid_reason = :directory_missing
+  rescue Rugged::RepositoryError
+    @invalid_reason = :no_repository
+  end
+
+  # Clone a repository, and create the destination path if necessary.
+  #
+  # @param [String] path to clone the repository to
+  # @param [String] remote URI of the git repository to clone
+  #
+  # @raise [RuntimeError] if the clone fails
+  #
+  # @return [Gitdocs::Repository]
+  def self.clone(path, remote)
+    FileUtils.mkdir_p(File.dirname(path))
+    # TODO: determine how to do this with rugged, and handle SSH and HTTPS
+    #   credentials.
+    Grit::Git.new(path).clone({ raise: true, quiet: true }, remote, path)
+
+    repository = new(path)
+    fail("Unable to clone into #{path}") unless repository.valid?
+    repository
+  rescue Grit::Git::GitTimeout => e
+    fail("Unable to clone into #{path} because it timed out")
+  rescue Grit::Git::CommandFailed => e
+    fail("Unable to clone into #{path} because of #{e.err}")
+  end
+
+  RepoDescriptor = Struct.new(:name, :index)
+
+  # Search across multiple repositories
+  #
+  # @param [String] term
+  # @param [Array<Repository>} repositories
+  #
+  # @return [Hash<RepoDescriptor, Array<SearchResult>>]
+  def self.search(term, repositories)
+    results = {}
+    repositories.each_with_index do |repository, index|
+      descriptor = RepoDescriptor.new(repository.root, index)
+      results[descriptor] = repository.search(term)
+    end
+    results.delete_if { |key, value| value.empty? }
+  end
+
+  SearchResult = Struct.new(:file, :context)
+
+  # Search a single repository
+  #
+  # @param [String] term
+  #
+  # @return [Array<SearchResult>]
+  def search(term)
+    return [] if term.empty?
+
+    results = []
+    options = { raise: true, bare: false, chdir: root, ignore_case: true }
+    @grit.git.grep(options, term).scan(/(.*?):([^\n]*)/) do |(file, context)|
+      if result = results.find { |s| s.file == file }
+        result.context += ' ... ' + context
+      else
+        results << SearchResult.new(file, context)
+      end
+    end
+    results
+  rescue Grit::Git::GitTimeout => e
+    # TODO: add logging to record the error details
+    []
+  rescue Grit::Git::CommandFailed => e
+    # TODO: add logging to record the error details if they are not just
+      # nothing found
+    []
+  end
+
+  # @return [String]
+  def root
+    return nil unless valid?
+    @rugged.path.sub(/.\.git./, '')
+  end
+
+  # @return [Boolean]
+  def valid?
+    !@invalid_reason
+  end
+
+  # @return [nil] if the repository is invalid
+  # @return [Array<String>] sorted list of remote branches
+  def available_remotes
+    return nil unless valid?
+    Rugged::Branch.each_name(@rugged, :remote).sort
+  end
+
+  # @return [nil] if the repository is invalid
+  # @return [Array<String>] sorted list of local branches
+  def available_branches
+    return nil unless valid?
+    Rugged::Branch.each_name(@rugged, :local).sort
+  end
+
+  # @return [String] oid of the HEAD of the working directory
+  def current_oid
+    @rugged.head.target
+  rescue Rugged::ReferenceError
+    nil
+  end
+
+  # Fetch and merge the repository
+  #
+  # @raise [RuntimeError] if there is a problem processing conflicted files
+  #
+  # @return [nil] if the repository is invalid
+  # @return [:no_remote] if the remote is not yet set
+  # @return [String] if there is an error return the message
+  # @return [Array<String>] if there is a conflict return the Array of
+  #   conflicted file names
+  # @return [:ok] if pulled and merged with no errors or conflicts
+  def pull
+    return nil unless valid?
+    return :no_remote unless has_remote?
+
+    out, status = sh_with_code("cd #{root} ; git fetch --all 2>/dev/null && git merge #{@remote_name}/#{@branch_name} 2>/dev/null")
+
+    if status.success?
+      :ok
+    elsif out[/CONFLICT/]
+      # Find the conflicted files
+      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
+
+      # Mark the conflicted files
+      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 --quiet #{conflict} >/dev/null 2>/dev/null") || fail
+      end
+
+      conflicted_files.keys
+    else
+      out # return the output on error
+    end
+  end
+
+  # Commit and push the repository
+  #
+  # @return [nil] if the repository is invalid
+  # @return [:no_remote] if the remote is not yet set
+  # @return [:nothing] if there was nothing to do
+  # @return [String] if there is an error return the message
+  # @return [:ok] if commited and pushed without errors or conflicts
+  def push(last_synced_oid, message='Auto-commit from gitdocs')
+    return nil unless valid?
+    return :no_remote unless has_remote?
+
+    #add and commit
+    sh_string('find . -type d -regex ``./[^.].*'' -empty -exec touch \'{}/.gitignore\' \;')
+    sh_string('git add .')
+    sh_string("git commit -a -m #{ShellTools.escape(message)}") unless sh("cd #{root} ; git status -s").empty?
+
+    if last_synced_oid.nil? || sh_string('git status')[/branch is ahead/]
+      out, code = sh_with_code("git push #{@remote_name} #{@branch_name}")
+      if code.success?
+        :ok
+      elsif last_synced_oid.nil?
+        :nothing
+      elsif out[/\[rejected\]/]
+        :conflict
+      else
+        out # return the output on error
+      end
+    else
+      :nothing
+    end
+  end
+
+  # Get the count of commits by author from the head to the specified oid.
+  #
+  # @param [String] last_oid
+  #
+  # @return [Hash<String, Int>]
+  def author_count(last_oid)
+    walker = head_walker
+    walker.hide(last_oid) if last_oid
+    walker.inject(Hash.new(0)) do |result, commit|
+      result["#{commit.author[:name]} <#{commit.author[:email]}>"] += 1
+      result
+    end
+  rescue Rugged::ReferenceError
+    {}
+  rescue Rugged::OdbError
+    {}
+  end
+
+  # Returns file meta data based on relative file path
+  #
+  # @example
+  #  file_meta("path/to/file")
+  #  => { :author => "Nick", :size => 1000, :modified => ... }
+  #
+  # @param [String] file relative path to file in repository
+  #
+  # @raise [RuntimeError] if the file is not found in any commits
+  #
+  # @return [Hash<Symbol=>String,Integer,Time>] the author, size and
+  #   modification date of the file
+  def file_meta(file)
+    file = file.gsub(%r{^/}, '')
+
+    commit = head_walker.find { |x| x.diff(paths: [file]).size > 0 }
+
+    fail "File #{file} not found" unless commit
+
+    full_path = File.expand_path(file, root)
+    size = if File.directory?(full_path)
+      Dir[File.join(full_path, '**', '*')].reduce(0) do |size, file|
+        File.symlink?(file) ? size : size += File.size(file)
+      end
+    else
+      File.symlink?(full_path) ? 0 : File.size(full_path)
+    end
+    size = -1 if size == 0 # A value of 0 breaks the table sort for some reason
+
+    { author: commit.author[:name], size: size, modified: commit.author[:time] }
+  end
+
+  # Returns the revisions available for a particular file
+  #
+  # @example
+  #   file_revisions("README")
+  #
+  # @param [String] file
+  #
+  # @return [Array<Hash>]
+  def file_revisions(file)
+    file = file.gsub(%r{^/}, '')
+    # Excluding the initial commit (without a parent) which keeps things
+    # consistent with the original behaviour.
+    # TODO: reconsider if this is the correct behaviour
+    head_walker.select{|x| x.parents.size == 1 && x.diff(paths: [file]).size > 0 }
+      .first(100)
+      .map do |commit|
+        {
+          commit:  commit.oid[0, 7],
+          subject: commit.message.split("\n")[0],
+          author:  commit.author[:name],
+          date:    commit.author[:time]
+        }
+      end
+  end
+
+  # Put the contents of the specified file revision into a temporary file
+  #
+  # @example
+  #   file_revision_at("README", "a4c56h")
+  #   => "/tmp/some/path/README"
+  #
+  # @param [String] file
+  # @param [String] ref
+  #
+  # @return [String] path of the temporary file
+  def file_revision_at(file, ref)
+    file = file.gsub(%r{^/}, '')
+    content = @rugged.blob_at(ref, file).text
+    tmp_path = File.expand_path(File.basename(file), Dir.tmpdir)
+    File.open(tmp_path, 'w') { |f| f.puts content }
+    tmp_path
+  end
+
+  # Revert file to the specified ref
+  #
+  # @param [String] file
+  # @param [String] ref
+  def file_revert(file, ref)
+    file = file.gsub(%r{^/}, '')
+    blob = @rugged.blob_at(ref, file)
+    # Silently fail if the file/ref do not existing in the repository.
+    # Which is consistent with the original behaviour.
+    # TODO: should consider throwing an exception on this condition
+    return unless blob
+
+    File.open(File.expand_path(file, root), 'w') { |f| f.puts(blob.text) }
+  end
+
+  ##############################################################################
+
+  private
+
+  def has_remote?
+    sh_string('git remote')
+  end
+
+  def head_walker
+    walker = Rugged::Walker.new(@rugged)
+    walker.sorting(Rugged::SORT_DATE)
+    walker.push(@rugged.head.target)
+    walker
+  end
+
+  # sh_string("git config branch.`git branch | grep '^\*' | sed -e 's/\* //'`.remote", "origin")
+  def sh_string(cmd, default = nil)
+    val = sh("cd #{root} ; #{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)
+  end
+end