dragonfly_phantomjs 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f6f61fe6650d4c2159f5dc77c215fa45eaa386d
-  data.tar.gz: dcc9104b633d05f4a9a8646f9438016b36d8ea04
+  metadata.gz: f10f860936a87eb0db8c933b363f6533e6d79b88
+  data.tar.gz: f13237acf25cdbae2095a4c73e5440dc36318e3e
 SHA512:
-  metadata.gz: ca6c5ab9973d7588acaa5e07c5054c56e5aff5b04ced61c97f02fb592b53c2aebb2acd387a123d4a0ceae6a2195565ee194d6268d7651503abc0b5867e2f3553
-  data.tar.gz: 405f6c7735019483a156b9cb229fd07b991da9ae952ae0a70c3a0d8c6473f729d12ac989f427c3f2879e40bcca9d10b039eb1cbc8922a78bf72891f3fc48875d
+  metadata.gz: 48ee7327877f0704ffc7fac84b15907c90629a0d061275416ac162464439b60f080d9eca5720d9198f6f53477cf6eda97dd4ff405d6a771c832245e32be5b7b8
+  data.tar.gz: abf665d554a9e35117384565891402b783f088408ecdaede38fc3552c51b82f43600e787ae98432d216cf240eb0d5c9720100173c48d4a7815d9818bbdcfab39

data/README.md

@@ -48,8 +48,12 @@ Options:
 :paper_size     - {string}, 'width*height', '300mm*300mm', supported units are 'mm', 'cm', 'in', 'px'
 :viewport_size  - {string}, 'width*height', '1440*900'
 :zoom_factor    - {number}, defaults to 1
