riven 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1d15b3e000390101dcda3dca562e42a14713cfa
-  data.tar.gz: 2fcd70e0c9116075b2b65ea8046ceef03b08eeb5
+  metadata.gz: 249713d59e43598175a09dbf188fdc4afaf4023c
+  data.tar.gz: 9843a8a2a382623f06c416d6e074d9c8cf9efea4
 SHA512:
-  metadata.gz: 45b1316495eff7da3960c231223e82ec12cec36c20638560a4a5945dffb57052ed537972adf74cf1bca10bec774d55c1fe9df51f78d5a3d7bf0026ae45a929c7
-  data.tar.gz: 163bcb01c7d628845ebcf775784bd5c700be3fff255879cb59720b31239b3aa16406816b9adfd09684cc511385ec0e7c4a347ed371549325955946e820626fac
+  metadata.gz: ebe32bc24a34766e3eda31553d1205adc2c2457976d1eb9f32d1113fde593fe842ecc1022d3fa8b0d4b328aa910a81dfc1f11662b78cdc3c97ebea6d21e59019
+  data.tar.gz: 52592999799d5e60e0ea8ead3c192187a0d3bc1f5dd3ddb8bf77ca3d22da600860509bbb35587cc2c53b8d69304f64ae6f8e70b88414583379090ea872593b57

data/Gemfile.lock

@@ -3,12 +3,16 @@ PATH
   specs:
     riven (0.0.1)
       coderay (~> 1.1.0)
+      github-markup (~> 1.2.0)
       redcarpet (~> 3.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.0)
+    github-markup (1.2.1)
+      posix-spawn (~> 0.3.8)
+    posix-spawn (0.3.9)
     rake (10.4.2)
     redcarpet (3.2.2)
 

data/README.md

@@ -6,21 +6,23 @@ Converts GitHub Flavored Markdown files to PDFs! Feature highlights:
 - Syntax Highlighting with GitHub like theme
 - Smart page breaks
 - Smart directory based file merging
-- Page numbers (not finised yet, sorry)
+- Page numbers (see *Prerequisites* section)
 - ~~Custom CSS~~ (not finised yet, sorry)
-- ~~Covers~~ (not finised yet, sorry)
-- ~~Table of Contents~~ (not finised yet, sorry)
+- Covers (see *Prerequisites* section)
+- Table of Contents (see *Prerequisites* section)
 
 The gem is still under development, but it already works. In the current version the output PDF file name will always be `test.pdf`. This will change soon.
 
 
 ## Prerequisites
 
-You need `wkhtmltopdf` in order to generate PDFs, since that's the PDF generator backend for riven:
+You need `wkhtmltopdf` in order to generate PDFs, since that's the PDF generator backend for riven. You should use the QT patched version of `wkhtmltopdf`. You may also use the version without patched qt, but that will disable the following features of riven: Page numbers, table of contents, covers.
 
-- If you got a Linux Distribution or OSX and your package mangement offers `wkhtmltopdf` in a newer version than `0.9.9.3`, then install it via your package manager.
+- If you got Arch Linux, you can just install the packages `wkhtmltopdf-static`and `icu48` from the AUR.
 
