wicked_pdf 1.0.6 → 1.1.0

data/lib/wicked_pdf/railtie.rb

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

data/lib/wicked_pdf/tempfile.rb

@@ -1,11 +1,13 @@
 require 'tempfile'
 
-class WickedPdfTempfile < Tempfile
-  # ensures the Tempfile's filename always keeps its extension
-  def initialize(filename, temp_dir = nil)
-    temp_dir ||= Dir.tmpdir
-    extension = File.extname(filename)
-    basename  = File.basename(filename, extension)
-    super([basename, extension], temp_dir)
+class WickedPdf
+  class WickedPdfTempfile < Tempfile
+    # ensures the Tempfile's filename always keeps its extension
+    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 = '1.0.6'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/wicked_pdf/wicked_pdf_helper.rb

@@ -1,33 +1,35 @@
-module WickedPdfHelper
-  def self.root_path
-    String === Rails.root ? Pathname.new(Rails.root) : Rails.root
-  end
+class WickedPdf
+  module WickedPdfHelper
+    def self.root_path
+      String === Rails.root ? Pathname.new(Rails.root) : Rails.root
+    end
 
-  def self.add_extension(filename, extension)
-    filename.to_s.split('.').include?(extension) ? filename : "#{filename}.#{extension}"
-  end
+    def self.add_extension(filename, extension)
+      filename.to_s.split('.').include?(extension) ? filename : "#{filename}.#{extension}"
+    end
 
-  def wicked_pdf_stylesheet_link_tag(*sources)
-    css_dir = WickedPdfHelper.root_path.join('public', 'stylesheets')
-    css_text = sources.collect do |source|
-      source = WickedPdfHelper.add_extension(source, 'css')
-      "<style type='text/css'>#{File.read(css_dir.join(source))}</style>"
-    end.join("\n")
-    css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
-  end
+    def wicked_pdf_stylesheet_link_tag(*sources)
+      css_dir = WickedPdfHelper.root_path.join('public', 'stylesheets')
+      css_text = sources.collect do |source|
+        source = WickedPdfHelper.add_extension(source, 'css')
+        "<style type='text/css'>#{File.read(css_dir.join(source))}</style>"
+      end.join("\n")
+      css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
+    end
 
-  def wicked_pdf_image_tag(img, options = {})
-    image_tag "file:///#{WickedPdfHelper.root_path.join('public', 'images', img)}", options
-  end
+    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 = {})
-    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))
-  end
+    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))
+    end
 
-  def wicked_pdf_javascript_include_tag(*sources)
-    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
+    def wicked_pdf_javascript_include_tag(*sources)
+      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
   end
 end

data/lib/wicked_pdf/wicked_pdf_helper/assets.rb

@@ -1,120 +1,130 @@
 require 'open-uri'
 
-module WickedPdfHelper
-  module Assets
-    ASSET_URL_REGEX = /url\(['"]?([^'"]+?)['"]?\)/
-
-    def wicked_pdf_asset_base64(path)
-      asset = Rails.application.assets.find_asset(path)
-      throw "Could not find asset '#{path}'" if asset.nil?
-      base64 = Base64.encode64(asset.to_s).gsub(/\s+/, '')
-      "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
-    end
-
-    def wicked_pdf_stylesheet_link_tag(*sources)
-      stylesheet_contents = sources.collect do |source|
-        source = WickedPdfHelper.add_extension(source, 'css')
-        "<style type='text/css'>#{read_asset(source)}</style>"
-      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
+class WickedPdf
+  module WickedPdfHelper
+    module Assets
+      ASSET_URL_REGEX = /url\(['"]?([^'"]+?)['"]?\)/
+
+      def wicked_pdf_asset_base64(path)
+        asset = find_asset(path)
+        raise "Could not find asset '#{path}'" if asset.nil?
+        base64 = Base64.encode64(asset.to_s).gsub(/\s+/, '')
+        "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
+      end
 
-    def wicked_pdf_image_tag(img, options = {})
-      image_tag wicked_pdf_asset_path(img), options
-    end
+      def wicked_pdf_stylesheet_link_tag(*sources)
+        stylesheet_contents = sources.collect do |source|
+          source = WickedPdfHelper.add_extension(source, 'css')
+          "<style type='text/css'>#{read_asset(source)}</style>"
+        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_javascript_src_tag(jsfile, options = {})
-      jsfile = WickedPdfHelper.add_extension(jsfile, 'js')
-      javascript_include_tag wicked_pdf_asset_path(jsfile), options
-    end
+      def wicked_pdf_image_tag(img, options = {})
+        image_tag wicked_pdf_asset_path(img), options
+      end
 
