gitdocs 0.5.0 → 0.6.0

data/lib/gitdocs/repository/committer.rb

@@ -0,0 +1,77 @@
+# -*- encoding : utf-8 -*-
+module Gitdocs
+  class Repository
+    class Committer
+      # @raise if the repository is not valid for commits
+      def initialize(root_dirname)
+        @root_dirname        = root_dirname
+        @rugged              = Rugged::Repository.new(root_dirname)
+        @grit                = Grit::Repo.new(root_dirname)
+        @commit_message_path = File.expand_path('.gitmessage~', root_dirname)
+      rescue Rugged::OSError
+        raise(Gitdocs::Repository::InvalidError, 'No directory')
+      rescue Rugged::RepositoryError
+        raise(Gitdocs::Repository::InvalidError, 'Not a repository')
+      end
+
+      # @return [Boolean]
+      def commit
+        # Do this first to allow the message file to be deleted, if it exists.
+        message = read_and_delete_commit_message_file
+
+        mark_empty_directories
+
+        # FIXME: Consider a more appropriate location for the dirty check.
+        return false unless Gitdocs::Repository.new(@root_dirname).dirty?
+        Gitdocs.log_debug("Repo #{@root_dirname} is dirty")
+
+        # Commit any changes in the working directory.
+        Dir.chdir(@root_dirname) do
+          @rugged.index.add_all
+          @rugged.index.update_all
+        end
+        @rugged.index.write
+        Gitdocs.log_debug("Index to be committed #{@rugged.index}")
+
+        commit_result = @grit.commit_index(message)
+        Gitdocs.log_debug("Commit result: <#{commit_result.inspect}>")
+
+        true
+      end
+
+      # @param [String] message
+      # @return [void]
+      def write_commit_message(message)
+        return unless message
+        return if message.empty?
+
+        File.open(@commit_message_path, 'w') { |f| f.print(message) }
+      end
+
+      ##########################################################################
+
+      private
+
+      def mark_empty_directories
+        Find.find(@root_dirname).each do |path|
+          Find.prune if File.basename(path) == '.git'
+          if File.directory?(path) && Dir.entries(path).count == 2
+            FileUtils.touch(File.join(path, '.gitignore'))
+          end
+        end
+      end
+
+      # @return [String] either the message in the file, or the regular
+      #   automatic commit message.
+      def read_and_delete_commit_message_file
+        return(
+          'Auto-commit from gitdocs'
+        ) unless File.exist?(@commit_message_path)
+
+        message = File.read(@commit_message_path)
+        File.delete(@commit_message_path)
+        message
+      end
+    end
+  end
+end

data/lib/gitdocs/repository/path.rb

@@ -2,170 +2,187 @@
 
 # Class for executing File and Git operations on a specific path in the
 # repository.