-- If you there's no newer version, you should use the `wkhtmltopdf-binary` gem: `gem install wkhtmltopdf-binary`
+- If you got a Linux Distribution or OSX you may compile `wkhtmltopdf` from the sources. See http://stackoverflow.com/questions/10981960/wkhtmltopdf-patched-qt.
+
+- Otherwise, you should download `wkhtmltopdf` from the [official website](http://wkhtmltopdf.org/downloads.html).
 
 After that, make sure you can execute the `wkhtmltopdf` command in your shell:
 
@@ -123,8 +125,8 @@ The syntax highlightning is powered by [coderay](https://github.com/rubychan/cod
 
 ### Table of Contents
 
-For an automatic generated table of contents after the cover, just add the `-t` param:
+For an automatic generated table of contents after the cover, just add the `-t` param and provide a headline for the table of contents:
 
 ```bash
-$ riven -t -c documentation/cover.md -o doc.pdf documentation/
-```
+$ riven -t "Contents" -c documentation/cover.md -o doc.pdf documentation/
+```

data/bin/riven

@@ -14,26 +14,51 @@ Riven::Wkhtmltopdf.check_installation
 
 ## Step 2: Parse command line options
 options = Riven::OptParser.options
-files = Riven::OptParser.files
+files = Riven::OptParser.files(options)
 
 
-## Step 3: Generate HTML
-markup = Riven::MarkupFile.read_all(files)
-generator = Riven::HTMLGenerator.new(markup)
+## Step 3: Change dir if directory is given to ensure the image pathes work
+unless options[:dir_given] === false
+  working_dir = Dir.pwd
+  Dir.chdir options[:dir_given]
+end
 
 
-## Step 4: Determine PDF file name
+## Step 4: Generate HTML for cover
+unless options[:cover_file] === ''
+  cover_markup = Riven::MarkupFile.read_cover(options[:cover_file])
+end
+cover_generator = Riven::HTMLGenerator.new('_riven_cover_tmp_file.html', cover_markup || '')
+
+
+## Step 5: Generate HTML for main document
+markup = Riven::MarkupFile.read_all(files, options[:cover_file])
+generator = Riven::HTMLGenerator.new('_riven_tmp_file.html', markup)
+
+
+## Step 6: Determine PDF file name
 # TODO auto generate output file name or take it from the options
 output_file = 'test.pdf'
 
 
-## Step 5: Generate the PDF file from HTML file
-Riven::Wkhtmltopdf.generate_pdf(generator.html_file, output_file)
+## Step 7: Generate the PDF file from HTML file
+output = Riven::Wkhtmltopdf.generate_pdf(generator.html_file, cover_generator.html_file, output_file, options)
+puts output if options[:verbose]
 
 
-## Step 6: Close the generator
+## Step 8: Close the generators
 generator.close!
+cover_generator.close!
+
+
+## Step 9: Dump the HTML code if requested
+puts generator.html if options[:dump_html]
+puts cover_generator.html if options[:dump_cover_html]
 
 
-## Step 7: Dump the HTML code if requested
-puts generator.html if options[:dump_html]
+## Step 10: If we changed the directory before, the PDF file is now located in the wrong directory,
+## so wie have to move it
+unless options[:dir_given] === false
+  require 'fileutils'
+  FileUtils.mv output_file, working_dir + '/' + output_file
+end

data/css/style.css

@@ -40,10 +40,6 @@ hr {
   height: 0;
 }
 
-pre {
-  overflow: auto;
-}
-
 code,
 kbd,
 pre {
@@ -265,6 +261,7 @@ h1 .anchor {
 
 h2 {
   padding-bottom: 0.3em;
+  margin-top: 2.5em;
   line-height: 1.225;
   border-bottom: 1px solid #eee;
 }
@@ -274,6 +271,7 @@ h2 .anchor {
 }
 
 h3 {
+  margin-top: 1.7em;
   line-height: 1.43;
 }
 
@@ -418,7 +416,8 @@ pre>code {
   margin: 0;
   font-size: 100%;
   word-break: normal;
-  white-space: pre;
+  white-space: pre-wrap;
+  word-wrap: break-word;
   background: transparent;
   border: 0;
 }
@@ -442,10 +441,6 @@ pre {
   word-break: normal;
 }
 
-pre {
-  word-wrap: normal;
-}
-
 pre code {
   display: inline;
   max-width: initial;
@@ -453,7 +448,8 @@ pre code {
   margin: 0;
   overflow: initial;
   line-height: inherit;
-  word-wrap: normal;
+  white-space: pre-wrap;
+  word-wrap: break-word;
   background-color: transparent;
   border: 0;
 }
@@ -636,7 +632,7 @@ kbd {
 }
 
 div.CodeRay { }
-span.CodeRay { white-space: pre; border: 0px; padding: 2px }
+span.CodeRay { white-space: pre-wrap; word-wrap: break-word; border: 0px; padding: 2px }
 
 table.CodeRay { border-collapse: collapse; width: 100%; padding: 2px }
 table.CodeRay td {
@@ -661,9 +657,8 @@ table.CodeRay td {
 .CodeRay .code { width: 100% }
 
 ol.CodeRay { font-size: 10pt }
-ol.CodeRay li { white-space: pre }
+ol.CodeRay li { white-space: pre-wrap; word-wrap: break-word; }
 
-.CodeRay .code pre { overflow: auto }
 .CodeRay .debug { color:white ! important; background:blue ! important; }
 
 .CodeRay .annotation { color:#007 }
@@ -754,4 +749,26 @@ ol.CodeRay li { white-space: pre }
 .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; }
+.CodeRay .head .head { color: #f4f; }
+
+
+
+
+.cover-page h1,
+.cover-page h2,
+.cover-page h3,
+.cover-page img {
+  text-align: center;
+  border-bottom: none;
+}
+
+.cover-page h1 {
+  margin: 15px 0;
+  font-size: 60px;
+  page-break-before: avoid;
+}
+
+.cover-page h2 {
+  margin-top: 0.5em;
+  color: #666;
+}

data/lib/riven/html_file.rb

@@ -3,7 +3,7 @@ module Riven
     attr_accessor :file_name
 
     public def initialize(file_name)
-      @file_name = file_name
+      @file_name = File.expand_path('./' + file_name)
     end
 
     public def write(content)

data/lib/riven/html_generator.rb

@@ -7,8 +7,8 @@ module Riven
   class HTMLGenerator
     attr_accessor :html, :html_file
 
-    public def initialize(markup)
-      @html_file = Riven::HTMLFile.new('_riven_tmp_file.html')
+    public def initialize(tmp_file, markup)
+      @html_file = Riven::HTMLFile.new(tmp_file)
 
       @markup = markup
 
@@ -35,7 +35,6 @@ module Riven
         tables: true,
         underline: true,
         highlight: true,
-        filter_html: true,
         with_toc_data: true,
         lax_spacing: true,
         xhtml: true,
@@ -47,6 +46,9 @@ module Riven
 
       html = code.process(html)
 
+      html.gsub! '////[COVERSTART]////', '<div class="cover-page">'
+      html.gsub! '////[COVEREND]////',   '</div>'
+
       return html
     end
 

data/lib/riven/markup_file.rb

@@ -26,15 +26,28 @@ module Riven
 
 
     class << self
-      public def read_all(markup_files)
+      public def read_all(markup_files, except = [])
         markup = ''
 
+        markup_files = [markup_files] unless markup_files.respond_to?(:each)
+        except = [except] unless except.respond_to?(:each)
+
         markup_files.each do |file|
-          markup << "\n\n" + File.read(file.path)
+          markup << "\n\n" + File.read(file.path) unless exclude?(except, file)
         end
 
         return markup
       end
+
+      public def read_cover(cover_file)
+        cover_markup =  "\n////[COVERSTART]////\n"
+        cover_markup << Riven::MarkupFile.read_all(cover_file)
+        cover_markup << "\n////[COVEREND]////\n"
+      end
+
+      private def exclude?(except, file)
+        except.select { |f| f.path === file.path }.any?
+      end
     end
   end
 end

data/lib/riven/opt_parser.rb

@@ -13,10 +13,11 @@ module Riven
       # Returns an array of Riven::MarkupFile for each given markdown file
       #
 
-      public def files
+      public def files(options)
         file_names = ARGV
 
         if file_names.size === 1 && File.directory?(file_names[0])
+          options[:dir_given] = file_names.first
           file_names = Dir["#{file_names[0]}/*.md"].sort
         end
 
@@ -34,7 +35,11 @@ module Riven
           cover_file: '',
           css_file: '',
           toc: false,
-          dump_html: false
+          toc_headline: 'Contents',
+          dump_html: false,
+          dump_cover_html: false,
+          verbose: false,
+          dir_given: false
         }
 
         opt_parser = OptionParser.new do |opts|
@@ -51,17 +56,26 @@ module Riven
           end
 
           opts.on("-c FILE", "--cover=FILE", "Path to the cover MD file") do |cover_file|
-            options[:cover_file] = cover_file
+            options[:cover_file] = Riven::MarkupFile.new(cover_file)
           end
 
-          opts.on("-t", "--toc", "Enabled the table of contents auto generation") do
+          opts.on("-t HEADLINE", "--toc=HEADLINE", "Enabled the table of contents auto generation") do |headline|
             options[:toc] = true
+            options[:toc_headline] = headline
           end
 
-          opts.on("-d", "--dump-html", "Dumps the HTML file to STDOUT") do
+          opts.on("-d", "--dump-html", "Dumps the main HTML file to STDOUT") do
             options[:dump_html] = true
           end
 
+          opts.on("-D", "--dump-cover-html", "Dumps the cover HTML file to STDOUT") do
+            options[:dump_cover_html] = true
+          end
+
+          opts.on('-v', '--verbose', 'Print the output of wkhtmltopdf to STDOUT. Don\'t combine with -d') do
+            options[:verbose] = true
+          end
+
           opts.on('-V', '--version', 'Displays the version') do
             puts Riven::VERSION.to_s
             exit

data/lib/riven/version.rb

@@ -1,3 +1,3 @@
 class Riven
-  VERSION = '0.0.1'
-end
+  VERSION = '0.1.0'
+end

data/lib/riven/wkhtmltopdf.rb

@@ -10,17 +10,38 @@ module Riven
         end
       end
 
-      public def generate_pdf(html_file, output_file)
+      public def generate_pdf(html_file, cover_html_file, output_file, options)
         params = [
-          '--disable-smart-shrinking',
           '--page-size A4',
           '--margin-bottom 10mm',
           '--margin-top 10mm',
-          '--margin-left 8mm',
-          '--margin-right 8mm'
+          '--margin-left 20mm',
+          '--margin-right 20mm',
+          '--footer-left "[section]"',
+          '--footer-right "[page] / [toPage]"',
+          '--footer-font-size 7',
+          '--footer-spacing 4'
         ]
 
-        output = `wkhtmltopdf #{params.join(' ')} #{html_file.file_name} #{output_file} 2>&1`
+        unless options[:cover_file] === ''
+          params << "cover \"#{cover_html_file.file_name}\""
+        end
+
+        if options[:toc]
+          xsl = File.read(File.expand_path(File.dirname(__FILE__)) + '/../../toc.xsl')
+          xsl.gsub! '[[toc_headline]]', options[:toc_headline]
+          xsl_file_name = '_tmp_toc.xsl'
+          File.open(xsl_file_name, 'w') { |file| file.write(xsl) }
+
+          params << 'toc'
+          params << "--xsl-style-sheet \"#{xsl_file_name}\""
+        end
+
+        output = `wkhtmltopdf #{params.join(' ')} "#{html_file.file_name}" "#{output_file}" 2>&1`
+
+        File.delete xsl_file_name
+
+        return output
       end
     end
   end

data/riven.gemspec

@@ -29,4 +29,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'redcarpet', '~> 3.2'
   spec.add_dependency 'coderay', '~> 1.1'
-end
+end

data/toc.xsl

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsl:stylesheet version="2.0"
+                xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+                xmlns:outline="http://wkhtmltopdf.org/outline"
+                xmlns="http://www.w3.org/1999/xhtml">
+  <xsl:output doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN"
+              doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
+              indent="yes" />
+  <xsl:template match="outline:outline">
+    <html>
+      <head>
+        <title>[[toc_headline]]</title>
+        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+        <style>
+			body {
+				color: #333;
+				font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif;
+				font-size: 14px;
+				line-height: 1.6;
+			}
+			a {
+				background: transparent;
+			}
+
+			a:active,
+			a:hover {
+			  outline: 0;
+			}
+			h1 {
+				margin-top: 15px;
+				margin-bottom: 15px;
+  				line-height: 1.2;
+				font-size: 24px;
+				page-break-inside: avoid;
+  				border-bottom: 1px solid #eee;
+			}
+			div {border-bottom: 1px dashed #eee; margin: 0 0 5px 0;}
+			span {float: right;}
+			li {list-style: none; padding: 0; margin: 0;}
+			ul {padding: 0; margin: 0; font-size: 14px;}
+			ul ul {font-size: 85%; padding-left: 1em;}
+        </style>
+      </head>
+      <body>
+        <h1>[[toc_headline]]</h1>
+        <ul><xsl:apply-templates select="outline:item/outline:item"/></ul>
+      </body>
+    </html>
+  </xsl:template>
+  <xsl:template match="outline:item">
+    <li>
+      <xsl:if test="@title!=''">
+        <div>
+          <a>
+            <xsl:if test="@link">
+              <xsl:attribute name="href"><xsl:value-of select="@link"/></xsl:attribute>
+            </xsl:if>
+            <xsl:if test="@backLink">
+              <xsl:attribute name="name"><xsl:value-of select="@backLink"/></xsl:attribute>
+            </xsl:if>
+            <xsl:value-of select="@title" />
+          </a>
+          <span> <xsl:value-of select="@page" /> </span>
+        </div>
+      </xsl:if>
+      <ul>
+        <xsl:comment>added to prevent self-closing tags in QtXmlPatterns</xsl:comment>
+        <xsl:apply-templates select="outline:item"/>
+      </ul>
+    </li>
+  </xsl:template>
+</xsl:stylesheet>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riven
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Benjamin Kammerl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-14 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +91,7 @@ files:
 - lib/riven/version.rb
 - lib/riven/wkhtmltopdf.rb
 - riven.gemspec
+- toc.xsl
 homepage: https://github.com/phortx/riven
 licenses:
 - MIT
@@ -111,8 +112,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Converts Markdown to PDF
 test_files: []
+has_rdoc: