zpdf 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fee29fbf4f292dfd6cb941b4e43828f3d3b51c2b
+  data.tar.gz: 808775939cf8169b55e3f6bdb07e142013cf2d07
+SHA512:
+  metadata.gz: db3a7d94cb6aaab4245e79ae722fad5f3dcfb0cfad67549ee77755fbe828934a99acff277770ec4794539b63c096f9664d1df8b56c6311b0a2e991475b49b925
+  data.tar.gz: d94ee994533ad5c914ca920d6f0bf5c56fed947fbb6358d9fe78f570baac9f45677905c39bba648b2348dbdc5185adefd33aadb5974475dca63e33aa4b217d12

data/lib/z_pdf/base.rb

@@ -0,0 +1,132 @@
+require 'z_pdf/html_pdf_object'
+require 'z_pdf/z_pdf_helper'
+
+module ZPdf #:nodoc:
+  #
+  # Example:
+  #
+  #  class PdfInvoice < ZPdf::Base
+  #
+  #    def invoice(client)
+  #      @client = client
+  #      generate( :pdf_params => { 'page-size'  => 'Letter', 'margin-top' => 4, 'margin-bottom' => 9.5, 'outline' => true } )
+  #    end
+  #
+  #
+  class RenderError < StandardError
+  end
+
+  class MissingTemplate < RenderError
+    def initialize(generator_class,view_paths,part_name,templates_path,template_name)
+      paths = view_paths.compact.map{ |p| p.to_s.inspect }.join(", ")
+      super("Missing #{part_name} template \"#{template_name}\" in \"#{templates_path}\" for #{generator_class.name} with view_paths: #{paths}")
+    end
+  end
+
+  class Base < AbstractController::Base
+    abstract!
+
+    include AbstractController::Rendering
+    include AbstractController::Layouts
+    include AbstractController::Helpers
+    include AbstractController::Translation
+    include AbstractController::AssetPaths
+    include AbstractController::Logger
+
+    helper ZPdf::PdfHelper
+
+    private_class_method :new #:nodoc:
+
+    class_attribute :default_params
+    self.default_params = {
+      :header_template => nil,
+      :footer_template => nil
+    }.freeze
+
+    class_attribute :default_pdf_params
+    self.default_pdf_params = { 'outline' => true }.freeze
+
+    config_accessor :pdf_views_path, :wkhtmltopdf_path
+
+    class << self
+
+      def generator_name
+        @generator_name ||= name.underscore
+      end
+      attr_writer :generator_name
+      alias :controller_path :generator_name
+
+      def default(value = nil)
+        self.default_params = default_params.merge(value).freeze if value
+        default_params
+      end
+
+      def default_pdf(value = nil)
+        self.default_pdf_params = default_pdf_params.merge(value).freeze if value
+        default_pdf_params
+      end
+
+      def respond_to?(method, *args)
+        super || action_methods.include?(method.to_s)
+      end
+
+    protected
+
+      def method_missing(method, *args) #:nodoc:
+        if action_methods.include?(method.to_s)
+          new(method, *args).html_pdf
+        else
+          super
+        end
+      end
+
+    end # class << self
+
+    attr_internal :html_pdf
+
+    def initialize(method_name, *args)
+      super()
+      process(method_name, *args)
+    end
+
+    def process(*args) #:nodoc:
+      lookup_context.skip_default_locale!
+      super
+    end
+
+    def generate(parameters={})
+      render_html(parameters)
+    end
+
+  protected
+
+    def render_html(parameters={})
+      params = parameters.reverse_merge(self.class.default)
+      html_parts = render_html_parts(params)
+      pdf_params = (parameters[:pdf_params] || {}).reverse_merge(self.class.default_pdf)
+      @_html_pdf = HtmlPdfObject.new(html_parts,pdf_params)
+    end
+
+    def render_html_parts(params) #:nodoc:
+      parts = {}
+
+      # TODO : support inline content
+      templates_path = params.delete(:template_path) || self.class.generator_name
+      template_names = { :content => params.delete(:template_name) || action_name,
+                         :header  => params.delete(:header_template),
+                         :footer  => params.delete(:footer_template) }
+      template_names.each_pair do |part_name,template_name|
+        unless template_name.nil?
+          if template = lookup_context.find_all(template_name,templates_path).first
+            parts[part_name] = render(:template => template)
+          else
+            raise MissingTemplate.new(self.class,lookup_context.view_paths,part_name,templates_path,template_name)
+          end
+        end
+      end
+      parts
+    end
+
+    ActiveSupport.run_load_hooks(:zpdf, self)
+  end
+end

