jugyo-gollum 1.3.1

data/test/test_page.rb

@@ -0,0 +1,146 @@
+# ~*~ encoding: utf-8 ~*~
+require File.expand_path(File.join(File.dirname(__FILE__), "helper"))
+
+context "Page" do
+  setup do
+    @wiki = Gollum::Wiki.new(testpath("examples/lotr.git"))
+  end
+
+  test "new page" do
+    page = Gollum::Page.new(@wiki)
+    assert_nil page.raw_data
+    assert_nil page.formatted_data
+  end
+
+  test "get existing 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_equal 'Bilbo-Baggins.md', page.path
+    assert_equal :markdown, page.format
+    assert_equal @wiki.repo.commits.first.id, page.version.id
+  end
+
+  test "get existing page case insensitive" do
+    assert_equal @wiki.page('Bilbo Baggins').path, @wiki.page('bilbo baggins').path
+  end
+
+  test "get nested page" do
+    page = @wiki.page('Eye Of Sauron')
+    assert_equal 'Mordor/Eye-Of-Sauron.md', page.path
+  end
+
+  test "page versions" do
+    page = @wiki.page('Bilbo Baggins')
+    assert_equal ["f25eccd98e9b667f9e22946f3e2f945378b8a72d", "5bc1aaec6149e854078f1d0f8b71933bbc6c2e43"],
+      page.versions.map { |v| v.id }
+  end
+
+  test "page versions across renames" do
+    page = @wiki.page 'My-Precious'
+    assert_equal ['60f12f4254f58801b9ee7db7bca5fa8aeefaa56b', '94523d7ae48aeba575099dd12926420d8fd0425d'],
+      page.versions(:follow => true).map { |v| v.id }
+  end
+
+  test "page versions without renames" do
+    page = @wiki.page 'My-Precious'
+    assert_equal ['60f12f4254f58801b9ee7db7bca5fa8aeefaa56b'],
+      page.versions(:follow => false).map { |v| v.id }
+  end
+
+  test "specific page version" do
+    page = @wiki.page('Bilbo Baggins', 'fbabba862dfa7ac35b39042dd4ad780c9f67b8cb')
+    assert_equal 'fbabba862dfa7ac35b39042dd4ad780c9f67b8cb', page.version.id
+  end
+
+  test "no page match" do
+    assert_nil @wiki.page('I do not exist')
+  end
+
+  test "no version match" do
+    assert_nil @wiki.page('Bilbo Baggins', 'I do not exist')
+  end
+
+  test "no ext match" do
+    assert_nil @wiki.page('Data')
+  end
+
+  test "cname" do
+    assert_equal "Foo", Gollum::Page.cname("Foo")
+    assert_equal "Foo-Bar", Gollum::Page.cname("Foo Bar")
+    assert_equal "Foo---Bar", Gollum::Page.cname("Foo / Bar")
+    assert_equal "José", Gollum::Page.cname("José")
+    assert_equal "モルドール", Gollum::Page.cname("モルドール")
+  end
+
+  test "title from filename with normal contents" do
+    page = @wiki.page('Bilbo Baggins')
+    assert_equal 'Bilbo Baggins', page.title
+  end
+
+  test "title from filename with html contents" do
+    page = @wiki.page('My <b>Precious', '0ed8cbe0a25235bd867e65193c7d837c66b328ef')
+    assert_equal 'My Precious', page.title
+  end
+
+  test "title from h1 with normal contents" do
+    page = @wiki.page('Home')
+    assert_equal "The LOTR Wiki", page.title
+  end
+
+  test "title from h1 with html contents" do
+    page = @wiki.page('Eye Of Sauron')
+    assert_equal "Eye Of Sauron", page.title
+  end
+
+  test "top level footer" do
+    footer = @wiki.page('Home').footer
+    assert_equal 'Lord of the Rings wiki', footer.raw_data
+    assert_equal '_Footer.md', footer.path
+  end
+
+  test "nested footer" do
+    footer = @wiki.page('Eye Of Sauron').footer
+    assert_equal "Ones does not simply **walk** into Mordor!\n", footer.raw_data
+    assert_equal "Mordor/_Footer.md", footer.path
+  end
+
+  test "footer itself" do
+    footer = @wiki.page("_Footer")
+    assert_nil footer.footer
+    assert_nil footer.sidebar
+  end
+
+  test "top level sidebar" do
+    sidebar = @wiki.page('Home').sidebar
+    assert_equal 'Lord of the Rings wiki', sidebar.raw_data
+    assert_equal '_Sidebar.md', sidebar.path
+  end
+
+  test "nested sidebar" do
+    sidebar = @wiki.page('Eye Of Sauron').sidebar
+    assert_equal "Ones does not simply **walk** into Mordor!\n", sidebar.raw_data
+    assert_equal "Mordor/_Sidebar.md", sidebar.path
+  end
+
+  test "sidebar itself" do
+    sidebar = @wiki.page("_Sidebar")
+    assert_nil sidebar.footer
+    assert_nil sidebar.sidebar
+  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
+
+  test "normalize_dir" do
+    assert_equal "", Gollum::BlobEntry.normalize_dir("")
+    assert_equal "", Gollum::BlobEntry.normalize_dir(".")
+    assert_equal "", Gollum::BlobEntry.normalize_dir("/")
+    assert_equal "", Gollum::BlobEntry.normalize_dir("c:/")
+    assert_equal "/foo", Gollum::BlobEntry.normalize_dir("foo")
+    assert_equal "/foo", Gollum::BlobEntry.normalize_dir("/foo")
+  end
+end

data/test/test_page_revert.rb

@@ -0,0 +1,45 @@
+# ~*~ encoding: utf-8 ~*~
+require File.expand_path(File.join(File.dirname(__FILE__), "helper"))
+
+context "Page Reverting" do
+  setup do
+    @path = cloned_testpath("examples/revert.git")
+    @wiki = Gollum::Wiki.new(@path)
+  end
+
+  teardown do
+    FileUtils.rm_rf(@path)
+  end
+
+  test "reverts single commit" do
+    page1 = @wiki.page("B")
+    sha   = @wiki.revert_commit('7c45b5f16ff3bae2a0063191ef832701214d4df5')
+    page2 = @wiki.page("B")
+    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
+
+  test "reverts single commit for a page" do
+    page1 = @wiki.page('B')
+    sha   = @wiki.revert_page(page1, '7c45b5f16ff3bae2a0063191ef832701214d4df5')
+    page2 = @wiki.page('B')
+    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
+
+  test "reverts multiple commits for a page" do
+    page1 = @wiki.page('A')
+    sha   = @wiki.revert_page(page1, '302a5491a9a5ba12c7652ac831a44961afa312d2^', 'b26b791cb7917c4f37dd9cb4d1e0efb24ac4d26f')
+    page2 = @wiki.page('A')
+    assert_equal sha,       page2.version.sha
+    assert_equal "INITIAL", body=page2.raw_data.strip
+    assert_equal body, File.read(File.join(@path, "A.md")).strip
+  end
+
+  test "cannot revert conflicting commit" do
+    page1 = @wiki.page('A')
+    assert_equal false, @wiki.revert_page(page1, '302a5491a9a5ba12c7652ac831a44961afa312d2')
+  end
+end

data/test/test_wiki.rb

@@ -0,0 +1,343 @@
+# ~*~ encoding: utf-8 ~*~
+require File.expand_path(File.join(File.dirname(__FILE__), "helper"))
+
+context "Wiki" do
+  setup do
+    @wiki = Gollum::Wiki.new(testpath("examples/lotr.git"))
+  end
+
+  test "repo path" do
+    assert_equal testpath("examples/lotr.git"), @wiki.path
+  end
+
+  test "git repo" do
+    assert_equal Grit::Repo, @wiki.repo.class
+    assert @wiki.exist?
+  end
+
+  test "shows paginated log with no page" do
+    Gollum::Wiki.per_page = 3
+    commits = @wiki.repo.commits[0..2].map { |x| x.id }
+    assert_equal commits, @wiki.log.map { |c| c.id }
+  end
+
+  test "shows paginated log with 1st page" do
+    Gollum::Wiki.per_page = 3
+    commits = @wiki.repo.commits[0..2].map { |x| x.id }
+    assert_equal commits, @wiki.log(:page => 1).map { |c| c.id }
+  end
+
+  test "shows paginated log with next page" do
+    Gollum::Wiki.per_page = 3
+    commits = @wiki.repo.commits[3..5].map { |x| x.id }
+    assert_equal commits, @wiki.log(:page => 2).map { |c| c.id }
+  end
+
+  test "list pages" do
+    pages = @wiki.pages
+    assert_equal \
+      %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 "text_data" do
+    wiki = Gollum::Wiki.new(testpath("examples/yubiwa.git"))
+    if String.instance_methods.include?(:encoding)
+      utf8 = wiki.page("strider").text_data
+      assert_equal Encoding::UTF_8, utf8.encoding
+      sjis = wiki.page("sjis").text_data(Encoding::SHIFT_JIS)
+      assert_equal Encoding::SHIFT_JIS, sjis.encoding
+    else
+      page = wiki.page("strider")
+      assert_equal page.raw_data, page.text_data
+    end
+  end
+
+  test "gets reverse diff" do
+    diff = @wiki.full_reverse_diff('a8ad3c09dd842a3517085bfadd37718856dee813')
+    assert_match "b/Mordor/_Sidebar.md", diff
+    assert_match "b/_Sidebar.md", diff
+  end
+
+  test "gets reverse diff for a page" do
+    diff  = @wiki.full_reverse_diff_for('_Sidebar.md', 'a8ad3c09dd842a3517085bfadd37718856dee813')
+    regex = /b\/Mordor\/\_Sidebar\.md/
+    assert_match    "b/_Sidebar.md", diff
+    assert_no_match regex, diff
+  end
+end
+
+context "Wiki page previewing" do
+  setup do
+    @path = testpath("examples/lotr.git")
+    @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 "Test.md", page.filename
+    assert_equal "Test", page.name
+  end
+end
+
+context "Wiki page writing" do
+  setup do
+    @path = testpath("examples/test.git")
+    FileUtils.rm_rf(@path)
+    Grit::Repo.init_bare(@path)
+    @wiki = Gollum::Wiki.new(@path)
+  end
+
+  test "write_page" do
+    cd = commit_details
+    @wiki.write_page("Gollum", :markdown, "# Gollum", cd)
+    assert_equal 1, @wiki.repo.commits.size
+    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_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
+    @wiki.write_page("Gollum", :markdown, "# Gollum", commit_details)
+
+    page = @wiki.page("Gollum")
+    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 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
+    @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_details)
+
+    assert_equal 2, @wiki.repo.commits.size
+    assert_equal :textile, @wiki.page("Gollum").format
+    assert_equal "h1. Gollum", @wiki.page("Gollum").raw_data
+  end
+
+  test "update page with name change" do
+    @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_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
+    @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_details)
+
+    assert_equal 2, @wiki.repo.commits.size
+    assert_equal :textile, @wiki.page("Smeagol").format
+    assert_equal "h1. Gollum", @wiki.page("Smeagol").raw_data
+  end
+
+  test "update nested page with format change" do
+    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_details)
+
+    page = @wiki.page("Gollum")
+    assert_equal "lotr/Gollum.textile", page.path
+    assert_equal :textile, page.format
+    assert_equal "h1. Gollum", page.raw_data
+  end
+
+  test "delete root page" do
+    @wiki.write_page("Gollum", :markdown, "# Gollum", commit_details)
+
+    page = @wiki.page("Gollum")
+    @wiki.delete_page(page, commit_details)
+
+    assert_equal 2, @wiki.repo.commits.size
+    assert_nil @wiki.page("Gollum")
+  end
+
+  test "delete nested page" do
+    index = @wiki.repo.index
+    index.add("greek/Bilbo-Baggins.md", "hi")
+    index.add("Gollum.md", "hi")
+    index.commit("Add alpha.jpg")
+
+    page = @wiki.page("Bilbo-Baggins")
+    assert page
+    @wiki.delete_page(page, commit_details)
+
+    assert_equal 2, @wiki.repo.commits.size
+    assert_nil @wiki.page("Bilbo-Baggins")
+
+    assert @wiki.page("Gollum")
+  end
+
+  teardown do
+    FileUtils.rm_r(File.join(File.dirname(__FILE__), *%w[examples test.git]))
+  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
+
+context "page_file_dir option" do
+  setup do
+    @path = cloned_testpath('examples/page_file_dir')
+    @repo = Grit::Repo.init(@path)
+    @page_file_dir = 'docs'
+    @wiki = Gollum::Wiki.new(@path, :page_file_dir => @page_file_dir)
+  end
+
+  test "write a page in sub directory" do
+    @wiki.write_page("New Page", :markdown, "Hi", commit_details)
+    assert_equal "Hi", File.read(File.join(@path, @page_file_dir, "New-Page.md"))
+    assert !File.exist?(File.join(@path, "New-Page.md"))
+  end
+  
+  test "edit a page in a sub directory" do
+    page = @wiki.page('foo')
+    @wiki.update_page(page, page.name, page.format, 'new contents', commit_details)
+  end
+
+  test "a file in page file dir should be found" do
+    assert @wiki.page("foo")
+  end
+
+  test "a file out of page file dir should not be found" do
+    assert !@wiki.page("bar")
+  end
+
+  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]
+  end
+
+  teardown do
+    FileUtils.rm_r(@path)
+  end
+end
+
+context "Wiki page writing with different branch" do
+  setup do
+    @path = testpath("examples/test.git")
+    FileUtils.rm_rf(@path)
+    @repo = Grit::Repo.init_bare(@path)
+    @wiki = Gollum::Wiki.new(@path)
+
+    # We need an initial commit to create the master branch
+    # before we can create new branches
+    cd = commit_details
+    @wiki.write_page("Gollum", :markdown, "# Gollum", cd)
+
+    # Create our test branch and check it out
+    @repo.update_ref("test", @repo.commits.first.id)
+    @branch = Gollum::Wiki.new(@path, :ref => "test")
+  end
+
+  teardown do
+    FileUtils.rm_rf(@path)
+  end
+
+  test "write_page" do
+    cd = commit_details
+
+    @branch.write_page("Bilbo", :markdown, "# Bilbo", commit_details)
+    assert @branch.page("Bilbo")
+    assert @wiki.page("Gollum")
+
+    assert_equal 1, @wiki.repo.commits.size
+    assert_equal 1, @branch.repo.commits.size
+
+    assert_equal nil, @wiki.page("Bilbo")
+  end
+end