gollum 1.0.1 → 1.1.0

data/test/helper.rb

@@ -18,6 +18,12 @@ def testpath(path)
   File.join(TEST_DIR, path)
 end
 
+def commit_details
+  { :message => "Did something at #{Time.now}",
+    :name => "Tom Preston-Werner",
+    :email => "tom@github.com" }
+end
+
 # test/spec/mini 3
 # http://gist.github.com/25455
 # chris@ozmm.org
@@ -26,7 +32,7 @@ def context(*args, &block)
   return super unless (name = args.first) && block
   require 'test/unit'
   klass = Class.new(defined?(ActiveSupport::TestCase) ? ActiveSupport::TestCase : Test::Unit::TestCase) do
-    def self.test(name, &block) 
+    def self.test(name, &block)
       define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
     end
     def self.xtest(*args) end

data/test/test_file.rb

@@ -11,8 +11,15 @@ context "File" do
   end
 
   test "existing file" do
-    file = @wiki.file("Mordor/todo.txt")
+    commit = @wiki.repo.commits.first
+    file   = @wiki.file("Mordor/todo.txt")
     assert_equal "[ ] Write section on Ents\n", file.raw_data
-    assert_equal @wiki.repo.commits.first.id, file.version.id
+    assert_equal 'todo.txt',         file.name
+    assert_equal commit.id,          file.version.id
+    assert_equal commit.author.name, file.version.author.name
+  end
+
+  test "accessing tree" do
+    assert_nil @wiki.file("Mordor")
   end
 end

data/test/test_markup.rb

@@ -6,10 +6,6 @@ context "Markup" do
     FileUtils.rm_rf(@path)
     Grit::Repo.init_bare(@path)
     @wiki = Gollum::Wiki.new(@path)
-
-    @commit = { :message => "Add stuff",
-                :name => "Tom Preston-Werner",
-                :email => "tom@github.com" }
   end
 
   teardown do
@@ -17,12 +13,18 @@ context "Markup" do
   end
 
   test "formats page from Wiki#pages" do
-    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Foo]][[Bar]] b", @commit)
+    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Foo]][[Bar]] b", commit_details)
     assert @wiki.pages[0].formatted_data
   end
 
+  #########################################################################
+  #
+  # Links
+  #
+  #########################################################################
+
   test "double page links no space" do
-    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Foo]][[Bar]] b", @commit)
+    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Foo]][[Bar]] b", commit_details)
 
     # "<p>a <a class=\"internal absent\" href=\"/Foo\">Foo</a><a class=\"internal absent\" href=\"/Bar\">Bar</a> b</p>"
     page    = @wiki.page("Bilbo Baggins")
@@ -41,7 +43,7 @@ context "Markup" do
   end
 
   test "double page links with space" do
-    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Foo]] [[Bar]] b", @commit)
+    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Foo]] [[Bar]] b", commit_details)
 
     # "<p>a <a class=\"internal absent\" href=\"/Foo\">Foo</a> <a class=\"internal absent\" href=\"/Bar\">Bar</a> b</p>"
     page = @wiki.page("Bilbo Baggins")
@@ -60,7 +62,7 @@ context "Markup" do
   end
 
   test "page link" do
-    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Bilbo Baggins]] b", @commit)
+    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Bilbo Baggins]] b", commit_details)
 
     page = @wiki.page("Bilbo Baggins")
     output = page.formatted_data
@@ -69,8 +71,18 @@ context "Markup" do
     assert_match /\>Bilbo Baggins\</,        output
   end
 
+  test "adds nofollow to links on historical pages" do
+    sha1 = @wiki.write_page("Sauron", :markdown, "a [[b]] c", commit_details)
+    page = @wiki.page("Sauron")
+    sha2 = @wiki.update_page(page, page.name, :markdown, "c [[b]] a", commit_details)
+    regx = /rel="nofollow"/
+    assert_no_match regx, page.formatted_data
+    assert_match    regx, @wiki.page(page.name, sha1).formatted_data
+    assert_match    regx, @wiki.page(page.name, sha2).formatted_data
+  end
+
   test "absent page link" do