data/lib/z_pdf/generators/controller_module/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates a module named PdfControllerMethods in lib/pdf_controller_module.rb 
+
+    The module can then be included in controller classes to provide methods
+    to send PDF content.
+
+Example:
+    `rails generate z_pdf:controller_module`
+

data/lib/z_pdf/generators/controller_module/controller_module.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/base'
+
+module ZPdf
+  module Generators
+    class ControllerModuleGenerator < Rails::Generators::Base
+      source_root File.join(File.dirname(__FILE__),'templates')
+
+      def create_controller_module
+        template "controller_module_template.rb", 'lib/pdf_controller_methods.rb'
+      end
+    end
+  end
+end

data/lib/z_pdf/generators/controller_module/templates/controller_module_template.rb

@@ -0,0 +1,57 @@
+require 'iconv'
+
+# USAGE:
+#  This module provides basic methods to send PDF content. Simply include this module
+#  in your controller(s):
+#
+#  class InvoiceController < ApplicationController
+#     include PdfControllerMethods
+#     ....
+
+#      def show
+#         ...
+#         respond_to do |format|
+#           ....
+#           format.pdf {
+#             send_pdf_content(InvoiceGenerator.invoice(@invoice).pdf_content,
+#                             :file_name => 'invoice.pdf', :force_download => true)
+#           }
+#           ....
+#         end
+#      end
+#  end
+#
+
+module PdfControllerMethods
+
+#  uncomment and implement if you want to add custom functionality when this module is
+#  included.
+#  def self.included(base)
+#    base.class_eval <<-EOV
+#      def do_something_when_pdf_controller_methods_are_included
+#      end
+#    EOV
+#  end
+
+  protected
+  # convert a file name to ISO-8859-1, so that all browsers correctly parse it.
+  def sanitize_file_name(name)
+     c = Iconv.new('ISO-8859-15','UTF-8')
+     s = c.iconv(name.gsub(/[—–]/,'-'))
+     s.gsub!(/^.*(\\|\/)/, '')
+     s.gsub(/[\:\*\?\"\<\>\|]/, '_')
+  end
+
+  def send_pdf_content(pdf_content,options = {})
+     force_download = options[:force_download] || false
+     file_name = options[:file_name] || self.class.name.underscore
+     # content type is 'iso-8859-1' because we want the header values (namely the filename) to
+     # be interpreted as such.
+     headers["Content-Type"] ||= 'application/pdf; charset=iso-8859-1'
+     if force_download
+       headers["Content-Disposition"] = "attachment; filename=\"#{sanitize_file_name(file_name)}\""
+     end
+     render :text => pdf_content, :layout => false
+  end
+
+end

data/lib/z_pdf/generators/producers/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Stubs out a new PDF producer and its views. Pass the producer name, either
+    CamelCased or under_scored, and an optional list of document names as arguments.
+
+    This generates a producer class in app/pdf_producers and invokes your template
+    engine and test framework generators.
+
+Example:
+    `rails generate z_pdf:producer Forms invoice receipt`
+
+    creates a Forms producer class and views:
+        PDF Producer:   app/pdf_producers/forms.rb
+        Views:          app/views/forms/invoice.erb
+                        app/views/forms/receipt.erb

data/lib/z_pdf/generators/producers/producer.rb

@@ -0,0 +1,34 @@
+require 'rails/generators/base'
+require 'rails/generators/erb'
+
+module ZPdf
+  module Generators
+    class ProducerGenerator < Erb::Generators::Base
+      source_root File.join(File.dirname(__FILE__),'templates')
+
+      argument :actions, :type => :array, :default => [], :banner => "method method"
+
+      def create_renderer_file
+        template "producer_template.rb", File.join('app/pdf_producers', class_path, "#{file_name}.rb")
+      end
+
+      def create_view_files
+        rails_root = Rails.root.to_s + "/"
+        config = Rails.application.config
+        paths  = Rails.application.paths
+        pdf_views_path = ( (config.zpdf ? config.zpdf.pdf_views_path : nil) || paths.app.views.to_a.first).gsub(rails_root,'')
+
+        base_path = File.join(pdf_views_path,class_path,file_name)
+        empty_directory base_path
+        actions.each do |a|
+          @action = a
+          ['','_header','_footer'].each do |view_name|
+            @path = File.join(base_path,filename_with_extensions("#{a}#{view_name}"))
+            template "view_template#{view_name}.html.erb", @path
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/z_pdf/generators/producers/templates/producer_template.rb

@@ -0,0 +1,11 @@
+class <%= class_name %> < ZPdf::Base
+  default_pdf 'outline' => true, 'page-size' => 'Letter'
+<% for action in actions -%>
+
+  def <%= action %>
+    generate :header_template => "<%= action %>_header",
+             :footer_template => "<%= action %>_footer",
+             :pdf_params => { 'margin-top' => 4, 'margin-bottom' => 4 }
+  end
+<% end -%>
+end

data/lib/z_pdf/generators/producers/templates/view_template.html.erb

@@ -0,0 +1,9 @@
+<html>
+  <style>
+    body { margin-top: 1.5em; }
+  </style>
+<body>
+  <h1><%= class_name %>#<%= @action %></h1>
+  <p>Find me in <%= @path %></p>
+</body>
+</html>

data/lib/z_pdf/generators/producers/templates/view_template_footer.html.erb

@@ -0,0 +1,5 @@
+<html>
+<body>
+  <p>Footer for <%= class_name %>#<%= @action %> (Find me in <%= @path %>)</p>
+</body>
+</html>

data/lib/z_pdf/generators/producers/templates/view_template_header.html.erb

@@ -0,0 +1,5 @@
+<html>
+<body>
+  <p>Header for <%= class_name %>#<%= @action %> (Find me in <%= @path %>)</p>
+</body>
+</html>

data/lib/z_pdf/html_pdf_object.rb

@@ -0,0 +1,121 @@
+require 'thread'
+require 'iconv'
+
+module ZPdf
+
+   class HtmlPdfObject
+
+     attr_reader :html_parts
+     attr_reader :pdf_content
+
+     def self.wkhtmltopdf_path
+       @@wkhtmltopdf_path ||= get_wkhtmltopdf_path
+     end
+
+     def self.get_wkhtmltopdf_path
+       ZPdf::Base.wkhtmltopdf_path || find_wkhtmltopdf_executable # will try to call it anyway, if it is on the path
+     end
+
+     def initialize(html_parts = {},params = {})
+       @html_parts = html_parts
+       @params = params
+       @verbose = params.delete('verbose')
+     end
+
+     def html_parts=(value)
+       @html_parts = value
+     end
+
+     def pdf_content
+       @pdf_content ||= convert_to_pdf
+     end
+
+     def save_to_file(filename)
+       File.open(filename,'wb') { |f| f.write(pdf_content) }
+     end
+
+    protected
+
+    def convert_to_pdf
+      wk_params = @params.dup
+      html_files = { :header  => make_temp_file_with_content(@html_parts[:header]),
+                     :footer  => make_temp_file_with_content(@html_parts[:footer]),
+                     :content => make_temp_file_with_content(@html_parts[:content]) }
+      begin
+        outfile_path = html_files[:content].path + '.pdf' # append correct extension to temp file name
+        wk_params['header-html'] = html_files[:header].nil? ? nil : "file:///#{html_files[:header].path}"
+        wk_params['footer-html'] = html_files[:footer].nil? ? nil : "file:///#{html_files[:footer].path}"
+        wk_params['quiet']       = true
+
+        cmd = "#{self.class.wkhtmltopdf_path}"
+        wk_params.each_pair do |k,v|
+          next if v.nil? || v === false
+          cmd << (v == true ? " --#{k}" : " --#{k} #{v}")
+        end
+
+        cmd << " file:///#{html_files[:content].path} #{outfile_path}"
+        puts "\n\nexecuting #{cmd}\n\n" if @verbose
+        # avoid errors on systems where command processor is not UTF-8
+       `#{Iconv.new('ISO-8859-1//TRANSLIT','UTF-8').iconv(cmd)}`
+        if File.exists?(outfile_path)
+          output = File.open(outfile_path,'rb') { |f| f.read }
+          File.unlink(outfile_path)
+        else
+          raise ZPdf::RenderError.new("Error running wkhtmltopdf: #{cmd}")
+        end
+      ensure
+        html_files.each_pair do |k,v|
+          File.unlink(v.path)  if v && File.exists?(v.path) # make sure we delete our temporary files!
+        end
+      end
+      output
+    end
+
+    # return an instance of File with a unique name, suitable for writing
+    def create_temp_file(basename = '__pdf.html.object',ext = 'html',tmpdir = Dir::tmpdir,mode = 'wb')
+      @@_temp_file_mutex ||= Mutex.new
+
+       failures = n = 0
+       begin
+         @@_temp_file_mutex.lock
+         begin
+           tmpname = File.join(tmpdir, sprintf('%s.%d.%d.%s', basename, $$, n, ext))
+           n += 1
+         end while File.exists?(tmpname)
+         return File.open(tmpname,mode)
+       rescue
+         failures += 1
+         retry if failures < 10
+         raise ZPdf::RenderError.new("ZPdf::HtmlPdfObject cannot create temp file")
+       ensure
+         @@_temp_file_mutex.unlock
+       end
+    end
+
+    def make_temp_file_with_content(content)
+      unless content.nil? || content.to_s.empty?
+        f = create_temp_file
+        f.write(content)
+        f.flush
+        f.close
+        f
+      end
+    end
+
+    def self.find_wkhtmltopdf_executable
+      rbCfg = defined?(RbConfig) ?  RbConfig : Config
+      if rbCfg::CONFIG['host_os'] =~ /mswin|mingw/ # windows?
+        ENV['PATH'].split(';').each do |p|
+          exec_path = File.join(p,'wkhtmltopdf.exe')
+          return exec_path if File.exists?(exec_path)
+        end
+        return 'wkhtmltopdf.exe'
+      else # *nix
+        exec_path = `which wkhtmltopdf`.to_s.strip
+        return File.exists?(exec_path) ? exec_path : 'wkhtmltopdf'
+      end
+    end
+
+   end
+
+end

data/lib/z_pdf/railtie.rb

@@ -0,0 +1,32 @@
+require "zpdf"
+require "rails"
+
+module ZPdf
+  class Railtie < Rails::Railtie
+    config.zpdf = ActiveSupport::OrderedOptions.new
+    
+    initializer "zpdf.set_configs" do |app|
+      paths   = app.config.paths
+      options = app.config.zpdf
+      
+      options.assets_dir      ||= paths.public.to_a.first
+      options.javascripts_dir ||= paths.public.javascripts.to_a.first
+      options.stylesheets_dir ||= paths.public.stylesheets.to_a.first
+
+      # by default, the views path for ZPdf::Base is the same as other views
+      pdf_views_path = options.pdf_views_path || paths.app.views.to_a.first
+
+      ActiveSupport.on_load(:zpdf) do
+        include app.routes.url_helpers
+        prepend_view_path pdf_views_path
+        options.each { |k,v| send("#{k}=", v) }
+      end
+    end
+    
+    generators do
+      load File.expand_path('./generators/producers/producer.rb',File.dirname(__FILE__))
+      load File.expand_path('./generators/controller_module/controller_module.rb',File.dirname(__FILE__))
+    end
+    
+  end
+end

data/lib/z_pdf/version.rb

@@ -0,0 +1,9 @@
+module ZPdf
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/z_pdf/z_pdf_helper.rb

@@ -0,0 +1,5 @@
+module ZPdf
+  module PdfHelper
+  
+  end
+end

data/lib/zpdf.rb

@@ -0,0 +1,25 @@
+zpdf_path = File.expand_path(File.dirname(__FILE__))
+$:.unshift(zpdf_path) if File.directory?(zpdf_path) && !$:.include?(zpdf_path)
+
+require 'rails'
+require 'active_support/core_ext/module/attr_internal'
+require 'active_support/lazy_load_hooks'
+require 'abstract_controller'
+require 'action_view'
+require 'z_pdf/version'
+require 'z_pdf/railtie'
+
+module ZPdf
+  extend ::ActiveSupport::Autoload
+
+#  autoload :AdvAttrAccessor
+#  autoload :Collector
+  autoload :Base
+#  autoload :DeliveryMethods
+#  autoload :DeprecatedApi
+#  autoload :MailHelper
+#  autoload :OldApi
+#  autoload :TestCase
+#  autoload :TestHelper
+end
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: zpdf
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Charles Bedard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: 
+email: charles@cbedard.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/z_pdf/base.rb
+- lib/z_pdf/generators/controller_module/controller_module.rb
+- lib/z_pdf/generators/controller_module/templates/controller_module_template.rb
+- lib/z_pdf/generators/controller_module/USAGE
+- lib/z_pdf/generators/producers/producer.rb
+- lib/z_pdf/generators/producers/templates/producer_template.rb
+- lib/z_pdf/generators/producers/templates/view_template.html.erb
+- lib/z_pdf/generators/producers/templates/view_template_footer.html.erb
+- lib/z_pdf/generators/producers/templates/view_template_header.html.erb
+- lib/z_pdf/generators/producers/USAGE
+- lib/z_pdf/html_pdf_object.rb
+- lib/z_pdf/railtie.rb
+- lib/z_pdf/version.rb
+- lib/z_pdf/z_pdf_helper.rb
+- lib/zpdf.rb
+homepage: http://github.com/schmlblk/zpdf
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: HTML-based PDF rendering engine (using wkhtmltopdf)
+test_files: []