wicked_pdf 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 120e7e1b14e3e17ac6bc407dd6c7d27438543e87a979d684bab919440ebd7879
-  data.tar.gz: f9340f26589900f6f30c19f5631ca2104b48685b9ac102c3bdc2e9d168c0c847
+  metadata.gz: ad0741c1e5c8b253601a248d448f53fe359547238517a6340c7ac340f4bf2e15
+  data.tar.gz: 1da781d4aa577dd9afb1e90c734c1507d4458d85d7a381dc0f005582dcd064a5
 SHA512:
-  metadata.gz: f26972b5aa38ac4785ffddd283e787ec49361ae1891d66b8bfe92d3e9b196d4215a03cec3ffced97ec5269f0316f53f0a24374c26a1df255898a01241b85ce57
-  data.tar.gz: 0d00bcb4d776acb3a469dfb55e0994ca22eab620694b92f7433a4a93aa91a07653848bef7bd3eaff709d861fdf6bf1260cd8ad048be9e671f8f26d78f37d0300
+  metadata.gz: dd1a3651d3ad14d2c0c8515e81f9cc75bbe617633e956127f77e6d287a761402f5b8d1448641772bf7e69cb16fefd5b38547da9628df43fdb0e6623b11527e9d
+  data.tar.gz: f4d1cd6cd91e60f4874e4ad269056a5af32da101e0e03a54231d701958d304f14beacfa9b262559fb56c5375b6899046c8a23090afde226721613d4e0db4f118

data/CHANGELOG.md

@@ -1,9 +1,20 @@
 # Change Log
-All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
+All notable changes to this project should be documented in this file.
+This project attempts to adhere to [Semantic Versioning](http://semver.org/).
 
-## [master branch] - Unreleased
+## [[master branch] - Unreleased changes](https://github.com/mileszs/wicked_pdf/compare/2.8.0...HEAD)
 ### Breaking Changes
+### New Features
+### Fixes
+
+## [2.8.0]
+### New Features
+- [Add New config option `raise_on_missing_assets`](https://github.com/mileszs/wicked_pdf/pull/1094)
+- [Add support for truffleruby (22.1.0) on Linux](https://github.com/mileszs/wicked_pdf/pull/1028)
+
+### Fixes
+- [Fix Propshaft encoding issue](https://github.com/mileszs/wicked_pdf/pull/1096)
+- [Fix Webpacker & Shakapacker compatibility issue](https://github.com/mileszs/wicked_pdf/pull/1099)
 
 ## [2.7.0]
 ### New Features
@@ -231,13 +242,3 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Issues with `url()` references and embedded `data:base64` assets in stylesheets rendered with `wicked_pdf_stylesheet_link_tag`
 - Asset helpers no longer add a file extension if it already is specified with one
 
-# Compare Releases
-- [2.1.0...HEAD (unreleased changes)](https://github.com/mileszs/wicked_pdf/compare/2.1.0...HEAD)
-- [2.0.2...2.1.0](https://github.com/mileszs/wicked_pdf/compare/2.0.2...2.1.0)
-- [2.0.0...2.0.2](https://github.com/mileszs/wicked_pdf/compare/2.0.0...2.0.2)
-- [1.4.0...2.0.0](https://github.com/mileszs/wicked_pdf/compare/1.4.0...2.0.0)
-- [1.3.0...1.4.0](https://github.com/mileszs/wicked_pdf/compare/1.3.0...1.4.0)
-- [1.2.0...1.3.0](https://github.com/mileszs/wicked_pdf/compare/1.2.0...1.3.0)
-- [1.1.0...1.2.0](https://github.com/mileszs/wicked_pdf/compare/1.1.0...1.2.0)
-- [1.0.0...1.1.0](https://github.com/mileszs/wicked_pdf/compare/1.0.0...1.0.0)
-- [0.11.0...1.0.0](https://github.com/mileszs/wicked_pdf/compare/0.11.0...1.0.0)

data/README.md

@@ -42,9 +42,9 @@ You can see what flags are supported for the current version in [wkhtmltopdf's a
 If your wkhtmltopdf executable is not on your webserver's path, you can configure it in an initializer:
 
 ```ruby
-WickedPdf.config = {
-  exe_path: '/usr/local/bin/wkhtmltopdf',
-  enable_local_file_access: true
+WickedPdf.configure do |c|
+  c.exe_path = '/usr/local/bin/wkhtmltopdf',
+  c.enable_local_file_access = true
 }
 ```
 
@@ -201,6 +201,7 @@ class ThingsController < ApplicationController
                viewport_size:                  'TEXT',                    # available only with use_xserver or patched QT
                extra:                          '',                        # directly inserted into the command to wkhtmltopdf
                raise_on_all_errors:            nil,                       # raise error for any stderr output.  Such as missing media, image assets
+               raise_on_missing_assets:        nil,                       # raise when trying to access a missing asset
                log_level:                      'info',                    # Available values: none, error, warn, or info - only available with wkhtmltopdf 0.12.5+
                quiet:                          false,                     # `false` is same as `log_level: 'info'`, `true` is same as `log_level: 'none'`
                outline: {   outline:           true,

data/generators/wicked_pdf/templates/wicked_pdf.rb

@@ -8,23 +8,23 @@
 #
 # https://github.com/mileszs/wicked_pdf/blob/master/README.md
 
-WickedPdf.config = {
+WickedPdf.configure do |config|
   # Path to the wkhtmltopdf executable: This usually isn't needed if using
   # one of the wkhtmltopdf-binary family of gems.
-  # exe_path: '/usr/local/bin/wkhtmltopdf',
+  # config.exe_path = '/usr/local/bin/wkhtmltopdf',
   #   or
-  # exe_path: Gem.bin_path('wkhtmltopdf-binary', 'wkhtmltopdf')
+  # config.exe_path = Gem.bin_path('wkhtmltopdf-binary', 'wkhtmltopdf')
 
   # Needed for wkhtmltopdf 0.12.6+ to use many wicked_pdf asset helpers
-  # enable_local_file_access: true,
+  # config.enable_local_file_access = true,
 
   # Layout file to be used for all PDFs
   # (but can be overridden in `render :pdf` calls)
-  # layout: 'pdf.html',
+  # config.layout = 'pdf.html',
 
   # Using wkhtmltopdf without an X server can be achieved by enabling the
   # 'use_xvfb' flag. This will wrap all wkhtmltopdf commands around the
   # 'xvfb-run' command, in order to simulate an X server.
   #
-  # use_xvfb: true,
-}
+  # config.use_xvfb = true,
+end

data/lib/wicked_pdf/progress.rb

@@ -1,10 +1,10 @@
 class WickedPdf
   module Progress
-    require 'pty' if RbConfig::CONFIG['target_os'] !~ /mswin|mingw/ # no support for windows
+    require 'pty' if RbConfig::CONFIG['target_os'] !~ /mswin|mingw/ && RUBY_ENGINE != 'truffleruby' # no support for windows and truffleruby
     require 'English'
 
     def track_progress?(options)
-      options[:progress] && !on_windows?
+      options[:progress] && !(on_windows? || RUBY_ENGINE == 'truffleruby')
     end
 
     def invoke_with_progress(command, options)

data/lib/wicked_pdf/version.rb

@@ -1,3 +1,3 @@
 class WickedPdf
-  VERSION = '2.7.0'.freeze
+  VERSION = '2.8.0'.freeze
 end

data/lib/wicked_pdf/wicked_pdf_helper/assets.rb

@@ -7,6 +7,27 @@ class WickedPdf
     module Assets
       ASSET_URL_REGEX = /url\(['"]?([^'"]+?)['"]?\)/
 
+      class MissingAsset < StandardError; end
+
+      class MissingLocalAsset < MissingAsset
+        attr_reader :path
+
+        def initialize(path)
+          @path = path
+          super("Could not find asset '#{path}'")
+        end
+      end
+
+      class MissingRemoteAsset < MissingAsset
+        attr_reader :url, :response
+
+        def initialize(url, response)
+          @url = url
+          @response = response
+          super("Could not fetch asset '#{url}': server responded with #{response.code} #{response.message}")
+        end
+      end
+
       class PropshaftAsset < SimpleDelegator
         def content_type
           super.to_s
@@ -21,9 +42,39 @@ class WickedPdf
         end
       end
 
+      class SprocketsEnvironment
+        def self.instance
+          @instance ||= Sprockets::Railtie.build_environment(Rails.application)
+        end
+
+        def self.find_asset(*args)
+          instance.find_asset(*args)
+        end
+      end
+
+      class LocalAsset
+        attr_reader :path
+
+        def initialize(path)
+          @path = path
+        end
+
+        def content_type
+          Mime::Type.lookup_by_extension(File.extname(path).delete('.'))
+        end
+
+        def to_s
+          IO.read(path)
+        end
+
+        def filename
+          path.to_s
+        end
+      end
+
       def wicked_pdf_asset_base64(path)
         asset = find_asset(path)
-        raise "Could not find asset '#{path}'" if asset.nil?
+        raise MissingLocalAsset, path if asset.nil?
 
         base64 = Base64.encode64(asset.to_s).gsub(/\s+/, '')
         "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
@@ -150,8 +201,11 @@ class WickedPdf
           Rails.application.assets.find_asset(path, :base_path => Rails.application.root.to_s)
         elsif defined?(Propshaft::Assembly) && Rails.application.assets.is_a?(Propshaft::Assembly)
           PropshaftAsset.new(Rails.application.assets.load_path.find(path))
+        elsif Rails.application.respond_to?(:assets_manifest)
+          asset_path = File.join(Rails.application.assets_manifest.dir, Rails.application.assets_manifest.assets[path])
+          LocalAsset.new(asset_path) if File.file?(asset_path)
         else
-          Sprockets::Railtie.build_environment(Rails.application).find_asset(path, :base_path => Rails.application.root.to_s)
+          SprocketsEnvironment.find_asset(path, :base_path => Rails.application.root.to_s)
         end
       end
 
@@ -175,20 +229,35 @@ class WickedPdf
       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)
-          end
-        else
-          find_asset(source).to_s
+        asset = find_asset(source)
+        return asset.to_s.force_encoding('UTF-8') if asset
+
+        unless precompiled_or_absolute_asset?(source)
+          raise MissingLocalAsset, source if WickedPdf.config[:raise_on_missing_assets]
+
+          return
+        end
+
+        pathname = asset_pathname(source)
+        if pathname =~ URI_REGEXP
+          read_from_uri(pathname)
+        elsif File.file?(pathname)
+          IO.read(pathname)
+        elsif WickedPdf.config[:raise_on_missing_assets]
+          raise MissingLocalAsset, pathname if WickedPdf.config[:raise_on_missing_assets]
         end
       end
 
       def read_from_uri(uri)
-        asset = Net::HTTP.get(URI(uri))
+        response = Net::HTTP.get_response(URI(uri))
+
+        unless response.is_a?(Net::HTTPSuccess)
+          raise MissingRemoteAsset.new(uri, response) if WickedPdf.config[:raise_on_missing_assets]
+
+          return
+        end
+
+        asset = response.body
         asset.force_encoding('UTF-8') if asset
         asset = gzip(asset) if WickedPdf.config[:expect_gzipped_remote_assets]
         asset
@@ -232,8 +301,10 @@ class WickedPdf
 
       def webpacker_version
         if defined?(Shakapacker)
+          require 'shakapacker/version'
           Shakapacker::VERSION
         elsif defined?(Webpacker)
+          require 'webpacker/version'
           Webpacker::VERSION
         end
       end

data/lib/wicked_pdf.rb

@@ -20,10 +20,27 @@ require 'wicked_pdf/progress'
 class WickedPdf
   DEFAULT_BINARY_VERSION = Gem::Version.new('0.9.9')
   @@config = {}
-  cattr_accessor :config
+  cattr_accessor :config, :silence_deprecations
 
   include Progress
 
+  def self.config=(config)
+    ::Kernel.warn 'WickedPdf.config= is deprecated and will be removed in future versions. Use WickedPdf.configure instead.' unless @@silence_deprecations
+
+    @@config = config
+  end
+
+  def self.configure
+    config = OpenStruct.new(@@config)
+    yield config
+
+    @@config.merge! config.to_h
+  end
+
+  def self.clear_config
+    @@config = {}
+  end
+
   def initialize(wkhtmltopdf_binary_path = nil)
     @binary = Binary.new(wkhtmltopdf_binary_path, DEFAULT_BINARY_VERSION)
   end

data/test/functional/wicked_pdf_helper_assets_test.rb

@@ -4,6 +4,15 @@ require 'action_view/test_case'
 class WickedPdfHelperAssetsTest < ActionView::TestCase
   include WickedPdf::WickedPdfHelper::Assets
 
+  setup do
+    @saved_config = WickedPdf.config
+    WickedPdf.config = {}
+  end
+
+  teardown do
+    WickedPdf.config = @saved_config
+  end
+
   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')
@@ -15,6 +24,58 @@ class WickedPdfHelperAssetsTest < ActionView::TestCase
                    wicked_pdf_stylesheet_link_tag('wicked')
     end
 
+    test 'wicked_pdf_stylesheet_link_tag should raise if the stylesheet is not available and config is set' do
+      Rails.configuration.assets.expects(:compile => true)
+      WickedPdf.config[:raise_on_missing_assets] = true
+      assert_raise WickedPdf::WickedPdfHelper::Assets::MissingLocalAsset do
+        wicked_pdf_stylesheet_link_tag('non_existent')
+      end
+    end
+
+    test 'wicked_pdf_stylesheet_link_tag should return empty if the stylesheet is not available' do
+      Rails.configuration.assets.expects(:compile => true)
+      assert_equal "<style type='text/css'></style>",
+                   wicked_pdf_stylesheet_link_tag('non_existent')
+    end
+
+    test 'wicked_pdf_stylesheet_link_tag should raise if the absolute path stylesheet is not available and config is set' do
+      Rails.configuration.assets.expects(:compile => true)
+      WickedPdf.config[:raise_on_missing_assets] = true
+      expects(:precompiled_or_absolute_asset? => true).twice
+      assert_raise WickedPdf::WickedPdfHelper::Assets::MissingLocalAsset do
+        wicked_pdf_stylesheet_link_tag('/non_existent')
+      end
+    end
+
+    test 'wicked_pdf_stylesheet_link_tag should return empty if the absolute path stylesheet is not available' do
+      Rails.configuration.assets.expects(:compile => true).twice
+      assert_equal "<style type='text/css'></style>",
+                   wicked_pdf_stylesheet_link_tag('/non_existent')
+    end
+
+    test 'wicked_pdf_stylesheet_link_tag should inline the stylesheets passed in when assets are remote' do
+      stub_request(:get, 'https://www.example.com/wicked.css').to_return(:status => 200, :body => '/* Wicked styles */')
+      expects(:precompiled_or_absolute_asset? => true).twice
+      assert_equal "<style type='text/css'>/* Wicked styles */</style>",
+                   wicked_pdf_stylesheet_link_tag('https://www.example.com/wicked.css')
+    end
+
+    test 'wicked_pdf_stylesheet_link_tag should raise if remote assets are not available and config is set' do
+      WickedPdf.config[:raise_on_missing_assets] = true
+      stub_request(:get, 'https://www.example.com/wicked.css').to_return(:status => 404, :body => 'File not found')
+      expects(:precompiled_or_absolute_asset? => true).twice
+      assert_raise WickedPdf::WickedPdfHelper::Assets::MissingRemoteAsset do
+        wicked_pdf_stylesheet_link_tag('https://www.example.com/wicked.css')
+      end
+    end
+
+    test 'wicked_pdf_stylesheet_link_tag should return empty if remote assets are not available' do
+      stub_request(:get, 'https://www.example.com/wicked.css').to_return(:status => 404, :body => 'File not found')
+      expects(:precompiled_or_absolute_asset? => true).twice
+      assert_equal "<style type='text/css'></style>",
+                   wicked_pdf_stylesheet_link_tag('https://www.example.com/wicked.css')
+    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')}"),

data/test/test_helper.rb

@@ -7,10 +7,12 @@ require 'test/unit'
 require 'mocha'
 require 'rails/test_help'
 require 'mocha/test_unit'
+require 'webmock/minitest'
 
 require 'wicked_pdf'
 
 Rails.backtrace_cleaner.remove_silencers!
+WickedPdf.silence_deprecations = true
 
 if (assets_dir = Rails.root.join('app/assets')) && File.directory?(assets_dir)
   # Copy CSS file

data/test/unit/wicked_pdf_test.rb

@@ -7,6 +7,23 @@ class WickedPdfTest < ActiveSupport::TestCase
     @wp = WickedPdf.new
   end
 
+  test 'should update config through .configure class method' do
+    WickedPdf.configure do |c|
+      c.test = 'foobar'
+    end
+
+    assert WickedPdf.config == { :exe_path => ENV['WKHTMLTOPDF_BIN'] || '/usr/local/bin/wkhtmltopdf', :test => 'foobar' }
+  end
+
+  test 'should clear config through .clear_config class method' do
+    backup_config = WickedPdf.config
+
+    WickedPdf.clear_config
+    assert WickedPdf.config == {}
+
+    WickedPdf.config = backup_config
+  end
+
   test 'should generate PDF from html document' do
     pdf = @wp.pdf_from_string HTML_DOCUMENT
     assert pdf.start_with?('%PDF-1.4')

data/wicked_pdf.gemspec

@@ -37,4 +37,5 @@ DESC
   spec.add_development_dependency 'rubocop', '~> 1.46'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'webmock', '~> 3.19'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wicked_pdf
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Miles Z. Sterrett
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
 description: |
   Wicked PDF uses the shell utility wkhtmltopdf to serve a PDF file to a user from HTML.
   In other words, rather than dealing with a PDF generation DSL of some sort,
@@ -200,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - wkhtmltopdf
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: PDF generator (from HTML) gem for Ruby on Rails