wicked_pdf 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad0741c1e5c8b253601a248d448f53fe359547238517a6340c7ac340f4bf2e15
-  data.tar.gz: 1da781d4aa577dd9afb1e90c734c1507d4458d85d7a381dc0f005582dcd064a5
+  metadata.gz: a0ccf42076502bc818ca5387b97d300bad8ebf99c0ecdcc024ea1a2e4d2c45a6
+  data.tar.gz: aaa9779f4c8ee4baf5b6e5ce27d7ebd7396e6b565c59263fc0a7db6f6e0518e9
 SHA512:
-  metadata.gz: dd1a3651d3ad14d2c0c8515e81f9cc75bbe617633e956127f77e6d287a761402f5b8d1448641772bf7e69cb16fefd5b38547da9628df43fdb0e6623b11527e9d
-  data.tar.gz: f4d1cd6cd91e60f4874e4ad269056a5af32da101e0e03a54231d701958d304f14beacfa9b262559fb56c5375b6899046c8a23090afde226721613d4e0db4f118
+  metadata.gz: d2e93a8024b529dadccf861026e916c4d75270d821f038bb4c5dd8d12f1bd73bae451ba288fc62e7e10d35380a573a4d554c8da0d39c2490c6ca38b6666590a7
+  data.tar.gz: 5624cbb405350aa731ffc9910e70d286dabdb833b15a38235f2b933a842e3c6ce9342001bd779a72abac668fe84455f32f9cb58cdad7417e62e2fcec6817856f

data/CHANGELOG.md

@@ -2,11 +2,16 @@
 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 changes](https://github.com/mileszs/wicked_pdf/compare/2.8.0...HEAD)
+## [[master branch] - Unreleased changes](https://github.com/mileszs/wicked_pdf/compare/2.8.1...HEAD)
 ### Breaking Changes
 ### New Features
 ### Fixes
 
+## [2.8.1]
+### Fixes
+- [Explicitly require OpenStruct, which isn't loaded by default anymore in new versions of Rake](https://github.com/mileszs/wicked_pdf/pull/1110)
+- [Ensure assets without extensions are handled correctly](https://github.com/mileszs/wicked_pdf/pull/1115)
+
 ## [2.8.0]
 ### New Features
 - [Add New config option `raise_on_missing_assets`](https://github.com/mileszs/wicked_pdf/pull/1094)

data/README.md

@@ -4,7 +4,7 @@
 
 Wicked PDF uses the shell utility [wkhtmltopdf](http://wkhtmltopdf.org) to serve a PDF file to a user from HTML.  In other words, rather than dealing with a PDF generation DSL of some sort, you simply write an HTML view as you would normally, then let Wicked PDF take care of the hard stuff.
 
-_Wicked PDF has been verified to work on Ruby versions 2.2 through 2.6; Rails 4 through 6.1_
+_Wicked PDF has been verified to work on Ruby versions 2.2 through 3.2; Rails 4 through 7.0_
 
 ### Installation
 
@@ -43,9 +43,9 @@ If your wkhtmltopdf executable is not on your webserver's path, you can configur
 
 ```ruby
 WickedPdf.configure do |c|
-  c.exe_path = '/usr/local/bin/wkhtmltopdf',
+  c.exe_path = '/usr/local/bin/wkhtmltopdf'
   c.enable_local_file_access = true
-}
+end
 ```
 
 For more information about `wkhtmltopdf`, see the project's [homepage](http://wkhtmltopdf.org/).

data/generators/wicked_pdf/templates/wicked_pdf.rb

@@ -11,20 +11,20 @@
 WickedPdf.configure do |config|
   # Path to the wkhtmltopdf executable: This usually isn't needed if using
   # one of the wkhtmltopdf-binary family of gems.
-  # config.exe_path = '/usr/local/bin/wkhtmltopdf',
+  # config.exe_path = '/usr/local/bin/wkhtmltopdf'
   #   or
   # config.exe_path = Gem.bin_path('wkhtmltopdf-binary', 'wkhtmltopdf')
 
   # Needed for wkhtmltopdf 0.12.6+ to use many wicked_pdf asset helpers
-  # config.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)
-  # config.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.
   #
-  # config.use_xvfb = true,
+  # config.use_xvfb = true
 end

data/lib/wicked_pdf/version.rb

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

data/lib/wicked_pdf/wicked_pdf_helper/assets.rb

@@ -202,13 +202,32 @@ class WickedPdf
         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])
+          relative_asset_path = get_asset_path_from_manifest(path)
+          return unless relative_asset_path
+
+          asset_path = File.join(Rails.application.assets_manifest.dir, relative_asset_path)
           LocalAsset.new(asset_path) if File.file?(asset_path)
         else
           SprocketsEnvironment.find_asset(path, :base_path => Rails.application.root.to_s)
         end
       end
 
+      def get_asset_path_from_manifest(path)
+        assets = Rails.application.assets_manifest.assets
+
+        if File.extname(path).empty?
+          assets.find do |asset, _v|
+            directory = File.dirname(asset)
+            asset_path = File.basename(asset, File.extname(asset))
+            asset_path = File.join(directory, asset_path) if directory != '.'
+
+            asset_path == path
+          end&.last
+        else
+          assets[path]
+        end
+      end
+
       # will prepend a http or default_protocol to a protocol relative URL
       # or when no protcol is set.
       def prepend_protocol(source)

data/lib/wicked_pdf.rb

@@ -5,6 +5,7 @@ require 'logger'
 require 'digest/md5'
 require 'rbconfig'
 require 'open3'
+require 'ostruct'
 
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/object/blank'

data/test/fixtures/subdirectory/nested.js

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

data/test/functional/wicked_pdf_helper_assets_test.rb

@@ -11,6 +11,10 @@ class WickedPdfHelperAssetsTest < ActionView::TestCase
 
   teardown do
     WickedPdf.config = @saved_config
+
+    # @see freerange/mocha#331
+    Rails.application.unstub(:assets)
+    Rails.application.unstub(:assets_manifest)
   end
 
   if Rails::VERSION::MAJOR > 3 || (Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR > 0)
@@ -18,12 +22,61 @@ class WickedPdfHelperAssetsTest < ActionView::TestCase
       assert_match %r{data:text\/css;base64,.+}, wicked_pdf_asset_base64('wicked.css')
     end
 
+    test 'wicked_pdf_asset_base64 works without file extension when using sprockets' do
+      assert_match %r{data:application\/javascript;base64,.+}, wicked_pdf_asset_base64('wicked')
+    end
+
+    test 'wicked_pdf_asset_base64 works with nested files and without file extension when using sprockets' do
+      assert_match %r{data:application\/javascript;base64,.+}, wicked_pdf_asset_base64('subdirectory/nested')
+    end
+
+    test 'wicked_pdf_asset_base64 works without file extension when using asset manifest' do
+      stub_manifest = OpenStruct.new(
+        :dir => Rails.root.join('app/assets'),
+        :assets => { 'wicked.css' => 'stylesheets/wicked.css', 'wicked.js' => 'javascripts/wicked.js' }
+      )
+      Rails.application.stubs(:assets).returns(nil)
+      Rails.application.stubs(:assets_manifest).returns(stub_manifest)
+
+      assert_match %r{data:text\/css;base64,.+}, wicked_pdf_asset_base64('wicked')
+    end
+
+    test 'wicked_pdf_asset_base64 works with nested files and without file extension when using asset manifest' do
+      stub_manifest = OpenStruct.new(
+        :dir => Rails.root.join('app/assets'),
+        :assets => { 'subdirectory/nested.js' => 'javascripts/subdirectory/nested.js' }
+      )
+      Rails.application.stubs(:assets).returns(nil)
+      Rails.application.stubs(:assets_manifest).returns(stub_manifest)
+
+      assert_match %r{data:text\/javascript;base64,.+}, wicked_pdf_asset_base64('subdirectory/nested')
+    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_stylesheet_link_tag should work without file extension when using sprockets' 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_stylesheet_link_tag should work without file extension when using asset manifest' do
+      stub_manifest = OpenStruct.new(
+        :dir => Rails.root.join('app/assets'),
+        :assets => { 'wicked.css' => 'stylesheets/wicked.css', 'wicked.js' => 'javascripts/wicked.js' }
+      )
+
+      Rails.application.stubs(:assets).returns(nil)
+      Rails.application.stubs(:assets_manifest).returns(stub_manifest)
+
+      assert_equal "<style type='text/css'>/* Wicked styles */\n</style>",
+                   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
@@ -60,6 +113,21 @@ class WickedPdfHelperAssetsTest < ActionView::TestCase
                    wicked_pdf_stylesheet_link_tag('https://www.example.com/wicked.css')
     end
 
+    test 'wicked_pdf_stylesheet_link_tag should inline the stylesheets passed in when assets are remote and using asset manifest' do
+      stub_manifest = OpenStruct.new(
+        :dir => Rails.root.join('app/assets'),
+        :assets => { 'wicked.css' => 'stylesheets/wicked.css', 'wicked.js' => 'javascripts/wicked.js' }
+      )
+
+      Rails.application.stubs(:assets).returns(nil)
+      Rails.application.stubs(:assets_manifest).returns(stub_manifest)
+
+      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')

data/test/test_helper.rb

@@ -27,6 +27,11 @@ if (assets_dir = Rails.root.join('app/assets')) && File.directory?(assets_dir)
   source = File.read('test/fixtures/wicked.js')
   File.open(destination, 'w') { |f| f.write(source) }
 
+  Dir.mkdir(js_dir.join('subdirectory')) unless File.directory?(js_dir.join('subdirectory'))
+  destination = js_dir.join('subdirectory/nested.js')
+  source = File.read('test/fixtures/subdirectory/nested.js')
+  File.open(destination, 'w') { |f| f.write(source) }
+
   config_dir = assets_dir.join('config')
   Dir.mkdir(config_dir) unless File.directory?(config_dir)
   source = File.read('test/fixtures/manifest.js')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wicked_pdf
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Miles Z. Sterrett
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -182,6 +182,7 @@ files:
 - test/fixtures/database.yml
 - test/fixtures/document_with_long_line.html
 - test/fixtures/manifest.js
+- test/fixtures/subdirectory/nested.js
 - test/fixtures/wicked.css
 - test/fixtures/wicked.js
 - test/functional/pdf_helper_test.rb
@@ -222,6 +223,7 @@ test_files:
 - test/fixtures/database.yml
 - test/fixtures/document_with_long_line.html
 - test/fixtures/manifest.js
+- test/fixtures/subdirectory/nested.js
 - test/fixtures/wicked.css
 - test/fixtures/wicked.js
 - test/functional/pdf_helper_test.rb