Merge pull request #2 from marcbachmann/prettify

Support global css styles

Author: marcbachmann

README.md

@@ -26,12 +26,44 @@ pdf.create(htmlString, options, callback)
 ```
 
 ## Options
-`script`: Absolute path to a custom phantomjs script, use the file in lib/scripts as example  
-`timeout`: Timeout that will cancel phantomjs, milliseconds as Integer, default: 10000  
-`filename`: The file path of the file that will be written. If you want to save the file permanently, you have to pass this option.  
-`directory`: The directory path of the file that will be written. default: '/tmp'  
+```javascript
+config = {
+  // Script options
+  script: '/url'             // Absolute path to a custom phantomjs script, use the file in lib/scripts as example
+  timeout: 10000           // Timeout that will cancel phantomjs, in milliseconds
 
-The full options object gets converted to JSON and will get passed to the phantomjs script as third argument.  
-There are more options concerning the paperSize, header & footer options inside the phantomjs script.  
+  // Papersize Options: http://phantomjs.org/api/webpage/property/paper-size.html
+  "height": "",              // allowed units: mm, cm, in, px
+  "width": "",               // allowed units: mm, cm, in, px
+  - or -
+  "format": "A4",            // allowed units: A3, A4, A5, Legal, Letter, Tabloid
+  "orientation": "portrait", // portrait or landscape
+
+
+  // Page options
+  "border": "0"              // default is 0, units: mm, cm, in, px
+  "header": {
+    "height": "45mm",
+    "contents": '<div style="text-align: center;">Author: Marc Bachmann</div>'
+  },
+  "footer": {
+    "height": "28mm",
+    "contents": '<span style="color: #444;">{{page}}</span>/<span>{{pages}}</span>'
+  },
+  
+
+  // File options
+  "type": "pdf",             // allowed file types: png, jpeg, pdf
+  "quality": "75",           // only used for types png & jpeg
 
-## documentations for more available options will follow soon :)  
+
+  // Export options
+  "buffer": true,            // only supported on certain systems
+  - or -
+  "filename": "/tmp/html-pdf-123-123.pdf" // The file path of the file that will be written. If you want to save the file permanently, you have to pass this option.
+  "directory": "/tmp"        // The directory the file gets written into if no filename is defined. default: '/tmp' 
+}
+```
+
+The full options object gets converted to JSON and will get passed to the phantomjs script as third argument.  
+There are more options concerning the paperSize, header & footer options inside the phantomjs script.

lib/index.coffee

@@ -31,7 +31,7 @@ exports.create = (string, options, callback) ->
     child.stdin.end()
     child.kill()
     stderr = [new Buffer('PDF creation timeout. PDF generation script did not end.')] unless stderr.length
-  , options.timeout || 10000
+  , parseInt(options.timeout) || 10000
 
   child.stdout.on 'data', (buffer) ->
     stdout.push(buffer)

lib/index.js

@@ -28,7 +28,7 @@ exports.create = function(string, options, callback) {
     if (!stderr.length) {
       return stderr = [new Buffer('PDF creation timeout. PDF generation script did not end.')];
     }
-  }, options.timeout || 10000);
+  }, parseInt(options.timeout) || 10000);
   child.stdout.on('data', function(buffer) {
     return stdout.push(buffer);
   });

lib/scripts/pdf_a4_portrait.coffee

@@ -2,14 +2,16 @@ sys = require('system')
 webpage = require('webpage')
 
 page = webpage.create()
-size = sys.args[1]
+bufferSize = sys.args[1]
 options = {}
 options = JSON.parse(sys.args[2]) if typeof sys.args[2] is 'string'
-page.content = sys.stdin.read(size)
+page.content = sys.stdin.read(bufferSize)
 
 
 # Set up content
+# --------------
 content = page.evaluate ->
+  styles = document.querySelector('head style')?.outerHTML || ''
   if $header = document.getElementById('pageHeader')
     header = $header.outerHTML
     $header.parentNode.removeChild($header)
@@ -21,41 +23,48 @@ content = page.evaluate ->
   if $body = document.getElementById('pageContent')
     body = $body.outerHTML
   else
-    document.body.outerHTML
+    body = document.body.outerHTML
 
-  return {
-    header:  header || ""
-    body: body || ""
-    footer: footer || ""
-  }
+  {styles, header, body, footer}
 
 
-# Set up options
-paperSize =
-  border: options.border || '0'
-  header: if options.header || content.header
-    height: options.header?.height || "45mm"
-    contents: phantom.callback (pageNum, numPages) ->
-      (options.header?.contents || content.header)
-        .replace('{{page}}', pageNum)
-        .replace('{{pages}}', numPages)
+# Set up paperSize options
+# -------------------------
+paper = border: options.border || '0'
+
+if options.height && options.width
+  paper.width = options.width
+  paper.height = options.height
+else
+  paper.format = options.format || 'A4'
+  paper.orientation = options.orientation || 'portrait'
+
 
-  footer: if options.footer || content.footer
-    height: options.footer?.height || "28mm"
+# Generate footer & header
+# ------------------------
+setContent = (type) ->
+  paper[type] =
+    height: options[type]?.height
     contents: phantom.callback (pageNum, numPages) ->
-      (options.footer?.contents || content.footer)
+      (options[type]?.contents || content[type] || '')
         .replace('{{page}}', pageNum)
-        .replace('{{pages}}', numPages)
+        .replace('{{pages}}', numPages)+content.styles
+
+for type in ['header', 'footer']
+  setContent(type) if options[type] || content[type]
+
+paper.header?.height ?= '45mm'
+paper.footer?.height ?= '28mm'
+
+
+# The paperSize object must be set at once
+# -----------------------------------------
+page.paperSize = paper
 
-if options.height && options.width
-  paperSize.width = options.width
-  paperSize.height = options.height
-else
-  paperSize.format = options.format || 'A4'
-  paperSize.orientation = options.orientation || 'portrait'
 
-page.paperSize = paperSize
 
+# Completely load page & end process
+# ----------------------------------
 page.onLoadFinished = (status) ->
   # Output to parent process
   fileOptions =
@@ -70,7 +79,7 @@ page.onLoadFinished = (status) ->
 
   # Option 2: Output filename to stdout
   else
-    filename = options.filename || ("#{options.directory || '/tmp'}/html-pdf-#{sys.pid}-#{size}.#{fileOptions.type}")
+    filename = options.filename || ("#{options.directory || '/tmp'}/html-pdf-#{sys.pid}-#{bufferSize}.#{fileOptions.type}")
     page.render(filename, fileOptions)
     sys.stdout.write(filename)