karmi-markout 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Karel Minarik
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,23 @@
+= Markout
+
+Markout makes it easy to export sexy formatted documents such as specifications from your plain text, Markdown-formatted files.
+
+Designed for easy extending, theming and adding output formats.
+
+More information soon.
+
+
+== Usage
+
+On the command line:
+
+    $ sudo gem install karmi-markout --source=http://gems.github.com
+
+
+== Todo
+
+[!] Visualize document history based on Git information
+
+== Copyright
+
+Copyright (c) 2009 Karel Minarik. Released under MIT license.

data/VERSION.yml

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

data/bin/markout

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+
+require File.join( File.join(File.dirname(__FILE__), '..', 'lib', 'markout') )
+
+opts = {}
+
+def die(msg)
+  STDERR.puts("\033[41;1mError!\033[0m\n" + msg)
+  exit 1
+end
+
+OptionParser.new do |o|
+  o.banner = "USAGE: #{$0} [options] [path/to/file]"
+
+  o.on("-f",
+       "--format   [FORMAT]",
+       "Output format (html, pdf)") do |f|
+    opts[:format] = f
+  end
+
+  o.on("-t",
+       "--template [TEMPLATE]",
+       "Output template") do |t|
+    opts[:template] = t
+  end
+
+  o.on("-o",
+       "--output [path/to/directory]",
+       "Output directory (default: same as source file)") do |d|
+    die('Output directory does not exist!') unless File.exist?(d)
+    opts[:output] = d
+  end
+
+  o.on("-h", "--help", "Show help") do |h|
+    puts o
+    exit
+  end
+end.parse!
+
+die("You need to provide path to a Markdown formatted text file!
+     USAGE: #{$0} [options] [path/to/file]
+     Type #{$0} -h for help") if ARGV.empty?
+
+begin
+  time = Time.now
+  o = Markout::Output.new( ARGV.first, opts )
+  puts "\033[0mConverting \033[1m#{ARGV[0]}\033[30;0m to \033[1m#{o.output_path}\033[0m"
+  o.export(true)
+  puts "\033[42mMarkout finished\033[0m in #{sprintf('%.2f', Time.now-time)} seconds\n"
+rescue Exception => e
+  puts "\033[41;1mMarkout Failed!\033[0m\n"
+  raise e
+end

data/lib/markout.rb

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

data/lib/markout/document.rb

@@ -0,0 +1,20 @@
+require 'pathname'
+require 'mime/types'
+
+module Markout
+
+  class Document
+
+    attr_reader :path, :base_path, :content
+
+    def initialize(path)
+      @path      = File.expand_path(path)
+      @base_path = Pathname.new( File.dirname(@path) )
+      raise FileNotFound, "File #{@path} not found" unless File.exist?(@path)
+      # TODO: Raise error for non-text file
+      @content   = File.read(path)
+    end
+
+  end
+
+end

data/lib/markout/formatter.rb

@@ -0,0 +1,25 @@
+require 'pathname'
+
+module Markout
+
+  class Formatter
+
+    def initialize(document, options={})
+      @document = document
+      @options  = options
+      @format   = self.class.to_s.gsub(/^.*::/, '').downcase
+    end
+
+    def export
+      raise NoMethodError, "Return String in `export()` method of your formatter (#{@format})"
+    end
+
+    def filename
+      basename = File.basename(@document.path).split('.')
+      ext = basename.pop
+      "#{basename.join('.')}.#{@format}"
+    end
+
+  end
+
+end

data/lib/markout/formatters/html/html.rb

@@ -0,0 +1,59 @@
+require 'rdiscount'
+require 'erb'
+require 'base64'
+require 'mime/types'
+
+module Markout
+
+  class Html < Formatter
+
+    def export
+      suck_in_images!
+      ERB.new( File.read(template_path.join('content.rhtml')) ).result(binding)
+    end
+
+    private
+
+    def template_name
+      @options[:template] || 'default'
+    end
+
+    def template_path
+      Pathname.new( File.join( File.dirname(__FILE__), 'templates', template_name ) )
+    end
+
+    def content
+      @content ||= RDiscount.new( @document.content ).to_html
+    end
+
+    def screen_style
+      File.read template_path.join('screen.css')
+    end
+
+    def print_style
+      File.read template_path.join('print.css')
+    end
+
+    def title
+      h1  = content.match(/<h1\s*.*>(.+)<\/h1>/)[1] rescue nil
+      h1 || ''
+    end
+
+    # TODO : Make 'alt' attribute optional
+    # TODO : Cleanup?
+    def suck_in_images!
+      content.to_s.gsub!(/<img src="([^"]+)".*alt="([^"]+)".*\s*\/?>/) do |match|
+        begin
+          file = File.read( @document.base_path.join($1) )
+          mime = MIME::Types.of(File.basename( @document.base_path.join($1) ))
+          "<img src=\"data:#{mime};base64,#{Base64.encode64(file)}\" alt=\"#{$2}\" />"
+        rescue
+          # TODO : Better error handling
+          puts "Error: Cannot load image #{$1}"
+        end
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,27 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+
+	<title><%= title %></title>
+
+  <style type="text/css" media="screen">
+  <%= screen_style %>
+  </style>
+
+  <style type="text/css" media="print">
+  <%= print_style %>
+  </style>
+
+</head>
+
+<body>
+
+  <div id="content">
+<%= content %>
+  </div>
+
+</body>
+</html>

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

@@ -0,0 +1,34 @@
+body
+  { color: #000;
+    background: #fff;
+    font-size: 85%; 
+    font-family: Helvetica, sans-serif;
+    margin: 0.5cm; }
+
+a
+  { color: #000;
+    text-decoration: underline; }
+
+a img
+  { border: none; }
+
+h2 {
+  font-size: 1.5em;
+  letter-spacing: -0.05em;
+  padding: 1.15em 0 0 0;
+  margin: 1.25em 0 0.25em 0;
+  border-top: 1mm solid #999;
+}
+
+h3 {
+  font-size: 1.1em;
+  font-weight:bold;
+  margin: 1.8em 0 0.25em 0;
+  letter-spacing: -0.05em;
+}
+
+pre {
+  border: 1pt solid #ccc;
+  padding: 0.5em;
+  white-space: pre-wrap; white-space: -moz-pre-wrap !important;
+}

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

@@ -0,0 +1,102 @@
+/* 
+= COLORS =
+
+Steel blue              #d8dde3
+Black blue              #172533
+Dark grey               #525c66
+Ash grey                #dfe2e5
+Live blue               #1177DD
+Pale green face         #b9cbdd
+
+*/
+
+body {
+  color: #222;
+  background: #fafafa;
+  font-family: Helvetica, sans-serif;
+  font-size: 85%;
+  line-height: 155%;
+  margin: 0;
+  padding: 0 5em;
+}
+
+.cleaner
+  { clear: both; height: 0; line-height: 0; width: 0; border: 0; font-size: 1px; }
+
+#content {
+  color: #172533;
+  font-size: 1.1em;
+  max-width: 55em;
+  padding-bottom: 4em;
+  margin: 7px auto;
+  margin-bottom: 4em;
+  border-top: 4px solid #172533;
+  border-bottom: 4px solid #b9cbdd;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  color: #222;
+}
+h1, h2 {
+  color: #172533;
+  font-weight: normal;
+}
+h1 a, h2 a { color: #172533; }
+
+h1 {
+  font-size: 2.25em;
+  letter-spacing: -1px;
+  margin-bottom: 0.5em;
+}
+
+h2 {
+  font-size: 1.5em;
+  letter-spacing: -1px;
+  padding: 1.15em 0 0 0;
+  margin: 1.25em 0 0.25em 0;
+  border-top: 4px solid #d8dde3;
+}
+
+h3 {
+  color: #172533;
+  font-size: 1.1em;
+  font-weight:bold;
+  margin: 1.8em 0 0.25em 0;
+  letter-spacing:-1px;
+}
+
+h3 a {
+  text-decoration:underline;
+}
+
+p {
+  margin: 0 0 0.8em 0;
+}
+
+a {
+  color: #172533;
+  text-decoration:underline;
+}
+a:hover {
+  color: #1177DD;
+  text-decoration:underline;
+}
+a img {
+  border:none;
+}
+
+code, pre, textarea, tt {
+  font-family: "Monaco", "lucida console", "bitstream vera sans mono", monospace;
+  font-size: 100%;
+}
+pre {
+  color: #172533;
+  background: #f5f9fc;
+  font-size: 100%;
+  line-height: 155%;
+  border: 4px solid #dfe2e5;
+  padding: 0.5em;
+  white-space: pre-wrap; white-space: -moz-pre-wrap !important;
+}
+
+hr { display: none; }

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

@@ -0,0 +1,27 @@
+require 'tempfile'
+require File.join(File.dirname(__FILE__), '..', 'html', 'html.rb')
+
+# Depends on HTMLDOC utility (http://www.easysw.com/htmldoc/)
+module Markout
+
+  class Pdf < Formatter
+
+    def export
+      `cat "#{tempfile.path}" | /opt/local/bin/htmldoc -t pdf \
+          --bodyfont "Helvetica" --headfootfont "Helvetica" \
+          --no-compression --color --embedfonts \
+          --header "" --footer .1. --links --no-title \
+          --toctitle "" --tocheader "..." --tocfooter "..." \
+          -`
+    end
+
+    private
+
+    def tempfile
+      tempfile = Tempfile.new(File.basename(@document.path) + '.html')
+      tempfile << Markout::Html.new(@document).export
+    end
+
+  end
+
+end

data/lib/markout/output.rb

@@ -0,0 +1,49 @@
+module Markout
+
+  class Output
+
+    attr_reader :document, :format, :formatter
+
+    def initialize(path, options = {})
+      @path      = path
+      @document  = Document.new(@path)
+      @options   = options
+      @format    = @options[:format]   || 'html'
+      @formatter = pick_formatter.new( @document, :template => @options[:template] || 'default' )
+      @output    = ''
+    end
+
+    def export(to_file=false)
+      @output = @formatter.export
+      write_file if to_file
+      return @output
+    end
+
+    def output_path
+      if @options[:output]
+        File.join( File.expand_path( @options[:output] ), @formatter.filename )
+      else
+        @document.base_path.join(@formatter.filename)
+      end
+    end
+
+    private
+
+    def write_file
+      File.open(output_path, 'w') { |f| f.write @output }
+    end
+
+    def pick_formatter
+      unless Markout::const_defined?(@format.to_s.capitalize)
+        begin
+          require File.join( File.dirname(__FILE__), 'formatters', @format, @format  ) 
+        rescue Exception => e
+          raise LoadError, "Formatter '#{@format}' not found! (#{e.message})"
+        end
+      end
+      Markout::const_get(@format.to_s.capitalize)
+    end
+
+  end
+
+end