wicked_pdf 0.11.0 → 1.0.0

data/lib/wicked_pdf/middleware.rb

@@ -26,11 +26,11 @@ class WickedPdf
         headers.delete('ETag')
         headers.delete('Cache-Control')
 
-        headers["Content-Length"]         = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
-        headers["Content-Type"]           = "application/pdf"
+        headers['Content-Length']         = (body.respond_to?(:bytesize) ? body.bytesize : body.size).to_s
+        headers['Content-Type']           = 'application/pdf'
         if @options.fetch(:disposition, '') == 'attachment'
-          headers["Content-Disposition"]       = 'attachment'
-          headers["Content-Transfer-Encoding"] = 'binary'
+          headers['Content-Disposition']       = 'attachment'
+          headers['Content-Transfer-Encoding'] = 'binary'
         end
       end
 
@@ -81,10 +81,9 @@ class WickedPdf
 
     def set_request_to_render_as_pdf(env)
       @render_pdf = true
-      path = @request.path.sub(%r{\.pdf$}, '')
-      %w[PATH_INFO REQUEST_URI].each { |e| env[e] = path }
+      %w(PATH_INFO REQUEST_URI).each { |e| env[e] = env[e].sub(%r{\.pdf\b}, '') }
       env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type('.html'))
-      env["Rack-Middleware-WickedPdf"] = "true"
+      env['Rack-Middleware-WickedPdf'] = 'true'
     end
 
     def concat(accepts, type)

data/lib/wicked_pdf/pdf_helper.rb

@@ -15,7 +15,7 @@ module PdfHelper
   end
 
   def render_with_wicked_pdf(options = nil, *args, &block)
-    if options.is_a?(Hash) && options.has_key?(:pdf)
+    if options.is_a?(Hash) && options.key?(:pdf)
       log_pdf_creation
       options[:basic_auth] = set_basic_auth(options)
       make_and_send_pdf(options.delete(:pdf), (WickedPdf.config || {}).merge(options))
@@ -25,7 +25,7 @@ module PdfHelper
   end
 
   def render_to_string_with_wicked_pdf(options = nil, *args, &block)
-    if options.is_a?(Hash) && options.has_key?(:pdf)
+    if options.is_a?(Hash) && options.key?(:pdf)
       log_pdf_creation
       options[:basic_auth] = set_basic_auth(options)
       options.delete :pdf
@@ -37,66 +37,66 @@ module PdfHelper
 
   private
 
-    def log_pdf_creation
-      logger.info '*'*15 + 'WICKED' + '*'*15 unless logger.nil?
-    end
+  def log_pdf_creation
+    logger.info '*' * 15 + 'WICKED' + '*' * 15 unless logger.nil?
+  end
 
-    def set_basic_auth(options={})
-      options[:basic_auth] ||= WickedPdf.config.fetch(:basic_auth){ false }
-      if options[:basic_auth] && request.env["HTTP_AUTHORIZATION"]
-        request.env["HTTP_AUTHORIZATION"].split(" ").last
-      end
+  def set_basic_auth(options = {})
+    options[:basic_auth] ||= WickedPdf.config.fetch(:basic_auth) { false }
+    if options[:basic_auth] && request.env['HTTP_AUTHORIZATION']
+      request.env['HTTP_AUTHORIZATION'].split(' ').last
     end
+  end
 
-    def clean_temp_files
-      if defined?(@hf_tempfiles)
-        @hf_tempfiles.each { |tf| tf.close! }
-      end
+  def clean_temp_files
+    if defined?(@hf_tempfiles)
+      @hf_tempfiles.each { |tf| tf.close! }
     end
+  end
+
+  def make_pdf(options = {})
+    render_opts = { :template => options[:template], :layout => options[:layout], :formats => options[:formats], :handlers => options[:handlers] }
+    render_opts.merge!(:locals => options[:locals]) if options[:locals]
+    render_opts.merge!(:file => options[:file]) if options[:file]
+    html_string = render_to_string(render_opts)
+    options = prerender_header_and_footer(options)
+    w = WickedPdf.new(options[:wkhtmltopdf])
+    w.pdf_from_string(html_string, options)
+  end
 
-    def make_pdf(options = {})
-      render_opts = {:template => options[:template], :layout => options[:layout], :formats => options[:formats], :handlers => options[:handlers]}
+  def make_and_send_pdf(pdf_name, options = {})
+    options[:wkhtmltopdf] ||= nil
+    options[:layout]      ||= false
+    options[:template]    ||= File.join(controller_path, action_name)
+    options[:disposition] ||= 'inline'
+    if options[:show_as_html]
+      render_opts = { :template => options[:template], :layout => options[:layout], :formats => options[:formats], :handlers => options[:handlers], :content_type => 'text/html' }
       render_opts.merge!(:locals => options[:locals]) if options[:locals]
       render_opts.merge!(:file => options[:file]) if options[:file]
-      html_string = render_to_string(render_opts)
-      options = prerender_header_and_footer(options)
-      w = WickedPdf.new(options[:wkhtmltopdf])
-      w.pdf_from_string(html_string, options)
-    end
-
-    def make_and_send_pdf(pdf_name, options={})
-      options[:wkhtmltopdf] ||= nil
-      options[:layout]      ||= false
-      options[:template]    ||= File.join(controller_path, action_name)
-      options[:disposition] ||= "inline"
-      if options[:show_as_html]
-        render_opts = {:template => options[:template], :layout => options[:layout], :formats => options[:formats], :handlers => options[:handlers], :content_type => "text/html"}
-        render_opts.merge!(:locals => options[:locals]) if options[:locals]
-        render_opts.merge!(:file => options[:file]) if options[:file]
-        render(render_opts)
-      else
-        pdf_content = make_pdf(options)
-        File.open(options[:save_to_file], 'wb') {|file| file << pdf_content } if options[:save_to_file]
-        send_data(pdf_content, :filename => pdf_name + '.pdf', :type => 'application/pdf', :disposition => options[:disposition]) unless options[:save_only]
-      end
+      render(render_opts)
+    else
+      pdf_content = make_pdf(options)
+      File.open(options[:save_to_file], 'wb') { |file| file << pdf_content } if options[:save_to_file]
+      send_data(pdf_content, :filename => pdf_name + '.pdf', :type => 'application/pdf', :disposition => options[:disposition]) unless options[:save_only]
     end
+  end
 
-    # Given an options hash, prerenders content for the header and footer sections
-    # to temp files and return a new options hash including the URLs to these files.
-    def prerender_header_and_footer(options)
-      [:header, :footer].each do |hf|
-        if options[hf] && options[hf][:html] && options[hf][:html][:template]
-          @hf_tempfiles = [] if ! defined?(@hf_tempfiles)
-          @hf_tempfiles.push( tf=WickedPdfTempfile.new("wicked_#{hf}_pdf.html") )
-          options[hf][:html][:layout] ||=  options[:layout]
-          render_opts = {:template => options[hf][:html][:template], :layout => options[hf][:html][:layout], :formats => options[hf][:html][:formats], :handlers => options[hf][:html][:handlers]}
-          render_opts.merge!(:locals => options[hf][:html][:locals]) if options[hf][:html][:locals]
-          render_opts.merge!(:file => options[hf][:html][:file]) if options[:file]
-          tf.write render_to_string(render_opts)
-          tf.flush
-          options[hf][:html][:url] = "file:///#{tf.path}"
-        end
+  # Given an options hash, prerenders content for the header and footer sections
+  # to temp files and return a new options hash including the URLs to these files.
+  def prerender_header_and_footer(options)
+    [:header, :footer].each do |hf|
+      if options[hf] && options[hf][:html] && options[hf][:html][:template]
+        @hf_tempfiles = [] unless defined?(@hf_tempfiles)
+        @hf_tempfiles.push(tf = WickedPdfTempfile.new("wicked_#{hf}_pdf.html"))
+        options[hf][:html][:layout] ||=  options[:layout]
+        render_opts = { :template => options[hf][:html][:template], :layout => options[hf][:html][:layout], :formats => options[hf][:html][:formats], :handlers => options[hf][:html][:handlers] }
+        render_opts.merge!(:locals => options[hf][:html][:locals]) if options[hf][:html][:locals]
+        render_opts.merge!(:file => options[hf][:html][:file]) if options[:file]
+        tf.write render_to_string(render_opts)
+        tf.flush
+        options[hf][:html][:url] = "file:///#{tf.path}"
       end
-      options
     end
+    options
+  end
 end

data/lib/wicked_pdf/railtie.rb

@@ -3,41 +3,41 @@ require 'wicked_pdf/wicked_pdf_helper'
 
 if defined?(Rails)
 
