gollum 2.0.0 → 2.1.0

data/test/test_git_access.rb

@@ -18,8 +18,9 @@ context "GitAccess" do
     assert @access.ref_map.empty?
     assert @access.tree_map.empty?
     @access.tree 'master'
-    assert_equal({"master"=>"1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3"}, @access.ref_map)
+    assert_equal({"master"=>"629aa678272b017a4d136d35e77ac94d80b08dc2"}, @access.ref_map)
 
+    @access.tree '1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3'
     map = @access.tree_map['1db89ebba7e2c14d93b94ff98cfa3708a4f0d4e3']
     assert_equal 'Bilbo-Baggins.md',        map[0].path
     assert_equal '',                        map[0].dir
@@ -49,4 +50,4 @@ context "GitAccess" do
   test "cannot access tree from invalid ref" do
     assert_equal [], @access.tree('foo')
   end
-end
+end

data/test/test_markup.rb

@@ -6,6 +6,7 @@ context "Markup" do
     @path = testpath("examples/test.git")
     FileUtils.rm_rf(@path)
     Grit::Repo.init_bare(@path)
+    Gollum::Wiki.default_options = {:universal_toc => false}
     @wiki = Gollum::Wiki.new(@path)
   end
 
@@ -173,7 +174,26 @@ context "Markup" do
     @wiki.write_page("Potato", :mediawiki, "a [[Potato|Potato Heaad]] ", commit_details)
     page = @wiki.page("Potato")
     output = page.formatted_data