-    @wiki.write_page("Tolkien", :markdown, "a [[J. R. R. Tolkien]]'s b", @commit)
+    @wiki.write_page("Tolkien", :markdown, "a [[J. R. R. Tolkien]]'s b", commit_details)
 
     page = @wiki.page("Tolkien")
     output = page.formatted_data
@@ -80,41 +92,76 @@ context "Markup" do
   end
 
   test "page link with custom base path" do
-    ["/wiki", "/wiki/"].each do |path|
+    ["/wiki", "/wiki/"].each_with_index do |path, i|
+      name = "Bilbo Baggins #{i}"
       @wiki = Gollum::Wiki.new(@path, :base_path => path)
-      @wiki.write_page("Bilbo Baggins", :markdown, "a [[Bilbo Baggins]] b", @commit)
+      @wiki.write_page(name, :markdown, "a [[#{name}]] b", commit_details)
 
-      page = @wiki.page("Bilbo Baggins")
+      page = @wiki.page(name)
       output = page.formatted_data
-      assert_match /class="internal present"/,     output
-      assert_match /href="\/wiki\/Bilbo-Baggins"/, output
-      assert_match /\>Bilbo Baggins\</,            output
+      assert_match /class="internal present"/,        output
+      assert_match /href="\/wiki\/Bilbo-Baggins-\d"/, output
+      assert_match /\>Bilbo Baggins \d\</,            output
     end
   end
 
+  test "page link with included #" do
+    @wiki.write_page("Precious #1", :markdown, "a [[Precious #1]] b", commit_details)
+    page   = @wiki.page('Precious #1')
+    output = page.formatted_data
+    assert_match /class="internal present"/, output
+    assert_match /href="\/Precious-%231"/,   output
+  end
+
+  test "page link with extra #" do
+    @wiki.write_page("Potato", :markdown, "a [[Potato#1]] b", commit_details)
+    page   = @wiki.page('Potato')
+    output = page.formatted_data
+    assert_match /class="internal present"/, output
+    assert_match /href="\/Potato#1"/,        output
+  end
+
   test "external page link" do
-    @wiki.write_page("Bilbo Baggins", :markdown, "a [[http://example.com]] b", @commit)
+    @wiki.write_page("Bilbo Baggins", :markdown, "a [[http://example.com]] b", commit_details)
 
     page = @wiki.page("Bilbo Baggins")
     assert_equal "<p>a <a href=\"http://example.com\">http://example.com</a> b</p>", page.formatted_data
   end
 
+  #########################################################################
+  #
+  # Images
+  #
+  #########################################################################
+
   test "image with http url" do
     ['http', 'https'].each do |scheme|
-      @wiki.write_page("Bilbo Baggins", :markdown, "a [[#{scheme}://example.com/bilbo.jpg]] b", @commit)
+      name = "Bilbo Baggins #{scheme}"
+      @wiki.write_page(name, :markdown, "a [[#{scheme}://example.com/bilbo.jpg]] b", commit_details)
 
-      page = @wiki.page("Bilbo Baggins")
+      page = @wiki.page(name)
       output = page.formatted_data
       assert_equal %{<p>a <img src="#{scheme}://example.com/bilbo.jpg" /> b</p>}, output
     end
   end
 
+  test "image with extension in caps with http url" do
+    ['http', 'https'].each do |scheme|
+      name = "Bilbo Baggins #{scheme}"
+      @wiki.write_page(name, :markdown, "a [[#{scheme}://example.com/bilbo.JPG]] b", commit_details)
+
+      page = @wiki.page(name)
+      output = page.formatted_data
+      assert_equal %{<p>a <img src="#{scheme}://example.com/bilbo.JPG" /> b</p>}, output
+    end
+  end
+
   test "image with absolute path" do
     @wiki = Gollum::Wiki.new(@path, :base_path => '/wiki')
     index = @wiki.repo.index
     index.add("alpha.jpg", "hi")
     index.commit("Add alpha.jpg")
-    @wiki.write_page("Bilbo Baggins", :markdown, "a [[/alpha.jpg]] [[a | /alpha.jpg]] b", @commit)
+    @wiki.write_page("Bilbo Baggins", :markdown, "a [[/alpha.jpg]] [[a | /alpha.jpg]] b", commit_details)
 
     page = @wiki.page("Bilbo Baggins")
     assert_equal %{<p>a <img src="/wiki/alpha.jpg" /><a href="/wiki/alpha.jpg">a</a> b</p>}, page.formatted_data
@@ -203,17 +250,29 @@ context "Markup" do
     relative_image(content, output)
   end
 
+  test "absolute image with frame" do
+    content = "a\n\n[[http://example.com/bilbo.jpg|frame]]\n\nb"
+    output = "<p>a</p>\n\n<p><span class=\"frame\"><span><img src=\"http://example.com/bilbo.jpg\" /></span></span></p>\n\n<p>b</p>"
+    relative_image(content, output)
+  end
+
   test "image with frame and alt" do
     content = "a\n\n[[alpha.jpg|frame|alt=Alpha]]\n\nb"
     output = "<p>a</p>\n\n<p><span class=\"frame\"><span><img src=\"/greek/alpha.jpg\" alt=\"Alpha\" /><span>Alpha</span></span></span></p>\n\n<p>b</p>"
     relative_image(content, output)
   end
 
+  #########################################################################
+  #
+  # File links
+  #
+  #########################################################################
+
   test "file link with absolute path" do
     index = @wiki.repo.index
     index.add("alpha.jpg", "hi")
     index.commit("Add alpha.jpg")
-    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Alpha|/alpha.jpg]] b", @commit)
+    @wiki.write_page("Bilbo Baggins", :markdown, "a [[Alpha|/alpha.jpg]] b", commit_details)
 
     page = @wiki.page("Bilbo Baggins")
     output = Gollum::Markup.new(page).render
@@ -240,6 +299,12 @@ context "Markup" do
     assert_equal %{<p>a <a href="http://example.com/alpha.jpg">Alpha</a> b</p>}, page.formatted_data
   end
 
+  #########################################################################
+  #
+  # Code
+  #
+  #########################################################################
+
   test "code blocks" do
     content = "a\n\n```ruby\nx = 1\n```\n\nb"
     output = "<p>a</p>\n\n<div class=\"highlight\"><pre>" +
@@ -288,6 +353,12 @@ context "Markup" do
     compare(content, output)
   end
 
+  #########################################################################
+  #
+  # Various
+  #
+  #########################################################################
+
   test "escaped wiki link" do
     content = "a '[[Foo]], b"
     output = "<p>a [[Foo]], b</p>"
@@ -309,18 +380,30 @@ context "Markup" do
     compare(content, output, 'org')
   end
 
-  test "tex block syntax" do
+  #########################################################################
+  #
+  # TeX
+  #
+  #########################################################################
+
+  test "TeX block syntax" do
     content = 'a \[ a^2 \] b'
     output = "<p>a <script type=\"math/tex; mode=display\">a^2</script> b</p>"
     compare(content, output, 'md')
   end
 
-  test "tex inline syntax" do
+  test "TeX inline syntax" do
     content = 'a \( a^2 \) b'
     output = "<p>a <script type=\"math/tex\">a^2</script> b</p>"
     compare(content, output, 'md')
   end
 
+  #########################################################################
+  #
+  # Helpers
+  #
+  #########################################################################
+
   def compare(content, output, ext = "md", regexes = [])
     index = @wiki.repo.index
     index.add("Bilbo-Baggins.#{ext}", content)
@@ -341,8 +424,9 @@ context "Markup" do
     index.add("greek/Bilbo-Baggins.md", content)
     index.commit("Add alpha.jpg")
 
+    @wiki.clear_cache
     page = @wiki.page("Bilbo Baggins")
     rendered = Gollum::Markup.new(page).render
     assert_equal output, rendered
   end
-end
+end

data/test/test_page.rb

@@ -1,3 +1,4 @@
+# ~*~ encoding: utf-8 ~*~
 require File.join(File.dirname(__FILE__), *%w[helper])
 
 context "Page" do
@@ -109,4 +110,9 @@ context "Page" do
     footer = @wiki.page("_Footer")
     assert_nil footer.footer
   end
-end
+
+  test "cannot convert non string to human readable page title" do
+    assert_equal '', Gollum::Page.cname(nil)
+    assert_equal '', Gollum::Page.cname(3)
+  end
+end