-  if Rails::VERSION::MAJOR == 4
+  if Rails::VERSION::MAJOR == 3
 
     class WickedRailtie < Rails::Railtie
-      initializer "wicked_pdf.register" do |app|
+      initializer 'wicked_pdf.register' do |app|
         ActionController::Base.send :include, PdfHelper
-        ActionView::Base.send :include, WickedPdfHelper::Assets
+        if Rails::VERSION::MINOR > 0 && Rails.configuration.assets.enabled
+          ActionView::Base.send :include, WickedPdfHelper::Assets
+        else
+          ActionView::Base.send :include, WickedPdfHelper
+        end
       end
     end
 
   elsif Rails::VERSION::MAJOR == 2
 
-    unless ActionController::Base.instance_methods.include? "render_with_wicked_pdf"
+    unless ActionController::Base.instance_methods.include? 'render_with_wicked_pdf'
       ActionController::Base.send :include, PdfHelper
     end
-    unless ActionView::Base.instance_methods.include? "wicked_pdf_stylesheet_link_tag"
+    unless ActionView::Base.instance_methods.include? 'wicked_pdf_stylesheet_link_tag'
       ActionView::Base.send :include, WickedPdfHelper
     end
-    
+
   else
 
     class WickedRailtie < Rails::Railtie
-      initializer "wicked_pdf.register" do |app|
+      initializer 'wicked_pdf.register' do |app|
         ActionController::Base.send :include, PdfHelper
-        if Rails::VERSION::MINOR > 0 && Rails.configuration.assets.enabled
-          ActionView::Base.send :include, WickedPdfHelper::Assets
-        else
-          ActionView::Base.send :include, WickedPdfHelper
-        end
+        ActionView::Base.send :include, WickedPdfHelper::Assets
       end
     end
 
   end
-  
+
   if Mime::Type.lookup_by_extension(:pdf).nil?
     Mime::Type.register('application/pdf', :pdf)
   end
-  
+
 end

data/lib/wicked_pdf/tempfile.rb

@@ -2,10 +2,10 @@ require 'tempfile'
 
 class WickedPdfTempfile < Tempfile
   # ensures the Tempfile's filename always keeps its extension
-  def initialize(filename, temp_dir=nil)
+  def initialize(filename, temp_dir = nil)
     temp_dir  ||= Dir.tmpdir
     extension = File.extname(filename)
     basename  = File.basename(filename, extension)
     super([basename, extension], temp_dir)
   end
-end
+end

data/lib/wicked_pdf/version.rb

@@ -1,3 +1,3 @@
 class WickedPdf
-  VERSION = '0.11.0'
-end
+  VERSION = '1.0.0'
+end

data/lib/wicked_pdf/wicked_pdf_helper.rb

@@ -6,7 +6,7 @@ module WickedPdfHelper
   end
 
   def self.add_extension(filename, extension)
-    (File.extname(filename.to_s)[1..-1] == extension) ? filename : "#{filename}.#{extension}"
+    (filename.to_s.split(".").include?(extension) ? filename : "#{filename}.#{extension}")
   end
 
   def wicked_pdf_stylesheet_link_tag(*sources)
@@ -18,34 +18,44 @@ module WickedPdfHelper
     css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
   end
 
-  def wicked_pdf_image_tag(img, options={})
+  def wicked_pdf_image_tag(img, options = {})
     image_tag "file:///#{WickedPdfHelper.root_path.join('public', 'images', img)}", options
   end
 
-  def wicked_pdf_javascript_src_tag(jsfile, options={})
+  def wicked_pdf_javascript_src_tag(jsfile, options = {})
     jsfile = WickedPdfHelper.add_extension(jsfile, 'js')
     src = "file:///#{WickedPdfHelper.root_path.join('public', 'javascripts', jsfile)}"
-    content_tag("script", "", { "type" => Mime::JS, "src" => path_to_javascript(src) }.merge(options))
+    content_tag('script', '', { 'type' => Mime::JS, 'src' => path_to_javascript(src) }.merge(options))
   end
 
   def wicked_pdf_javascript_include_tag(*sources)
-    js_text = sources.collect{ |source| wicked_pdf_javascript_src_tag(source, {}) }.join("\n")
+    js_text = sources.collect { |source| wicked_pdf_javascript_src_tag(source, {}) }.join("\n")
     js_text.respond_to?(:html_safe) ? js_text.html_safe : js_text
   end
 
   module Assets
