ginatra 3.0.1 → 4.0.0

data/config.ru

@@ -1,5 +1,37 @@
-require "ginatra"
+require 'ginatra'
+require 'sprockets'
 
-map '/' do
-  run Ginatra::App
+map '/assets' do
+  environment = Sprockets::Environment.new
+  root_path   = File.dirname __FILE__
+  environment.append_path "#{root_path}/public/js"
+  environment.append_path "#{root_path}/public/css"
+  run environment
+end
+
+if Ginatra.config.git_clone_enabled?
+  require 'mkmf'
+  require 'git/webby'
+
+  # Make the MakeMakefile logger write file output to null
+  module MakeMakefile::Logging; @logfile = File::NULL; end
+
+  git_executable = find_executable 'git'
+  raise 'Git executable not found in PATH' if git_executable.nil?
+  root_path = File.dirname __FILE__
+
+  Git::Webby::HttpBackend.configure do |server|
+    server.project_root = "#{root_path}/repos"
+    server.git_path     = git_executable
+    server.get_any_file = true
+    server.upload_pack  = false
+    server.receive_pack = false
+    server.authenticate = false
+  end
+
+  run Rack::Cascade.new [Git::Webby::HttpBackend, Ginatra::App]
+else
+  map '/' do
+    run Ginatra::App
+  end
 end

data/ginatra.gemspec

@@ -1,21 +1,32 @@
-Gem::Specification.new do |s|
-  s.name = "ginatra"
-  s.version = "3.0.1"
-  s.summary = "A Gitweb Clone in Sinatra and Grit"
-  s.description = "Host your own git repository browser through the power of Sinatra and Grit"
-  s.email = "sam@lenary.co.uk"
-  s.homepage = "http://lenary.co.uk/ginatra"
-  s.authors = ["Sam Elliott", "Ryan Bigg"]
-  s.add_dependency('bundler', '~> 1.0.15')
-  s.add_dependency('sinatra', '~> 1.2.6')
-  s.add_dependency('grit', '~> 2.4.1')
-  s.add_dependency('vegas', '~> 0.1.8')
-  s.add_dependency('builder', '~> 3.0.0')
-  s.add_dependency('erubis', '~> 2.7.0')
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ginatra/version'
 
