gollum-site 0.1.9 → 0.1.10

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    gollum-site (0.1.9)
+      directory_watcher
+      gollum (>= 1.2.0)
+      liquid (>= 2.2.2)
+      mixlib-log (>= 1.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    albino (1.3.3)
+      posix-spawn (>= 0.3.6)
+    diff-lcs (1.1.2)
+    directory_watcher (1.4.0)
+    github-markup (0.5.3)
+    gollum (1.3.0)
+      albino (~> 1.3.2)
+      github-markup (>= 0.4.0, < 1.0.0)
+      grit (~> 2.4.1)
+      mustache (>= 0.11.2, < 1.0.0)
+      nokogiri (~> 1.4)
+      sanitize (~> 2.0.0)
+      sinatra (~> 1.0)
+    grit (2.4.1)
+      diff-lcs (~> 1.1)
+      mime-types (~> 1.15)
+    liquid (2.2.2)
+    mime-types (1.16)
+    mixlib-log (1.3.0)
+    mustache (0.99.3)
+    nokogiri (1.4.4)
+    posix-spawn (0.3.6)
+    rack (1.2.2)
+    sanitize (2.0.1)
+      nokogiri (~> 1.4.4)
+    sinatra (1.2.3)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gollum-site!

data/README.md

@@ -145,13 +145,23 @@ You can generate a static site from untracked/uncommitted changes by using the
 ## Watch
 
 When running the gollum-site server you can enable directory watching to update
-the static site when changes are made to any of the wiki or static files. This
-currently does not work for layout updates (full site regeneration is required).
+the static site when changes are made to any of the wiki or static
+files. This feature only works with the "serve" command.
 
        $ gollum-site serve --watch
 
 This feature requires the
-[directory_watcher](https://rubygems.org/gems/directory_watcher) gem
+[directory_watcher](https://rubygems.org/gems/directory_watcher) gem.
+
+## Sanitization
+
+You can customize sanitization with three options:
+
+* --allow_elements: custom elements allowed, comma separated
+* --allow_attributes: custom attributes allowed, comma separated
+* --allow_protocols: custom protocols in *href* allowed, comma separated
+
+       $ gollum-site generate --allow_elements embed,object --allow_attributes src --allow_protocols irc
 
 ## Example
 

data/bin/gollum-site

@@ -28,7 +28,10 @@ options = {
   'output_path' => '_site',
   'port' => 8000,
   'watch' => false,
-  'level' => :warn
+  'level' => :warn,
+  'allow_elements' => [],
+  'allow_attributes' => [],
+  'allow_protocols' => []
 }
 opts = OptionParser.new do |opts|
   opts.banner = help
@@ -57,6 +60,18 @@ opts = OptionParser.new do |opts|
     options['watch'] = true
   end
 
+  opts.on("--allow_elements ELMS", "Custom elements to prevent sanitization (comma separated)") do |elements|
+    options['allow_elements'] = elements.split(',')
+  end
+
+  opts.on("--allow_attributes ATTRS", "Custom attributes to prevent sanitization (comma separated)") do |attrs|
+    options['allow_attributes'] = attrs.split(',')
+  end
+
+  opts.on("--allow_protocols PROTOCOLS", "Custom protocols to prevent sanitization (comma separated)") do |protocols|
+    options['allow_protocols'] = protocols.split(',')
+  end
+
   opts.on("--log_level LEVEL", %w[debug info warn error fatal],
           "Set logging level (debug, info, warn, error, fatal)") do |level|
     options['level'] = level.to_sym
@@ -92,7 +107,10 @@ when 'generate'
   site = Gollum::Site.new('.', {
                             :base_path => options['base_path'],
                             :output_path => options['output_path'],
-                            :version => options['working'] ? :working : options['ref']
+                            :version => options['working'] ? :working : options['ref'],
+                            :allow_elements => options['allow_elements'],
+                            :allow_attributes => options['allow_attributes'],
+                            :allow_protocols => options['allow_protocols']
                           })
   start = Time.now
   site.generate()
@@ -100,6 +118,17 @@ when 'generate'
   puts "Generated site in #{stop - start}(s)"
 when 'serve'
   if options['watch']
+    site = Gollum::Site.new('.', {
+                            :base_path => options['base_path'],
+                            :output_path => options['output_path'],
+                            :version => :working
+                            })
+    puts "Generating site"
+    start = Time.now
+    site.generate()
+    stop = Time.now
+    puts "Generated site in #{stop - start}(s)"
+
     require 'directory_watcher'
 
     dw = DirectoryWatcher.new('.', {
@@ -108,12 +137,6 @@ when 'serve'
                                 :interval => 1
                               })
 
-    site = Gollum::Site.new('.', {
-                              :base_path => options['base_path'],
-                              :output_path => options['output_path'],
-                              :version => :working
-                            })
-
     dw.add_observer do |*args|
       args.each do |event|
         # Only respond to modified/added events
@@ -121,8 +144,11 @@ when 'serve'
           # Ignore modifications to output path
           unless ::File.expand_path(event.path).match(::File.expand_path(site.output_path))
             item = event.path[2..-1]
-            puts "Updating #{item}"
-            site.update_working_item(item)
+            puts "Regenerating site"
+            start = Time.now
+            site.generate()
+            stop = Time.now
+            puts "Generated site in #{stop - start}(s)"
           end
         end
       end

data/gollum-site.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.add_dependency('gollum', '>= 1.2.0')
   s.add_dependency('liquid', '>= 2.2.2')
   s.add_dependency('mixlib-log', '>= 1.1.0')
+  s.add_dependency('directory_watcher')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/gollum-site/page.rb

@@ -65,13 +65,17 @@ module Gollum
 
     def liquify
       SiteLog.debug("Starting page liquefication - #{name}")
-      data = { "path" => self.class.cname(name),
+      data = {
+        "path" => self.class.cname(name),
         "link" => ::File.join(@wiki.base_path, CGI.escape(self.class.cname(name))),
         "content" => formatted_data,
         "title" => title,
-        "format" => format.to_s,
-        "author" => version.author.name,
-        "date" => version.authored_date.strftime("%Y-%m-%d %H:%M:%S")}
+        "format" => format.to_s
+      }
+      data["author"] = version.author.name rescue nil
+      data["date"] = version.authored_date.strftime("%Y-%m-%d %H:%M:%S") rescue nil
+      data["footer"] = footer.formatted_data if footer
+      data["sidebar"] = sidebar.formatted_data if sidebar
       SiteLog.debug("Finished page liquefication - #{name}")
       return data
     end

data/lib/gollum-site/sanitization.rb

@@ -16,7 +16,7 @@ module Gollum
       'select', 'small', 'span', 'strike', 'strong', 'sub',
       'sup', 'table', 'tbody', 'td', 'textarea', 'tfoot', 'th',
       'thead', 'tr', 'tt', 'u', 'ul', 'var', 'iframe'
-    ].freeze
+    ]
 
     # Default whitelisted attributes.
     ATTRIBUTES = {

data/lib/gollum-site/site.rb

@@ -13,29 +13,30 @@ module Gollum
                                  :markup_class => Gollum::SiteMarkup,
                                  :page_class => Gollum::SitePage,
                                  :base_path => options[:base_path],
-                                 :sanitization => Gollum::SiteSanitization.new,
-                                 :history_sanitization => Gollum::SiteSanitization.new
+                                 :sanitization => sanitization(options),
+                                 :history_sanitization => sanitization(options)
                                })
       @wiki.site = self
       @output_path = options[:output_path] || "_site"
-      set_version(options[:version] || "master")
+      @version = options[:version] || "master"
     end
 
     # Prepare site for specified version
-    def set_version(version)
-      @version = version
+    def prepare()
       @pages = {}
       @files = {}
       @layouts = {}
 
-      @commit = version == :working ? @wiki.repo.commit("HEAD") : @wiki.repo.commit(version)
-      items = self.ls(version)
+      @commit = @version == :working ? @wiki.repo.head.commit : @wiki.repo.commit(@version)
+      items = self.ls(@version)
 
       items.each do |item|
         filename = ::File.basename(item.path)
         dirname = ::File.dirname(item.path)
         if filename =~ /^_Footer./
           # ignore
+        elsif filename =~ /^_Sidebar./
+          # ignore
         elsif filename =~ /^_Layout.html/
           # layout
           @layouts[item.path] = ::Liquid::Template.parse(item.data)
@@ -91,37 +92,17 @@ module Gollum
       end
     end
 
-    # path must be relative to top level of wiki repo
-    def update_working_item(path)
-      filename = ::File.basename(path)
-      dirname = ::File.dirname(path)
-      if filename =~ /^_Footer./
-        # ignore
-      elsif filename =~ /^_Layout.html/
-        # layout
-      elsif @wiki.page_class.valid_page_name?(filename)
-        # page
-        abspath = ::File.join(@wiki.repo.git.work_tree, path)
-        page = @wiki.page_class.new(@wiki)
-        blob = OpenStruct.new(:name => filename, :data => IO.read(abspath))
-        page.populate(blob, dirname)
-        page.version = @commit
-        @pages[page.name.downcase] = page
-        page.generate(@output_path, @version)
-      else
-        # file
-        data = IO.read(abspath)
-        @files[path] = data
-        path = ::File.join(@output_path, path)
-        ::FileUtils.mkdir_p(::File.dirname(path))
-        ::File.open(path, "w") do |f|
-          f.write(data)
-        end
-      end
+    def sanitization(options)
+      site_sanitization = Gollum::SiteSanitization.new
+      site_sanitization.elements.concat options[:allow_elements] || []
+      site_sanitization.attributes[:all].concat options[:allow_attributes] || []
+      site_sanitization.protocols['a']['href'].concat options[:allow_protocols] || []
+      site_sanitization
     end
 
     # Public: generate the static site
     def generate()
+      prepare
       ::Dir.mkdir(@output_path) unless ::File.exists? @output_path
 
       @pages.each do |name, page|

data/lib/gollum-site/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   class Site
-    VERSION = "0.1.9"
+    VERSION = "0.1.10"
   end
 end

data/test/examples/test_footer_and_sidebar.git/COMMIT_EDITMSG

@@ -0,0 +1 @@
+second commit

data/test/examples/test_footer_and_sidebar.git/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

data/test/examples/test_footer_and_sidebar.git/config

@@ -0,0 +1,12 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+	ignorecase = true
+[remote "origin"]
+	fetch = +refs/heads/*:refs/remotes/origin/*
+	url = /Users/dreverri/src/basho/gollum-site/test/examples/test_footer_and_sidebar.git
+[branch "master"]
+	remote = origin
+	merge = refs/heads/master

data/test/examples/test_footer_and_sidebar.git/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file 'description' to name the repository.

data/test/examples/test_footer_and_sidebar.git/hooks/applypatch-msg.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message taken by
+# applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.  The hook is
+# allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "applypatch-msg".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/commit-msg" &&
+	exec "$GIT_DIR/hooks/commit-msg" ${1+"$@"}
+:

data/test/examples/test_footer_and_sidebar.git/hooks/commit-msg.sample

@@ -0,0 +1,24 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}

data/test/examples/test_footer_and_sidebar.git/hooks/post-commit.sample

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# An example hook script that is called after a successful
+# commit is made.
+#
+# To enable this hook, rename this file to "post-commit".
+
+: Nothing

data/test/examples/test_footer_and_sidebar.git/hooks/post-receive.sample

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# An example hook script for the "post-receive" event.
+#
+# The "post-receive" script is run after receive-pack has accepted a pack
+# and the repository has been updated.  It is passed arguments in through
+# stdin in the form
+#  <oldrev> <newrev> <refname>
+# For example:
+#  aa453216d1b3e49e7f6f98441fa56946ddcd6a20 68f7abf4e6f922807889f52bc043ecd31b79f814 refs/heads/master
+#
+# see contrib/hooks/ for a sample, or uncomment the next line and
+# rename the file to "post-receive".
+
+#. /usr/share/doc/git-core/contrib/hooks/post-receive-email

data/test/examples/test_footer_and_sidebar.git/hooks/post-update.sample

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# An example hook script to prepare a packed repository for use over
+# dumb transports.
+#
+# To enable this hook, rename this file to "post-update".
+
+exec git update-server-info

data/test/examples/test_footer_and_sidebar.git/hooks/pre-applypatch.sample

@@ -0,0 +1,14 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed
+# by applypatch from an e-mail message.
+#
+# The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-applypatch".
+
+. git-sh-setup
+test -x "$GIT_DIR/hooks/pre-commit" &&
+	exec "$GIT_DIR/hooks/pre-commit" ${1+"$@"}
+:

data/test/examples/test_footer_and_sidebar.git/hooks/pre-commit.sample

@@ -0,0 +1,46 @@
+#!/bin/sh
+#
+# An example hook script to verify what is about to be committed.
+# Called by "git commit" with no arguments.  The hook should
+# exit with non-zero status after issuing an appropriate message if
+# it wants to stop the commit.
+#
+# To enable this hook, rename this file to "pre-commit".
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+fi
+
+# If you want to allow non-ascii filenames set this variable to true.
+allownonascii=$(git config hooks.allownonascii)
+
+# Cross platform projects tend to avoid non-ascii filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test "$(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0')"
+then
+	echo "Error: Attempt to add a non-ascii file name."
+	echo
+	echo "This can cause problems if you want to work"
+	echo "with people on other platforms."
+	echo
+	echo "To be portable it is advisable to rename the file ..."
+	echo
+	echo "If you know what you are doing you can disable this"
+	echo "check using:"
+	echo
+	echo "  git config hooks.allownonascii true"
+	echo
+	exit 1
+fi
+
+exec git diff-index --check --cached $against --

data/test/examples/test_footer_and_sidebar.git/hooks/pre-rebase.sample

@@ -0,0 +1,169 @@
+#!/bin/sh
+#
+# Copyright (c) 2006, 2008 Junio C Hamano
+#
+# The "pre-rebase" hook is run just before "git rebase" starts doing
+# its job, and can prevent the command from running by exiting with
+# non-zero status.
+#
+# The hook is called with the following parameters:
+#
+# $1 -- the upstream the series was forked from.
+# $2 -- the branch being rebased (or empty when rebasing the current branch).
+#
+# This sample shows how to prevent topic branches that are already
+# merged to 'next' branch from getting rebased, because allowing it
+# would result in rebasing already published history.
+
+publish=next
+basebranch="$1"
+if test "$#" = 2
+then
+	topic="refs/heads/$2"
+else
+	topic=`git symbolic-ref HEAD` ||
+	exit 0 ;# we do not interrupt rebasing detached HEAD
+fi
+
+case "$topic" in
+refs/heads/??/*)
+	;;
+*)
+	exit 0 ;# we do not interrupt others.
+	;;
+esac
+
+# Now we are dealing with a topic branch being rebased
+# on top of master.  Is it OK to rebase it?
+
+# Does the topic really exist?
+git show-ref -q "$topic" || {
+	echo >&2 "No such branch $topic"
+	exit 1
+}
+
+# Is topic fully merged to master?
+not_in_master=`git rev-list --pretty=oneline ^master "$topic"`
+if test -z "$not_in_master"
+then
+	echo >&2 "$topic is fully merged to master; better remove it."
+	exit 1 ;# we could allow it, but there is no point.
+fi
+
+# Is topic ever merged to next?  If so you should not be rebasing it.
+only_next_1=`git rev-list ^master "^$topic" ${publish} | sort`
+only_next_2=`git rev-list ^master           ${publish} | sort`
+if test "$only_next_1" = "$only_next_2"
+then
+	not_in_topic=`git rev-list "^$topic" master`
+	if test -z "$not_in_topic"
+	then
+		echo >&2 "$topic is already up-to-date with master"
+		exit 1 ;# we could allow it, but there is no point.
+	else
+		exit 0
+	fi
+else
+	not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
+	/usr/bin/perl -e '
+		my $topic = $ARGV[0];
+		my $msg = "* $topic has commits already merged to public branch:\n";
+		my (%not_in_next) = map {
+			/^([0-9a-f]+) /;
+			($1 => 1);
+		} split(/\n/, $ARGV[1]);
+		for my $elem (map {
+				/^([0-9a-f]+) (.*)$/;
+				[$1 => $2];
+			} split(/\n/, $ARGV[2])) {
+			if (!exists $not_in_next{$elem->[0]}) {
+				if ($msg) {
+					print STDERR $msg;
+					undef $msg;
+				}
+				print STDERR " $elem->[1]\n";
+			}
+		}
+	' "$topic" "$not_in_next" "$not_in_master"
+	exit 1
+fi
+
+exit 0
+
+################################################################
+
+This sample hook safeguards topic branches that have been
+published from being rewound.
+
+The workflow assumed here is:
+
+ * Once a topic branch forks from "master", "master" is never
+   merged into it again (either directly or indirectly).
+
+ * Once a topic branch is fully cooked and merged into "master",
+   it is deleted.  If you need to build on top of it to correct
+   earlier mistakes, a new topic branch is created by forking at
+   the tip of the "master".  This is not strictly necessary, but
+   it makes it easier to keep your history simple.
+
+ * Whenever you need to test or publish your changes to topic
+   branches, merge them into "next" branch.
+
+The script, being an example, hardcodes the publish branch name
+to be "next", but it is trivial to make it configurable via
+$GIT_DIR/config mechanism.
+
+With this workflow, you would want to know:
+
+(1) ... if a topic branch has ever been merged to "next".  Young
+    topic branches can have stupid mistakes you would rather
+    clean up before publishing, and things that have not been
+    merged into other branches can be easily rebased without
+    affecting other people.  But once it is published, you would
+    not want to rewind it.
+
+(2) ... if a topic branch has been fully merged to "master".
+    Then you can delete it.  More importantly, you should not
+    build on top of it -- other people may already want to
+    change things related to the topic as patches against your
+    "master", so if you need further changes, it is better to
+    fork the topic (perhaps with the same name) afresh from the
+    tip of "master".
+
+Let's look at this example:
+
+		   o---o---o---o---o---o---o---o---o---o "next"
+		  /       /           /           /
+		 /   a---a---b A     /           /
+		/   /               /           /
+	       /   /   c---c---c---c B         /
+	      /   /   /             \         /
+	     /   /   /   b---b C     \       /
+	    /   /   /   /             \     /
+    ---o---o---o---o---o---o---o---o---o---o---o "master"
+
+
+A, B and C are topic branches.
+
+ * A has one fix since it was merged up to "next".
+
+ * B has finished.  It has been fully merged up to "master" and "next",
+   and is ready to be deleted.
+
+ * C has not merged to "next" at all.
+
+We would want to allow C to be rebased, refuse A, and encourage
+B to be deleted.
+
+To compute (1):
+
+	git rev-list ^master ^topic next
+	git rev-list ^master        next
+
+	if these match, topic has not merged in next at all.
+
+To compute (2):
+
+	git rev-list master..topic
+
+	if this is empty, it is fully merged to "master".

data/test/examples/test_footer_and_sidebar.git/hooks/prepare-commit-msg.sample

@@ -0,0 +1,36 @@
+#!/bin/sh
+#
+# An example hook script to prepare the commit log message.
+# Called by "git commit" with the name of the file that has the
+# commit message, followed by the description of the commit
+# message's source.  The hook's purpose is to edit the commit
+# message file.  If the hook fails with a non-zero status,
+# the commit is aborted.
+#
+# To enable this hook, rename this file to "prepare-commit-msg".
+
+# This hook includes three examples.  The first comments out the
+# "Conflicts:" part of a merge commit.
+#
+# The second includes the output of "git diff --name-status -r"
+# into the message, just before the "git status" output.  It is
+# commented because it doesn't cope with --amend or with squashed
+# commits.
+#
+# The third example adds a Signed-off-by line to the message, that can
+# still be edited.  This is rarely a good idea.
+
+case "$2,$3" in
+  merge,)
+    /usr/bin/perl -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1" ;;
+
+# ,|template,)
+#   /usr/bin/perl -i.bak -pe '
+#      print "\n" . `git diff --cached --name-status -r`
+#	 if /^#/ && $first++ == 0' "$1" ;;
+
+  *) ;;
+esac
+
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"

data/test/examples/test_footer_and_sidebar.git/hooks/update.sample

@@ -0,0 +1,128 @@
+#!/bin/sh
+#
+# An example hook script to blocks unannotated tags from entering.
+# Called by "git receive-pack" with arguments: refname sha1-old sha1-new
+#
+# To enable this hook, rename this file to "update".
+#
+# Config
+# ------
+# hooks.allowunannotated
+#   This boolean sets whether unannotated tags will be allowed into the
+#   repository.  By default they won't be.
+# hooks.allowdeletetag
+#   This boolean sets whether deleting tags will be allowed in the
+#   repository.  By default they won't be.
+# hooks.allowmodifytag
+#   This boolean sets whether a tag may be modified after creation. By default
+#   it won't be.
+# hooks.allowdeletebranch
+#   This boolean sets whether deleting branches will be allowed in the
+#   repository.  By default they won't be.
+# hooks.denycreatebranch
+#   This boolean sets whether remotely creating branches will be denied
+#   in the repository.  By default this is allowed.
+#
+
+# --- Command line
+refname="$1"
+oldrev="$2"
+newrev="$3"
+
+# --- Safety check
+if [ -z "$GIT_DIR" ]; then
+	echo "Don't run this script from the command line." >&2
+	echo " (if you want, you could supply GIT_DIR then run" >&2
+	echo "  $0 <ref> <oldrev> <newrev>)" >&2
+	exit 1
+fi
+
+if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then
+	echo "Usage: $0 <ref> <oldrev> <newrev>" >&2
+	exit 1
+fi
+
+# --- Config
+allowunannotated=$(git config --bool hooks.allowunannotated)
+allowdeletebranch=$(git config --bool hooks.allowdeletebranch)
+denycreatebranch=$(git config --bool hooks.denycreatebranch)
+allowdeletetag=$(git config --bool hooks.allowdeletetag)
+allowmodifytag=$(git config --bool hooks.allowmodifytag)
+
+# check for no description
+projectdesc=$(sed -e '1q' "$GIT_DIR/description")
+case "$projectdesc" in
+"Unnamed repository"* | "")
+	echo "*** Project description file hasn't been set" >&2
+	exit 1
+	;;
+esac
+
+# --- Check types
+# if $newrev is 0000...0000, it's a commit to delete a ref.
+zero="0000000000000000000000000000000000000000"
+if [ "$newrev" = "$zero" ]; then
+	newrev_type=delete
+else
+	newrev_type=$(git cat-file -t $newrev)
+fi
+
+case "$refname","$newrev_type" in
+	refs/tags/*,commit)
+		# un-annotated tag
+		short_refname=${refname##refs/tags/}
+		if [ "$allowunannotated" != "true" ]; then
+			echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2
+			echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,delete)
+		# delete tag
+		if [ "$allowdeletetag" != "true" ]; then
+			echo "*** Deleting a tag is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/tags/*,tag)
+		# annotated tag
+		if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1
+		then
+			echo "*** Tag '$refname' already exists." >&2
+			echo "*** Modifying a tag is not allowed in this repository." >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,commit)
+		# branch
+		if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then
+			echo "*** Creating a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/heads/*,delete)
+		# delete branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	refs/remotes/*,commit)
+		# tracking branch
+		;;
+	refs/remotes/*,delete)
+		# delete tracking branch
+		if [ "$allowdeletebranch" != "true" ]; then
+			echo "*** Deleting a tracking branch is not allowed in this repository" >&2
+			exit 1
+		fi
+		;;
+	*)
+		# Anything else (is there anything else?)
+		echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2
+		exit 1
+		;;
+esac
+
+# --- Finished
+exit 0

data/test/examples/test_footer_and_sidebar.git/info/exclude

@@ -0,0 +1,6 @@
+# git ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~

data/test/examples/test_footer_and_sidebar.git/logs/HEAD

@@ -0,0 +1,2 @@
+0000000000000000000000000000000000000000 f81dd0b9cec9c51bbf0ced5d75d329ab14ab4c69 Daniel Reverri <reverri@gmail.com> 1305254691 -0700	clone: from /Users/dreverri/src/basho/gollum-site/test/examples/test_footer_and_sidebar.git
+f81dd0b9cec9c51bbf0ced5d75d329ab14ab4c69 0d8513659a6a4837331c5a407b333acaa7260275 Daniel Reverri <reverri@gmail.com> 1305254741 -0700	commit: second commit

data/test/examples/test_footer_and_sidebar.git/logs/refs/heads/master

@@ -0,0 +1,2 @@
+0000000000000000000000000000000000000000 f81dd0b9cec9c51bbf0ced5d75d329ab14ab4c69 Daniel Reverri <reverri@gmail.com> 1305254691 -0700	clone: from /Users/dreverri/src/basho/gollum-site/test/examples/test_footer_and_sidebar.git
+f81dd0b9cec9c51bbf0ced5d75d329ab14ab4c69 0d8513659a6a4837331c5a407b333acaa7260275 Daniel Reverri <reverri@gmail.com> 1305254741 -0700	commit: second commit

data/test/examples/test_footer_and_sidebar.git/packed-refs

@@ -0,0 +1,2 @@
+# pack-refs with: peeled 
+f81dd0b9cec9c51bbf0ced5d75d329ab14ab4c69 refs/remotes/origin/master

data/test/examples/test_footer_and_sidebar.git/refs/heads/master

@@ -0,0 +1 @@
+0d8513659a6a4837331c5a407b333acaa7260275

data/test/examples/test_footer_and_sidebar.git/refs/remotes/origin/HEAD

@@ -0,0 +1 @@
+ref: refs/remotes/origin/master

data/test/test_site.rb

@@ -54,6 +54,9 @@ end
 context "Preview" do
   setup do
     @path = testpath("examples/uncommitted_untracked_changes")
+    @repo = Grit::Repo.init(@path)
+    @repo.add("#{@path}")
+    @repo.commit_all("Initial commit")
     # Add untracked file
     File.open(@path + '/Foo.md', 'w') { |f| f.write("Bar") }
     # Modify tracked file
@@ -78,18 +81,80 @@ context "Preview" do
     assert_equal("<p>Hello World\nHello World</p>", data)
   end
 
-  test "one item can be updated" do
-    File.open(@path + '/Foo.md', 'w') { |f| f.write("Baz") }
-    @site.update_working_item('Foo.md')
-    data = IO.read(::File.join(@site.output_path, "Foo.html"))
-    assert_equal("<p>Baz</p>", data)
-  end
-
   teardown do
     # Remove untracked file
     FileUtils.rm(@path + '/Foo.md')
     # Reset tracked file
     File.open(@path + '/Home.md', 'w') { |f| f.write("Hello World\n") }
     FileUtils.rm_r(@site.output_path)
+    FileUtils.rm_r(@path + '/.git')
+  end
+end
+
+context "Sanitization" do
+  setup do
+    @path = Dir.mktmpdir('gollumsite')
+    @repo = Grit::Repo.init(@path)
+    @repo.add("#{@path}")
+    @repo.commit_all("Initial commit")
+    # protocols
+    File.open(@path + '/Home.md', 'w') { |f| f.write("<a href=\"irc://irc.freenode.net/foo\">Hello World</a>") }
+    # elements
+    File.open(@path + '/Foo.md', 'w') { |f| f.write("<embed src=\"foo.html\">") }
+    @site = Gollum::Site.new(@path, {
+                               :output_path => testpath("examples/site"),
+                               :version => :working,
+                               :allow_protocols => ['irc'],
+                               :allow_elements => ['embed'],
+                               :allow_attributes => ['src']
+                             })
+    @site.generate()
+  end
+
+  test "link with irc protocol" do
+    data = IO.read(::File.join(@site.output_path, "Home.html"))
+    assert_equal("<p><a href=\"irc://irc.freenode.net/foo\">Hello World</a></p>", data)
+  end
+
+  test "embed with src" do
+    data = IO.read(::File.join(@site.output_path, "Foo.html"))
+    assert_equal("<p><embed src=\"foo.html\"></embed></p>", data)
+  end
+
+  teardown do
+    FileUtils.rm_r(@site.output_path)
+    FileUtils.rm_r(@path)
+  end
+
+end
+
+context "Sidebar and Footer" do
+  setup do
+    @path = testpath("examples/test_footer_and_sidebar.git")
+
+    @site = Gollum::Site.new(@path, {
+                               :output_path => testpath("examples/site"),
+                               :version => "master"
+                             })
+    @site.generate()
+  end
+
+  test "Sidebar and Footer files are ignored" do
+    assert !File.exists?(@site.output_path + '_Footer.html')
+    assert !File.exists?(@site.output_path + '_Sidebar.html')
+  end
+
+  test "Footer is rendered in _Layout" do
+    data = IO.read(::File.join(@site.output_path, "footer.html"))
+    assert_equal "<p>hello</p>\n", data
+  end
+
+  test "Sidebar is rendered in _Layout" do
+    data = IO.read(::File.join(@site.output_path, "sidebar.html"))
+    assert_equal "<p>world</p>\n", data
+  end
+
+  teardown do
+    FileUtils.rm_r(@site.output_path)
   end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: gollum-site
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 9
-  version: 0.1.9
+  prerelease: 
+  version: 0.1.10
 platform: ruby
 authors: 
 - Daniel Reverri
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 -07:00
-default_executable: 
+date: 2011-06-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gollum
@@ -25,10 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 0
         version: 1.2.0
   type: :runtime
   version_requirements: *id001
@@ -40,10 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 2
-        - 2
         version: 2.2.2
   type: :runtime
   version_requirements: *id002
@@ -55,13 +42,20 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        - 0
         version: 1.1.0
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: directory_watcher
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: Generate a static site for Gollum Wikis
 email: 
 - dan@basho.com
@@ -74,6 +68,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - bin/gollum-site
@@ -472,6 +467,40 @@ files:
 - lib/gollum-site/site.rb
 - lib/gollum-site/version.rb
 - lib/gollum-site/wiki.rb
+- test/examples/test_footer_and_sidebar.git/COMMIT_EDITMSG
+- test/examples/test_footer_and_sidebar.git/HEAD
+- test/examples/test_footer_and_sidebar.git/config
+- test/examples/test_footer_and_sidebar.git/description
+- test/examples/test_footer_and_sidebar.git/hooks/applypatch-msg.sample
+- test/examples/test_footer_and_sidebar.git/hooks/commit-msg.sample
+- test/examples/test_footer_and_sidebar.git/hooks/post-commit.sample
+- test/examples/test_footer_and_sidebar.git/hooks/post-receive.sample
+- test/examples/test_footer_and_sidebar.git/hooks/post-update.sample
+- test/examples/test_footer_and_sidebar.git/hooks/pre-applypatch.sample
+- test/examples/test_footer_and_sidebar.git/hooks/pre-commit.sample
+- test/examples/test_footer_and_sidebar.git/hooks/pre-rebase.sample
+- test/examples/test_footer_and_sidebar.git/hooks/prepare-commit-msg.sample
+- test/examples/test_footer_and_sidebar.git/hooks/update.sample
+- test/examples/test_footer_and_sidebar.git/index
+- test/examples/test_footer_and_sidebar.git/info/exclude
+- test/examples/test_footer_and_sidebar.git/logs/HEAD
+- test/examples/test_footer_and_sidebar.git/logs/refs/heads/master
+- test/examples/test_footer_and_sidebar.git/objects/07/748c9bf3b10a2dbc88830595850c36b8908a94
+- test/examples/test_footer_and_sidebar.git/objects/0d/8513659a6a4837331c5a407b333acaa7260275
+- test/examples/test_footer_and_sidebar.git/objects/11/1fe2807960c86c8ee1c4d5141d068f52abadb6
+- test/examples/test_footer_and_sidebar.git/objects/4b/9f13d3082668e68a988e7f74f7a94e34931652
+- test/examples/test_footer_and_sidebar.git/objects/8b/137891791fe96927ad78e64b0aad7bded08bdc
+- test/examples/test_footer_and_sidebar.git/objects/aa/69c7a27988b76fe398d1dccc171e25cfc99e3a
+- test/examples/test_footer_and_sidebar.git/objects/bb/4397734f9c55a065348686324f81be81769642
+- test/examples/test_footer_and_sidebar.git/objects/c0/a8e615860c09ef147e590c3335210b5efb7725
+- test/examples/test_footer_and_sidebar.git/objects/cc/628ccd10742baea8241c5924df992b5c019f71
+- test/examples/test_footer_and_sidebar.git/objects/ce/013625030ba8dba906f756967f9e9ca394464a
+- test/examples/test_footer_and_sidebar.git/objects/e6/9de29bb2d1d6434b8b29ae775ad8c2e48c5391
+- test/examples/test_footer_and_sidebar.git/objects/f4/fcee7b7e2c4de453db5c4b70d7a6fc53ba9769
+- test/examples/test_footer_and_sidebar.git/objects/f8/1dd0b9cec9c51bbf0ced5d75d329ab14ab4c69
+- test/examples/test_footer_and_sidebar.git/packed-refs
+- test/examples/test_footer_and_sidebar.git/refs/heads/master
+- test/examples/test_footer_and_sidebar.git/refs/remotes/origin/HEAD
 - test/examples/test_site.git/COMMIT_EDITMSG
 - test/examples/test_site.git/HEAD
 - test/examples/test_site.git/config
@@ -552,7 +581,6 @@ files:
 - test/examples/test_site_no_layout.git/refs/heads/master
 - test/helper.rb
 - test/test_site.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/gollum-site
 licenses: []
 
@@ -566,25 +594,55 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: gollum-site
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Static site generator for Gollum Wikis
 test_files: 
+- test/examples/test_footer_and_sidebar.git/COMMIT_EDITMSG
+- test/examples/test_footer_and_sidebar.git/HEAD
+- test/examples/test_footer_and_sidebar.git/config
+- test/examples/test_footer_and_sidebar.git/description
+- test/examples/test_footer_and_sidebar.git/hooks/applypatch-msg.sample
+- test/examples/test_footer_and_sidebar.git/hooks/commit-msg.sample
+- test/examples/test_footer_and_sidebar.git/hooks/post-commit.sample
+- test/examples/test_footer_and_sidebar.git/hooks/post-receive.sample
+- test/examples/test_footer_and_sidebar.git/hooks/post-update.sample
+- test/examples/test_footer_and_sidebar.git/hooks/pre-applypatch.sample
+- test/examples/test_footer_and_sidebar.git/hooks/pre-commit.sample
+- test/examples/test_footer_and_sidebar.git/hooks/pre-rebase.sample
+- test/examples/test_footer_and_sidebar.git/hooks/prepare-commit-msg.sample
+- test/examples/test_footer_and_sidebar.git/hooks/update.sample
+- test/examples/test_footer_and_sidebar.git/index
+- test/examples/test_footer_and_sidebar.git/info/exclude
+- test/examples/test_footer_and_sidebar.git/logs/HEAD
+- test/examples/test_footer_and_sidebar.git/logs/refs/heads/master
+- test/examples/test_footer_and_sidebar.git/objects/07/748c9bf3b10a2dbc88830595850c36b8908a94
+- test/examples/test_footer_and_sidebar.git/objects/0d/8513659a6a4837331c5a407b333acaa7260275
+- test/examples/test_footer_and_sidebar.git/objects/11/1fe2807960c86c8ee1c4d5141d068f52abadb6
+- test/examples/test_footer_and_sidebar.git/objects/4b/9f13d3082668e68a988e7f74f7a94e34931652
+- test/examples/test_footer_and_sidebar.git/objects/8b/137891791fe96927ad78e64b0aad7bded08bdc
+- test/examples/test_footer_and_sidebar.git/objects/aa/69c7a27988b76fe398d1dccc171e25cfc99e3a
+- test/examples/test_footer_and_sidebar.git/objects/bb/4397734f9c55a065348686324f81be81769642
+- test/examples/test_footer_and_sidebar.git/objects/c0/a8e615860c09ef147e590c3335210b5efb7725
+- test/examples/test_footer_and_sidebar.git/objects/cc/628ccd10742baea8241c5924df992b5c019f71
+- test/examples/test_footer_and_sidebar.git/objects/ce/013625030ba8dba906f756967f9e9ca394464a
+- test/examples/test_footer_and_sidebar.git/objects/e6/9de29bb2d1d6434b8b29ae775ad8c2e48c5391
+- test/examples/test_footer_and_sidebar.git/objects/f4/fcee7b7e2c4de453db5c4b70d7a6fc53ba9769
+- test/examples/test_footer_and_sidebar.git/objects/f8/1dd0b9cec9c51bbf0ced5d75d329ab14ab4c69
+- test/examples/test_footer_and_sidebar.git/packed-refs
+- test/examples/test_footer_and_sidebar.git/refs/heads/master
+- test/examples/test_footer_and_sidebar.git/refs/remotes/origin/HEAD
 - test/examples/test_site.git/COMMIT_EDITMSG
 - test/examples/test_site.git/HEAD
 - test/examples/test_site.git/config