+    ASSET_URL_REGEX = /url\(['"]?([^'"]+?)['"]?\)/
+
     def wicked_pdf_stylesheet_link_tag(*sources)
-      sources.collect { |source|
+      stylesheet_contents = sources.collect do |source|
         source = WickedPdfHelper.add_extension(source, 'css')
         "<style type='text/css'>#{read_asset(source)}</style>"
-      }.join("\n").html_safe
+      end.join("\n")
+
+      stylesheet_contents.gsub(ASSET_URL_REGEX) do
+        if Regexp.last_match[1].starts_with?('data:')
+          "url(#{Regexp.last_match[1]})"
+        else
+          "url(#{wicked_pdf_asset_path(Regexp.last_match[1])})"
+        end
+      end.html_safe
     end
 
-    def wicked_pdf_image_tag(img, options={})
+    def wicked_pdf_image_tag(img, options = {})
       image_tag wicked_pdf_asset_path(img), options
     end
 
-    def wicked_pdf_javascript_src_tag(jsfile, options={})
+    def wicked_pdf_javascript_src_tag(jsfile, options = {})
       jsfile = WickedPdfHelper.add_extension(jsfile, 'js')
       javascript_include_tag wicked_pdf_asset_path(jsfile), options
     end
@@ -83,11 +93,16 @@ module WickedPdfHelper
       end
     end
 
-    #will prepend a http or default_protocol to a protocol realtive URL
+    # will prepend a http or default_protocol to a protocol relative URL
+    # or when no protcol is set.
     def set_protocol(source)
-      protocol = WickedPdf.config[:default_protocol] || "http"
-      source = [protocol, ":", source].join if source[0,2] == "//"
-      return source
+      protocol = WickedPdf.config[:default_protocol] || 'http'
+      if source[0, 2] == '//'
+        source = [protocol, ':', source].join
+      elsif source[0] != '/' && !source[0, 8].include?('://')
+        source = [protocol, '://', source].join
+      end
+      source
     end
 
     def precompiled_asset?(source)
@@ -95,7 +110,7 @@ module WickedPdfHelper
     end
 
     def read_asset(source)
-      if precompiled_asset?(source) 
+      if precompiled_asset?(source)
         if set_protocol(asset_path(source)) =~ URI_REGEXP
           read_from_uri(source)
         else
@@ -108,7 +123,7 @@ module WickedPdfHelper
 
     def read_from_uri(source)
       encoding = ':UTF-8' if RUBY_VERSION > '1.8'
-      asset = open(asset_pathname(source), "r#{encoding}") {|f| f.read }
+      asset = open(asset_pathname(source), "r#{encoding}") { |f| f.read }
       asset = gzip(asset) if WickedPdf.config[:expect_gzipped_remote_assets]
       asset
     end

data/test/functional/pdf_helper_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module ActionController
   class Base
-    def render_to_string opts={}
+    def render_to_string(opts = {})
       opts.to_s
     end
   end
@@ -14,13 +14,13 @@ class PdfHelperTest < ActionController::TestCase
   end
 
   def teardown
-    @ac=nil
+    @ac = nil
   end
 
   if Rails::VERSION::MAJOR == 2
-    test "should prerender header and footer :template options" do
-      options = @ac.send( :prerender_header_and_footer,
-                          :header => {:html => { :template => 'hf.html.erb'}});
+    test 'should prerender header and footer :template options' do
+      options = @ac.send(:prerender_header_and_footer,
+                         :header => { :html => { :template => 'hf.html.erb' } })
       assert_match /^file:\/\/\/.*wicked_header_pdf.*\.html/, options[:header][:html][:url]
     end
   end

data/test/functional/wicked_pdf_helper_assets_test.rb

@@ -5,25 +5,52 @@ class WickedPdfHelperAssetsTest < ActionView::TestCase
 
   include WickedPdfHelper::Assets
 
-  if Rails::VERSION::MAJOR == 4
-    test 'wicked_pdf_asset_path should return an url when assets are served by an asset server' do
+  if Rails::VERSION::MAJOR > 3 || (Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR > 0)
+    test 'wicked_pdf_asset_path should return a url when assets are served by an asset server' do
       expects(:asset_pathname => 'http://assets.domain.com/dummy.png')
       assert_equal 'http://assets.domain.com/dummy.png', wicked_pdf_asset_path('dummy.png')
     end
 
