gollum 1.0.1 → 1.1.0

data/HISTORY.md

@@ -1,6 +1,36 @@
+# 1.1.0 / 2010-10-28
+
+* Major Enhancements
+  * Optimize page write/update/delete to use Grit::Index::read_tree instead
+    of manually recreating entire index contents.
+  * Added --irb option for the gollum command.
+  * Update working dir (if present) when edited via the API (#6)
+  * Add basic `git grep` based search for repos.
+* Minor Enhancements
+  * Support a `:gollum_path` Sinatra setting for `Precious::App`
+  * Add Wiki#size to efficiently count pages without loading them.
+  * Add the correct content type when serving files from the frontend.
+  * Add --host option and default it to 127.0.0.1.
+  * Allow anchors in page links, such as `[[Abc#header]]`.
+  * All pages retrieved with a SHA add `rel="nofollow"` to all
+    page links.
+* Bug Fixes
+  * Increase minimum Sanitize version requirement to 1.1.0.
+    1.0.x versions of Sanitize require Hpricot instead of Nokogiri
+    and have bugs that may allow non-whitelisted HTML to sneak
+    through.
+  * Introduce Ruby 1.9 compatibility fixes.
+  * Commit hashes are normalized so that missing author data is replaced with
+    anonymous info.
+  * Prevent `Gollum::Wiki#write_page` from clobbering existing pages.
+  * Handle duplicate page errors in frontend.
+  * Fix bugs trying to retrieve pages with invalid names.
+  * CGI escape page names in links and redirects.
+
 # 1.0.1 / 2010-08-12
 
-* Force Grit dep to 2.1 or higher.
+* Bug Fixes
+  * Force Grit dep to 2.1 or higher.
 
 # 1.0.0 / 2010-08-12
 

data/README.md

@@ -63,7 +63,7 @@ choose. Special footers can be created in `footer files`. Other content
 ## PAGE FILES
 
 Page files may be written in any format supported by
-[GitHub-Markup](http://github.com/defunkt/github-markup) (except roff). The
+[GitHub-Markup](http://github.com/github/markup) (except roff). The
 current list of formats and allowed extensions is:
 
 * ASCIIDoc: .asciidoc
@@ -326,7 +326,7 @@ Initialize the Gollum::Repo object:
     wiki = Gollum::Wiki.new("my-gollum-repo.git")
     # => <Gollum::Wiki>
 
-By default, internal wiki links are all absolute from the root. To specify a different base path, you can send specify the `:base_path` option:
+By default, internal wiki links are all absolute from the root. To specify a different base path, you can specify the `:base_path` option:
 
     wiki = Gollum::Wiki.new("my-gollum-repo.git", :base_path => "/wiki")
 

data/Rakefile

@@ -47,7 +47,7 @@ task :default => :test
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
+  test.libs << 'lib' << 'test' << '.'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
@@ -143,4 +143,4 @@ task :validate do
     puts "A `VERSION` file at root level violates Gem best practices."
     exit!
   end
-end
+end

data/bin/gollum

@@ -8,18 +8,17 @@ Gollum is a multi-format Wiki Engine/API/Frontend.
 Basic Command Line Usage:
   gollum [OPTIONS] [PATH]
 
-        PATH                         The path to the Gollum repository.
+        PATH                         The path to the Gollum repository (default .).
 
 Options:
 HELP
 
 require 'optparse'
-
 require 'rubygems'
-require 'gollum/frontend/app'
+require 'gollum'
 
 exec = {}
-options = {}
+options = { 'port' => 4567, 'bind' => '127.0.0.1' }
 opts = OptionParser.new do |opts|
   opts.banner = help
 
@@ -27,15 +26,78 @@ opts = OptionParser.new do |opts|
     options['port'] = port.to_i
   end
 
+  opts.on("--host [HOST]", "Hostname or IP address to listen on (default 0.0.0.0).") do |host|
+    options['bind'] = host
+  end
+
   opts.on("--version", "Display current version.") do
     puts "Gollum " + Gollum::VERSION
     exit 0
   end
+
+  opts.on("--irb", "Start an irb process with gollum loaded for the current wiki.") do
+    options['irb'] = true
+  end
 end
 
 # Read command line options into `options` hash
-opts.parse!
+begin
+  opts.parse!
+rescue OptionParser::InvalidOption
+  puts "gollum: #{$!.message}"
+  puts "gollum: try 'gollum --help' for more information"
+  exit
+end
 
-$path = ARGV[0] || Dir.pwd
+gollum_path = ARGV[0] || Dir.pwd
 
-Precious::App.run!(options)
+if options['irb']
+  require 'irb'
+  # http://jameskilton.com/2009/04/02/embedding-irb-into-your-ruby-application/
+  module IRB # :nodoc:
+    def self.start_session(binding)
+      unless @__initialized
+        args = ARGV
+        ARGV.replace(ARGV.dup)
+        IRB.setup(nil)
+        ARGV.replace(args)
+        @__initialized = true
+      end
+ 
+      ws  = WorkSpace.new(binding)
+      irb = Irb.new(ws)
+ 
+      @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
+      @CONF[:MAIN_CONTEXT] = irb.context
+ 
+      catch(:IRB_EXIT) do
+        irb.eval_input
+      end
+    end
+  end
+
+  begin
+    wiki = Gollum::Wiki.new(gollum_path)
+    if !wiki.exist? then raise Grit::InvalidGitRepositoryError end
+    puts "Loaded Gollum wiki at #{File.expand_path(gollum_path).inspect}."
+    puts 
+    puts %(    page = wiki.page('page-name'))
+    puts %(    # => <Gollum::Page>)
+    puts
+    puts %(    page.raw_data)
+    puts %(    # => "# My wiki page")
+    puts
+    puts %(    page.formatted_data)
+    puts %(    # => "<h1>My wiki page</h1>")
+    puts
+    puts "Check out the Gollum README for more."
+    IRB.start_session(binding)
+  rescue Grit::InvalidGitRepositoryError, Grit::NoSuchPathError
+    puts "Invalid Gollum wiki at #{File.expand_path(gollum_path).inspect}"
+    exit 0
+  end
+else
+  require 'gollum/frontend/app'
+  Precious::App.set(:gollum_path, gollum_path)
+  Precious::App.run!(options)
+end

data/gollum.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'gollum'
-  s.version           = '1.0.1'
-  s.date              = '2010-08-12'
+  s.version           = '1.1.0'
+  s.date              = '2010-10-28'
   s.rubyforge_project = 'gollum'
 
   s.summary     = "A simple, Git-powered wiki."
@@ -23,17 +23,19 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.md LICENSE]
 
-  s.add_dependency('grit', "~> 2.1")
+  s.add_dependency('grit', "~> 2.3")
   s.add_dependency('github-markup', [">= 0.4.0", "< 1.0.0"])
   s.add_dependency('albino', "~> 1.0")
   s.add_dependency('sinatra', "~> 1.0")
   s.add_dependency('mustache', [">= 0.11.2", "< 1.0.0"])
-  s.add_dependency('sanitize', "~> 1.0")
+  s.add_dependency('sanitize', "~> 1.1")
   s.add_dependency('nokogiri', "~> 1.4")
 
-  s.add_development_dependency('shoulda')
+  s.add_development_dependency('RedCloth')
   s.add_development_dependency('mocha')
   s.add_development_dependency('org-ruby')
+  s.add_development_dependency('rdiscount')
+  s.add_development_dependency('shoulda')
 
   # = MANIFEST =
   s.files = %w[
@@ -46,6 +48,7 @@ Gem::Specification.new do |s|
     gollum.gemspec
     lib/gollum.rb
     lib/gollum/albino.rb
+    lib/gollum/blob_entry.rb
     lib/gollum/file.rb
     lib/gollum/frontend/app.rb
     lib/gollum/frontend/public/css/editbar.css
@@ -443,19 +446,24 @@ Gem::Specification.new do |s|
     lib/gollum/frontend/templates/create.mustache
     lib/gollum/frontend/templates/edit.mustache
     lib/gollum/frontend/templates/editbar.mustache
+    lib/gollum/frontend/templates/error.mustache
     lib/gollum/frontend/templates/history.mustache
     lib/gollum/frontend/templates/layout.mustache
     lib/gollum/frontend/templates/page.mustache
+    lib/gollum/frontend/templates/search.mustache
     lib/gollum/frontend/views/compare.rb
     lib/gollum/frontend/views/create.rb
     lib/gollum/frontend/views/edit.rb
     lib/gollum/frontend/views/editable.rb
+    lib/gollum/frontend/views/error.rb
     lib/gollum/frontend/views/history.rb
     lib/gollum/frontend/views/layout.rb
     lib/gollum/frontend/views/page.rb
+    lib/gollum/frontend/views/search.rb
     lib/gollum/markup.rb
     lib/gollum/page.rb
     lib/gollum/pagination.rb
+    lib/gollum/ruby1.8.rb
     lib/gollum/wiki.rb
     templates/formatting.html
     test/examples/lotr.git/HEAD
@@ -503,4 +511,4 @@ Gem::Specification.new do |s|
   # = MANIFEST =
 
   s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
-end
+end

data/lib/gollum.rb

@@ -1,13 +1,18 @@
 # stdlib
 require 'digest/md5'
+require 'ostruct'
 
 # external
 require 'grit'
 require 'github/markup'
 require 'sanitize'
 
+# ruby 1.8 compatibility
+require 'gollum/ruby1.8'
+
 # internal
 require 'gollum/pagination'
+require 'gollum/blob_entry'
 require 'gollum/wiki'
 require 'gollum/page'
 require 'gollum/file'
@@ -15,7 +20,7 @@ require 'gollum/markup'
 require 'gollum/albino'
 
 module Gollum
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 
   SANITIZATION_OPTIONS = {
     :elements => [
@@ -54,5 +59,24 @@ module Gollum
       'img' => {'href' => ['http', 'https', :relative]}
     }
   }
+  HISTORY_SANITIZATION_OPTIONS = SANITIZATION_OPTIONS.merge(
+    :add_attributes => {
+      'a' => {'rel' => 'nofollow'}
+    }
+  )
+
+  class Error < StandardError; end
+  class DuplicatePageError < Error
+    attr_accessor :dir
+    attr_accessor :existing_path
+    attr_accessor :attempted_path
+
+    def initialize(dir, existing, attempted, message = nil)
+      @dir            = dir
+      @existing_path  = existing
+      @attempted_path = attempted
+      super(message || "Cannot write #{@dir}/#{@attempted_path}, found #{@dir}/#{@existing_path}.")
+    end
+  end
 end
 

data/lib/gollum/blob_entry.rb

@@ -0,0 +1,71 @@
+module Gollum
+  class BlobEntry
+    # Gets the String SHA for this blob.
+    attr_reader :sha
+
+    # Gets the String full path for this blob.
+    attr_reader :path
+
+    def initialize(sha, path)
+      @sha  = sha
+      @path = path
+      @dir = @name = @blob = nil
+    end
+
+    # Gets the normalized directory path for this blob.
+    def dir
+      @dir ||= self.class.normalize_dir(::File.dirname(@path))
+    end
+
+    # Gets the String file base name for this blob.
+    def name
+      @name ||= ::File.basename(@path)
+    end
+
+    # Gets a Grit::Blob instance for this blob.
+    #
+    # repo - Grit::Repo instance for the Grit::Blob.
+    #
+    # Returns an unbaked Grit::Blob instance.
+    def blob(repo)
+      @blob ||= Grit::Blob.create(repo, :id => @sha, :name => @name)
+    end
+
+    # Gets a Page instance for this blob.
+    #
+    # wiki - Gollum::Wiki instance for the Gollum::Page
+    #
+    # Returns a Gollum::Page instance.
+    def page(wiki, commit)
+      blob = self.blob(wiki.repo)
+      page = wiki.page_class.new(wiki).populate(blob, self.dir)
+      page.version = commit
+      page
+    end
+
+    def inspect
+      %(#<Gollum::BlobEntry #{@sha} #{@path}>)
+    end
+
+    # Normalizes a given directory name for searching through tree paths.
+    # Ensures that a directory begins with a slash, or 
+    #
+    #   normalize_dir("")      # => ""
+    #   normalize_dir(".")     # => ""
+    #   normalize_dir("foo")   # => "/foo"
+    #   normalize_dir("/foo/") # => "/foo"
+    #   normalize_dir("/")     # => ""
+    #
+    # dir - String directory name.
+    #
+    # Returns a normalized String directory name, or nil if no directory 
+    # is given.
+    def self.normalize_dir(dir)
+      if dir
+        dir = ::File.expand_path(dir, '/')
+        dir = '' if dir == '/'
+      end
+      dir
+    end
+  end
+end

data/lib/gollum/file.rb

@@ -33,6 +33,11 @@ module Gollum
     # Public: The String path of the file.
     attr_reader :path
 
+    # Public: The String mime type of the file.
+    def mime_type
+      @blob.mime_type
+    end
+
     #########################################################################
     #
     # Internal Methods
@@ -46,14 +51,14 @@ module Gollum
     #
     # Returns a Gollum::File or nil if the file could not be found.
     def find(name, version)
-      commit = @wiki.repo.commit(version)
-      if blob = commit.tree / name
-        @blob    = blob
+      checked = name.downcase
+      map     = @wiki.tree_map_for(version)
+      sha     = @wiki.ref_map[version] || version
+      if entry = map.detect { |entry| entry.path.downcase == checked }
         @path    = name
-        @version = commit
+        @blob    = Grit::Blob.create(@wiki.repo,   :id => entry.sha, :name => entry.name)
+        @version = Grit::Commit.create(@wiki.repo, :id => sha)
         self
-      else
-        nil
       end
     end
   end

data/lib/gollum/frontend/app.rb

@@ -1,3 +1,4 @@
+require 'cgi'
 require 'sinatra'
 require 'gollum'
 require 'mustache/sinatra'
@@ -12,6 +13,7 @@ module Precious
     dir = File.dirname(File.expand_path(__FILE__))
 
     # We want to serve public assets for now
+
     set :public,    "#{dir}/public"
     set :static,    true
 
@@ -38,9 +40,9 @@ module Precious
       show_page_or_file('Home')
     end
 
-    get '/edit/:name' do
-      @name = params[:name]
-      wiki = Gollum::Wiki.new($path)
+    get '/edit/*' do
+      @name = params[:splat].first
+      wiki = Gollum::Wiki.new(settings.gollum_path)
       if page = wiki.page(@name)
         @page = page
         @content = page.raw_data
@@ -50,38 +52,43 @@ module Precious
       end
     end
 
-    post '/edit/:name' do
-      name   = params[:name]
-      wiki   = Gollum::Wiki.new($path)
+    post '/edit/*' do
+      name   = params[:splat].first
+      wiki   = Gollum::Wiki.new(settings.gollum_path)
       page   = wiki.page(name)
       format = params[:format].intern
       name   = params[:rename] if params[:rename]
 
       wiki.update_page(page, name, format, params[:content], commit_message)
 
-      redirect "/#{Gollum::Page.cname name}"
+      redirect "/#{CGI.escape(Gollum::Page.cname(name))}"
     end
 
-    post '/create/:name' do
+    post '/create/*' do
       name = params[:page]
-      wiki = Gollum::Wiki.new($path)
+      wiki = Gollum::Wiki.new(settings.gollum_path)
 
       format = params[:format].intern
 
-      wiki.write_page(name, format, params[:content], commit_message)
-      redirect "/#{name}"
+      begin
+        wiki.write_page(name, format, params[:content], commit_message)
+        redirect "/#{CGI.escape(name)}"
+      rescue Gollum::DuplicatePageError => e
+        @message = "Duplicate page: #{e.message}"
+        mustache :error
+      end
     end
 
     post '/preview' do
       format = params['wiki_format']
       data = params['text']
-      wiki = Gollum::Wiki.new($path)
+      wiki = Gollum::Wiki.new(settings.gollum_path)
       wiki.preview_page("Preview", data, format).formatted_data
     end
 
     get '/history/:name' do
       @name     = params[:name]
-      wiki      = Gollum::Wiki.new($path)
+      wiki      = Gollum::Wiki.new(settings.gollum_path)
       @page     = wiki.page(@name)
       @page_num = [params[:page].to_i, 1].max
       @versions = @page.versions :page => @page_num
@@ -91,10 +98,10 @@ module Precious
     post '/compare/:name' do
       @versions = params[:versions] || []
       if @versions.size < 2
-        redirect "/history/#{params[:name]}"
+        redirect "/history/#{CGI.escape(params[:name])}"
       else
         redirect "/compare/%s/%s...%s" % [
-          params[:name],
+          CGI.escape(params[:name]),
           @versions.last,
           @versions.first]
       end
@@ -103,7 +110,7 @@ module Precious
     get '/compare/:name/:version_list' do
       @name     = params[:name]
       @versions = params[:version_list].split(/\.{2,3}/)
-      wiki      = Gollum::Wiki.new($path)
+      wiki      = Gollum::Wiki.new(settings.gollum_path)
       @page     = wiki.page(@name)
       diffs     = wiki.repo.diff(@versions.first, @versions.last, @page.path)
       @diff     = diffs.first
@@ -112,7 +119,7 @@ module Precious
 
     get %r{/(.+?)/([0-9a-f]{40})} do
       name = params[:captures][0]
-      wiki = Gollum::Wiki.new($path)
+      wiki = Gollum::Wiki.new(settings.gollum_path)
       if page = wiki.page(name, params[:captures][1])
         @page = page
         @name = name
@@ -123,18 +130,26 @@ module Precious
       end
     end
 
+    get '/search' do
+      @query = params[:q]
+      wiki = Gollum::Wiki.new(settings.gollum_path)
+      @results = wiki.search @query
+      mustache :search
+    end
+
     get '/*' do
       show_page_or_file(params[:splat].first)
     end
 
     def show_page_or_file(name)
-      wiki = Gollum::Wiki.new($path)
+      wiki = Gollum::Wiki.new(settings.gollum_path)
       if page = wiki.page(name)
         @page = page
         @name = name
         @content = page.formatted_data
         mustache :page
       elsif file = wiki.file(name)
+        content_type file.mime_type
         file.raw_data
       else
         @name = name
@@ -143,12 +158,7 @@ module Precious
     end
 
     def commit_message
-      message = params[:message]
-      author_name = `git config --get user.name`.strip || 'Anonymous'
-      author_email = `git config --get user.email`.strip || 'anon@anon.com'
-      { :message => message,
-        :name => author_name,
-        :email => author_email }
+      { :message => params[:message] }
     end
   end
 end