-    assert_equal normal("<p>\na <a class=\"internal present\" href=\"/Potato\">Potato Heaad</a> </p>"), normal(output)
+    assert_equal normal("<p>\na <a class=\"internal present\" href=\"/Potato\">Potato Heaad</a> </p>
+"), normal(output)
+  end
+
+  test "wiki link within inline code block" do
+    @wiki.write_page("Potato", :markdown, "`sed -i '' 's/[[:space:]]*$//'`", commit_details)
+    page = @wiki.page("Potato")
+    assert_equal "<p><code>sed -i '' 's/[[:space:]]*$//'</code></p>", page.formatted_data
+  end
+
+  test "wiki link within code block" do
+    @wiki.write_page("Potato", :markdown, "    sed -i '' 's/[[:space:]]*$//'", commit_details)
+    page = @wiki.page("Potato")
+    assert_equal "<pre><code>sed -i '' 's/[[:space:]]*$//'\n</code></pre>", page.formatted_data
+  end
+
+  test "piped wiki link within code block" do
+    @wiki.write_page("Potato", :markdown, "`make a link [[home|sweet home]]`", commit_details)
+    page = @wiki.page("Potato")
+    assert_equal "<p><code>make a link [[home|sweet home]]</code></p>", page.formatted_data
   end
 
   #########################################################################
@@ -458,6 +478,20 @@ np.array([[2,2],[1,3]],np.float)
     assert_markup_highlights_code Gollum::Markup, rendered
   end
 
+  test "code with trailing whitespace" do
+    content = <<-END
+shoop da woop
+
+``` python 
+np.array([[2,2],[1,3]],np.float)
+```
+    END
+
+    # rendered with Gollum::Markup
+    page, rendered = render_page(content)
+    assert_markup_highlights_code Gollum::Markup, rendered
+  end
+
   def assert_markup_highlights_code(markup_class, rendered)
     assert_match /div class="highlight"/, rendered, "#{markup_class} doesn't highlight code\n #{rendered}"
     assert_match /span class="n"/, rendered, "#{markup_class} doesn't highlight code\n #{rendered}"
@@ -471,7 +505,7 @@ np.array([[2,2],[1,3]],np.float)
   #########################################################################
 
   test "sequence diagram blocks" do
-    content = "a\n\n{{{default\nalice->bob: Test\n}}}\n\nb"
+    content = "a\n\n{{{{{{default\nalice->bob: Test\n}}}}}}\n\nb"
     output = /.*<img src="http:\/\/www\.websequencediagrams\.com\/\?img=\w{9}" \/>.*/
 
     index = @wiki.repo.index
@@ -501,7 +535,6 @@ np.array([[2,2],[1,3]],np.float)
     compare(content, output)
   end
 
-
   test "removes style blocks completely" do
     content = "<style>body { color: red }</style>foobar"
     output = "<p>foobar</p>"
@@ -555,14 +588,15 @@ np.array([[2,2],[1,3]],np.float)
 
   test "id with prefix ok" do
     content = "h2(example#wiki-foo). xxxx"
-    output = %(<h2 class="example" id="wiki-foo">xxxx</h2>)
-    compare(content, output, :textile)
-  end
+output = %(<h2 class="example" id="wiki-foo">xxxx<a class=\"anchor\" id=\"xxxx\" href=\"#xxxx\"></a></h2>)
+compare(content, output, :textile)
+end
 
   test "id prefix added" do
     content = "h2(#foo). xxxx[1]\n\nfn1.footnote"
     output = "<h2 id=\"wiki-foo\">xxxx" +
-             "<sup class=\"footnote\" id=\"wiki-fnr1\"><a href=\"#wiki-fn1\">1</a></sup></h2>" +
+             "<sup class=\"footnote\" id=\"wiki-fnr1\"><a href=\"#wiki-fn1\">1</a></sup>" +
+             "<a class=\"anchor\" id=\"xxxx1\" href=\"#xxxx1\"></a></h2>" +
              "\n<p class=\"footnote\" id=\"wiki-fn1\"><a href=\"#wiki-fnr1\"><sup>1</sup></a> footnote</p>"
     compare(content, output, :textile)
   end
@@ -585,13 +619,13 @@ np.array([[2,2],[1,3]],np.float)
 
   test "TeX block syntax" do
     content = 'a \[ a^2 \] b'
-    output = "<p>a<imgsrc=\"/_tex.png?type=block&data=YV4y\"alt=\"a^2\">b</p>"
+    output = "<p>a<imgwidth=\"15\"height=\"16\"style=\"vertical-align:-1px;\"src=\"/_tex.png?type=block&data=YV4y\"alt=\"a^2\"/>b</p>"
     compare(content, output, 'md')
   end
 
   test "TeX inline syntax" do
     content = 'a \( a^2 \) b'
-    output = "<p>a<imgsrc=\"/_tex.png?type=inline&data=YV4y\"alt=\"a^2\">b</p>"
+    output = "<p>a<imgwidth=\"15\"height=\"16\"style=\"vertical-align:-1px;\"src=\"/_tex.png?type=inline&data=YV4y\"alt=\"a^2\"/>b</p>"
     compare(content, output, 'md')
   end
 
@@ -600,14 +634,13 @@ np.array([[2,2],[1,3]],np.float)
   #########################################################################
 
   test "asciidoc header" do 
-    compare("= Book Title\n\n== Heading", '<div class="sect1"><h2 id="wiki-_heading">Heading</h2><div class="sectionbody"></div></div>', 'asciidoc')
+    compare("= Book Title\n\n== Heading", '<div class="sect1"><h2 id="wiki-_heading">Heading<a class="anchor" id="Heading" href="#Heading"></a></h2><div class="sectionbody"></div></div>', 'asciidoc')
   end
 
   test "internal links with asciidoc" do 
-    compare("= Book Title\n\n[[anid]]\n== Heading", '<div class="sect1"><h2 id="wiki-anid">Heading</h2><div class="sectionbody"></div></div>', 'asciidoc')
+    compare("= Book Title\n\n[[anid]]\n== Heading", '<div class="sect1"><h2 id="wiki-anid">Heading<a class="anchor" id="Heading" href="#Heading"></a></h2><div class="sectionbody"></div></div>', 'asciidoc')
   end
 
-
   #########################################################################
   #
   # Helpers

data/test/test_page.rb

@@ -16,7 +16,7 @@ context "Page" do
     page = @wiki.page('Bilbo Baggins')
     assert_equal Gollum::Page, page.class
     assert page.raw_data =~ /^# Bilbo Baggins\n\nBilbo Baggins/
-    assert page.formatted_data =~ /<h1>Bilbo Baggins<\/h1>\n\n<p>Bilbo Baggins/
+    assert page.formatted_data =~ %r{<h1>Bilbo Baggins<a class="anchor" id="Bilbo-Baggins" href="#Bilbo-Baggins"></a>\n</h1>\n\n<p>Bilbo Baggins}
     assert_equal 'Bilbo-Baggins.md', page.path
     assert_equal :markdown, page.format
     assert_equal @wiki.repo.commits.first.id, page.version.id
@@ -51,6 +51,16 @@ context "Page" do
     assert_equal 'Mordor/Eye-Of-Sauron.md', page.path
   end
 
+  test "url_path" do
+    page = @wiki.page('Bilbo Baggins')
+    assert_equal 'Bilbo-Baggins', page.url_path
+  end
+
+  test "nested url_path" do
+    page = @wiki.page('Eye Of Sauron')
+    assert_equal 'Mordor/Eye-Of-Sauron', page.url_path
+  end
+
   test "page versions" do
     page = @wiki.page('Bilbo Baggins')
     assert_equal ["f25eccd98e9b667f9e22946f3e2f945378b8a72d", "5bc1aaec6149e854078f1d0f8b71933bbc6c2e43"],
@@ -114,6 +124,25 @@ context "Page" do
     assert_equal "Eye Of Sauron", page.title
   end
 
+  test "top level header" do
+    header = @wiki.page('Home').header
+    assert_equal "Hobbits\n", header.raw_data
+    assert_equal "_Header.md", header.path
+  end
+
+  test "nested header" do
+    header = @wiki.page('Eye Of Sauron').header
+    assert_equal "Sauron\n", header.raw_data
+    assert_equal "Mordor/_Header.md", header.path
+  end
+
+  test "header itself" do
+    header = @wiki.page("_Header")
+    assert_nil header.header
+    assert_nil header.footer
+    assert_nil header.sidebar
+  end
+
   test "top level footer" do
     footer = @wiki.page('Home').footer
     assert_equal 'Lord of the Rings wiki', footer.raw_data
@@ -128,6 +157,7 @@ context "Page" do
 
   test "footer itself" do
     footer = @wiki.page("_Footer")
+    assert_nil footer.header
     assert_nil footer.footer
     assert_nil footer.sidebar
   end
@@ -146,6 +176,7 @@ context "Page" do
 
   test "sidebar itself" do
     sidebar = @wiki.page("_Sidebar")
+    assert_nil sidebar.header
     assert_nil sidebar.footer
     assert_nil sidebar.sidebar
   end
@@ -164,3 +195,36 @@ context "Page" do
     assert_equal "/foo", Gollum::BlobEntry.normalize_dir("/foo")
   end
 end
+
+context "within a sub-directory" do
+  setup do
+    @wiki = Gollum::Wiki.new(testpath("examples/lotr.git"), { :page_file_dir => 'Rivendell' })
+  end
+
+  test "get existing page" do
+    page = @wiki.page('Elrond')
+    assert_equal Gollum::Page, page.class
+    assert page.raw_data =~ /^# Elrond\n\nElrond/
+    assert_equal 'Rivendell/Elrond.md', page.path
+    assert_equal :markdown, page.format
+    assert_equal @wiki.repo.commits.first.id, page.version.id
+  end
+
+  test "should not get page from parent dir" do
+    page = @wiki.page('Bilbo Baggins')
+    assert_equal nil, page
+  end
+
+  test "should inherit header/footer/sidebar pages from parent directories" do
+    page = @wiki.page('Elrond')
+
+    assert_equal Gollum::Page, page.sidebar.class
+    assert_equal Gollum::Page, page.header.class
+    assert_equal Gollum::Page, page.footer.class
+
+    assert page.sidebar.raw_data =~ /^Lord of the Rings/
+    assert page.header.raw_data =~ /^Hobbits/
+    assert page.footer.raw_data =~ /^Lord of the Rings/
+  end
+end
+

data/test/test_page_revert.rb

@@ -11,6 +11,8 @@ context "Page Reverting" do
     FileUtils.rm_rf(@path)
   end
 
+=begin
+  # Grit is broken and this test fails often. See #363.
   test "reverts single commit" do
     page1 = @wiki.page("B")
     sha   = @wiki.revert_commit('7c45b5f16ff3bae2a0063191ef832701214d4df5')
@@ -21,13 +23,23 @@ context "Page Reverting" do
   end
 
   test "reverts single commit for a page" do
-    page1 = @wiki.page('B')
+    page1 = nil
+    while (page1 == nil)
+      page1 = @wiki.page('B')
+    end
+
     sha   = @wiki.revert_page(page1, '7c45b5f16ff3bae2a0063191ef832701214d4df5')
-    page2 = @wiki.page('B')
+    
+    page2 = nil
+    while (page2 == nil)
+      page2 = @wiki.page('B')
+    end
+    
     assert_equal sha,       page2.version.sha
     assert_equal "INITIAL", body=page2.raw_data.strip
     assert_equal body, File.read(File.join(@path, "B.md")).strip
   end
+=end
 
   test "reverts multiple commits for a page" do
     page1 = @wiki.page('A')

data/test/test_pages_view.rb

@@ -0,0 +1,37 @@
+# ~*~ encoding: utf-8 ~*~
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+require File.expand_path '../../lib/gollum/frontend/views/pages', __FILE__
+
+FakeResult = Struct.new(:path) do
+  def name
+    File.basename(path, File.extname(path)).gsub("-", " ")
+  end
+
+  def escaped_url_path
+    CGI.escape(path).gsub(/\..+$/, "").gsub("%2F", "/")
+  end
+end
+
+context "Precious::Views::Pages" do
+  setup do
+    @page = Precious::Views::Pages.new
+  end
+
+  test "breadcrumb" do
+    @page.instance_variable_set("@path", "Mordor/Eye-Of-Sauron/Saruman")
+    @page.instance_variable_set("@base_url", "/")
+    assert_equal '<a href="/pages/">Home</a> / <a href="/pages/Mordor/">Mordor</a> / <a href="/pages/Mordor/Eye-Of-Sauron/">Eye-Of-Sauron</a> / Saruman', @page.breadcrumb
+  end
+
+  test "breadcrumb with no path" do
+    assert_equal 'Home', @page.breadcrumb
+  end
+
+  test "files_folders" do
+    @page.instance_variable_set("@path", "Mordor")
+    @page.instance_variable_set("@base_url", "/")
+    results = [FakeResult.new("Mordor/Eye-Of-Sauron.md"), FakeResult.new("Mordor/Orc/Saruman.md"), FakeResult.new("Mordor/.gitkeep")]
+    @page.instance_variable_set("@results", results)
+    assert_equal %{<li><a href="/Mordor/Eye-Of-Sauron" class="file">Eye Of Sauron</a></li>\n<li><a href="/pages/Mordor/Orc/" class="folder">Orc</a></li>}, @page.files_folders
+  end
+end

data/test/test_unicode.rb

@@ -0,0 +1,110 @@
+# ~*~ encoding: utf-8 ~*~
+require File.expand_path(File.join(File.dirname(__FILE__), "helper"))
+
+def utf8(str)
+  str.respond_to?(:force_encoding) ? str.force_encoding('utf-8') : str
+end
+
+context "Unicode Support" do
+  setup do
+    @path = cloned_testpath("examples/revert.git")
+    @wiki = Gollum::Wiki.new(@path)
+  end
+
+  teardown do
+    FileUtils.rm_rf(@path)
+  end
+
+  test "create and read non-latin page" do
+    @wiki.write_page("test", :markdown, "# 한글")
+
+    page = @wiki.page("test")
+    assert_equal Gollum::Page, page.class
+    assert_equal "# 한글", utf8(page.raw_data)
+  end
+
+  test "unicode with existing format rules" do
+    @wiki.write_page("test", :markdown, "# 한글")
+    assert_equal @wiki.page("test").path, @wiki.page("test").path
+  end
+end
+
+context "Frontend Unicode support" do
+  include Rack::Test::Methods
+
+  setup do
+    @path = cloned_testpath("examples/revert.git")
+    @wiki = Gollum::Wiki.new(@path)
+    Precious::App.set(:gollum_path, @path)
+    Precious::App.set(:wiki_options, {})
+  end
+
+  teardown do
+    FileUtils.rm_rf(@path)
+  end
+
+  test "creates korean page which contains korean content" do
+    post "/create", :content => '한글 text', :page => "k",
+      :format => 'markdown', :message => 'def'
+    follow_redirect!
+    assert last_response.ok?
+
+    page = @wiki.page('k')
+    assert_equal '한글 text', utf8(page.raw_data)
+    assert_equal 'def', page.version.message
+  end
+
+  test "heavy use 1" do
+    post "/create", :content => '한글 text', :page => "PG",
+      :format => 'markdown', :message => 'def'
+    follow_redirect!
+    assert last_response.ok?
+
+    @wiki.update_page(@wiki.page('PG'), nil, nil, '다른 text', {})
+    page = @wiki.page('PG')
+    assert_equal '다른 text', utf8(page.raw_data)
+
+    post '/edit/PG', :page => 'PG', :content => '바뀐 text', :message => 'ghi'
+    follow_redirect!
+    assert last_response.ok?
+
+    @wiki = Gollum::Wiki.new(@path)
+    page = @wiki.page('PG')
+    assert_equal '바뀐 text', utf8(page.raw_data)
+    assert_equal 'ghi', page.version.message
+  end
+
+  test "heavy use 2" do
+    post "/create", :content => '한글 text', :page => "k",
+      :format => 'markdown', :message => 'def'
+    follow_redirect!
+    assert last_response.ok?
+
+    @wiki.update_page(@wiki.page('k'), nil, nil, '다른 text', {})
+    @wiki = Gollum::Wiki.new(@path)
+    page = @wiki.page('k')
+    assert_equal '다른 text', utf8(page.raw_data)
+
+    post '/edit/' + CGI.escape('한글'), :page => 'k', :content => '바뀐 text',
+      :format => 'markdown', :message => 'ghi'
+    follow_redirect!
+    assert last_response.ok?
+
+    @wiki = Gollum::Wiki.new(@path)
+    page = @wiki.page('k')
+    assert_equal '바뀐 text', utf8(page.raw_data)
+    assert_equal 'ghi', page.version.message
+  end
+
+  test 'transliteration' do
+    # TODO: Remove to_url once write_page changes are merged.
+    @wiki.write_page('ééééé'.to_url, :markdown, '한글 text', { :name => '', :email => '' } )
+    page = @wiki.page('eeeee')
+    assert_equal '한글 text', utf8(page.raw_data)
+  end
+
+  def app
+    Precious::App
+  end
+end
+

data/test/test_wiki.rb

@@ -54,12 +54,19 @@ context "Wiki" do
   test "list pages" do
     pages = @wiki.pages
     assert_equal \
-      ['Bilbo-Baggins.md', 'Eye-Of-Sauron.md', 'Home.textile', 'My-Precious.md', 'Samwise Gamgee.mediawiki'],
+      ['Bilbo-Baggins.md', 'Boromir.md', 'Elrond.md', 'Eye-Of-Sauron.md', 'Home.textile', 'My-Precious.md', 'Samwise Gamgee.mediawiki'],
       pages.map { |p| p.filename }.sort
   end
 
+  test "list files" do
+    files = @wiki.files
+    assert_equal \
+      ['Data.csv', 'eye.jpg', 'todo.txt'],
+      files.map { |p| p.filename }.sort
+  end
+
   test "counts pages" do
-    assert_equal 5, @wiki.size
+    assert_equal 7, @wiki.size
   end
 
   test "text_data" do
@@ -87,23 +94,56 @@ context "Wiki" do
     assert_match    "b/_Sidebar.md", diff
     assert_no_match regex, diff
   end
+
+  test "gets scoped page from specified directory" do
+    @path = cloned_testpath('examples/lotr.git')
+    begin
+      wiki = Gollum::Wiki.new(@path)
+      index = wiki.repo.index
+      index.read_tree 'master'
+      index.add('Foobar/Elrond.md', 'Baz')
+      index.commit 'Add Foobar/Elrond.', [wiki.repo.commits.last], Grit::Actor.new('Tom Preston-Werner', 'tom@github.com')
+
+      assert_equal 'Rivendell/Elrond.md', wiki.page('Elrond', nil, 'Rivendell').path
+      # test paged as well.
+      assert_equal 'Foobar/Elrond.md', wiki.paged('Elrond', 'Foobar').path
+    ensure
+      FileUtils.rm_rf(@path)
+    end
+  end
 end
 
 context "Wiki page previewing" do
   setup do
     @path = testpath("examples/lotr.git")
+    Gollum::Wiki.default_options = {:universal_toc => false}
     @wiki = Gollum::Wiki.new(@path)
   end
 
   test "preview_page" do
     page = @wiki.preview_page("Test", "# Bilbo", :markdown)
     assert_equal "# Bilbo", page.raw_data
-    assert_equal "<h1>Bilbo</h1>", page.formatted_data
+    assert_equal %Q{<h1>Bilbo<a class="anchor" id="Bilbo" href="#Bilbo"></a>\n</h1>}, page.formatted_data
     assert_equal "Test.md", page.filename
     assert_equal "Test", page.name
   end
 end
 
+context "Wiki TOC" do
+  setup do
+    @path = testpath("examples/lotr.git")
+    options = {:universal_toc => true}
+    @wiki = Gollum::Wiki.new(@path, options)
+  end
+
+  test "toc_generation" do
+    page = @wiki.preview_page("Test", "# Bilbo", :markdown)
+    assert_equal "# Bilbo", page.raw_data
+    assert_equal '<h1>Bilbo<a class="anchor" id="Bilbo" href="#Bilbo"></a></h1>', page.formatted_data.gsub(/\n/,"")
+    assert_equal %{<div class="toc"><div class="toc-title">Table of Contents</div><ul><li><a href="#Bilbo">Bilbo</a></li></ul></div>}, page.toc_data.gsub(/\n */,"")
+  end
+end
+
 context "Wiki page writing" do
   setup do
     @path = testpath("examples/test.git")
@@ -418,7 +458,14 @@ context "page_file_dir option" do
   test "search results should be restricted in page filer dir" do
     results = @wiki.search("foo")
     assert_equal 1, results.size
-    assert_equal "foo", results[0][:name]
+    assert_equal "docs/foo", results[0][:name]
+  end
+
+  test "search results should make the content/filename search additive" do
+    # This file contains the word 'foo' and is called 'foo', so it should
+    # have a count of 2, not 1...
+    results = @wiki.search("foo")
+    assert_equal 2, results[0][:count]
   end
 
   teardown do