-    test 'wicked_pdf_asset_path should return an url with a protocol when assets are served by an asset server with relative urls' do
+    test 'wicked_pdf_asset_path should return a url when assets are served by an asset server using HTTPS' do
+      expects(:asset_path => 'https://assets.domain.com/dummy.png', 'precompiled_asset?' => true)
+      assert_equal 'https://assets.domain.com/dummy.png', wicked_pdf_asset_path('dummy.png')
+    end
+
+    test 'wicked_pdf_asset_path should return a url with a protocol when assets are served by an asset server with relative urls' do
       expects(:asset_path => '//assets.domain.com/dummy.png')
-      expects("precompiled_asset?" => true)
+      expects('precompiled_asset?' => true)
+      assert_equal 'http://assets.domain.com/dummy.png', wicked_pdf_asset_path('dummy.png')
+    end
+
+    test 'wicked_pdf_asset_path should return a url with a protocol when assets are served by an asset server with no protocol set' do
+      expects(:asset_path => 'assets.domain.com/dummy.png')
+      expects('precompiled_asset?' => true)
       assert_equal 'http://assets.domain.com/dummy.png', wicked_pdf_asset_path('dummy.png')
     end
 
     test 'wicked_pdf_asset_path should return a path when assets are precompiled' do
-      expects("precompiled_asset?" => false)
+      expects('precompiled_asset?' => false)
       path = wicked_pdf_asset_path('application.css')
 
-      assert path.include?("/assets/stylesheets/application.css")
-      assert path.include?("file://")
+      assert path.include?('/assets/stylesheets/application.css')
+      assert path.include?('file:///')
+    end
+
+    test 'WickedPdfHelper::Assets::ASSET_URL_REGEX should match various URL data type formats' do
+      assert_match WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url(\'/asset/stylesheets/application.css\');'
+      assert_match WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url("/asset/stylesheets/application.css");'
+      assert_match WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url(/asset/stylesheets/application.css);'
+      assert_match WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url(\'http://assets.domain.com/dummy.png\');'
+      assert_match WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url("http://assets.domain.com/dummy.png");'
+      assert_match WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url(http://assets.domain.com/dummy.png);'
+      assert_no_match WickedPdfHelper::Assets::ASSET_URL_REGEX, '.url { \'http://assets.domain.com/dummy.png\' }'
     end
-  end
 
+    test 'set_protocol should properly set the protocol when the asset is precompiled' do
+      assert_equal 'http://assets.domain.com/dummy.png', set_protocol('//assets.domain.com/dummy.png')
+      assert_equal '/assets.domain.com/dummy.png', set_protocol('/assets.domain.com/dummy.png')
+      assert_equal 'http://assets.domain.com/dummy.png', set_protocol('http://assets.domain.com/dummy.png')
+      assert_equal 'https://assets.domain.com/dummy.png', set_protocol('https://assets.domain.com/dummy.png')
+    end
+  end
 end

data/test/functional/wicked_pdf_helper_test.rb

@@ -9,12 +9,12 @@ class WickedPdfHelperTest < ActionView::TestCase
     end
 
     test 'wicked_pdf_image_tag should return the same as image_tag when passed a full path' do
-      assert_equal image_tag("file:///#{Rails.root.join('public','images','pdf')}"),
+      assert_equal image_tag("file:///#{Rails.root.join('public', 'images', 'pdf')}"),
                    wicked_pdf_image_tag('pdf')
     end
 
     test 'wicked_pdf_javascript_src_tag should return the same as javascript_src_tag when passed a full path' do
-      assert_equal javascript_src_tag("file:///#{Rails.root.join('public','javascripts','pdf')}", {}),
+      assert_equal javascript_src_tag("file:///#{Rails.root.join('public', 'javascripts', 'pdf')}", {}),
                    wicked_pdf_javascript_src_tag('pdf')
     end
 

data/test/test_helper.rb

@@ -1,13 +1,18 @@
 # Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'test/unit'
+require 'mocha'
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 if Rails::VERSION::MAJOR == 2
-  require "test_help"
+  require 'test_help'
 else
-  require "rails/test_help"
+  require 'rails/test_help'
+  require 'mocha/test_unit'
 end
 
-require "wicked_pdf"
+require 'wicked_pdf'
 
 Rails.backtrace_cleaner.remove_silencers!