data/test/test_wiki.rb

@@ -35,9 +35,54 @@ context "Wiki" do
   test "list pages" do
     pages = @wiki.pages
     assert_equal \
-      %w(Bilbo-Baggins.md Eye-Of-Sauron.md Home.textile My-Precious.md), 
+      %w(Bilbo-Baggins.md Eye-Of-Sauron.md Home.textile My-Precious.md),
       pages.map { |p| p.filename }.sort
   end
+
+  test "counts pages" do
+    assert_equal 4, @wiki.size
+  end
+
+  test "normalizes commit hash" do
+    commit = {:message => 'abc'}
+    name  = @wiki.repo.config['user.name']
+    email = @wiki.repo.config['user.email']
+    assert_equal({:message => 'abc', :name => name, :email => email},
+      @wiki.normalize_commit(commit.dup))
+
+    commit[:name]  = 'bob'
+    commit[:email] = ''
+    assert_equal({:message => 'abc', :name => 'bob', :email => email},
+      @wiki.normalize_commit(commit.dup))
+
+    commit[:email] = 'foo@bar.com'
+    assert_equal({:message => 'abc', :name => 'bob', :email => 'foo@bar.com'},
+      @wiki.normalize_commit(commit.dup))
+  end
+
+  test "#tree_map_for caches ref and tree" do
+    assert @wiki.ref_map.empty?
+    assert @wiki.tree_map.empty?
+    @wiki.tree_map_for 'master'
+    assert_equal({"master"=>"60f12f4254f58801b9ee7db7bca5fa8aeefaa56b"}, @wiki.ref_map)
+
+    map = @wiki.tree_map['60f12f4254f58801b9ee7db7bca5fa8aeefaa56b']
+    assert_equal 'Bilbo-Baggins.md',        map[0].path
+    assert_equal '',                        map[0].dir
+    assert_equal map[0].path,               map[0].name
+    assert_equal 'Mordor/Eye-Of-Sauron.md', map[3].path
+    assert_equal '/Mordor',                 map[3].dir
+    assert_equal 'Eye-Of-Sauron.md',        map[3].name
+  end
+
+  test "#tree_map_for only caches tree for commit" do
+    assert @wiki.tree_map.empty?
+    @wiki.tree_map_for '60f12f4254f58801b9ee7db7bca5fa8aeefaa56b'
+    assert @wiki.ref_map.empty?
+
+    entry = @wiki.tree_map['60f12f4254f58801b9ee7db7bca5fa8aeefaa56b'][0]
+    assert_equal 'Bilbo-Baggins.md', entry.path
+  end
 end
 
 context "Wiki page previewing" do
@@ -64,48 +109,48 @@ context "Wiki page writing" do
   end
 
   test "write_page" do
-    commit = { :message => "Gollum page",
-               :name => "Tom Preston-Werner",
-               :email => "tom@github.com" }
-    @wiki.write_page("Gollum", :markdown, "# Gollum", commit)
+    cd = commit_details
+    @wiki.write_page("Gollum", :markdown, "# Gollum", cd)
     assert_equal 1, @wiki.repo.commits.size
-    assert_equal "Gollum page", @wiki.repo.commits.first.message
-    assert_equal "Tom Preston-Werner", @wiki.repo.commits.first.author.name
-    assert_equal "tom@github.com", @wiki.repo.commits.first.author.email
+    assert_equal cd[:message], @wiki.repo.commits.first.message
+    assert_equal cd[:name], @wiki.repo.commits.first.author.name
+    assert_equal cd[:email], @wiki.repo.commits.first.author.email
     assert @wiki.page("Gollum")
 
-    @wiki.write_page("Bilbo", :markdown, "# Bilbo", commit)
+    @wiki.write_page("Bilbo", :markdown, "# Bilbo", commit_details)
     assert_equal 2, @wiki.repo.commits.size
     assert @wiki.page("Bilbo")
     assert @wiki.page("Gollum")
   end
 