+:header         - {hash}, {height: '10mm', content: 'Header content'}
+:footer         - {hash}, {height: '10mm', content: 'Footer content'}
 ```
 
+For now refer to the phantomjs [api](http://phantomjs.org/api/webpage/property/paper-size.html) for more details on how to construct the string for the header/footer. You can use `pageNum` and `numPages` as variables.
+
 ## Contributing
 
 1. Fork it ( https://github.com/tomasc/dragonfly_phantomjs/fork )

data/lib/dragonfly_phantomjs/plugin.rb

@@ -10,4 +10,4 @@ module DragonflyPhantomjs
   end
 end
 
-Dragonfly::App.register_plugin(:phantomjs) { DragonflyPhantomjs::Plugin.new }
+Dragonfly::App.register_plugin(:phantomjs){ DragonflyPhantomjs::Plugin.new }

data/lib/dragonfly_phantomjs/processors/rasterize.rb

@@ -11,28 +11,28 @@ module DragonflyPhantomjs
     # Incase of .svg file, the viewport_size is automatically set to the
     # dimensions in the .svg file, unless explicitly specified in options
     #
-    # IMPORTANT: Requires +phantomjs+
+    # IMPORTANT: Requires +phantomjs (~> 1.9)+
 
     class Rasterize
 
       class UnsupportedFormat < RuntimeError; end
 
-      #   :border         - {number, string}, defaults to 0, supported units are 'mm', 'cm', 'in', 'px'
-      #   :format         - {string}, defaults to 'A4', supported formats are 'A4', 'A3', 'A5', 'Legal', 'Letter', 'Tabloid'
-      #   :paper_size     - {string}, 'width*height', '300mm*300mm', supported units are 'mm', 'cm', 'in', 'px'
-      #   :viewport_size  - {string}, 'width*height', '1440*900'
-      #   :zoom_factor    - {number}, defaults to 1
+      # :margin         - {number, string}, defaults to 0, supported units are 'mm', 'cm', 'in', 'px'
+      # :format         - {string}, defaults to 'A4', supported formats are 'A4', 'A3', 'A5', 'Legal', 'Letter', 'Tabloid'
+      # :paper_size     - {string}, 'width*height', '300mm*300mm', supported units are 'mm', 'cm', 'in', 'px'
+      # :viewport_size  - {string}, 'width*height', '1440*900'
+      # :zoom_factor    - {number}, defaults to 1
+      # :header         - {hash}, {height: '10mm', contents: 'foo'}
+      # :footer         - {hash}, {height: '10mm', contents: 'foo'}
 
       def call content, format=:pdf, options={}
         raise UnsupportedFormat unless %w(gif jpeg pdf png).include?(format.to_s)
-
         content.shell_update(ext: format) do |old_path, new_path|
           if File.extname(old_path) == 'svg' && options[:viewport_size].blank?
             width = Dragonfly::Analysers::SvgAnalyser.new(content)[:width]
             height = Dragonfly::Analysers::SvgAnalyser.new.(content)[:height]
             options[:viewport_size] = "#{width.to_i}*#{height.to_i}"
           end
-
           "#{phantomjs_command} #{rasterize_script} #{old_path} #{new_path} '#{options.to_json}'"
         end
       end

data/lib/dragonfly_phantomjs/version.rb

@@ -1,3 +1,3 @@
 module DragonflyPhantomjs
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/script/rasterize.coffee

@@ -24,6 +24,7 @@ else
 
 
 
+margin = options['margin'] || 0
 border = options['border'] || 0
 format = options['format'] || 'A4'
 paper_size = options['paper_size']
@@ -33,6 +34,24 @@ user_agent = options['user_agent']
 referer = options['referer']
 element_id = options['element_id']
 
+header =
+  if options['header']
+    height: options['header']['height']
+    contents: phantom.callback((pageNum, numPages) ->
+      eval options['header']['content']
+    )
+  else
+    null
+
+footer =
+  if options['footer']
+    height: options['footer']['height']
+    contents: phantom.callback((pageNum, numPages) ->
+      eval options['footer']['content']
+    )
+  else
+    null
+
 
 
 # ---------------------------------------------------------------------
@@ -53,10 +72,10 @@ if output.substr(-4) is ".pdf"
   if paper_size != undefined
     page_width = paper_size.split('*')[0]
     page_height = paper_size.split('*')[1]
-    page.paperSize = { width: page_width, height: page_height, border: border }
+    page.paperSize = { width: page_width, height: page_height, margin: margin, border: border, header: header, footer: footer }
 
   else if format != undefined
-    page.paperSize = { format: format, border: border }
+    page.paperSize = { format: format, margin: margin, border: border, header: header, footer: footer }
 
 if viewport_size != undefined
   viewport_width = viewport_size.split('*')[0]

data/test/dragonfly_phantomjs/processors/rasterize_test.rb

@@ -4,68 +4,95 @@ module DragonflyPhantomjs
   module Processors
     describe Rasterize do
 
-      let(:app) { test_app.configure_with(:svg) }
+      let(:app) { test_app.configure_with(:phantomjs) }
       let(:processor) { DragonflyPhantomjs::Processors::Rasterize.new }
 
       let(:html) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample.html')) }
       let(:svg) { Dragonfly::Content.new(app, SAMPLES_DIR.join('sample.svg')) }
 
+      let(:html_string) { Dragonfly::Content.new(app, '<html><head></head><body>foo</body></html>', name: 'foo.html') }
+
       let(:options) {
         {
-          border: 0,
+          margin: 0,
           format: 'A4',
           paper_size: '210mm*297mm',
           viewport_size: '1440*900',
-          zoom_factor: 1
+          zoom_factor: 1,
+          header: {
+            height: '10mm',
+            content: 'foo'
+          },
+          footer: {
+            height: '10mm',
+            content: 'foo'
+          }
         }
       }
 
       describe 'html' do
         it 'returns PDF' do
-          result = processor.call(html, :pdf, options)
-          get_mime_type(result.path).must_include "application/pdf"
+          processor.call(html, :pdf)
+          get_mime_type(html.path).must_include "application/pdf"
+          assert is_pdf(html.data)
         end
 
         it 'returns PNG' do
-          result = processor.call(html, :png, options)
-          get_mime_type(result.path).must_include "image/png"
+          processor.call(html, :png, options)
+          get_mime_type(html.path).must_include "image/png"
         end
 
         it 'returns GIF' do
-          result = processor.call(html, :gif, options)
-          get_mime_type(result.path).must_include "image/gif"
+          processor.call(html, :gif, options)
+          get_mime_type(html.path).must_include "image/gif"
         end
 
         it 'returns JPEG' do
-          result = processor.call(html, :jpeg, options)
-          get_mime_type(result.path).must_include "image/jpeg"
+          processor.call(html, :jpeg, options)
+          get_mime_type(html.path).must_include "image/jpeg"
         end
       end
 
       describe 'svg' do
         it 'returns PDF' do
-          result = processor.call(svg, :pdf, options)
-          get_mime_type(result.path).must_include "application/pdf"
+          processor.call(svg, :pdf, options)
+          get_mime_type(svg.path).must_include "application/pdf"
+          assert is_pdf(svg.data)
         end
 
         it 'returns PNG' do
-          result = processor.call(svg, :png, options)
-          get_mime_type(result.path).must_include "image/png"
+          processor.call(svg, :png, options)
+          get_mime_type(svg.path).must_include "image/png"
         end
 
         it 'returns GIF' do
-          result = processor.call(svg, :gif, options)
-          get_mime_type(result.path).must_include "image/gif"
+          processor.call(svg, :gif, options)
+          get_mime_type(svg.path).must_include "image/gif"
         end
 
         it 'returns JPEG' do
-          result = processor.call(svg, :jpeg, options)
-          get_mime_type(result.path).must_include "image/jpeg"
+          processor.call(svg, :jpeg, options)
+          get_mime_type(svg.path).must_include "image/jpeg"
+        end
+      end
+
+      describe 'string' do
+        it 'returns PDF' do
+          obj = '<html><head></head><body>foo</body></html>'
+          def obj.original_filename; 'something.html'; end
+          html_string.update(obj)
+          processor.call(html_string, :pdf)
+          get_mime_type(html_string.path).must_include "application/pdf"
+          assert is_pdf(html_string.data)
         end
       end
 
       # ---------------------------------------------------------------------
 
+      def is_pdf data
+        data =~ /\A%PDF-1.4/
+      end
+
       def get_mime_type file_path
         `file --mime-type #{file_path}`.gsub(/\n/, "")
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_phantomjs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Tomas Celizna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-03 00:00:00.000000000 Z
+date: 2014-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly