dragonfly_phantomjs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f6f61fe6650d4c2159f5dc77c215fa45eaa386d
+  data.tar.gz: dcc9104b633d05f4a9a8646f9438016b36d8ea04
+SHA512:
+  metadata.gz: ca6c5ab9973d7588acaa5e07c5054c56e5aff5b04ced61c97f02fb592b53c2aebb2acd387a123d4a0ceae6a2195565ee194d6268d7651503abc0b5867e2f3553
+  data.tar.gz: 405f6c7735019483a156b9cb229fd07b991da9ae952ae0a70c3a0d8c6473f729d12ac989f427c3f2879e40bcca9d10b039eb1cbc8922a78bf72891f3fc48875d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+dragonfly.log

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+rvm:
+  - 1.9.3
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dragonfly_phantomjs.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$})                       { 'test' }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tomas Celizna
+
+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,59 @@
+# Dragonfly PhantomJS
+
+[![Build Status](https://travis-ci.org/tomasc/dragonfly_phantomjs.svg)](https://travis-ci.org/tomasc/dragonfly_phantomjs) [![Gem Version](https://badge.fury.io/rb/dragonfly_phantomjs.svg)](http://badge.fury.io/rb/dragonfly_phantomjs) [![Coverage Status](https://img.shields.io/coveralls/tomasc/dragonfly_phantomjs.svg)](https://coveralls.io/r/tomasc/dragonfly_phantomjs)
+
+This [Dragonfly](https://github.com/markevans/dragonfly) plugin uses [PhantomJS](https://github.com/ariya/phantomjs) headless browser to convert `HTML` or `SVG` documents to `GIF`, `JPEG`, `PDF` or `PNG`
+
+If passed an `SVG` and the `viewport_size` is not specified in the options, the `viewport_size` is automatically set to the dimensions of the `SVG` file.
+
+IMPORTANT: Requires [PhantomJS](http://phantomjs.org)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dragonfly_phantomjs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dragonfly_phantomjs
+
+## Usage
+
+Add the plugin to Dragonfly:
+
+```ruby
+Dragonfly.app.configure do
+  plugin :svg
+end
+```
+
+## Rasterize
+
+```ruby
+html.rasterize(format, options)
+svg.rasterize(format, options)
+```
+
+Formats: `:gif`, `:jpeg`, `:pdf`, `:png`
+
+Options:
+```Ruby
+: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
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/tomasc/dragonfly_phantomjs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/dragonfly_phantomjs.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dragonfly_phantomjs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dragonfly_phantomjs"
+  spec.version       = DragonflyPhantomjs::VERSION
+  spec.authors       = ["Tomas Celizna"]
+  spec.email         = ["tomas.celizna@gmail.com"]
+  spec.summary       = %q{An encoder converting .html or .svg documents to .gif, .jpeg, .pdf or .png using PhantomJs}
+  spec.description   = %q{An encoder converting .html or .svg documents to .gif, .jpeg, .pdf or .png using PhantomJs}
+  spec.homepage      = "https://github.com/tomasc/dragonfly_phantomjs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dragonfly", "~> 1.0.5"
+  spec.add_dependency "dragonfly_svg"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "minitest"
+end

data/lib/dragonfly_phantomjs.rb

@@ -0,0 +1,9 @@
+require "dragonfly"
+require "dragonfly_phantomjs/plugin"
+require "dragonfly_phantomjs/version"
+
+module DragonflyPhantomjs
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+end

data/lib/dragonfly_phantomjs/plugin.rb

@@ -0,0 +1,13 @@
+require 'dragonfly_phantomjs/processors/rasterize'
+
+module DragonflyPhantomjs
+  class Plugin
+
+    def call app, opts={}
+      app.add_processor :rasterize, DragonflyPhantomjs::Processors::Rasterize.new
+    end
+
+  end
+end
+
+Dragonfly::App.register_plugin(:phantomjs) { DragonflyPhantomjs::Plugin.new }

data/lib/dragonfly_phantomjs/processors/rasterize.rb

@@ -0,0 +1,56 @@
+require 'dragonfly_svg'
+require 'json'
+
+module DragonflyPhantomjs
+  module Processors
+
+    # ---------------------------------------------------------------------
+    # This processor uses PhantomJs to convert .html or .svg documents to
+    # .gif, .jpeg, .pdf or .png
+    #
+    # 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+
+
+    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
+
+      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
+
+      def update_url attrs, format, args=""
+        attrs.ext = format.to_s
+      end
+
+      private # =============================================================
+
+      def phantomjs_command
+        "phantomjs"
+      end
+
+      def rasterize_script
+        File.join(DragonflyPhantomjs.root, "script", "rasterize.coffee")
+      end
+
+    end
+  end
+end

data/lib/dragonfly_phantomjs/version.rb

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

data/samples/sample.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>Dragonfly PhantomJS Sample HTML</title>
+  <meta name="description" content="Sample HTML">
+  <meta name="author" content="Asger Behncke Jacobsen">
+</head>
+<body>
+  <h1>Dragonfly PhantomJS</h1>
+  <p>Lorem ipsum Dolore enim dolore sunt sint esse ut nostrud sed eu minim proident anim amet tempor cillum in do sunt ex aliqua commodo veniam in in adipisicing deserunt anim voluptate reprehenderit sed mollit deserunt tempor ea commodo laborum deserunt esse deserunt exercitation sit ut commodo adipisicing voluptate incididunt nostrud esse labore deserunt id deserunt irure nisi veniam in dolore aliquip adipisicing ut anim ut ullamco sed eu elit quis culpa exercitation proident dolore magna exercitation deserunt anim tempor consectetur amet et culpa adipisicing aliquip labore ea ex exercitation reprehenderit deserunt in incididunt qui sint Excepteur fugiat elit voluptate reprehenderit sit laboris ad elit tempor laboris nulla exercitation qui irure dolor fugiat voluptate in commodo cillum in dolore reprehenderit laborum nulla amet tempor ad occaecat consectetur Duis cillum est cupidatat eiusmod laborum cupidatat sed sed dolor id consequat cillum enim proident sit anim ut magna proident veniam fugiat mollit aliqua dolore ex do laborum ut nisi cupidatat nisi nostrud occaecat labore est in ea dolor ad ullamco occaecat commodo velit id ut magna qui adipisicing in commodo voluptate laboris velit reprehenderit commodo mollit irure consequat in veniam enim Excepteur ut anim dolor aute cillum in reprehenderit sed incididunt sunt laboris id aute qui Ut velit in tempor veniam consequat consequat nulla pariatur do occaecat aute tempor Ut labore dolore ullamco veniam adipisicing Duis cillum occaecat dolore sit officia magna aliquip esse in elit dolore proident sit ut commodo sit quis in et veniam eiusmod dolore et commodo in qui dolore eu nisi minim commodo exercitation.</p>
+</body>
+</html>

data/samples/sample.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<svg version="1.1" id="sample_id" xmlns="http://www.w3.org/2000/svg" width="200" height="300" viewBox="0 0 200 300">
+  <rect fill="none" stroke="#000000" x="0" y="0" width="200" height="300" />
+</svg>

data/script/rasterize.coffee

@@ -0,0 +1,81 @@
+
+
+
+fs = require('fs')
+system = require('system')
+
+
+
+# ---------------------------------------------------------------------
+
+
+
+input = system.args[1]
+output = system.args[2]
+
+if options_json = system.args[3]
+  options = JSON.parse options_json
+else
+  options = {}
+
+
+
+# ---------------------------------------------------------------------
+
+
+
+border = options['border'] || 0
+format = options['format'] || 'A4'
+paper_size = options['paper_size']
+viewport_size = options['viewport_size']
+zoom_factor = options['zoom_factor'] || 1
+user_agent = options['user_agent']
+referer = options['referer']
+element_id = options['element_id']
+
+
+
+# ---------------------------------------------------------------------
+
+
+
+page = require('webpage').create()
+page.settings.userAgent = options['user_agent'] if user_agent
+page.customHeaders = { 'Referer': options['referer'] } if referer
+
+
+
+# ---------------------------------------------------------------------
+
+
+
+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 }
+
+  else if format != undefined
+    page.paperSize = { format: format, border: border }
+
+if viewport_size != undefined
+  viewport_width = viewport_size.split('*')[0]
+  viewport_height = viewport_size.split('*')[1]
+  page.viewportSize = { width: viewport_width, height: viewport_height }
+
+page.zoomFactor = zoom_factor
+
+
+
+# ---------------------------------------------------------------------
+
+
+
+page.open input, ->
+  if element_id
+    page.clipRect = page.evaluate ->
+      document.getElementById('demo').getBoundingClientRect()
+  page.render(output)
+  phantom.exit()
+
+

data/test/dragonfly_phantomjs/plugin_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+module DragonflyPhantomjs
+  describe Plugin do
+
+    let(:app) { test_app.configure_with(:phantomjs) }
+    let(:html) { app.fetch_file(SAMPLES_DIR.join('sample.html')) }
+    let(:svg) { app.fetch_file(SAMPLES_DIR.join('sample.svg')) }
+
+    # ---------------------------------------------------------------------
+
+    describe 'processors' do
+      it 'adds #rasterize' do
+        html.must_respond_to :rasterize
+        svg.must_respond_to :rasterize
+      end
+    end
+
+  end
+end

data/test/dragonfly_phantomjs/processors/rasterize_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+module DragonflyPhantomjs
+  module Processors
+    describe Rasterize do
+
+      let(:app) { test_app.configure_with(:svg) }
+      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(:options) {
+        {
+          border: 0,
+          format: 'A4',
+          paper_size: '210mm*297mm',
+          viewport_size: '1440*900',
+          zoom_factor: 1
+        }
+      }
+
+      describe 'html' do
+        it 'returns PDF' do
+          result = processor.call(html, :pdf, options)
+          get_mime_type(result.path).must_include "application/pdf"
+        end
+
+        it 'returns PNG' do
+          result = processor.call(html, :png, options)
+          get_mime_type(result.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"
+        end
+
+        it 'returns JPEG' do
+          result = processor.call(html, :jpeg, options)
+          get_mime_type(result.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"
+        end
+
+        it 'returns PNG' do
+          result = processor.call(svg, :png, options)
+          get_mime_type(result.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"
+        end
+
+        it 'returns JPEG' do
+          result = processor.call(svg, :jpeg, options)
+          get_mime_type(result.path).must_include "image/jpeg"
+        end
+      end
+
+      # ---------------------------------------------------------------------
+
+      def get_mime_type file_path
+        `file --mime-type #{file_path}`.gsub(/\n/, "")
+      end
+
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'bundler/setup'
+
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require 'dragonfly'
+require 'dragonfly_phantomjs'
+
+# ---------------------------------------------------------------------
+
+SAMPLES_DIR = Pathname.new(File.expand_path('../../samples', __FILE__))
+
+# ---------------------------------------------------------------------
+
+def test_app name=nil
+  app = Dragonfly::App.instance(name)
+  app.datastore = Dragonfly::MemoryDataStore.new
+  app.secret = "test secret"
+  app
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: dragonfly_phantomjs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dragonfly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: dragonfly_svg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An encoder converting .html or .svg documents to .gif, .jpeg, .pdf or
+  .png using PhantomJs
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- dragonfly_phantomjs.gemspec
+- lib/dragonfly_phantomjs.rb
+- lib/dragonfly_phantomjs/plugin.rb
+- lib/dragonfly_phantomjs/processors/rasterize.rb
+- lib/dragonfly_phantomjs/version.rb
+- samples/sample.html
+- samples/sample.svg
+- script/rasterize.coffee
+- test/dragonfly_phantomjs/plugin_test.rb
+- test/dragonfly_phantomjs/processors/rasterize_test.rb
+- test/test_helper.rb
+homepage: https://github.com/tomasc/dragonfly_phantomjs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An encoder converting .html or .svg documents to .gif, .jpeg, .pdf or .png
+  using PhantomJs
+test_files:
+- test/dragonfly_phantomjs/plugin_test.rb
+- test/dragonfly_phantomjs/processors/rasterize_test.rb
+- test/test_helper.rb