+Gem::Specification.new do |gem|
+  gem.name          = "ginatra"
+  gem.version       = Ginatra::VERSION
+  gem.summary       = "Web interface for git repositories"
+  gem.description   = "Git repository viewer with a rocking good web interface"
+  gem.homepage      = "https://github.com/narkoz/ginatra"
+  gem.email         = ["mail@narkoz.me"]
+  gem.authors       = ["Nihad Abbasov", "Sam Elliott", "Ryan Bigg"]
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- spec`.split("\n")
-  s.executables   = `git ls-files -- bin`.split("\n").map {|f| File.basename(f) }
-  s.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split($/) - ['Gemfile.lock']
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 1.9"
+
+  gem.add_dependency 'sinatra',   '~> 1.4.5'
+  gem.add_dependency 'rugged',    '~> 0.21.3'
+  gem.add_dependency 'rouge',     '~> 1.7.7'
+  gem.add_dependency 'sprockets', '~> 2.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'sinatra-contrib'
+  gem.add_development_dependency 'better_errors', '~> 1.1.0'
+  gem.add_development_dependency 'binding_of_caller'
 end

data/lib/ginatra.rb

@@ -1,74 +1,59 @@
-
 require 'sinatra/base'
-require "sinatra/partials"
-require 'json'
+require 'sinatra/partials'
+require 'rouge'
+require 'ginatra/config'
+require 'ginatra/errors'
+require 'ginatra/helpers'
+require 'ginatra/repo'
+require 'ginatra/repo_list'
+require 'ginatra/repo_stats'
 
-# Written myself. i know, what the hell?!
 module Ginatra
+  # The main application class.
+  # Contains all the core application logic and mounted in +config.ru+ file.
+  class App < Sinatra::Base
+    helpers Helpers, Sinatra::Partials
 
-  autoload :Config,   "ginatra/config"
-  autoload :Helpers,  "ginatra/helpers"
-  autoload :Repo,     "ginatra/repo"
-  autoload :RepoList, "ginatra/repo_list"
-  autoload :GraphCommit, "ginatra/graph_commit"
+    configure do
+      set :host, Ginatra.config.host
+      set :port, Ginatra.config.port
+      set :public_folder, "#{settings.root}/../public"
+      set :views, "#{settings.root}/../views"
+      enable :dump_errors, :logging, :static
+    end
 
-  # A standard error class for inheritance.
-  class Error < StandardError; end
+    configure :development do
+      # Use better errors in development
+      require 'better_errors'
+      use BetterErrors::Middleware
+      BetterErrors.application_root = settings.root
 
-  # An error related to a commit somewhere.
-  class CommitsError < Error
-    def initialize(repo)
-      super("Something went wrong looking for the commits for #{repo}")
+      # Reload modified files in development
+      require 'sinatra/reloader'
+      register Sinatra::Reloader
+      Dir["#{settings.root}/ginatra/*.rb"].each { |file| also_reload file }
     end
-  end
 
-  # Error raised when commit ref passed in parameters
-  # does not exist in repository
-  class InvalidCommit < Error
-    def initialize(id)
-      super("Could not find a commit with the id of #{id}")
+    def cache(obj)
+      etag obj if settings.production?
     end
-  end
-
-  VERSION = "3.0.1"
-
-  # The main application class.
-  #
-  # This class contains all the core application logic
-  # and is what is mounted by the +rackup.ru+ files.
-  class App < Sinatra::Base
 
-    # logger that can be used with the Sinatra code
-    def logger
-      Ginatra::Config.logger
+    not_found do
+      erb :'404', layout: false
     end
 
-    configure do
-      Config.load!
-      set :host, Ginatra::Config[:host]
-      set :port, Ginatra::Config[:port]
-      set :raise_errors, Proc.new { test? }
-      set :show_exceptions, Proc.new { development? }
-      set :dump_errors, true
-      set :logging, Proc.new { !test? }
-      set :static, true
-      current_path = File.expand_path(File.dirname(__FILE__))
-      set :public, "#{current_path}/../public"
-      set :views, "#{current_path}/../views"
+    error Ginatra::RepoNotFound, Ginatra::InvalidRef,
+          Rugged::OdbError, Rugged::ObjectError, Rugged::InvalidError do
+      halt 404, erb(:'404', layout: false)
     end
 
-    helpers Helpers, Sinatra::Partials
-
-    # Let's handle a CommitsError.
-    #
-    # @todo prettify
-    error CommitsError do
-      'No commits were returned for ' + request.uri
+    error 500 do
+      erb :'500', layout: false
     end
 
     # The root route
-    # This works by interacting with the Ginatra::Repolist singleton.
     get '/' do
+      @repositories = Ginatra::RepoList.list
       erb :index
     end
 
@@ -80,47 +65,34 @@ module Ginatra
     get '/:repo.atom' do
       @repo = RepoList.find(params[:repo])
       @commits = @repo.commits
-      return "" if @commits.empty?
-      etag(@commits.first.id) if Ginatra::App.production?
-      builder :atom, :layout => nil
+
+      if @commits.empty?
+        return ''
+      else
+        cache "#{@commits.first.oid}/atom"
+        content_type 'application/xml'
+        erb :atom, layout: false
+      end
     end
 
     # The html page for a +repo+.
     #
-    # Shows the most recent commits in a log format
+    # Shows the most recent commits in a log format.
     #
     # @param [String] repo the repository url-sanitised-name
-    get '/:repo' do
+    get '/:repo/?' do
       @repo = RepoList.find(params[:repo])
-      @commits = @repo.commits
-      etag(@commits.first.id) if Ginatra::App.production?
-      erb :log
-    end
 
-    get '/:repo/graph' do
-      @repo = RepoList.find(params[:repo])
-      max_count = 650
-      max_count = params[:max_count].to_i unless params[:max_count].nil?
-      commits = @repo.all_commits(max_count)
-
-      days = GraphCommit.index_commits(commits)
-      @days_json = days.compact.collect{|d|[d.day,d.strftime("%b")]}.to_json
-      @commits_json = commits.collect do |c|
-        h = {}
-        h[:parents] = c.parents.collect do |p|
-          [p.id,0,0]
-        end
-        h[:author] = c.author.name.force_encoding("UTF-8")
-        h[:time] = c.time
-        h[:space] = c.space
-        h[:refs] = c.refs.collect{|r|r.name}.join(" ") unless c.refs.nil?
-        h[:id] = c.sha
-        h[:date] = c.date
-        h[:message] = c.message.force_encoding("UTF-8")
-        h[:login] = c.author.email
-        h
-      end.to_json
-      erb :graph
+      if @repo.branches.none?
+        erb :empty_repo
+      else
+        params[:page] = 1
+        params[:ref] = @repo.branch_exists?('master') ? 'master' : @repo.branches.first.name
+        @commits = @repo.commits(params[:ref])
+        cache "#{@commits.first.oid}/log"
+        @next_commits = !@repo.commits(params[:ref], 10, 10).nil?
+        erb :log
+      end
     end
 
     # The atom feed of recent commits to a certain branch of a +repo+.
@@ -130,33 +102,54 @@ module Ginatra
     get '/:repo/:ref.atom' do
       @repo = RepoList.find(params[:repo])
       @commits = @repo.commits(params[:ref])
-      return "" if @commits.empty?
-      etag(@commits.first.id) if Ginatra::App.production?
-      builder :atom, :layout => nil
+
+      if @commits.empty?
+        return ''
+      else
+        cache "#{@commits.first.oid}/atom/ref"
+        content_type 'application/xml'
+        erb :atom, layout: false
+      end
     end
 
     # The html page for a given +ref+ of a +repo+.
     #
-    # Shows the most recent commits in a log format
+    # Shows the most recent commits in a log format.
     #
     # @param [String] repo the repository url-sanitised-name
     # @param [String] ref the repository ref
     get '/:repo/:ref' do
-      params[:page] = 1
       @repo = RepoList.find(params[:repo])
       @commits = @repo.commits(params[:ref])
-      etag(@commits.first.id) if Ginatra::App.production?
+      cache "#{@commits.first.oid}/ref" if @commits.any?
+      params[:page] = 1
+      @next_commits = !@repo.commits(params[:ref], 10, 10).nil?
       erb :log
     end
 
+    # The html page for a +repo+ stats.
+    #
+    # Shows information about repository branch.
+    #
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] ref the repository ref
+    get '/:repo/stats/:ref' do
+      @repo = RepoList.find(params[:repo])
+      @stats = RepoStats.new(@repo, params[:ref])
+      erb :stats
+    end
+
     # The patch file for a given commit to a +repo+.
     #
     # @param [String] repo the repository url-sanitised-name
     # @param [String] commit the repository commit
     get '/:repo/commit/:commit.patch' do
-      response['Content-Type'] = "text/plain"
-      @repo = RepoList.find(params[:repo])
-      @repo.git.format_patch({}, "--stdout", "-1", params[:commit])
+      content_type :txt
+      repo   = RepoList.find(params[:repo])
+      commit = repo.commit(params[:commit])
+      cache "#{commit.oid}/patch"
+      diff   = commit.parents.first.diff(commit)
+      diff.patch
     end
 
     # The html representation of a commit.
@@ -165,64 +158,58 @@ module Ginatra
     # @param [String] commit the repository commit
     get '/:repo/commit/:commit' do
       @repo = RepoList.find(params[:repo])
-      @commit = @repo.commit(params[:commit]) # can also be a ref
-      etag(@commit.id) if Ginatra::App.production?
-      erb(:commit)
+      @commit = @repo.commit(params[:commit])
+      cache @commit.oid
+      erb :commit
     end
 
-    # Download an archive of a given tree!
+    # The html representation of a tag.
     #
     # @param [String] repo the repository url-sanitised-name
-    # @param [String] tree the repository tree
-    get '/:repo/archive/:tree.tar.gz' do
-      response['Content-Type'] = "application/x-tar-gz"
+    # @param [String] tag the repository tag
+    get '/:repo/tag/:tag' do
       @repo = RepoList.find(params[:repo])
-      @repo.archive_tar_gz(params[:tree])
+      @commit = @repo.commit_by_tag(params[:tag])
+      cache "#{@commit.oid}/tag"
+      erb :commit
     end
 
     # HTML page for a given tree in a given +repo+
     #
-    # @todo cleanup!
     # @param [String] repo the repository url-sanitised-name
     # @param [String] tree the repository tree
     get '/:repo/tree/:tree' do
       @repo = RepoList.find(params[:repo])
+      @tree = @repo.find_tree(params[:tree])
+      cache @tree.oid
 
-      if (tag = @repo.git.rev_parse({'--verify' => ''}, "#{params[:tree]}^{tree}")).empty?
-        # we don't have a tree.
-        not_found
-      else
-        etag(tag) if Ginatra::App.production?
-      end
-
-      @tree = @repo.tree(params[:tree]) # can also be a ref (i think)
-      @path = {}
-      @path[:tree] = "#{params[:repo]}/tree/#{params[:tree]}"
-      @path[:blob] = "#{params[:repo]}/blob/#{params[:tree]}"
-      erb(:tree)
+      @path = {
+        blob: "#{params[:repo]}/blob/#{params[:tree]}",
+        tree: "#{params[:repo]}/tree/#{params[:tree]}"
+      }
+      erb :tree, layout: !is_pjax?
     end
 
     # HTML page for a given tree in a given +repo+.
     #
-    # This one supports a splat parameter so you can specify a path
+    # This one supports a splat parameter so you can specify a path.
     #
-    # @todo cleanup!
     # @param [String] repo the repository url-sanitised-name
     # @param [String] tree the repository tree
-    get '/:repo/tree/:tree/*' do # for when we specify a path
+    get '/:repo/tree/:tree/*' do
       @repo = RepoList.find(params[:repo])
-      @tree = @repo.tree(params[:tree])/params[:splat].first # can also be a ref (i think)
-      if @tree.is_a?(Grit::Blob)
-        # we need @tree to be a tree. if it's a blob, send it to the blob page
-        # this allows people to put in the remaining part of the path to the file, rather than endless clicks like you need in github
-        redirect "#{params[:repo]}/blob/#{params[:tree]}/#{params[:splat].first}"
-      else
-        etag(@tree.id) if Ginatra::App.production?
-        @path = {}
-        @path[:tree] = "#{params[:repo]}/tree/#{params[:tree]}/#{params[:splat].first}"
-        @path[:blob] = "#{params[:repo]}/blob/#{params[:tree]}/#{params[:splat].first}"
-        erb(:tree)
+      @tree = @repo.find_tree(params[:tree])
+      cache "#{@tree.oid}/#{params[:splat].first}"
+
+      @tree.walk(:postorder) do |root, entry|
+        @tree = @repo.lookup entry[:oid] if "#{root}#{entry[:name]}" == params[:splat].first
       end
+
+      @path = {
+        blob: "#{params[:repo]}/blob/#{params[:tree]}/#{params[:splat].first}",
+        tree: "#{params[:repo]}/tree/#{params[:tree]}/#{params[:splat].first}"
+      }
+      erb :tree, layout: !is_pjax?
     end
 
     # HTML page for a given blob in a given +repo+
@@ -231,49 +218,75 @@ module Ginatra
     # @param [String] tree the repository tree
     get '/:repo/blob/:blob' do
       @repo = RepoList.find(params[:repo])
-      @blob = @repo.blob(params[:blob])
-      etag(@blob.id) if Ginatra::App.production?
-      erb(:blob)
+      @tree = @repo.lookup(params[:tree])
+
+      @tree.walk(:postorder) do |root, entry|
+        @blob = entry if "#{root}#{entry[:name]}" == params[:splat].first
+      end
+
+      cache @blob[:oid]
+      erb :blob, layout: !is_pjax?
     end
 
     # HTML page for a given blob in a given repo.
     #
     # Uses a splat param to specify a blob path.
     #
-    # @todo cleanup!
     # @param [String] repo the repository url-sanitised-name
     # @param [String] tree the repository tree
     get '/:repo/blob/:tree/*' do
       @repo = RepoList.find(params[:repo])
-      @blob = @repo.tree(params[:tree])/params[:splat].first
-      if @blob.is_a?(Grit::Tree)
-        # as above, we need @blob to be a blob. if it's a tree, send it to the tree page
-        # this allows people to put in the remaining part of the path to the folder, rather than endless clicks like you need in github
-        redirect "/#{params[:repo]}/tree/#{params[:tree]}/#{params[:splat].first}"
+      @tree = @repo.find_tree(params[:tree])
+
+      @tree.walk(:postorder) do |root, entry|
+        @blob = entry if "#{root}#{entry[:name]}" == params[:splat].first
+      end
+
+      cache "#{@blob[:oid]}/#{@tree.oid}"
+      erb :blob, layout: !is_pjax?
+    end
+
+    # HTML page for a raw blob contents in a given repo.
+    #
+    # Uses a splat param to specify a blob path.
+    #
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] tree the repository tree
+    get '/:repo/raw/:tree/*' do
+      @repo = RepoList.find(params[:repo])
+      @tree = @repo.find_tree(params[:tree])
+
+      @tree.walk(:postorder) do |root, entry|
+        @blob = entry if "#{root}#{entry[:name]}" == params[:splat].first
+      end
+
+      cache "#{@blob[:oid]}/#{@tree.oid}/raw"
+      blob = @repo.find_blob @blob[:oid]
+      if blob.binary?
+        content_type 'application/octet-stream'
+        blob.text
       else
-        etag(@blob.id) if Ginatra::App.production?
-        erb(:blob)
+        content_type :txt
+        blob.text
       end
     end
 
-    # pagination route for the commits to a given ref in a +repo+.
+    # Pagination route for the commits to a given ref in a +repo+.
     #
-    # @todo cleanup!
     # @param [String] repo the repository url-sanitised-name
     # @param [String] ref the repository ref
-    get '/:repo/:ref/:page' do
-      pass unless params[:page] =~ /^(\d)+$/
+    get '/:repo/:ref/page/:page' do
+      pass unless params[:page] =~ /\A\d+\z/
       params[:page] = params[:page].to_i
       @repo = RepoList.find(params[:repo])
       @commits = @repo.commits(params[:ref], 10, (params[:page] - 1) * 10)
-      @next_commits = !@repo.commits(params[:ref], 10, params[:page] * 10).empty?
+      cache "#{@commits.first.oid}/page/#{params[:page]}/ref/#{params[:ref]}" if @commits.any?
+      @next_commits = !@repo.commits(params[:ref], 10, params[:page] * 10).nil?
       if params[:page] - 1 > 0
         @previous_commits = !@repo.commits(params[:ref], 10, (params[:page] - 1) * 10).empty?
       end
-      @separator = @next_commits && @previous_commits
       erb :log
     end
 
   end # App
-
 end # Ginatra