Release 2.2.9

Base path now sets a default map without having to use an external config.ru.

README.md

@@ -413,6 +413,17 @@ By default, internal wiki links are all absolute from the root. To specify a dif
 
     wiki = Gollum::Wiki.new("my-gollum-repo.git", :base_path => "/wiki")
 
+Note that base_path just modifies the links. To map gollum to a non-root location:
+
+- Use the gollum binary: `gollum path/to/wiki --base-path mywiki`
+- Define config.ru with `map`. See [#532](https://github.com/github/gollum/issues/532) for an example.
+
+> :base_path     - String base path for all Wiki links.
+>
+> The String base path to prefix to internal links. For example, when set
+> to "/wiki", the page "Hobbit" will be linked as "/wiki/Hobbit". Defaults
+> to "/".
+
 Get the latest version of the given human or canonical page name:
 
     page = wiki.page('page-name')

bin/gollum

@@ -141,5 +141,31 @@ else
     require cfg
   end
 
-  Precious::App.run!(options)
+  base_path = wiki_options[:base_path]
+
+  if wiki_options[:base_path].nil?
+    Precious::App.run!(options)
+  else
+    require 'rack'
+
+    class MapGollum
+      def initialize base_path
+        @mg = Rack::Builder.new do
+          map '/' do
+            run Proc.new { [ 302, {'Location'=> "/#{base_path}" }, [] ] }
+          end
+
+          map "/#{base_path}" do
+            run Precious::App
+          end
+        end
+      end
+
+      def call(env)
+        @mg.call(env)
+      end
+    end
+    # Rack::Handler does not work with Ctrl + C. Use Rack::Server instead.
+    Rack::Server.new(:app => MapGollum.new(base_path), :Port => options['port']).start
+  end
 end

gollum.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.8.7"
 
   s.name              = 'gollum'
-  s.version           = '2.2.6'
+  s.version           = '2.2.9'
   s.date              = '2012-10-14'
   s.rubyforge_project = 'gollum'
 

lib/gollum.rb

@@ -23,7 +23,7 @@ require File.expand_path('../gollum/web_sequence_diagram', __FILE__)
 require File.expand_path('../gollum/frontend/uri_encode_component', __FILE__)
 
 module Gollum
-  VERSION = '2.2.6'
+  VERSION = '2.2.9'
 
   def self.assets_path
     ::File.expand_path('gollum/frontend/public', ::File.dirname(__FILE__))

lib/gollum/frontend/app.rb

@@ -86,7 +86,7 @@ module Precious
     end
 
     get '/' do
-      redirect File.join(settings.wiki_options[:base_path].to_s, 'Home')
+      redirect File.join(settings.wiki_options[:page_file_dir].to_s,settings.wiki_options[:base_path].to_s, 'Home')
     end
 
     # path is set to name if path is nil.
@@ -145,6 +145,7 @@ module Precious
       page_name = CGI.unescape(params[:page])
       wiki      = wiki_new
       page      = wiki.paged(page_name, path, exact = true)
+      return if page.nil?
       rename    = params[:rename].to_url if params[:rename]
       name      = rename || page.name
       committer = Gollum::Committer.new(wiki, commit_message)
@@ -190,13 +191,20 @@ module Precious
       path = '' if path.nil?
       format       = params[:format].intern
 
+      page_dir = File.join(settings.wiki_options[:page_file_dir].to_s,
+                           settings.wiki_options[:base_path].to_s)
+      # Home is a special case.
+      path = '' if name.downcase == 'home'
+
+      page_dir = File.join(page_dir, path)
+
       # write_page is not directory aware so use wiki_options to emulate dir support.
-      wiki_options = settings.wiki_options.merge({ :page_file_dir => path })
+      wiki_options = settings.wiki_options.merge({ :page_file_dir => page_dir })
       wiki         = Gollum::Wiki.new(settings.gollum_path, wiki_options)
 
       begin
         wiki.write_page(name, format, params[:content], commit_message)
-        redirect to("/#{clean_url(CGI.escape(::File.join(path,name)))}")
+        redirect to("/#{clean_url(CGI.escape(::File.join(page_dir,name)))}")
       rescue Gollum::DuplicatePageError => e
         @message = "Duplicate page: #{e.message}"
         mustache :error

lib/gollum/markup.rb

@@ -95,7 +95,8 @@ module Gollum
     def process_headers(doc)
       toc = nil
       doc.css('h1,h2,h3,h4,h5,h6').each do |h|
-        h_name = h.content.gsub(' ','-')
+        # must escape "
+        h_name = h.content.gsub(' ','-').gsub('"','%22')
 
         level = h.name.gsub(/[hH]/,'').to_i
 

test/test_app.rb

@@ -184,7 +184,7 @@ context "Frontend" do
     name = "A"
     post "/create", :content => 'abc', :page => name,
       :format => 'markdown', :message => 'def'
-    follow_redirect!
+
     assert last_response.ok?
 
     @wiki.clear_cache
@@ -273,6 +273,9 @@ context "Frontend" do
     Precious::App.set(:wiki_options, { :base_path => '/wiki/' })
     get "/"
     assert_match "http://example.org/wiki/Home", last_response.headers['Location']
+
+    # Reset base path
+    Precious::App.set(:wiki_options, { :base_path => nil })
   end
   
   test "author details in session are used" do
@@ -377,6 +380,7 @@ context "Frontend with lotr" do
   test "edit pages within sub-directories" do
     post "/create", :content => 'big smelly creatures', :page => 'Orc',
       :path => 'Mordor', :format => 'markdown', :message => 'oooh, scary'
+
     assert_equal 'http://example.org/Mordor/orc', last_response.headers['Location']
 
     post "/edit/Mordor/Orc", :content => 'not so big smelly creatures',

test/test_unicode.rb

@@ -42,21 +42,21 @@ context "Unicode Support" do
   end
 
   test "create and read non-latin page with anchor 2" do
-    @wiki.write_page("test", :markdown, "# La faune d'Édiacara")
+    @wiki.write_page("test", :markdown, "# \"La\" faune d'Édiacara")
 
     page = @wiki.page("test")
     assert_equal Gollum::Page, page.class
-    assert_equal "# La faune d'Édiacara", utf8(page.raw_data)
+    assert_equal "# \"La\" faune d'Édiacara", utf8(page.raw_data)
 
-    # markup.rb
+    # markup.rb test: ', ", É
     doc     = Nokogiri::HTML page.formatted_data
     h1s     = doc / :h1
     h1      = h1s.first
     anchors = h1 / :a
     assert_equal 1, h1s.size
     assert_equal 1, anchors.size
-    assert_equal %q(#La-faune-d'Édiacara), anchors[0]['href']
-    assert_equal %q(La-faune-d'Édiacara),  anchors[0]['id']
+    assert_equal %q(#%22La%22-faune-d'Édiacara), anchors[0]['href']
+    assert_equal %q(%22La%22-faune-d'Édiacara),  anchors[0]['id']
     assert_equal 'anchor',                 anchors[0]['class']
     assert_equal '',                       anchors[0].text
   end