dolt 0.1.1 → 0.2.0

data/Gemfile.lock

@@ -3,11 +3,17 @@ PATH
   specs:
     dolt (0.1.1)
       async_sinatra (~> 1.0)
-      eventmachine (~> 0.12)
+      builder (~> 3.1)
+      em_pessimistic (~> 0.1)
+      em_rugged (~> 0.1.0)
+      eventmachine (~> 1.0)
+      github-markup (~> 0.7)
+      htmlentities (~> 4.3)
       pygments.rb (~> 0.2)
       sinatra (~> 1.3)
       thin (~> 1.4)
       tilt (~> 1.3)
+      tzinfo (~> 0.3)
 
 GEM
   remote: http://rubygems.org/
@@ -15,23 +21,35 @@ GEM
     async_sinatra (1.0.0)
       rack (>= 1.4.1)
       sinatra (>= 1.3.2)
-    blankslate (2.1.2.4)
+    blankslate (3.1.2)
+    builder (3.1.3)
     daemons (1.1.9)
     em-minitest-spec (1.1.1)
       eventmachine
-    eventmachine (0.12.10)
+    em_pessimistic (0.1.2)
+      eventmachine (~> 1.0)
+    em_rugged (0.1.1)
+      eventmachine (~> 1.0)
+      rugged (~> 0.17)
+    eventmachine (1.0.0)
     ffi (1.0.11)
-    minitest (2.1.0)
-    mocha (0.9.12)
+    github-markup (0.7.4)
+    htmlentities (4.3.1)
+    metaclass (0.0.1)
+    minitest (2.12.1)
+    mocha (0.12.4)
+      metaclass (~> 0.0.1)
     pygments.rb (0.2.13)
       rubypython (~> 0.5.3)
     rack (1.4.1)
     rack-protection (1.2.0)
       rack
     rake (0.9.2.2)
+    redcarpet (2.1.1)
     rubypython (0.5.3)
       blankslate (>= 2.1.2.3)
       ffi (~> 1.0.7)
+    rugged (0.17.0)
     sinatra (1.3.3)
       rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
@@ -41,6 +59,7 @@ GEM
       eventmachine (>= 0.12.6)
       rack (>= 1.0.0)
     tilt (1.3.3)
+    tzinfo (0.3.33)
 
 PLATFORMS
   ruby
@@ -51,3 +70,4 @@ DEPENDENCIES
   minitest (~> 2.0)
   mocha
   rake (~> 0.9)
+  redcarpet

data/Readme.md

@@ -1,25 +1,99 @@
 # Dolt - The Git project browser
 
-Dolt is a stand-alone server that allows you to browse git repositories in your
-browser. It uses Pygments to syntax highlight code, and displays blame as well
-as git history for individual files.
+Dolt is a stand-alone Git repository browser. It can be used to explore repos in
+your browser of choice and features syntax highlighting with
+[Pygments](http://pygments.org/),
+[Markdown](http://daringfireball.net/projects/markdown/)/[org-mode](http://orgmode.org/)/[+++](https://github.com/github/markup/)
+rendering, commit log and blame.
 
-Dolt can also be used as a library to serve git trees from e.g. a Rails app. It
-is the blob viewer implementation that will be used in the Gitorious application
-(gitorious.org) when it is ready.
+Dolt is also a library, designed to render Git trees, blobs, commit log and
+blame. It can render said views with or without a layout, or you can provide
+your own templates (through [Tilt](https://github.com/rtomayko/tilt/)). You can
+also provide your own rendering implementation to render other formats than
+templates outputting HTML.
 
-## Blobs
+Dolt is the implementation of the next generation repo browser to be used in the
+[Gitorious](http://gitorious.org) software.
 
-Dolt currenly only serves blobs. The sample Rack application that comes with
-Dolt allows you to surf repos locally on your disk:
+## Installing Dolt
 
-    env REPO_ROOT=/where/git/repos/reside rackup -Ilib
+To install `dolt` you need Ruby, RubyGems and Python development files. The
+Python development files are required to support Pygments syntax highlighting.
 
-That command will start the server, and allow you to view blobs in repos
-available in the `/where/git/repos/reside` directory. For example, on my machine,
-when I issue:
+Note: Dolt uses [libgit2](http://libgit2.github.com) and its Ruby bindings,
+[Rugged](http://github.com/libgit2/rugged) through
+[em-rugged](http://gitorious.org/gitorious/em-rugged) for Git access where
+feasible. Currently, ``EMRugged`` relies on a version of `Rugged` that is not
+yet released, so you have to build it yourself.
+[See em-rugged instructions](http://github.com/cjohansen/em-rugged).
 
-    env REPO_ROOT=/home/christian/projects rackup -Ilib
+### Systems using apt (Debian/Ubuntu, others)
 
-I can go to [http://localhost:9292/gitorious/blob/master:app/models/repository.rb](http://localhost:9292/gitorious/blob/master:app/models/repository.rb)
-to view Gitorious blobs.
+    # 1) Install Ruby (skip if you already have Ruby installed)
+    sudo apt-get install ruby
+
+    # 2) Install Python development files
+    sudo apt-get install python-dev
+
+    # 3) Install dolt. This may or may not require the use of sudo, depending on
+    #    how you installed Ruby. This step assumes that you already built and
+    #    installed em-rugged as explained above.
+    sudo gem install dolt
+
+### Systems using yum (Fedora/CentOS/RedHat, others)
+
+    # 1) Install Ruby (skip if you already have Ruby installed)
+    sudo yum install ruby
+
+    # 2) Install Python development files
+    sudo yum install python-devel
+
+    # 3) Install dolt. This may or may not require the use of sudo, depending on
+    #    how you installed Ruby. This step assumes that you already built and
+    #    installed em-rugged as explained above.
+    sudo gem install dolt
+
+# The Dolt CLI
+
+The `dolt` library installs a CLI that can be used to quickly browse either a
+single (typically the current) repository, or multiple repositories.
+
+## Browsing a single repository
+
+In a git repository, issue the following command:
+
+    $ dolt .
+
+Then open a browser at [http://localhost:3000](http://localhost:3000). You will
+be redirected to the root tree, and can browse the repository. To view trees and
+blobs at specific refs, use the URL. A branch/tag selector will be added later.
+
+## Browsing multiple repositories
+
+The idea is that eventually, `dolt` should be able to serve up all Git
+repositories managed by your Gitorious server. It does not yet do that, because
+there currently is no "repository resolver" that understands the hashed paths
+Gitorious uses.
+
+Meanwhile, if you have a directory that contains multiple git repositories, you
+can browse all of them through the same process by doing:
+
+    $ dolt /path/to/repos
+
+Now [http://localhost:3000/repo](http://localhost:3000/repo) will allow you to
+browse the `/path/repos/repo` repository. As `dolt` matures, there will be a
+listing of all repositories and more.
+
+## Markup rendering
+
+Dolt uses the [``GitHub::Markup``](https://github.com/github/markup/) library to
+render certain markup formats as HTML. Dolt does not have a hard dependency on
+any of the required gems to actually render markups, so see the
+[``GitHub::Markup`` docs](https://github.com/github/markup/) for information on
+what and how to install support for various languages.
+
+# License
+
+Dolt is free software licensed under the
+[GNU Affero General Public License (AGPL)](http://www.gnu.org/licenses/agpl-3.0.html).
+Dolt is developed as part of the Gitorious project.

data/bin/dolt

@@ -21,14 +21,16 @@ end
 
 def create_app(dir, view)
   if is_git_repo?(dir)
-    require "dolt/sinatra/single_repo_browser"
     dir = File.expand_path(dir)
     resolver = Dolt::DiskRepoResolver.new(File.dirname(dir))
     actions = Dolt::RepoActions.new(resolver)
+    view.helper(Dolt::View::SingleRepository)
+    require "dolt/sinatra/single_repo_browser"
     Dolt::Sinatra::SingleRepoBrowser.new(File.basename(dir), actions, view)
   else
     resolver = Dolt::DiskRepoResolver.new(dir)
     actions = Dolt::RepoActions.new(resolver)
+    view.helper(Dolt::View::MultiRepository)
     require "dolt/sinatra/multi_repo_browser"
     Dolt::Sinatra::MultiRepoBrowser.new(actions, view)
   end
@@ -39,11 +41,27 @@ base = File.join(File.dirname(__FILE__), "..")
 template_root = File.join(base, "views")
 view = Dolt::TemplateRenderer.new(template_root, {
   :cache => false,
-  :layout => "layout",
-  :attributes => { :multi_repo_mode => !is_git_repo?(ARGV[0]) }
+  :layout => "layout"
 })
 
-view.helper(Dolt::View)
+view.helper(Dolt::View::Object)
+view.helper(Dolt::View::Blob)
+view.helper(Dolt::View::Blame)
+view.helper(Dolt::View::Breadcrumb)
+view.helper(Dolt::View::Tree)
+view.helper(Dolt::View::Commit)
+view.helper(Dolt::View::Gravatar)
+
+# Configure blob rendering module
+
+# Attempt to syntax highlight every blob
+# view.helper(Dolt::View::SyntaxHighlight)
+
+# Attempt to render every blob as markup
+# view.helper(Dolt::View::Markup)
+
+# Render supported formats as markup, syntax highlight the rest
+view.helper(Dolt::View::SmartBlobRenderer)
 
 Sinatra::Base.set(:public_folder, File.join(base, "vendor/ui"))
 server = create_app(ARGV[0], view)

data/dolt.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
-require File.join("lib/dolt/version")
+dir = File.expand_path(File.dirname(__FILE__))
+require File.join(dir, "lib/dolt/version")
 
 module GemSpecHelper
   def self.files(path)
@@ -20,17 +21,24 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "dolt"
 
-  s.add_dependency "eventmachine", "~>0.12"
+  s.add_dependency "eventmachine", "~>1.0"
   s.add_dependency "thin", "~>1.4"
   s.add_dependency "sinatra", "~>1.3"
   s.add_dependency "async_sinatra", "~>1.0"
   s.add_dependency "tilt", "~>1.3"
   s.add_dependency "pygments.rb", "~>0.2"
+  s.add_dependency "em_pessimistic", "~>0.1"
+  s.add_dependency "builder", "~> 3.1"
+  s.add_dependency "em_rugged", "~> 0.1.2"
+  s.add_dependency "tzinfo", "~> 0.3"
+  s.add_dependency "github-markup", "~> 0.7"
+  s.add_dependency "htmlentities", "~> 4.3"
 
   s.add_development_dependency "minitest", "~> 2.0"
   s.add_development_dependency "em-minitest-spec", "~> 1.1"
   s.add_development_dependency "rake", "~> 0.9"
   s.add_development_dependency "mocha"
+  s.add_development_dependency "redcarpet"
 
   s.files         = GemSpecHelper.files(".") + GemSpecHelper.files("vendor/ui")
   s.test_files    = `git ls-files -- {test}/*`.split("\n")

data/lib/dolt/disk_repo_resolver.rb

@@ -15,7 +15,6 @@
 #   You should have received a copy of the GNU Affero General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
-require "dolt/git/shell"
 require "dolt/git/repository"
 
 module Dolt
@@ -25,13 +24,12 @@ module Dolt
     end
 
     def resolve(repo)
-      git = Dolt::Git::Shell.new(File.join(root, repo))
-      Dolt::Git::Repository.new(repo, git)
+      Dolt::Git::Repository.new(File.join(root, repo))
     end
 
     def all
-      Dir.entries(root).reject do |e|
-        e =~ /^\.+$/ || File.file?(File.join(root, e))
+      Dir.entries(root).select do |e|
+        File.exists?(File.join(root, e, ".git"))
       end
     end
 

data/lib/dolt/git/blame.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+#--
+#   Copyright (C) 2012 Gitorious AS
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#++
+require "tzinfo"
+
+module Dolt
+  module Git
+    class Blame
+      attr_reader :chunks
+
+      def initialize(chunks)
+        @chunks = chunks
+      end
+
+      def self.parse_porcelain(output)
+        self.new(Dolt::Git::Blame::PorcelainParser.new(output).parse)
+      end
+
+      class PorcelainParser
+        def initialize(output)
+          @output = output
+          @commits = {}
+        end
+
+        def parse
+          lines = @output.split("\n")
+          chunks = []
+
+          while lines.length > 0
+            chunk = extract_header(lines)
+            affected_lines = extract_lines(lines, chunk[:num_lines])
+
+            if chunks.last && chunk[:oid] == chunks.last[:oid]
+              chunks.last[:lines].concat(affected_lines)
+            else
+              chunk[:lines] = affected_lines
+              chunks << chunk
+            end
+          end
+
+          chunks
+        end
+
+        def is_header?(line)
+          line =~ /^[0-9a-f]{40} \d+ \d+ \d+$/
+        end
+
+        def extract_header(lines)
+          header = lines.shift
+          pieces = header.scan(/^([0-9a-f]{40}) (\d+) (\d+) (\d+)$/).first
+          header = { :oid => pieces.first, :num_lines => pieces[3].to_i }
+
+          if lines.first =~ /^author/
+            header[:author] = extract_hash(lines, :author)
+            header[:committer] = extract_hash(lines, :committer)
+            header[:summary] = extract(lines, "summary")
+            throwaway = lines.shift until throwaway =~ /^filename/
+            @commits[header[:oid]] = header
+          else
+            header[:author] = @commits[header[:oid]][:author]
+            header[:committer] = @commits[header[:oid]][:committer]
+            header[:summary] = @commits[header[:oid]][:summary]
+          end
+
+          header
+        end
+
+        def extract_lines(lines, num)
+          extracted = []
+
+          num.times do
+            if extracted.length > 0
+              line = lines.shift # Header for next line
+            end
+
+            content = lines.shift # Actual content
+            extracted.push(content[1..content.length]) # 8 spaces padding
+          end
+
+          extracted
+        end
+
+        def extract_hash(lines, type)
+          {
+            :name => extract(lines, "#{type}"),
+            :mail => extract(lines, "#{type}-mail").gsub(/[<>]/, ""),
+            :time => (Time.at(extract(lines, "#{type}-time").to_i) +
+                      Time.zone_offset(extract(lines, "#{type}-tz")))
+          }
+        end
+
+        def extract(lines, thing)
+          lines.shift.split("#{thing} ")[1]
+        end
+      end
+    end
+  end
+end

data/lib/dolt/git/commit.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+#--
+#   Copyright (C) 2012 Gitorious AS
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#++
+require "parsedate"
+
+module Dolt
+  module Git
+    class Commit
+      def self.parse_log(log)
+        commits = []
+        lines = log.split("\n")
+        commits << extract_commit(lines) while lines.length > 0
+        commits
+      end
+
+      def self.extract_commit(lines)
+        commit = { :oid => lines.shift.split(" ")[1] }
+        while (line = lines.shift) != ""
+          pieces = line.split(": ")
+          extract_property(commit, pieces[0], pieces[1])
+        end
+
+        commit[:summary] = extract_commit_summary(lines)
+        commit[:message] = extract_commit_message(lines)
+        commit
+      end
+
+      def self.extract_property(hash, name, value)
+        key = name.downcase.to_sym
+
+        case key
+        when :author
+          pieces = value.match(/(.*)\s<(.*)>/)
+          value = { :name => pieces[1], :email => pieces[2] }
+        when :date
+          value = Time.mktime(*ParseDate.parsedate(value))
+        end
+
+        hash[key] = value
+      end
+
+      def self.extract_commit_summary(lines)
+        summary = lines.shift
+        lines.shift if lines.first == ""
+        summary
+      end
+
+      def self.extract_commit_message(lines)
+        message = ""
+
+        while !lines.first.nil? && lines.first !~ /^commit [a-z0-9]{40}$/
+          message << lines.shift
+        end
+
+        message
+      end
+    end
+  end
+end