From 94f05b07964e58da7eda395a1d3ccf125bb8d40c Mon Sep 17 00:00:00 2001 From: Tom Preston-Werner Date: Tue, 24 Aug 2010 13:58:05 -0700 Subject: [PATCH] Update working dir (if present) when edited via the API. Closes #6. --- HISTORY.md | 1 + gollum.gemspec | 2 +- lib/gollum/wiki.rb | 102 +++++++++++++++++++++++++++++++++++++++------ test/helper.rb | 6 +++ test/test_wiki.rb | 57 ++++++++++++++++++++++++- 5 files changed, 153 insertions(+), 15 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 7d20d2f1..9a585d1d 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -4,6 +4,7 @@ * 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) * Minor Enhancements * Support a `:gollum_path` Sinatra setting for `Precious::App` * Bug Fixes diff --git a/gollum.gemspec b/gollum.gemspec index e13e105b..7aa05337 100644 --- a/gollum.gemspec +++ b/gollum.gemspec @@ -23,7 +23,7 @@ Gem::Specification.new do |s| s.rdoc_options = ["--charset=UTF-8"] s.extra_rdoc_files = %w[README.md LICENSE] - s.add_dependency('grit', "~> 2.2") + 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") diff --git a/lib/gollum/wiki.rb b/lib/gollum/wiki.rb index b00d8954..ea4ab46d 100644 --- a/lib/gollum/wiki.rb +++ b/lib/gollum/wiki.rb @@ -135,9 +135,12 @@ module Gollum parents = pcommit ? [pcommit] : [] actor = Grit::Actor.new(commit[:name], commit[:email]) - sha = index.commit(commit[:message], parents, actor) + sha1 = index.commit(commit[:message], parents, actor) + @ref_map.clear - sha + update_working_dir(index, '', name, format) + + sha1 end # Public: Update an existing page with new content. The location of the @@ -162,21 +165,26 @@ module Gollum format ||= page.format index = self.repo.index + dir = ::File.dirname(page.path) + dir = '' if dir == '.' + index.read_tree(pcommit.tree.id) if page.name == name && page.format == format index.add(page.path, normalize(data)) else index.delete(page.path) - dir = ::File.dirname(page.path) - dir = '' if dir == '.' add_to_index(index, dir, name, format, data, :allow_same_ext) end actor = Grit::Actor.new(commit[:name], commit[:email]) - sha = index.commit(commit[:message], [pcommit], actor) + sha1 = index.commit(commit[:message], [pcommit], actor) + @ref_map.clear - sha + update_working_dir(index, dir, page.name, page.format) + update_working_dir(index, dir, name, format) + + sha1 end # Public: Delete a page. @@ -195,10 +203,16 @@ module Gollum index.read_tree(pcommit.tree.id) index.delete(page.path) + dir = ::File.dirname(page.path) + dir = '' if dir == '.' + actor = Grit::Actor.new(commit[:name], commit[:email]) - sha = index.commit(commit[:message], [pcommit], actor) + sha1 = index.commit(commit[:message], [pcommit], actor) + @ref_map.clear - sha + update_working_dir(index, dir, page.name, page.format) + + sha1 end # Public: Lists all pages for this wiki. @@ -265,6 +279,45 @@ module Gollum data.gsub(/\r/, '') end + # Assemble a Page's filename from its name and format. + # + # name - The String name of the page (may be in human format). + # format - The Symbol format of the page. + # + # Returns the String filename. + def page_file_name(name, format) + ext = @page_class.format_to_ext(format) + @page_class.cname(name) + '.' + ext + end + + # Update the given file in the repository's working directory if there + # is a working directory present. + # + # index - The Grit::Index with which to sync. + # dir - The String directory in which the file lives. + # name - The String name of the page (may be in human format). + # format - The Symbol format of the page. + # + # Returns nothing. + def update_working_dir(index, dir, name, format) + unless @repo.bare + path = + if dir == '' + page_file_name(name, format) + else + ::File.join(dir, page_file_name(name, format)) + end + + Dir.chdir(::File.join(@repo.path, '..')) do + if file_path_scheduled_for_deletion?(index.tree, path) + @repo.git.rm({'f' => true}, '--', path) + else + @repo.git.checkout({}, 'HEAD', '--', path) + end + end + end + end + # Fill an array with a list of pages. # # commit - The Grit::Commit @@ -290,8 +343,32 @@ module Gollum list end - # Determine if a given page path is scheduled to be deleted in the next - # commit for the given Index. + # Determine if a given file is scheduled to be deleted in the next commit + # for the given Index. + # + # map - The Hash map: + # key - The String directory or filename. + # val - The Hash submap or the String contents of the file. + # path - The String path of the file including extension. + # + # Returns the Boolean response. + def file_path_scheduled_for_deletion?(map, path) + parts = path.split('/') + if parts.size == 1 + deletions = map.keys.select { |k| !map[k] } + deletions.any? { |d| d == parts.first } + else + part = parts.shift + if rest = map[part] + file_path_scheduled_for_deletion?(rest, parts.join('/')) + else + false + end + end + end + + # Determine if a given page (regardless of format) is scheduled to be + # deleted in the next commit for the given Index. # # map - The Hash map: # key - The String directory or filename. @@ -311,7 +388,7 @@ module Gollum if rest = map[part] page_path_scheduled_for_deletion?(rest, parts.join('/')) else - nil + false end end end @@ -332,8 +409,7 @@ module Gollum # # Returns nothing (modifies the Index in place). def add_to_index(index, dir, name, format, data, allow_same_ext = false) - ext = @page_class.format_to_ext(format) - path = @page_class.cname(name) + '.' + ext + path = page_file_name(name, format) dir = '/' if dir.strip.empty? diff --git a/test/helper.rb b/test/helper.rb index 0b11383e..1db68446 100644 --- a/test/helper.rb +++ b/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 diff --git a/test/test_wiki.rb b/test/test_wiki.rb index 7b45ea53..5b066bc7 100644 --- a/test/test_wiki.rb +++ b/test/test_wiki.rb @@ -238,4 +238,59 @@ context "Wiki page writing" do teardown do FileUtils.rm_r(File.join(File.dirname(__FILE__), *%w[examples test.git])) end -end \ No newline at end of file +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