+  test "is not allowed to overwrite file" do
+    @wiki.write_page("Abc-Def", :markdown, "# Gollum", commit_details)
+    assert_raises Gollum::DuplicatePageError do
+      @wiki.write_page("ABC DEF", :textile,  "# Gollum", commit_details)
+    end
+  end
+
   test "update_page" do
-    commit = { :message => "Gollum page",
-               :name => "Tom Preston-Werner",
-               :email => "tom@github.com" }
-    @wiki.write_page("Gollum", :markdown, "# Gollum", commit)
+    @wiki.write_page("Gollum", :markdown, "# Gollum", commit_details)
 
     page = @wiki.page("Gollum")
-    @wiki.update_page(page, page.name, :markdown, "# Gollum2", commit)
+    cd = commit_details
+    @wiki.update_page(page, page.name, :markdown, "# Gollum2", cd)
 
     assert_equal 2, @wiki.repo.commits.size
     assert_equal "# Gollum2", @wiki.page("Gollum").raw_data
-    assert_equal "Gollum page", @wiki.repo.commits.first.message
-    assert_equal "Tom Preston-Werner", @wiki.repo.commits.first.author.name
-    assert_equal "tom@github.com", @wiki.repo.commits.first.author.email
+    assert_equal cd[:message], @wiki.repo.commits.first.message
+    assert_equal cd[:name], @wiki.repo.commits.first.author.name
+    assert_equal cd[:email], @wiki.repo.commits.first.author.email
   end
 
   test "update page with format change" do
-    commit = { :message => "Gollum page",
-               :name => "Tom Preston-Werner",
-               :email => "tom@github.com" }
-    @wiki.write_page("Gollum", :markdown, "# Gollum", commit)
+    @wiki.write_page("Gollum", :markdown, "# Gollum", commit_details)
 
     assert_equal :markdown, @wiki.page("Gollum").format
 
     page = @wiki.page("Gollum")
-    @wiki.update_page(page, page.name, :textile, "h1. Gollum", commit)
+    @wiki.update_page(page, page.name, :textile, "h1. Gollum", commit_details)
 
     assert_equal 2, @wiki.repo.commits.size
     assert_equal :textile, @wiki.page("Gollum").format
@@ -113,30 +158,24 @@ context "Wiki page writing" do
   end
 
   test "update page with name change" do
-    commit = { :message => "Gollum page",
-               :name => "Tom Preston-Werner",
-               :email => "tom@github.com" }
-    @wiki.write_page("Gollum", :markdown, "# Gollum", commit)
+    @wiki.write_page("Gollum", :markdown, "# Gollum", commit_details)
 
     assert_equal :markdown, @wiki.page("Gollum").format
 
     page = @wiki.page("Gollum")
-    @wiki.update_page(page, 'Smeagol', :markdown, "h1. Gollum", commit)
+    @wiki.update_page(page, 'Smeagol', :markdown, "h1. Gollum", commit_details)
 
     assert_equal 2, @wiki.repo.commits.size
     assert_equal "h1. Gollum", @wiki.page("Smeagol").raw_data
   end
 
   test "update page with name and format change" do
-    commit = { :message => "Gollum page",
-               :name => "Tom Preston-Werner",
-               :email => "tom@github.com" }
-    @wiki.write_page("Gollum", :markdown, "# Gollum", commit)
+    @wiki.write_page("Gollum", :markdown, "# Gollum", commit_details)
 
     assert_equal :markdown, @wiki.page("Gollum").format
 
     page = @wiki.page("Gollum")
-    @wiki.update_page(page, 'Smeagol', :textile, "h1. Gollum", commit)
+    @wiki.update_page(page, 'Smeagol', :textile, "h1. Gollum", commit_details)
 
     assert_equal 2, @wiki.repo.commits.size
     assert_equal :textile, @wiki.page("Smeagol").format
@@ -144,17 +183,13 @@ context "Wiki page writing" do
   end
 
   test "update nested page with format change" do
-    commit = { :message => "Gollum page",
-               :name => "Tom Preston-Werner",
-               :email => "tom@github.com" }
-
     index = @wiki.repo.index
     index.add("lotr/Gollum.md", "# Gollum")
     index.commit("Add nested page")
 
     page = @wiki.page("Gollum")
     assert_equal :markdown, @wiki.page("Gollum").format
