ezprint 0.2.2 → 0.3.1

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Jason Stewart
+Copyright (c) 2011 Jason Stewart
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README

@@ -56,6 +56,27 @@ layout:      false
 template:    the template for the current controller/action
 stylesheets: none
 
+
+Using another PDF processor
+===========================
+
+While ezprint has been designed with PDFKit in mind, other PDF processors
+such as princexml can be used. A princexml processor is included and can be used
+by setting Ezprint.processor = :prince in an initializer.
+
+It's also easy to create your own processor:
+
+module Ezprint
+  module Processors
+    class MyProcessor < Base
+      def self.process(html_string, options = {})
+        # Code to return a PDF string from an html string here.
+      end
+    end
+  end
+end
+
+
 Credits
 =======
 

data/README.rdoc

@@ -54,6 +54,25 @@ The defaults for the render options are as follows:
     template:    the template for the current controller/action
     stylesheets: none
 
+
+== Using another PDF processor
+
+While ezprint has been designed with PDFKit in mind, other PDF processors
+such as princexml can be used. A princexml processor is included and can be used
+by setting Ezprint.processor = :prince in an initializer.
+
+It's also easy to create your own processor:
+
+  module Ezprint
+    module Processors
+      class MyProcessor < Base
+        def self.process(html_string, options = {})
+          # Code to return a PDF string from an html string here.
+        end
+      end
+    end
+  end
+
 == Credits
 
 * Michael Bleigh for writing the awesome princely plugin, which most of the code is reworked from.

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = "jstewart@fusionary.com"
     gem.homepage = "http://github.com/jstewart/ezprint"
     gem.authors = ["Jason Stewart"]
-    gem.add_dependency 'pdfkit', '>=0.4.1'
+    gem.add_dependency 'pdfkit', '~> 0.5.0'
   end
 
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.1

data/ezprint.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ezprint}
-  s.version = "0.2.2"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Stewart"]
-  s.date = %q{2011-01-13}
+  s.date = %q{2011-05-16}
   s.description = %q{A Rails wrapper for the PDFkit library. Meant to be a drop in replacement for princely.}
   s.email = %q{jstewart@fusionary.com}
   s.extra_rdoc_files = [
@@ -27,24 +27,26 @@ Gem::Specification.new do |s|
     "init.rb",
     "lib/ezprint.rb",
     "lib/ezprint/pdf_helper.rb",
+    "lib/ezprint/processors/base.rb",
+    "lib/ezprint/processors/pdfkit.rb",
+    "lib/ezprint/processors/prince.rb",
     "lib/ezprint/railtie.rb"
   ]
   s.homepage = %q{http://github.com/jstewart/ezprint}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.1}
   s.summary = %q{A Rails wrapper for the PDFkit library. Meant to be a drop in replacement for princely.}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<pdfkit>, [">= 0.4.1"])
+      s.add_runtime_dependency(%q<pdfkit>, ["~> 0.5.0"])
     else
-      s.add_dependency(%q<pdfkit>, [">= 0.4.1"])
+      s.add_dependency(%q<pdfkit>, ["~> 0.5.0"])
     end
   else
-    s.add_dependency(%q<pdfkit>, [">= 0.4.1"])
+    s.add_dependency(%q<pdfkit>, ["~> 0.5.0"])
   end
 end
 

data/lib/ezprint.rb

@@ -1,9 +1,26 @@
-require 'ezprint/pdf_helper'
+require 'active_support/inflector'
+
+module Ezprint
+  autoload :PdfHelper, 'ezprint/pdf_helper'
+
+  module Processors
+    autoload :Base, 'ezprint/processors/base'
+    autoload :Pdfkit, 'ezprint/processors/pdfkit'
+    autoload :Prince, 'ezprint/processors/prince'
+  end
+
+  @@processor = :pdfkit
+  mattr_accessor :processor
+
+  def self.get_processor
+    ::Ezprint::Processors.const_get(Ezprint.processor.to_s.classify)
+  end
+end
 
 if defined?(::Rails::Railtie)
   require 'ezprint/railtie'
 else
   # Rails 2.x
   Mime::Type.register 'application/pdf', :pdf
-  ActionController::Base.send(:include, EzPrint::PdfHelper)
+  ActionController::Base.send(:include, Ezprint::PdfHelper)
 end

data/lib/ezprint/pdf_helper.rb

@@ -1,13 +1,11 @@
-module EzPrint
+module Ezprint
   module PdfHelper
-    require 'pdfkit'
-
     def self.included(base)
       base.class_eval do
         alias_method_chain :render, :ezprint
       end
     end
-    
+
     def render_with_ezprint(options = nil, *args, &block)
       if options.is_a?(Symbol) or options.nil? or options[:pdf].nil?
         render_without_ezprint(options, *args, &block)
@@ -20,18 +18,14 @@ module EzPrint
     private
 
     def make_pdf(options = {})
-      stylesheets = options.delete(:stylesheets) || []
-      layout = options.delete(:layout) || false
-      template = options.delete(:template) || File.join(controller_path,action_name)
+      template              = options.delete(:template) || File.join(controller_path,action_name)
+      layout                = options.delete(:layout) || false
+      stylesheets           = options[:stylesheets] || []
+      options[:stylesheets] = stylesheets.map { |s| stylesheet_file_path(s) }
 
