From e9a9eb1779b879b47b5e002f19d42481df2114c7 Mon Sep 17 00:00:00 2001 From: bootstraponline Date: Sat, 5 May 2012 13:49:01 -0600 Subject: [PATCH] Add header. --- README.md | 8 +++++++- lib/gollum/frontend/app.rb | 1 + lib/gollum/frontend/templates/page.mustache | 7 +++++++ lib/gollum/frontend/views/create.rb | 5 +++++ lib/gollum/frontend/views/edit.rb | 11 +++++++++++ lib/gollum/frontend/views/page.rb | 15 ++++++++++++++- lib/gollum/page.rb | 9 ++++++++- test/test_app.rb | 6 ++++-- 8 files changed, 57 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d8d9aa62..7f6c10b5 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,13 @@ are named `_Sidebar.ext` where the extension is one of the supported formats. Sidebars affect all pages in their directory and any subdirectories that do not have a sidebar file of their own. +## HEADER FILES + +Header files allow you to add a simple header to your wiki. Header files must +be named `_Header.ext` where the extension is one of the supported formats. +Like sidebars, headers affect all pages in their directory and any +subdirectories that do not have a header file of their own. + ## FOOTER FILES Footer files allow you to add a simple footer to your wiki. Footer files must @@ -113,7 +120,6 @@ be named `_Footer.ext` where the extension is one of the supported formats. Like sidebars, footers affect all pages in their directory and any subdirectories that do not have a footer file of their own. - ## HTML SANITIZATION For security and compatibility reasons Gollum wikis may not contain custom CSS diff --git a/lib/gollum/frontend/app.rb b/lib/gollum/frontend/app.rb index 05db3563..01ab8d82 100644 --- a/lib/gollum/frontend/app.rb +++ b/lib/gollum/frontend/app.rb @@ -63,6 +63,7 @@ module Precious update_wiki_page(wiki, page, params[:content], commit, name, params[:format]) + update_wiki_page(wiki, page.header, params[:header], commit) if params[:header] update_wiki_page(wiki, page.footer, params[:footer], commit) if params[:footer] update_wiki_page(wiki, page.sidebar, params[:sidebar], commit) if params[:sidebar] committer.commit diff --git a/lib/gollum/frontend/templates/page.mustache b/lib/gollum/frontend/templates/page.mustache index 8d29fb4c..4400181b 100644 --- a/lib/gollum/frontend/templates/page.mustache +++ b/lib/gollum/frontend/templates/page.mustache @@ -20,6 +20,13 @@
+ {{#has_header}} +
+
+ {{{header_content}}} +
+
+ {{/has_header}}
{{{content}}}
diff --git a/lib/gollum/frontend/views/create.rb b/lib/gollum/frontend/views/create.rb index b5e974d0..7d09c7fe 100755 --- a/lib/gollum/frontend/views/create.rb +++ b/lib/gollum/frontend/views/create.rb @@ -27,6 +27,11 @@ module Precious !!@footer end + def has_header + @header = (@page.header || false) if @header.nil? && @page + !!@header + end + def has_sidebar @sidebar = (@page.sidebar || false) if @sidebar.nil? && @page !!@sidebar diff --git a/lib/gollum/frontend/views/edit.rb b/lib/gollum/frontend/views/edit.rb index 21078dbc..d78cbb7c 100755 --- a/lib/gollum/frontend/views/edit.rb +++ b/lib/gollum/frontend/views/edit.rb @@ -13,6 +13,17 @@ module Precious @name.gsub('-', ' ') end + def header + if @header.nil? + if page = @page.header + @header = page.raw_data + else + @header = false + end + end + @header + end + def footer if @footer.nil? if page = @page.footer diff --git a/lib/gollum/frontend/views/page.rb b/lib/gollum/frontend/views/page.rb index 2b3ef0c3..2fe2ab0f 100644 --- a/lib/gollum/frontend/views/page.rb +++ b/lib/gollum/frontend/views/page.rb @@ -1,7 +1,7 @@ module Precious module Views class Page < Layout - attr_reader :content, :page, :footer + attr_reader :content, :page, :header, :footer DATE_FORMAT = "%Y-%m-%d %H:%M:%S" DEFAULT_AUTHOR = 'you' @@ -27,6 +27,19 @@ module Precious @editable end + def has_header + @header = (@page.header || false) if @header.nil? + !!@header + end + + def header_content + has_header && @header.formatted_data + end + + def header_format + has_header && @header.format.to_s + end + def has_footer @footer = (@page.footer || false) if @footer.nil? !!@footer diff --git a/lib/gollum/page.rb b/lib/gollum/page.rb index 9787c3ee..07296faf 100644 --- a/lib/gollum/page.rb +++ b/lib/gollum/page.rb @@ -99,7 +99,7 @@ module Gollum # Returns a newly initialized Gollum::Page. def initialize(wiki) @wiki = wiki - @blob = @footer = @sidebar = nil + @blob = @header = @footer = @sidebar = nil end # Public: The on-disk filename of the page including extension. @@ -209,6 +209,13 @@ module Gollum end end + # Public: The header Page. + # + # Returns the header Page or nil if none exists. + def header + @header ||= find_sub_page(:header) + end + # Public: The footer Page. # # Returns the footer Page or nil if none exists. diff --git a/test/test_app.rb b/test/test_app.rb index 2d065249..ef967bcc 100644 --- a/test/test_app.rb +++ b/test/test_app.rb @@ -29,13 +29,13 @@ context "Frontend" do assert_not_equal page_1.version.sha, page_2.version.sha end - test "edits page footer and sidebar" do + test "edits page header footer and sidebar" do commits = @wiki.repo.commits('master').size page_1 = @wiki.page('A') foot_1 = page_1.footer side_1 = page_1.sidebar - post "/edit/A", + post "/edit/A", :header => 'header', :footer => 'footer', :page => "A", :sidebar => 'sidebar', :message => 'def' follow_redirect! assert_equal "/A", last_request.fullpath @@ -43,10 +43,12 @@ context "Frontend" do @wiki.clear_cache page_2 = @wiki.page(page_1.name) + header_2 = page_2.header foot_2 = page_2.footer side_2 = page_2.sidebar assert_equal page_1.raw_data, page_2.raw_data + assert_equal 'header', header_2.raw_data assert_equal 'footer', foot_2.raw_data assert_equal 'def', foot_2.version.message assert_not_equal foot_1.version.sha, foot_2.version.sha