-    def wicked_pdf_javascript_include_tag(*sources)
-      sources.collect do |source|
-        source = WickedPdfHelper.add_extension(source, 'js')
-        "<script type='text/javascript'>#{read_asset(source)}</script>"
-      end.join("\n").html_safe
-    end
+      def wicked_pdf_javascript_src_tag(jsfile, options = {})
+        jsfile = WickedPdfHelper.add_extension(jsfile, 'js')
+        javascript_include_tag wicked_pdf_asset_path(jsfile), options
+      end
 
-    def wicked_pdf_asset_path(asset)
-      if (pathname = asset_pathname(asset).to_s) =~ URI_REGEXP
-        pathname
-      else
-        "file:///#{pathname}"
+      def wicked_pdf_javascript_include_tag(*sources)
+        sources.collect do |source|
+          source = WickedPdfHelper.add_extension(source, 'js')
+          "<script type='text/javascript'>#{read_asset(source)}</script>"
+        end.join("\n").html_safe
       end
-    end
 
-    private
+      def wicked_pdf_asset_path(asset)
+        if (pathname = asset_pathname(asset).to_s) =~ URI_REGEXP
+          pathname
+        else
+          "file:///#{pathname}"
+        end
+      end
 
-    # borrowed from actionpack/lib/action_view/helpers/asset_url_helper.rb
-    URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}
+      private
+
+      # borrowed from actionpack/lib/action_view/helpers/asset_url_helper.rb
+      URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}
+
+      def asset_pathname(source)
+        if precompiled_or_absolute_asset?(source)
+          asset = asset_path(source)
+          pathname = prepend_protocol(asset)
+          if pathname =~ URI_REGEXP
+            # asset_path returns an absolute URL using asset_host if asset_host is set
+            pathname
+          else
+            File.join(Rails.public_path, asset.sub(/\A#{Rails.application.config.action_controller.relative_url_root}/, ''))
+          end
+        else
+          asset = find_asset(source)
+          asset ? asset.pathname : File.join(Rails.public_path, source)
+        end
+      end
 
-    def asset_pathname(source)
-      if precompiled_or_absolute_asset?(source)
-        asset = asset_path(source)
-        pathname = prepend_protocol(asset)
-        if pathname =~ URI_REGEXP
-          # asset_path returns an absolute URL using asset_host if asset_host is set
-          pathname
+      def find_asset(path)
+        if Rails.application.assets.respond_to?(:find_asset)
+          Rails.application.assets.find_asset(path)
         else
-          File.join(Rails.public_path, asset.sub(/\A#{Rails.application.config.action_controller.relative_url_root}/, ''))
+          Sprockets::Railtie.build_environment(Rails.application).find_asset(path)
         end
-      else
-        asset = Rails.application.assets.find_asset(source)
-        asset ? asset.pathname : File.join(Rails.public_path, source)
       end
-    end
 
-    # will prepend a http or default_protocol to a protocol relative URL
-    # or when no protcol is set.
-    def prepend_protocol(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
+      # will prepend a http or default_protocol to a protocol relative URL
+      # or when no protcol is set.
+      def prepend_protocol(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
-      source
-    end
 
-    def precompiled_or_absolute_asset?(source)
-      Rails.configuration.assets.compile == false ||
-        source.to_s[0] == '/' ||
-        source.to_s.match(/\Ahttps?\:\/\//)
-    end
+      def precompiled_or_absolute_asset?(source)
+        Rails.configuration.assets.compile == false ||
+          source.to_s[0] == '/' ||
+          source.to_s.match(/\Ahttps?\:\/\//)
+      end
 
-    def read_asset(source)
-      if precompiled_or_absolute_asset?(source)
-        pathname = asset_pathname(source)
-        if pathname =~ URI_REGEXP
-          read_from_uri(pathname)
-        elsif File.file?(pathname)
-          IO.read(pathname)
+      def read_asset(source)
+        if precompiled_or_absolute_asset?(source)
+          pathname = asset_pathname(source)
+          if pathname =~ URI_REGEXP
+            read_from_uri(pathname)
+          elsif File.file?(pathname)
+            IO.read(pathname)
+          end
+        else
+          find_asset(source).to_s
         end
-      else
-        Rails.application.assets.find_asset(source).to_s
       end
-    end
 
-    def read_from_uri(uri)
-      encoding = ':UTF-8' if RUBY_VERSION > '1.8'
-      asset = open(uri, "r#{encoding}", &:read)
-      asset = gzip(asset) if WickedPdf.config[:expect_gzipped_remote_assets]
-      asset
-    end
+      def read_from_uri(uri)
+        encoding = ':UTF-8' if RUBY_VERSION > '1.8'
+        asset = open(uri, "r#{encoding}", &:read)
+        asset = gzip(asset) if WickedPdf.config[:expect_gzipped_remote_assets]
+        asset
+      end
 
-    def gzip(asset)
-      stringified_asset = StringIO.new(asset)
-      gzipper = Zlib::GzipReader.new(stringified_asset)
-      gzipper.read
-    rescue Zlib::GzipFile::Error
-      nil
+      def gzip(asset)
+        stringified_asset = StringIO.new(asset)
+        gzipper = Zlib::GzipReader.new(stringified_asset)
+        gzipper.read
+      rescue Zlib::GzipFile::Error
+        nil
+      end
     end
   end
 end

data/test/fixtures/wicked.js

@@ -0,0 +1 @@
+// Wicked js

data/test/functional/pdf_helper_test.rb

@@ -17,11 +17,9 @@ class PdfHelperTest < ActionController::TestCase
     @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' } })
-      assert_match %r(^file:\/\/\/.*wicked_header_pdf.*\.html), options[:header][:html][:url]
-    end
+  test 'should prerender header and footer :template options' do
+    options = @ac.send(:prerender_header_and_footer,
+                       :header => { :html => { :template => 'hf.html.erb' } })
+    assert_match %r{^file:\/\/\/.*wicked_header_pdf.*\.html}, options[:header][:html][:url]
   end
 end

data/test/functional/wicked_pdf_helper_assets_test.rb

@@ -2,11 +2,29 @@ require 'test_helper'
 require 'action_view/test_case'
 
 class WickedPdfHelperAssetsTest < ActionView::TestCase
-  include WickedPdfHelper::Assets
+  include WickedPdf::WickedPdfHelper::Assets
 
   if Rails::VERSION::MAJOR > 3 || (Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR > 0)
     test 'wicked_pdf_asset_base64 returns a base64 encoded asset' do
-      assert_match %r(data:text\/css;base64,.+), wicked_pdf_asset_base64('wicked.css')
+      assert_match %r{data:text\/css;base64,.+}, wicked_pdf_asset_base64('wicked.css')
+    end
+
+    test 'wicked_pdf_stylesheet_link_tag should inline the stylesheets passed in' do
+      Rails.configuration.assets.expects(:compile => true)
+      assert_equal "<style type='text/css'>/* Wicked styles */\n\n</style>",
+                   wicked_pdf_stylesheet_link_tag('wicked')
+    end
+
+    test 'wicked_pdf_image_tag should return the same as image_tag when passed a full path' do
+      Rails.configuration.assets.expects(:compile => true)
+      assert_equal image_tag("file:///#{Rails.root.join('public', 'pdf')}"),
+                   wicked_pdf_image_tag('pdf')
+    end
+
+    test 'wicked_pdf_javascript_include_tag should inline the javascripts passed in' do
+      Rails.configuration.assets.expects(:compile => true)
+      assert_equal "<script type='text/javascript'>// Wicked js\n;\n</script>",
+                   wicked_pdf_javascript_include_tag('wicked')
     end
 
     test 'wicked_pdf_asset_path should return a url when assets are served by an asset server' do
@@ -86,13 +104,13 @@ class WickedPdfHelperAssetsTest < ActionView::TestCase
     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\' }'
+      assert_match WickedPdf::WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url(\'/asset/stylesheets/application.css\');'
+      assert_match WickedPdf::WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url("/asset/stylesheets/application.css");'
+      assert_match WickedPdf::WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url(/asset/stylesheets/application.css);'
+      assert_match WickedPdf::WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url(\'http://assets.domain.com/dummy.png\');'
+      assert_match WickedPdf::WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url("http://assets.domain.com/dummy.png");'
+      assert_match WickedPdf::WickedPdfHelper::Assets::ASSET_URL_REGEX, 'url(http://assets.domain.com/dummy.png);'
+      assert_no_match WickedPdf::WickedPdfHelper::Assets::ASSET_URL_REGEX, '.url { \'http://assets.domain.com/dummy.png\' }'
     end
 
     test 'prepend_protocol should properly set the protocol when the asset is precompiled' do