karmi-markout 0.1.3 → 0.1.5

data/README.rdoc

@@ -4,19 +4,34 @@ Markout makes it easy to export sexy formatted documents such as specifications
 
 Designed for easy extending, theming and adding output formats.
 
-More information soon.
+Work in progress.
 
 
 == Usage
 
-On the command line:
+Installation:
 
     $ sudo gem install karmi-markout --source=http://gems.github.com
 
+Converting Markdown file with history to an HTML file in the same location as source:
+
+    $ markout -h /path/to/your/file.txt
+    
+More information:
+
+    $ markout --help
+
 
 == Todo
 
-[!] Visualize document history based on Git information
+* Cleanup Git-related code
+* Add test coverage
+* Embedded Sinatra app for more lush display of everything on the server
+* More flexibility in Git features
+* Cleaner PDF dependencies
+* Setting-up remote Git repo and post-receive hooks with simple Rake tasks
+* Notifications on new revision pushes
+
 
 == Copyright
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 1
-:patch: 3
+:patch: 5
 :major: 0

data/lib/markout/formatters/html/templates/common/code.css

@@ -7,5 +7,5 @@
 .diff del,
 .diff .del {
   color: red;
-  text-decoration: none;
+  text-decoration: line-through;
 }

data/lib/markout/formatters/html/templates/default/content.rhtml

@@ -41,6 +41,7 @@
     <div id="revision_<%= revision.sha %>" class="revision">
       <h4><%= revision.date.strftime('%d/%m/%Y %H:%M') %> : <%= revision.subject %> (<%= revision.author %>)</h4>
       <div class="detail">
+      <% if revision.message %><%= revision.message(:format => :html) %><% end %>
       <pre>
 <code class="diff">
 <%= revision.diff(:format => 'inline') %>

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

@@ -80,8 +80,10 @@ h3 {
   color: #172533;
   font-size: 1.1em;
   font-weight:bold;
-  margin: 1.8em 0 0.25em 0;
   letter-spacing:-1px;
+  padding: 1em 0 0 0;
+  margin: 1.8em 0 0.25em 0;
+  border-top: 1px solid #d8dde3;
 }
 
 h3 a {
@@ -120,6 +122,9 @@ pre {
 
 hr { display: none; }
 
+ul { list-style-type: square; margin: 0.5em 0 1em 0; padding-left: 1.5em; }
+ul li { margin-left: 0em; }
+
 #history {
   margin-bottom: 2em;
 }
@@ -158,10 +163,14 @@ hr { display: none; }
 }
 
 #history .revision .detail {
-  margin: 0 4px 0 4px;
+  margin: 0 0.8em 0 0.8em;
   padding: 0;
 }
 
+#history .revision .detail p {
+  font-size: 95%;
+}
+
 #history .revision pre {
   background: none;
   line-height: 120%;
@@ -170,6 +179,9 @@ hr { display: none; }
   padding: 0 1em 0 1em;
 }
 
+#history .revision pre {
+  margin: 0 0.1em 0 0.1em;
+}
 #history .revision code {
   margin: 0;
   padding: 0;
@@ -184,5 +196,5 @@ hr { display: none; }
 #history .diff del,
 #history .diff .del {
   color: red;
-  text-decoration: none;
+  text-decoration: line-through;
 }

data/lib/markout/revision.rb

@@ -1,8 +1,10 @@
+require 'rdiscount'
+
 module Markout
 
   class Revision
 
-    attr_reader :sha, :date, :author, :subject, :message
+    attr_reader :sha, :date, :author, :subject
 
     def initialize(repo, commit)
       @repo   = repo
@@ -22,10 +24,19 @@ module Markout
       end
     end
 
+    def message(options={})
+      case options[:format]
+      when :html
+        return RDiscount.new(@message).to_html
+      else
+        return @message
+      end
+    end
+
     private
 
     def parse_commit_message(commit)
-      lines = commit.message.split("/n")
+      lines = commit.message.split("\n")
       [ lines.first, lines[1..commit.message.size].join("\n") ]
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: karmi-markout
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors: 
 - Karel Minarik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-06 00:00:00 -07:00
+date: 2009-04-13 00:00:00 -07:00
 default_executable: markout
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,91 +49,32 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
 - LICENSE
+- README.rdoc
 files: 
 - README.rdoc
 - VERSION.yml
-- bin/markout
-- lib/markout
+- lib/markout.rb
 - lib/markout/document.rb
 - lib/markout/formatter.rb
-- lib/markout/formatters
-- lib/markout/formatters/html
 - lib/markout/formatters/html/html.rb
-- lib/markout/formatters/html/templates
-- lib/markout/formatters/html/templates/common
 - lib/markout/formatters/html/templates/common/application.js
 - lib/markout/formatters/html/templates/common/code.css
 - lib/markout/formatters/html/templates/common/code_highlighter.js
 - lib/markout/formatters/html/templates/common/jquery-1.3.2.min.js
 - lib/markout/formatters/html/templates/common/syntax_diff.js
-- lib/markout/formatters/html/templates/default
 - lib/markout/formatters/html/templates/default/content.rhtml
 - lib/markout/formatters/html/templates/default/print.css
 - lib/markout/formatters/html/templates/default/screen.css
-- lib/markout/formatters/pdf
 - lib/markout/formatters/pdf/pdf.rb
 - lib/markout/history.rb
 - lib/markout/output.rb
 - lib/markout/revision.rb
-- lib/markout.rb
-- test/fixtures
-- test/fixtures/empty.txt
-- test/fixtures/empty_repository__dot__git
-- test/fixtures/empty_repository__dot__git/COMMIT_EDITMSG
-- test/fixtures/empty_repository__dot__git/config
-- test/fixtures/empty_repository__dot__git/description
-- test/fixtures/empty_repository__dot__git/HEAD
-- test/fixtures/empty_repository__dot__git/hooks
-- test/fixtures/empty_repository__dot__git/hooks/applypatch-msg.sample
-- test/fixtures/empty_repository__dot__git/hooks/commit-msg.sample
-- test/fixtures/empty_repository__dot__git/hooks/post-commit.sample
-- test/fixtures/empty_repository__dot__git/hooks/post-receive.sample
-- test/fixtures/empty_repository__dot__git/hooks/post-update.sample
-- test/fixtures/empty_repository__dot__git/hooks/pre-applypatch.sample
-- test/fixtures/empty_repository__dot__git/hooks/pre-commit.sample
-- test/fixtures/empty_repository__dot__git/hooks/pre-rebase.sample
-- test/fixtures/empty_repository__dot__git/hooks/prepare-commit-msg.sample
-- test/fixtures/empty_repository__dot__git/hooks/update.sample
-- test/fixtures/empty_repository__dot__git/index
-- test/fixtures/empty_repository__dot__git/info
-- test/fixtures/empty_repository__dot__git/info/exclude
-- test/fixtures/empty_repository__dot__git/logs
-- test/fixtures/empty_repository__dot__git/logs/HEAD
-- test/fixtures/empty_repository__dot__git/logs/refs
-- test/fixtures/empty_repository__dot__git/logs/refs/heads
-- test/fixtures/empty_repository__dot__git/logs/refs/heads/master
-- test/fixtures/empty_repository__dot__git/objects
-- test/fixtures/empty_repository__dot__git/objects/25
-- test/fixtures/empty_repository__dot__git/objects/25/877ea00eb8d2de7a31cf7c4c4c16f0390d48fd
-- test/fixtures/empty_repository__dot__git/objects/a0
-- test/fixtures/empty_repository__dot__git/objects/a0/b6af2541dce8f646276ec7340695c34c7578aa
-- test/fixtures/empty_repository__dot__git/objects/ec
-- test/fixtures/empty_repository__dot__git/objects/ec/9e2a7b50ee2dfd5e6f8b5224fb3d7a98a79558
-- test/fixtures/empty_repository__dot__git/objects/info
-- test/fixtures/empty_repository__dot__git/objects/pack
-- test/fixtures/empty_repository__dot__git/refs
-- test/fixtures/empty_repository__dot__git/refs/heads
-- test/fixtures/empty_repository__dot__git/refs/heads/master
-- test/fixtures/empty_repository__dot__git/refs/tags
-- test/fixtures/markdown.html
-- test/fixtures/markdown.txt
-- test/fixtures/mt_textformat_menu.png
-- test/markout_document_test.rb
-- test/markout_formatter_test.rb
-- test/markout_history_test.rb
-- test/markout_html_test.rb
-- test/markout_output_test.rb
-- test/markout_revision_test.rb
-- test/markout_test.rb
-- test/test_helper.rb
 - LICENSE
 has_rdoc: true
 homepage: http://github.com/karmi/markout
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -156,5 +97,12 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Sexy Markdown output
-test_files: []
-
+test_files: 
+- test/markout_document_test.rb
+- test/markout_formatter_test.rb
+- test/markout_history_test.rb
+- test/markout_html_test.rb
+- test/markout_output_test.rb
+- test/markout_revision_test.rb
+- test/markout_test.rb
+- test/test_helper.rb

data/test/fixtures/empty_repository__dot__git/COMMIT_EDITMSG

@@ -1,12 +0,0 @@
-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

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

data/test/fixtures/empty_repository__dot__git/config

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

data/test/fixtures/empty_repository__dot__git/description

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

data/test/fixtures/empty_repository__dot__git/hooks/applypatch-msg.sample

@@ -1,15 +0,0 @@
-#!/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

@@ -1,24 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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

@@ -1,15 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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

@@ -1,14 +0,0 @@
-#!/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

@@ -1,18 +0,0 @@
-#!/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

@@ -1,169 +0,0 @@
-#!/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".