-class Gitdocs::Repository::Path
-  attr_reader :relative_path
-
-  # @param [Gitdocs::Repository] repository
-  # @param [String] relative_path
-  def initialize(repository, relative_path)
-    @repository    = repository
-    @relative_path = relative_path.gsub(/^\//, '')
-    @absolute_path = File.join(
-      File.absolute_path(@repository.root), @relative_path
-    )
-  end
+module Gitdocs
+  class Repository
+    class Path
+      attr_reader :relative_path
+
+      # @param [Gitdocs::Repository] repository
+      # @param [String] relative_path
+      def initialize(repository, relative_path)
+        @repository    = repository
+        @relative_path = relative_path.gsub(%r{^/}, '')
+        @absolute_path = File.join(
+          File.absolute_path(@repository.root), @relative_path
+        )
+      end
 
-  def join(path_fragment)
-    @relative_path = File.join(@relative_path, path_fragment)
-    @absolute_path = File.join(@absolute_path, path_fragment)
-  end
+      # @return [String]
+      def relative_dirname
+        result = File.dirname(@relative_path)
+        return '' if result == '.'
+        result
+      end
 
-  # Write the content to the path and create any necessary directories.
-  #
-  # @param [String] content
-  # @param [String] commit_message
-  def write(content, commit_message)
-    FileUtils.mkdir_p(File.dirname(@absolute_path))
-    File.open(@absolute_path, 'w') { |f| f.puts(content) }
+      def join(path_fragment)
+        @relative_path = File.join(@relative_path, path_fragment)
+        @absolute_path = File.join(@absolute_path, path_fragment)
+      end
 
-    @repository.write_commit_message(commit_message)
-  end
+      # Write the content to the path and create any necessary directories.
+      #
+      # @param [String] content
+      # @return [void]
+      def write(content)
+        FileUtils.mkdir_p(File.dirname(@absolute_path))
+        File.open(@absolute_path, 'w') { |f| f.puts(content) }
+      end
 
-  # Touch and path and create any necessary directories.
-  def touch
-    FileUtils.mkdir_p(File.dirname(@absolute_path))
-    FileUtils.touch(@absolute_path)
-  end
+      # Touch and path and create any necessary directories.
+      def touch
+        FileUtils.mkdir_p(File.dirname(@absolute_path))
+        FileUtils.touch(@absolute_path)
+      end
 
-  # Create the path as a directory.
-  def mkdir
-    FileUtils.mkdir_p(@absolute_path)
-  end
+      # Create the path as a directory.
+      def mkdir
+        FileUtils.mkdir_p(@absolute_path)
+      end
 
-  # Remove the path, but only if it is a file.
-  def remove
-    return nil unless File.file?(@absolute_path)
-    FileUtils.rm(@absolute_path)
-  end
+      # Move file to the repository path
+      # @param [String] filename
+      def mv(filename)
+        FileUtils.mkdir_p(File.dirname(@absolute_path))
+        FileUtils.mv(filename, @absolute_path)
+      end
 
-  # @return [Boolean]
-  def text?
-    return false unless File.file?(@absolute_path)
-    mime_type = File.mime_type?(File.open(@absolute_path))
-    !!(mime_type =~ /text\/|x-empty/) # rubocop:disable DoubleNegation
-  end
+      # Remove the path, but only if it is a file.
+      def remove
+        return nil unless File.file?(@absolute_path)
+        FileUtils.rm(@absolute_path)
+      end
 
-  # Returns file meta data based on relative file path
-  #
-  # @example
-  #  meta
-  #  => { :author => "Nick", :size => 1000, :modified => ... }
-  #
-  # @raise [RuntimeError] if the file is not found in any commits
-  #
-  # @return [Hash<:author => String, :size => Integer, modified => Time>]
-  def meta
-    commit = @repository.last_commit_for(@relative_path)
-
-    # FIXME: This should actually just return an empty hash
-    fail("File #{@relative_path} not found") unless commit
-
-    {
-      author:   commit.author[:name],
-      size:     total_size,
-      modified: commit.author[:time]
-    }
-  end
+      # @return [Boolean]
+      def text?
+        return false unless File.file?(@absolute_path)
+        mime_type = File.mime_type?(File.open(@absolute_path))
+        !!(mime_type =~ %r{text/|x-empty}) # rubocop:disable DoubleNegation
+      end
 
-  def exist?
-    File.exist?(@absolute_path)
-  end
+      # Returns file meta data based on relative file path
+      #
+      # @example
+      #  meta
+      #  => { :author => "Nick", :size => 1000, :modified => ... }
+      #
+      # @raise [RuntimeError] if the file is not found in any commits
+      #
+      # @return [Hash<:author => String, :size => Integer, modified => Time>]
+      def meta
+        commit = @repository.last_commit_for(@relative_path)
+
+        # FIXME: This should actually just return an empty hash
+        fail("File #{@relative_path} not found") unless commit
+
+        {
+          author:   commit.author[:name],
+          size:     total_size,
+          modified: commit.author[:time]
+        }
+      end
 
-  def directory?
-    File.directory?(@absolute_path)
-  end
+      def exist?
+        File.exist?(@absolute_path)
+      end
 
-  def absolute_path(ref = nil)
-    return @absolute_path unless ref
+      def directory?
+        File.directory?(@absolute_path)
+      end
 
-    blob    = @repository.blob_at(@relative_path, ref)
-    content = blob ? blob.text : ''
-    tmp_path = File.expand_path(File.basename(@relative_path), Dir.tmpdir)
-    File.open(tmp_path, 'w') { |f| f.puts content }
-    tmp_path
-  end
+      def absolute_path(ref = nil)
+        return @absolute_path unless ref
 
-  def readme_path
-    return nil unless directory?
-    Dir.glob(File.join(@absolute_path, 'README.{md}')).first
-  end
+        blob    = @repository.blob_at(@relative_path, ref)
+        content = blob ? blob.text : ''
+        tmp_path = File.expand_path(File.basename(@relative_path), Dir.tmpdir)
+        File.open(tmp_path, 'w') { |f| f.puts content }
+        tmp_path
+      end
 
-  DirEntry = Struct.new(:name, :is_directory)
+      def readme_path
+        return nil unless directory?
+        Dir.glob(File.join(@absolute_path, 'README.{md}')).first
+      end
 
-  # @return [Array<DirEntry>] entries in the directory
-  #   * excluding any git related directories
-  #   * sorted by filename, ignoring any leading '.'s
-  def file_listing
-    return nil unless directory?
+      DirEntry = Struct.new(:name, :is_directory)
 
-    Dir.glob(File.join(@absolute_path, '{*,.*}'))
-      .reject  { |x| x.match(/\/\.(\.|git|gitignore|gitmessage~)?$/) }
-      .sort_by { |x| File.basename(x).sub(/^\./, '') }
-      .map     { |x| DirEntry.new(File.basename(x), File.directory?(x)) }
-  end
+      # @return [Array<DirEntry>] entries in the directory
+      #   * excluding any git related directories
+      #   * sorted by filename, ignoring any leading '.'s
+      def file_listing
+        return nil unless directory?
 
-  def content
-    return nil unless File.file?(@absolute_path)
-    File.read(@absolute_path)
-  end
+        Dir
+          .glob(File.join(@absolute_path, '{*,.*}'))
+          .reject  { |x| x.match(%r{/\.(\.|git|gitignore|gitmessage~)?$}) }
+          .sort_by { |x| File.basename(x).sub(/^\./, '') }
+          .map     { |x| DirEntry.new(File.basename(x), File.directory?(x)) }
+      end
 
-  # Returns the revisions available for a particular file
-  #
-  # @param [String] file
-  #
-  # @return [Array<Hash>]
-  def revisions
-    @repository.commits_for(@relative_path, 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
+      def content
+        return nil unless File.file?(@absolute_path)
+        File.read(@absolute_path)
+      end
 
-  # Revert file to the specified ref
-  #
-  # @param [String] ref
-  def revert(ref)
-    return unless ref
+      # Returns the revisions available for a particular file
+      #
+      # @param [String] file
+      #
+      # @return [Array<Hash>]
+      def revisions
+        @repository.commits_for(@relative_path, 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
 
-    blob = @repository.blob_at(@relative_path, ref)
-    # 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
+      # Revert file to the specified ref
+      #
+      # @param [String] ref
+      def revert(ref)
+        return unless ref
 
-    write(blob.text, "Reverting '#{@relative_path}' to #{ref}")
-  end
+        blob = @repository.blob_at(@relative_path, ref)
+        # 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
+
+        write(blob.text)
+      end
 
-  #############################################################################
+      ##########################################################################
 
-  private
+      private
 
-  def total_size
-    result =
-      if File.directory?(@absolute_path)
-        Dir[File.join(@absolute_path, '**', '*')].reduce(0) do |size, filename|
-          File.symlink?(filename) ? size : size + File.size(filename)
-        end
-      else
-        File.symlink?(@absolute_path) ? 0 : File.size(@absolute_path)
-      end
+      def total_size
+        result =
+          if File.directory?(@absolute_path)
+            Dir[File.join(@absolute_path, '**', '*')].reduce(0) do |size, filename|
+              File.symlink?(filename) ? size : size + File.size(filename)
+            end
+          else
+            File.symlink?(@absolute_path) ? 0 : File.size(@absolute_path)
+          end
 
-    # HACK: A value of 0 breaks the table sort for some reason
-    return -1 if result == 0
-    result
+        # HACK: A value of 0 breaks the table sort for some reason
+        return -1 if result == 0
+        result
+      end
+    end
   end
 end

data/lib/gitdocs/search.rb

@@ -1,35 +1,50 @@
-class Gitdocs::Search
-  RepoDescriptor = Struct.new(:name, :index)
-  SearchResult   = Struct.new(:file, :context)
+# -*- encoding : utf-8 -*-
 
-  # @param [Array<Gitdocs::Repository>] repositories
-  def initialize(repositories)
-    @repositories = repositories
-  end
+module Gitdocs
+  class Search
+    RepoDescriptor = Struct.new(:name, :index)
+    SearchResult   = Struct.new(:file, :context)
 
-  def search(term)
-    results = {}
-    @repositories.each_with_index do |repository, index|
-      descriptor = RepoDescriptor.new(repository.root, index)
-      results[descriptor] = search_repository(repository, term)
+    # @param [String] term
+    # @return (see #search)
+    def self.search(term)
+      new(Share.all.map { |x| Repository.new(x) }).search(term)
+    end
+
+    # @param [Array<Gitdocs::Repository>] repositories
+    def initialize(repositories)
+      @repositories = repositories
+    end
+
+    # @param [String] term
+    # @return [Hash<RepoDescriptor, Array<SearchResult>>]
+    def search(term)
+      results = {}
+      @repositories.each_with_index do |repository, index|
+        descriptor = RepoDescriptor.new(repository.root, index)
+        results[descriptor] = search_repository(repository, term)
+      end
+      results.delete_if { |_key, value| value.empty? }
     end
-    results.delete_if { |_key, value| value.empty? }
-  end
 
-  private
+    private
 
-  def search_repository(repository, term)
-    return [] if term.nil? || term.empty?
+    # @param [Repository] repository
+    # @param [String] term
+    # @return [Array<SearchResult>]
+    def search_repository(repository, term)
+      return [] if term.nil? || term.empty?
 
-    results = []
-    repository.grep(term) do |file, context|
-      result = results.find { |s| s.file == file }
-      if result
-        result.context += ' ... ' + context
-      else
-        results << SearchResult.new(file, context)
+      results = []
+      repository.grep(term) do |file, context|
+        result = results.find { |s| s.file == file }
+        if result
+          result.context += ' ... ' + context
+        else
+          results << SearchResult.new(file, context)
+        end
       end
+      results
     end
-    results
   end
 end