-      # Stop Rails from appending timestamps to assets.
-      ENV["RAILS_ASSET_ID"] = ''
+      ENV["RAILS_ASSET_ID"] = ''  # Stop Rails from appending timestamps to assets
       html_string = render_to_string(:template => template, :layout => layout)
-
-      kit = PDFKit.new(process_html_string(html_string), options)
-      kit.stylesheets = stylesheets.collect{ |style| stylesheet_file_path(style) }
-
-      kit.to_pdf
+      Ezprint.get_processor.send(:process, html_string, options)
     end
 
     def make_and_send_pdf(pdf_name, options = {})
@@ -53,15 +47,13 @@ module EzPrint
 
     def stylesheet_file_path(stylesheet)
       stylesheet = stylesheet.to_s.gsub(".css","")
-      File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR,"#{stylesheet}.css")
-    end
 
-    def process_html_string(html)
-      # reroute absolute paths
-      html.gsub!("src=\"/", "src=\"#{RAILS_ROOT}/public/")
-      html.gsub!("href=\"/", "src=\"#{RAILS_ROOT}/public/")
-      html.gsub!("url(/", "url(#{RAILS_ROOT}/public/")
-      html
+      stylesheets_dir = if defined? ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR
+                          ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR
+                        else
+                          config.stylesheets_dir
+                        end
+      File.join(stylesheets_dir, "#{stylesheet}.css")
     end
   end
 end

data/lib/ezprint/processors/base.rb

@@ -0,0 +1,9 @@
+module Ezprint
+  module Processors
+    class Base
+      def self.process(html_string, options = {})
+        raise RuntimeError.new "Process is not implemented"
+      end
+    end
+  end
+end

data/lib/ezprint/processors/pdfkit.rb

@@ -0,0 +1,22 @@
+require 'pdfkit'
+
+module Ezprint
+  module Processors
+    class Pdfkit < Base
+      def self.process(html_string, options = {})
+        stylesheets = options.delete(:stylesheets)
+        kit = PDFKit.new(self.process_html(html_string), options)
+        kit.stylesheets = stylesheets
+        kit.to_pdf
+      end
+
+      def self.process_html(html)
+        # reroute absolute paths
+        html.gsub!("src=\"/", "src=\"#{RAILS_ROOT}/public/")
+        html.gsub!("href=\"/", "src=\"#{RAILS_ROOT}/public/")
+        html.gsub!("url(/", "url(#{RAILS_ROOT}/public/")
+        html
+      end
+    end
+  end
+end

data/lib/ezprint/processors/prince.rb

@@ -0,0 +1,35 @@
+module Ezprint
+  module Processors
+    class Prince < Base
+      def self.process(html_string, options = {})
+        pdf = IO.popen(self.cmd(options), "w+")
+        pdf.puts(self.process_html(html_string))
+        pdf.close_write
+        result = pdf.gets(nil)
+        pdf.close_read
+        result
+      end
+
+      def self.cmd(options)
+        stylesheets           = options.delete(:stylesheets)
+        prince_cmd            = `which prince`.chomp
+
+        if prince_cmd.length == 0
+          raise RuntimeError.new "Cannot locate prince binary. Please check your path"
+        end
+
+        prince_cmd << " --input=html --server "
+        stylesheets.each { |s| prince_cmd << " -s #{s} " }
+        prince_cmd << " --silent - -o -"
+      end
+
+      def self.process_html(html)
+        # reroute absolute paths
+        html.gsub!("src=\"/", "src=\"#{RAILS_ROOT}/public/")
+        html.gsub!("href=\"/", "src=\"#{RAILS_ROOT}/public/")
+        html.gsub!("url(/", "url(#{RAILS_ROOT}/public/")
+        html
+      end
+    end
+  end
+end

data/lib/ezprint/railtie.rb

@@ -1,8 +1,7 @@
 require 'action_controller/base'
 require 'action_dispatch/http/mime_types'
-require 'ezprint/pdf_helper'
 
-module EzPrint
+module Ezprint
   class Railtie < Rails::Railtie
 
     initializer :init_mime_types do
@@ -11,7 +10,7 @@ module EzPrint
 
     initializer :insert_into_action_controller do
       ActiveSupport.on_load :action_controller  do
-        ActionController::Base.send(:include, EzPrint::PdfHelper)
+        ActionController::Base.send(:include, Ezprint::PdfHelper)
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ezprint
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
+  hash: 17
+  prerelease: 
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jason Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 -05:00
+date: 2011-05-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,14 +24,14 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 11
         segments: 
         - 0
-        - 4
-        - 1
-        version: 0.4.1
+        - 5
+        - 0
+        version: 0.5.0
   type: :runtime
   version_requirements: *id001
 description: A Rails wrapper for the PDFkit library. Meant to be a drop in replacement for princely.
@@ -54,6 +54,9 @@ files:
 - init.rb
 - lib/ezprint.rb
 - lib/ezprint/pdf_helper.rb
+- lib/ezprint/processors/base.rb
+- lib/ezprint/processors/pdfkit.rb
+- lib/ezprint/processors/prince.rb
 - lib/ezprint/railtie.rb
 has_rdoc: true
 homepage: http://github.com/jstewart/ezprint
@@ -85,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: A Rails wrapper for the PDFkit library. Meant to be a drop in replacement for princely.