markover 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daa4c691576601fd45a61afe55986a5c08835013
+  data.tar.gz: dc00fd881aeb4c08e8bb4b935e2f444171cc32e2
+SHA512:
+  metadata.gz: 981805f3b6b6096b7d31783561ac32e67bce34c27fcbb1dece16c9825403fbd9e147993ba6388d8d1bf3a2276842a294696d5371618c058334ef029b3bc9f53d
+  data.tar.gz: 6f4ea2ad54aae0dbe214589c98ddacfbc5707d2b7ac9db50c97afa829eb004aff7fbc9e49b90a06d066810ee5e9e8203d8418704a72d3d9de1429d63c06afaff

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Benjamin Kammerl aka phortx
+
+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.md

@@ -0,0 +1,102 @@
+# markover
+
+[![Build Status](https://travis-ci.org/phortx/markover.png?branch=master)](https://travis-ci.org/phortx/markover)
+
+## Description
+markover is a utility for converting markup (markdown, textile, ...) to PDF files. Useful for reports, documentations and such things.
+
+It's a fork of the dead [gimli gem](https://github.com/phortx/markover.git).
+
+It supports ...
+- ... multiple markup styles
+- ... syntax highlighting
+- ... covers
+- ... CSS
+- ... images
+- ... table of contents
+- and more.
+
+It works by converting the markup to pdf using [wkhtmltopdf](https://github.com/antialize/wkhtmltopdf)
+The markup is converted to html using [github/markup](https://github.com/github/markup)
+
+
+## Markup
+Markup files may be written in any format supported by GitHub-Markup (except roff).
+
+
+## Images
+Images can be included by absolute url on your hard drive or a absolute url on the Internet. You can also refer to an image relative from the markup file. Example in markdown.
+
+```markdown
+![test.jpg](/tmp/test.jpg)
+![wiki.png](http://upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png)
+![test.jpg](../images/test.jpg)
+```
+
+## Installation
+The best way to install markoverf is with RubyGems:
+
+```bash
+$ gem install markover
+```
+
+You can also install from source:
+
+```bash
+$ git clone https://github.com/phortx/markover.git
+$ cd markover
+$ bundle
+$ rake install
+```
+
+## Usage
+The standard way to run markover is to go to a folder with markup files and running `markover`
+
+
+### Own CSS
+To apply some style to the pdf or override the standard style add a css file in the directory named `markover.css` or use the `-s` flag to point out another css file.
+
+
+### Output file
+Standard behavior is for md2pd to output the files in the current directory. To override this use the `-o` flag to point out another output directory. markover tries to create it if it doesn't exist.
+
+
+### Jekyll
+markover also plays nice with Jekyll style markup files. You can pass markover the `-y` flag to have it remove Jekyll's YAML front matter from the top of your markup files. Allowing you to use markover & Jekyll together on your Blog/Resume/Catalogue to create nicely formatted versions for online and offline viewing.
+
+
+### wkhtmlpdf
+To pass parameters directly to wkhtmltopdf, use the `-w` flag. eg.
+
+```bash
+$ markover -f test.md -w '--toc --footer-right "[page]/[toPage]"'
+```
+
+This gives a pdf with a table of contents and page numbers in the footer.
+
+See the [man page](http://wkhtmltopdf.org/usage/wkhtmltopdf.txt) for wkhtmltopdf for all possible parameters.
+
+
+### Everything else
+Run `markover -h` for a full list of options available.
+
+
+
+## Syntax highlighting
+In page files you can get automatic syntax highlighting for a wide range of languages by using the following syntax:
+
+<pre lang="no-highlight"><code>
+```ruby
+  def foo
+    puts 'bar'
+  end
+```
+</pre>
+
+The block must start with three backticks (as the first characters on the line). After that comes the name of the language that is contained by the block. The language must be one of the short name lexer strings supported by coderay. See the list of lexers for valid options.
+
+If the block contents are indented two spaces or one tab, then that whitespace will be ignored (this makes the blocks easier to read in plaintext).
+
+The block must end with three backticks as the first characters on a line.
+
+The syntax highlightning is powered by [coderay](https://github.com/rubychan/coderay) and is using a [github theme](https://github.com/pie4dan/CodeRay-GitHub-Theme).

data/bin/markover

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + '/../lib/')
+
+require 'markover'
+require 'markover/optionparser'
+require 'markover/path'
+require 'markover/markupfile'
+
+files = []
+options = Markover::Parser.parse!(ARGV)
+
+ARGV.each do |target|
+  files += Markover::Path.list_valid(target, options[:recursive]).map { |file| Markover::MarkupFile.new(file) }
+end
+
+config = Markover.configure do |config|
+  config.files = files
+  config.recursive = options[:recursive]
+  config.merge = options[:merge]
+  config.debug = options[:debug]
+  config.wkhtmltopdf_parameters = options[:wkhtmltopdfparameters]
+  config.remove_front_matter = options[:removefrontmatter]
+  config.output_filename = options[:filename]
+  config.output_dir = options[:outputdir]
+  config.stylesheet = options[:stylesheet]
+  config.table_of_contents = options[:table_of_contents]
+end
+
+Markover.process! config
+

data/config/style.css

@@ -0,0 +1,174 @@
+body
+{
+  font-family: "Trebuchet MS", "Lucida Sans Unicode", "Lucida Sans", Arial, sans-serif;
+  font-size: 12px;
+}
+
+.page-break
+{
+  page-break-before: always;
+}
+
+.CodeRay {
+  background-color: #FFF;
+  border: 1px solid #CCC;
+  font-family: Monaco, "Courier New", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", monospace;
+  color: #000;
+  padding: 1em 0px 1em 1em;
+}
+
+.CodeRay pre {
+  margin: 0px;
+}
+
+div.CodeRay { }
+span.CodeRay { white-space: pre; border: 0px; padding: 2px }
+
+table.CodeRay { border-collapse: collapse; width: 100%; padding: 2px }
+table.CodeRay td {
+  padding: 1em 0.5em;
+  vertical-align: top;
+}
+
+.CodeRay .line-numbers, .CodeRay .no {
+  background-color: #ECECEC;
+  color: #AAA;
+  text-align: right;
+}
+
+.CodeRay .line-numbers a {
+  color: #AAA;
+}
+
+.CodeRay .line-numbers tt { font-weight: bold }
+.CodeRay .line-numbers .highlighted { color: red }
+.CodeRay .line { display: block; float: left; width: 100%; }
+.CodeRay span.line-numbers { padding: 0px 4px }
+.CodeRay .code { width: 100% }
+
+ol.CodeRay { font-size: 10pt }
+ol.CodeRay li { white-space: pre }
+
+.CodeRay .code pre { overflow: auto }
+.CodeRay .debug { color:white ! important; background:blue ! important; }
+
+.CodeRay .annotation { color:#007 }
+.CodeRay .attribute-name { color:#f08 }
+.CodeRay .attribute-value { color:#700 }
+.CodeRay .binary { color:#509; font-weight:bold }
+.CodeRay .comment  { color:#998; font-style: italic;}
+.CodeRay .char { color:#04D }
+.CodeRay .char .content { color:#04D }
+.CodeRay .char .delimiter { color:#039 }
+.CodeRay .class { color:#458; font-weight:bold }
+.CodeRay .complex { color:#A08; font-weight:bold }
+.CodeRay .constant { color:teal; }
+.CodeRay .color { color:#0A0 }
+.CodeRay .class-variable { color:#369 }
+.CodeRay .decorator { color:#B0B; }
+.CodeRay .definition { color:#099; font-weight:bold }
+.CodeRay .directive { color:#088; font-weight:bold }
+.CodeRay .delimiter { color:black }
+.CodeRay .doc { color:#970 }
+.CodeRay .doctype { color:#34b }
+.CodeRay .doc-string { color:#D42; font-weight:bold }
+.CodeRay .escape  { color:#666; font-weight:bold }
+.CodeRay .entity { color:#800; font-weight:bold }
+.CodeRay .error { color:#F00; background-color:#FAA }
+.CodeRay .exception { color:#C00; font-weight:bold }
+.CodeRay .filename { color:#099; }
+.CodeRay .function { color:#900; font-weight:bold }
+.CodeRay .global-variable { color:teal; font-weight:bold }
+.CodeRay .hex { color:#058; font-weight:bold }
+.CodeRay .integer  { color:#099; }
+.CodeRay .include { color:#B44; font-weight:bold }
+.CodeRay .inline { color: black }
+.CodeRay .inline .inline { background: #ccc }
+.CodeRay .inline .inline .inline { background: #bbb }
+.CodeRay .inline .inline-delimiter { color: #D14; }
+.CodeRay .inline-delimiter { color: #D14; }
+.CodeRay .important { color:#f00; }
+.CodeRay .interpreted { color:#B2B; font-weight:bold }
+.CodeRay .instance-variable { color:teal }
+.CodeRay .label { color:#970; font-weight:bold }
+.CodeRay .local-variable { color:#963 }
+.CodeRay .octal { color:#40E; font-weight:bold }
+.CodeRay .operator { }
+.CodeRay .predefined-constant {  font-weight:bold }
+.CodeRay .predefined { color:#369; font-weight:bold }
+.CodeRay .preprocessor { color:#579; }
+.CodeRay .pseudo-class { color:#00C; font-weight:bold }
+.CodeRay .predefined-type { color:#074; font-weight:bold }
+.CodeRay .reserved, .keyword  { color:#000; font-weight:bold }
+
+.CodeRay .key { color: #808; }
+.CodeRay .key .delimiter { color: #606; }
+.CodeRay .key .char { color: #80f; }
+.CodeRay .value { color: #088; }
+
+.CodeRay .regexp { background-color:#fff0ff }
+.CodeRay .regexp .content { color:#808 }
+.CodeRay .regexp .delimiter { color:#404 }
+.CodeRay .regexp .modifier { color:#C2C }
+.CodeRay .regexp .function  { color:#404; font-weight: bold }
+
+.CodeRay .string { color: #D20; }
+.CodeRay .string .string { }
+.CodeRay .string .string .string { background-color:#ffd0d0 }
+.CodeRay .string .content { color: #D14; }
+.CodeRay .string .char { color: #D14; }
+.CodeRay .string .delimiter { color: #D14; }
+
+.CodeRay .shell { color:#D14 }
+.CodeRay .shell .content { }
+.CodeRay .shell .delimiter { color:#D14 }
+
+.CodeRay .symbol { color:#990073 }
+.CodeRay .symbol .content { color:#A60 }
+.CodeRay .symbol .delimiter { color:#630 }
+
+.CodeRay .tag { color:#070 }
+.CodeRay .tag-special { color:#D70; font-weight:bold }
+.CodeRay .type { color:#339; font-weight:bold }
+.CodeRay .variable  { color:#036 }
+
+.CodeRay .insert { background: #afa; }
+.CodeRay .delete { background: #faa; }
+.CodeRay .change { color: #aaf; background: #007; }
+.CodeRay .head { color: #f8f; background: #505 }
+
+.CodeRay .insert .insert { color: #080; font-weight:bold }
+.CodeRay .delete .delete { color: #800; font-weight:bold }
+.CodeRay .change .change { color: #66f; }
+.CodeRay .head .head { color: #f4f; }
+
+.code pre {
+  white-space: pre;
+  white-space: pre-wrap;
+  word-break: break-all;
+  word-wrap: break-word;
+}
+
+table {
+  width: 100%;
+  overflow: auto;
+  display: block;
+}
+
+table th {
+  font-weight: bold;
+}
+
+table th, table td {
+  border: 1px solid #ddd;
+  padding: 6px 13px;
+}
+
+table tr {
+  border-top: 1px solid #ccc;
+  background-color: #fff;
+}
+
+table tr:nth-child(2n) {
+  background-color: #f8f8f8;
+}

data/ext/github_markup.rb

@@ -0,0 +1,11 @@
+# Monkey patch github markup to use redcarpet with support for autolinks and tables
+module GitHub::Markup
+  alias_method :old_render, :render
+  def render(filename, content = nil)
+    if Regexp.compile("\\.(md|mkdn?|mdwn|mdown|markdown|litcoffee)$") =~ filename
+      Redcarpet::Markdown.new(Redcarpet::Render::HTML, :autolink => true, :tables => true).render(content)
+    else
+      old_render(filename, content)
+    end
+  end
+end

data/lib/markover.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'markover/version'
+require 'markover/config'
+require 'markover/markupfile'
+require 'markover/converter'
+require 'markover/path'
+require 'markover/wkhtmltopdf'
+
+require File.expand_path(File.dirname(__FILE__)) + '/../ext/github_markup.rb'
+
+module Markover
+
+  # Create a config object
+  # @example Example usage
+  #   config = Markover.configure |config| do
+  #     config.file = './test.md'
+  #     config.output_dir = '/tmp'
+  #     config.table_of_contents = true
+  #   end
+  def self.configure
+    config = Config.new
+    yield config
+    config
+  end
+
+  # Starts the processing of selected files
+  def self.process!(config)
+    Converter.new(config.files, config).convert!
+  end
+end

data/lib/markover/config.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Markover
+
+  # Class that keeps the config parameters
+  class Config
+    attr_accessor :recursive,
+                  :merge,
+                  :debug,
+                  :wkhtmltopdf_parameters,
+                  :remove_front_matter,
+                  :output_filename,
+                  :output_dir,
+                  :stylesheet,
+                  :files,
+                  :table_of_contents
+
+    # Sets default values
+    def initialize
+      @recursive = false
+      @merge = false
+      @debug = false
+      @page_numbers = false
+      @table_of_contents = false
+      @remove_front_matter = false
+    end
+  end
+end

data/lib/markover/converter.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+
+require 'fileutils'
+
+require 'markover/markup'
+
+module Markover
+
+  # The class that converts the files
+  class Converter
+
+    # Initialize the converter with a File
+    # @param [Array] files The list of Markover::MarkupFile to convert (passing a single file will still work)
+    # @param [Markover::Config] config
+    def initialize(files, config)
+      @files, @config = files, config
+
+      @stylesheets = []
+      @wkhtmltopdf = Wkhtmltopdf.new @config.wkhtmltopdf_parameters
+    end
+
+    # Convert the file and save it as a PDF file
+    def convert!
+      merged_contents = []
+      @files.each do |file|
+        markup = Markup::Renderer.new file, @config.remove_front_matter
+        html = convert_image_urls markup.render, file.filename
+        if @config.merge
+          html = "<div class=\"page-break\"></div>#{html}" unless merged_contents.empty?
+          merged_contents << html
+        else
+          output_pdf(html, file)
+        end
+        puts html if @config.debug
+      end
+
+      unless merged_contents.empty?
+        html = merged_contents.join
+        output_pdf(html, nil)
+      end
+    end
+
+    # Rewrite relative image urls to absolute
+    # @param [String] html some html to parse
+    # @return [String] the html with all image urls replaced to absolute
+    def convert_image_urls(html, filename)
+      dir_string = ::File.dirname(::File.expand_path(filename))
+      html.scan(/<img[^>]+src="([^"]+)"/).each do |url|
+        html.gsub!(url[0], ::File.expand_path(url[0], dir_string)) unless url[0] =~ /^https?/
+      end
+
+      html
+    end
+
+    # Create the pdf
+    # @param [String] html the html input
+    # @param [String] filename the name of the output file
+    def output_pdf(html, filename)
+      load_stylesheets
+      append_stylesheets html
+      add_head html
+      @wkhtmltopdf.output_pdf html, output_file(filename)
+    end
+
+    def add_head(html)
+        html.insert(0, "\n<head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n</head>\n")
+    end
+
+    # Load the stylesheets to pdfkit loads the default and the user selected if any
+    def load_stylesheets
+      # Load standard stylesheet
+      style = ::File.expand_path("../../../config/style.css", __FILE__)
+      @stylesheets << style
+      @stylesheets << stylesheet if ::File.exists?(stylesheet)
+    end
+
+    def append_stylesheets(html)
+      @stylesheets.each do |stylesheet|
+        html.insert(0, style_tag_for(stylesheet))
+      end
+    end
+
+    def style_tag_for(stylesheet)
+      "<style>#{File.read(stylesheet)}</style>"
+    end
+
+    # Returns the selected stylesheet. Defaults to ./markover.css
+    # @return [String]
+    def stylesheet
+      @config.stylesheet.nil? ? 'markover.css' : @config.stylesheet
+    end
+
+    # Returns the directory where to save the output. Defaults to ./
+    # @return [String]
+    def output_dir
+      output_dir = @config.output_dir.nil? ? Dir.getwd : @config.output_dir
+      FileUtils.mkdir_p(output_dir) unless ::File.directory?(output_dir)
+      output_dir
+    end
+
+    # Generate the name of the output file
+    # @return [String]
+    # @param [Markover::MarkupFile] file optionally, specify a file, otherwise use output filename
+    def output_file(file = nil)
+      if file
+        output_filename = file.name
+        if !@config.output_filename.nil? && @files.length == 1
+          output_filename = @config.output_filename
+        end
+      else
+        output_filename = Time.now.to_s.split(' ').join('_')
+        output_filename = @files.last.name if @files.length == 1 || @config.merge
+        output_filename = @config.output_filename unless @config.output_filename.nil?
+      end
+
+      ::File.join(output_dir, "#{output_filename}.pdf")
+    end
+  end
+end
+