karmi-markout 0.1.0 → 0.1.1

data/lib/markout/formatters/html/templates/default/screen.css

@@ -17,16 +17,35 @@ body {
   font-size: 85%;
   line-height: 155%;
   margin: 0;
-  padding: 0 5em;
+/*  padding: 0 5em;*/
 }
 
 .cleaner
   { clear: both; height: 0; line-height: 0; width: 0; border: 0; font-size: 1px; }
 
+#container {
+  margin: 0 5em;
+}
+
+#history_header {
+  color: #525c66;
+  padding: 0.6em 5em 0em 1em;
+  text-align: right;
+}
+#history_header p {
+  padding: 0; margin: 0;
+}
+
+#history_header a {
+  color: #525c66;
+}
+#history_header .new_revisions {
+  color: #ff3d00;
+}
+
 #content {
   color: #172533;
   font-size: 1.1em;
-  max-width: 55em;
   padding-bottom: 4em;
   margin: 7px auto;
   margin-bottom: 4em;
@@ -46,7 +65,7 @@ h1 a, h2 a { color: #172533; }
 h1 {
   font-size: 2.25em;
   letter-spacing: -1px;
-  margin-bottom: 0.5em;
+  margin: 1em 0 0.5em 0;
 }
 
 h2 {
@@ -100,3 +119,56 @@ pre {
 }
 
 hr { display: none; }
+
+#history {
+  margin-bottom: 2em;
+}
+
+#history h2,
+#history h3,
+#history h4 {
+  border: none;
+}
+
+#history h2 {
+  padding-bottom: 0.2em;
+  padding-left: 0.5em;
+  margin: 0;
+  border-bottom: 2px solid #dfe2e5;
+}
+
+#history code {
+  font-size: 80%;
+}
+
+#history .revision {
+  border-bottom: 1px solid #dfe2e5;
+  padding: 0.5em 0 0.5em 0;
+}
+#history .revision:hover,
+#history .revision.expanded {
+  background-color: #dfe2e5;
+}
+
+#history .revision h4 {
+  margin: 0;
+  padding: 0 0 0 0.7em;
+}
+#history .revision.expanded h4 {
+}
+
+#history .revision .detail {
+  margin: 0 4px 0 4px;
+  padding: 0;
+}
+
+#history .revision pre {
+  border: none;
+  margin: 0;
+  padding: 0;
+}
+
+#history .revision code {
+  margin: 0;
+  padding: 0;
+}

data/lib/markout/formatters/pdf/pdf.rb

@@ -1,3 +1,5 @@
+$KCODE = 'UTF-8'
+
 require 'tempfile'
 require File.join(File.dirname(__FILE__), '..', 'html', 'html.rb')
 
@@ -19,7 +21,8 @@ module Markout
 
     def tempfile
       tempfile = Tempfile.new(File.basename(@document.path) + '.html')
-      tempfile << Markout::Html.new(@document).export
+      content  = Markout::Html.new(@document).export
+      tempfile << content.gsub(/[^\x00-\x7F]/) { |ch| "&##{ch.unpack("U")[0]};" } # From the Textmate Markdown bundle
     end
 
   end

data/lib/markout/history.rb

@@ -0,0 +1,31 @@
+require 'grit'
+
+module Markout
+
+  class History
+    attr_reader :repo, :revisions
+    def initialize(document, options={})
+      @document = document
+      @options  = options
+      load_repository
+      load_revisions
+      # puts @revisions.first.inspect
+    end
+
+    private
+    def git_dir
+      @options[:git_dir] || @document.base_path.join('.git')
+    end
+    def load_repository
+      # TODO : raise when no Git repo available
+      @repo = Grit::Repo.new(git_dir, :is_bare => !git_dir.nil?)
+    end
+    def load_revisions
+      @repo ||= load_repository
+      commits = @repo.log 'master', @document.filename
+      @revisions = commits.collect { |c| Markout::Revision.new(c) }
+      # puts @revisions
+    end
+  end
+
+end

data/lib/markout/output.rb

@@ -6,8 +6,8 @@ module Markout
 
     def initialize(path, options = {})
       @path      = path
-      @document  = Document.new(@path)
       @options   = options
+      @document  = Document.new(@path, :history => @options[:history])
       @format    = @options[:format]   || 'html'
       @formatter = pick_formatter.new( @document, :template => @options[:template] || 'default' )
       @output    = ''

data/lib/markout/revision.rb

@@ -0,0 +1,20 @@
+module Markout
+
+  class Revision
+    attr_reader :sha, :date, :author, :subject, :message, :diff
+    def initialize(commit)
+      @sha    = commit.sha
+      @date   = commit.date
+      @author = commit.author.to_s
+      @subject, @message = parse_commit_message(commit)
+      @diff   = commit.show.first.diff
+    end
+
+    private
+    def parse_commit_message(commit)
+      lines = commit.message.split("/n")
+      [ lines.first, lines[1..commit.message.size].join("\n") ]
+    end
+  end
+
+end

data/lib/markout.rb

@@ -1,9 +1,10 @@
 $LOAD_PATH << File.join( File.dirname(__FILE__), 'markout' )
 
-%w{output document formatter}.each { |lib| require lib }
+%w{output document formatter history revision}.each { |lib| require lib }
 
 module Markout
 
-  class FileNotFound < Exception; end
+  class FileNotFound     < StandardError; end
+  class FileNotSupported < StandardError; end
 
 end

data/test/fixtures/empty_repository__dot__git/COMMIT_EDITMSG

@@ -0,0 +1,12 @@
+Initial commit to empty repository
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+# On branch master
+#
+# Initial commit
+#
+# Changes to be committed:
+#   (use "git rm --cached <file>..." to unstage)
+#
+#	new file: .gitignore
+#

data/test/fixtures/empty_repository__dot__git/HEAD

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

data/test/fixtures/empty_repository__dot__git/config

@@ -0,0 +1,6 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+	ignorecase = true

data/test/fixtures/empty_repository__dot__git/description

@@ -0,0 +1 @@
+Unnamed repository; edit this file to name it for gitweb.

data/test/fixtures/empty_repository__dot__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/fixtures/empty_repository__dot__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/fixtures/empty_repository__dot__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/fixtures/empty_repository__dot__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 an 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/fixtures/empty_repository__dot__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/fixtures/empty_repository__dot__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/fixtures/empty_repository__dot__git/hooks/pre-commit.sample

@@ -0,0 +1,18 @@
+#!/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 2>/dev/null
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+fi
+
+exec git diff-index --check --cached $against --

data/test/fixtures/empty_repository__dot__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"`
+	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/fixtures/empty_repository__dot__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,)
+    perl -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1" ;;
+
+# ,|template,)
+#   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/fixtures/empty_repository__dot__git/hooks/update.sample

@@ -0,0 +1,107 @@
+#!/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.allowdeletebranch
+#   This boolean sets whether deleting branches will be allowed in the
+#   repository.  By default they won't be.
+#
+
+# --- 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)
+allowdeletetag=$(git config --bool hooks.allowdeletetag)
+
+# check for no description
+projectdesc=$(sed -e '1q' "$GIT_DIR/description")
+if [ -z "$projectdesc" -o "$projectdesc" = "Unnamed repository; edit this file to name it for gitweb." ]; then
+	echo "*** Project description file hasn't been set" >&2
+	exit 1
+fi
+
+# --- Check types
+# if $newrev is 0000...0000, it's a commit to delete a ref.
+if [ "$newrev" = "0000000000000000000000000000000000000000" ]; 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
+		;;
+	refs/heads/*,commit)
+		# branch
+		;;
+	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/fixtures/empty_repository__dot__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/fixtures/empty_repository__dot__git/logs/HEAD

@@ -0,0 +1 @@
+0000000000000000000000000000000000000000 a0b6af2541dce8f646276ec7340695c34c7578aa Karel Minarik <karmi@karmi.cz> 1238762119 +0200	commit (initial): Initial commit to empty repository

data/test/fixtures/empty_repository__dot__git/logs/refs/heads/master

@@ -0,0 +1 @@
+0000000000000000000000000000000000000000 a0b6af2541dce8f646276ec7340695c34c7578aa Karel Minarik <karmi@karmi.cz> 1238762119 +0200	commit (initial): Initial commit to empty repository

data/test/fixtures/empty_repository__dot__git/refs/heads/master

@@ -0,0 +1 @@
+a0b6af2541dce8f646276ec7340695c34c7578aa