-    @wiki.update_page(page, page.name, :textile, "h1. Gollum", commit)
+    @wiki.update_page(page, page.name, :textile, "h1. Gollum", commit_details)
 
     page = @wiki.page("Gollum")
     assert_equal "lotr/Gollum.textile", page.path
@@ -163,23 +198,16 @@ context "Wiki page writing" do
   end
 
   test "delete root page" do
-    commit = { :message => "Gollum page",
-               :name => "Tom Preston-Werner",
-               :email => "tom@github.com" }
-    @wiki.write_page("Gollum", :markdown, "# Gollum", commit)
+    @wiki.write_page("Gollum", :markdown, "# Gollum", commit_details)
 
     page = @wiki.page("Gollum")
-    @wiki.delete_page(page, commit)
+    @wiki.delete_page(page, commit_details)
 
     assert_equal 2, @wiki.repo.commits.size
     assert_nil @wiki.page("Gollum")
   end
 
   test "delete nested page" do
-    commit = { :message => "Gollum page",
-               :name => "Tom Preston-Werner",
-               :email => "tom@github.com" }
-
     index = @wiki.repo.index
     index.add("greek/Bilbo-Baggins.md", "hi")
     index.add("Gollum.md", "hi")
@@ -187,7 +215,7 @@ context "Wiki page writing" do
 
     page = @wiki.page("Bilbo-Baggins")
     assert page
-    @wiki.delete_page(page, commit)
+    @wiki.delete_page(page, commit_details)
 
     assert_equal 2, @wiki.repo.commits.size
     assert_nil @wiki.page("Bilbo-Baggins")
@@ -198,4 +226,59 @@ context "Wiki page writing" do
   teardown do
     FileUtils.rm_r(File.join(File.dirname(__FILE__), *%w[examples test.git]))
   end
-end
+end
+
+context "Wiki sync with working directory" do
+  setup do
+    @path = testpath('examples/wdtest')
+    Grit::Repo.init(@path)
+    @wiki = Gollum::Wiki.new(@path)
+  end
+
+  test "write a page" do
+    @wiki.write_page("New Page", :markdown, "Hi", commit_details)
+    assert_equal "Hi", File.read(File.join(@path, "New-Page.md"))
+  end
+
+  test "update a page with same name and format" do
+    @wiki.write_page("New Page", :markdown, "Hi", commit_details)
+    page = @wiki.page("New Page")
+    @wiki.update_page(page, page.name, page.format, "Bye", commit_details)
+    assert_equal "Bye", File.read(File.join(@path, "New-Page.md"))
+  end
+
+  test "update a page with different name and same format" do
+    @wiki.write_page("New Page", :markdown, "Hi", commit_details)
+    page = @wiki.page("New Page")
+    @wiki.update_page(page, "New Page 2", page.format, "Bye", commit_details)
+    assert_equal "Bye", File.read(File.join(@path, "New-Page-2.md"))
+    assert !File.exist?(File.join(@path, "New-Page.md"))
+  end
+
+  test "update a page with same name and different format" do
+    @wiki.write_page("New Page", :markdown, "Hi", commit_details)
+    page = @wiki.page("New Page")
+    @wiki.update_page(page, page.name, :textile, "Bye", commit_details)
+    assert_equal "Bye", File.read(File.join(@path, "New-Page.textile"))
+    assert !File.exist?(File.join(@path, "New-Page.md"))
+  end
+
+  test "update a page with different name and different format" do
+    @wiki.write_page("New Page", :markdown, "Hi", commit_details)
+    page = @wiki.page("New Page")
+    @wiki.update_page(page, "New Page 2", :textile, "Bye", commit_details)
+    assert_equal "Bye", File.read(File.join(@path, "New-Page-2.textile"))
+    assert !File.exist?(File.join(@path, "New-Page.md"))
+  end
+
+  test "delete a page" do
+    @wiki.write_page("New Page", :markdown, "Hi", commit_details)
+    page = @wiki.page("New Page")
+    @wiki.delete_page(page, commit_details)
+    assert !File.exist?(File.join(@path, "New-Page.md"))
+  end
+
+  teardown do
+    FileUtils.rm_r(@path)
+  end
+end