adzap-wicked_pdf 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df55b441686f92b7087e24ccc0311fdb2c2653a6a07ee8a661f5168ba403462c
-  data.tar.gz: c9016439d082b975e932d1912f84434375897d06a17905065b5cbbf18e1f2354
+  metadata.gz: ee59b976a1f8a763eb2a754baf8727f970fe5f06c88194b42735d5c37e3ac6b7
+  data.tar.gz: 543153109daf65bcbe75959aecf5416689fd54481dd31b08bf068322de805551
 SHA512:
-  metadata.gz: 7a7568160aadb93576e342cb0185b44854658029c3f46a4fe50c5a3b69b9ef36d06692679760353f535981c2f603637af705e458cc887dce331506763d341b59
-  data.tar.gz: 739be6b379f0834f488c6db9aad4ecc5561838a981b11f5589f54ad6d1d4c7b5b202373518cdce66c68f69a78e6d9b40e5f153e31f94e68d22c7d9d8301551d5
+  metadata.gz: bc98c1fbb159ec1c228f320d8d79d805d8c9e85927fd3f6b4f96b7d0927c05da270a55d3e87f348a4c7602f350ce855761c3a65f671d133b7bab6e7712cf4296
+  data.tar.gz: 237bef4134c63adb17a206b197888e7a6f8845a7fa4f637454420ab91590c40706766a3d14f1d50f60b3c4df168158751716258b8865ae80c639c4afb75e128c

data/lib/wicked_pdf/asset_cache.rb

@@ -0,0 +1,33 @@
+module WickedPdf
+  # Process-wide memo for the output of the inlining asset helpers
+  # (wicked_pdf_asset_base64, wicked_pdf_stylesheet_link_tag,
+  # wicked_pdf_javascript_include_tag).
+  #
+  # Reading, concatenating and base64-encoding assets is deterministic for a
+  # given deployment, but the helpers are invoked once per rendered document —
+  # expensive when many documents are rendered in one request (e.g. printing a
+  # batch). Enable with `config.cache_assets = true`; disabled by default so
+  # environments that recompile assets on change (development) stay live.
+  #
+  # Cached values are frozen so a stale reference can't be mutated in place.
+  class AssetCache
+    def initialize
+      @store = {}
+      @mutex = Mutex.new
+    end
+
+    def fetch(key)
+      @mutex.synchronize do
+        @store.fetch(key) { @store[key] = yield.freeze }
+      end
+    end
+
+    def clear
+      @mutex.synchronize { @store.clear }
+    end
+
+    def size
+      @mutex.synchronize { @store.size }
+    end
+  end
+end

data/lib/wicked_pdf/asset_helper.rb

@@ -13,26 +13,30 @@ module WickedPdf
     end
 
     def wicked_pdf_asset_base64(path)
-      asset = find_asset(path)
-      raise "Could not find asset '#{path}'" if asset.nil?
+      wicked_pdf_asset_cache(:base64, path) do
+        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)}"
+        base64 = Base64.encode64(asset.to_s).gsub(/\s+/, '')
+        "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
+      end
     end
 
     def wicked_pdf_stylesheet_link_tag(*sources)
-      stylesheet_contents = sources.collect do |source|
-        source = WickedPdf::AssetHelper.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
+      wicked_pdf_asset_cache(:stylesheet, *sources) do
+        stylesheet_contents = sources.collect do |source|
+          source = WickedPdf::AssetHelper.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
     end
 
     def wicked_pdf_image_tag(img, options = {})
@@ -45,10 +49,12 @@ module WickedPdf
     end
 
     def wicked_pdf_javascript_include_tag(*sources)
-      sources.collect do |source|
-        source = WickedPdf::AssetHelper.add_extension(source, 'js')
-        "<script type='text/javascript'>#{read_asset(source)}</script>"
-      end.join("\n").html_safe
+      wicked_pdf_asset_cache(:javascript, *sources) do
+        sources.collect do |source|
+          source = WickedPdf::AssetHelper.add_extension(source, 'js')
+          "<script type='text/javascript'>#{read_asset(source)}</script>"
+        end.join("\n").html_safe
+      end
     end
 
     def wicked_pdf_asset_path(asset)
@@ -64,6 +70,11 @@ module WickedPdf
     # borrowed from actionpack/lib/action_view/helpers/asset_url_helper.rb
     URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}
 
+    # Inlined asset output is deterministic per deployment; memoized process-wide when config.cache_assets is on.
+    def wicked_pdf_asset_cache(*key, &block)
+      WickedPdf.config.cache_assets ? WickedPdf.asset_cache.fetch(key, &block) : yield
+    end
+
     def asset_pathname(source)
       if precompiled_or_absolute_asset?(source)
         asset = asset_path(source)

data/lib/wicked_pdf/configuration.rb

@@ -16,7 +16,8 @@ module WickedPdf
       :root_url,
       :default_protocol,
       :expect_gzipped_remote_assets,
-      :enable_local_file_access
+      :enable_local_file_access,
+      :cache_assets
     ].freeze
 
     attr_accessor(*SETTINGS)
@@ -31,6 +32,7 @@ module WickedPdf
     def initialize
       @basic_auth = false
       @enable_local_file_access = true
+      @cache_assets = false
       @default_options = {}
     end
 

data/lib/wicked_pdf/version.rb

@@ -1,3 +1,3 @@
 module WickedPdf
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/lib/wicked_pdf.rb

@@ -10,6 +10,7 @@ require 'active_support/core_ext/object/blank'
 
 require 'wicked_pdf/version'
 require 'wicked_pdf/configuration'
+require 'wicked_pdf/asset_cache'
 require 'wicked_pdf/tempfile'
 require 'wicked_pdf/binary'
 require 'wicked_pdf/option_parser'
@@ -41,6 +42,11 @@ module WickedPdf
     def configure
       yield config
     end
+
+    # Shared store used by the asset helpers when config.cache_assets is on.
+    def asset_cache
+      @asset_cache ||= AssetCache.new
+    end
   end
 
   def self.new(command = WickedPdf::Command.new)

data/test/functional/wicked_pdf_asset_helper_test.rb

@@ -4,10 +4,70 @@ require 'action_view/test_case'
 class WickedPdfAssetHelperTest < ActionView::TestCase
   include WickedPdf::AssetHelper
 
+  teardown do
+    WickedPdf.config.cache_assets = false
+    WickedPdf.asset_cache.clear
+  end
+
   test 'wicked_pdf_asset_base64 returns a base64 encoded asset' do
     assert_match %r{data:text/css;base64,.+}, wicked_pdf_asset_base64('wicked.css')
   end
 
+  test 'inlining helpers recompute on every call by default' do
+    asset = stub(:to_s => 'body { color: red; }', :content_type => 'text/css')
+    expects(:find_asset).with('wicked.css').twice.returns(asset)
+
+    2.times { wicked_pdf_asset_base64('wicked.css') }
+  end
+
+  test 'wicked_pdf_asset_base64 memoizes when cache_assets is enabled' do
+    WickedPdf.config.cache_assets = true
+    asset = stub(:to_s => 'body { color: red; }', :content_type => 'text/css')
+    expects(:find_asset).with('wicked.css').once.returns(asset)
+
+    first = wicked_pdf_asset_base64('wicked.css')
+
+    assert_equal first, wicked_pdf_asset_base64('wicked.css')
+  end
+
+  test 'wicked_pdf_stylesheet_link_tag memoizes when cache_assets is enabled' do
+    WickedPdf.config.cache_assets = true
+    Rails.configuration.assets.stubs(:compile => true)
+    expects(:read_asset).with('wicked.css').once.returns('/* Wicked styles */')
+
+    first = wicked_pdf_stylesheet_link_tag('wicked')
+
+    assert_equal first, wicked_pdf_stylesheet_link_tag('wicked')
+    assert_predicate wicked_pdf_stylesheet_link_tag('wicked'), :html_safe?
+  end
+
+  test 'wicked_pdf_javascript_include_tag memoizes when cache_assets is enabled' do
+    WickedPdf.config.cache_assets = true
+    expects(:read_asset).with('wicked.js').once.returns('// Wicked js')
+
+    first = wicked_pdf_javascript_include_tag('wicked')
+
+    assert_equal first, wicked_pdf_javascript_include_tag('wicked')
+  end
+
+  test 'cached helpers key by helper and sources so results do not collide' do
+    WickedPdf.config.cache_assets = true
+    stubs(:read_asset).returns('content')
+
+    refute_equal wicked_pdf_stylesheet_link_tag('wicked'), wicked_pdf_javascript_include_tag('wicked')
+    refute_equal wicked_pdf_javascript_include_tag('wicked'), wicked_pdf_javascript_include_tag('wicked', 'other')
+  end
+
+  test 'clearing the asset cache forces recomputation' do
+    WickedPdf.config.cache_assets = true
+    asset = stub(:to_s => 'x', :content_type => 'text/css')
+    expects(:find_asset).with('wicked.css').twice.returns(asset)
+
+    wicked_pdf_asset_base64('wicked.css')
+    WickedPdf.asset_cache.clear
+    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)
     # Sprockets versions differ in trailing whitespace when concatenating assets

data/test/unit/wicked_pdf_asset_cache_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+class WickedPdfAssetCacheTest < ActiveSupport::TestCase
+  setup do
+    @cache = WickedPdf::AssetCache.new
+  end
+
+  test 'fetch computes the value once and memoizes it' do
+    computations = 0
+    2.times do
+      @cache.fetch([:base64, 'font.ttf']) do
+        computations += 1
+        'data:...'
+      end
+    end
+
+    assert_equal 1, computations
+    assert_equal 1, @cache.size
+  end
+
+  test 'fetch returns the cached value on subsequent calls' do
+    @cache.fetch([:stylesheet, 'print']) { '<style>a</style>' }
+
+    assert_equal '<style>a</style>', @cache.fetch([:stylesheet, 'print']) { flunk 'should not recompute' }
+  end
+
+  test 'fetch freezes cached values' do
+    assert_predicate @cache.fetch([:javascript, 'app']) { +'<script></script>' }, :frozen?
+  end
+
+  test 'distinct keys are cached independently' do
+    @cache.fetch([:base64, 'a.ttf']) { 'a' }
+    @cache.fetch([:base64, 'b.ttf']) { 'b' }
+
+    assert_equal 2, @cache.size
+    assert_equal 'a', @cache.fetch([:base64, 'a.ttf']) { 'wrong' }
+  end
+
+  test 'clear empties the store so values are recomputed' do
+    @cache.fetch([:base64, 'font.ttf']) { 'stale' }
+    @cache.clear
+
+    assert_equal 0, @cache.size
+    assert_equal 'fresh', @cache.fetch([:base64, 'font.ttf']) { 'fresh' }
+  end
+
+  test 'WickedPdf.asset_cache returns a shared instance' do
+    assert_same WickedPdf.asset_cache, WickedPdf.asset_cache
+    assert_kind_of WickedPdf::AssetCache, WickedPdf.asset_cache
+  end
+end

data/test/unit/wicked_pdf_configuration_test.rb

@@ -15,6 +15,17 @@ class WickedPdfConfigurationTest < ActiveSupport::TestCase
     assert_kind_of WickedPdf::Configuration, WickedPdf.config
   end
 
+  test 'cache_assets is a typed setting defaulting to false' do
+    config = WickedPdf::Configuration.new
+
+    assert_equal false, config.cache_assets
+
+    config[:cache_assets] = true
+
+    assert_equal true, config.cache_assets
+    assert_empty config.default_options
+  end
+
   test 'assigning a Hash routes settings to accessors and unknown keys to default_options' do
     WickedPdf.config = {
       :exe_path => '/usr/bin/wkhtmltopdf',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adzap-wicked_pdf
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Miles Z. Sterrett
@@ -9,7 +9,7 @@ authors:
 - Adam Meehan
 bindir: bin
 cert_chain: []
-date: 2026-08-07 00:00:00.000000000 Z
+date: 2026-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -155,6 +155,7 @@ files:
 - init.rb
 - lib/generators/wicked_pdf_generator.rb
 - lib/wicked_pdf.rb
+- lib/wicked_pdf/asset_cache.rb
 - lib/wicked_pdf/asset_helper.rb
 - lib/wicked_pdf/binary.rb
 - lib/wicked_pdf/command.rb
@@ -185,6 +186,7 @@ files:
 - test/functional/pdf_helper_test.rb
 - test/functional/wicked_pdf_asset_helper_test.rb
 - test/test_helper.rb
+- test/unit/wicked_pdf_asset_cache_test.rb
 - test/unit/wicked_pdf_binary_test.rb
 - test/unit/wicked_pdf_command_test.rb
 - test/unit/wicked_pdf_configuration_test.rb
@@ -233,6 +235,7 @@ test_files:
 - test/functional/pdf_helper_test.rb
 - test/functional/wicked_pdf_asset_helper_test.rb
 - test/test_helper.rb
+- test/unit/wicked_pdf_asset_cache_test.rb
 - test/unit/wicked_pdf_binary_test.rb
 - test/unit/wicked_pdf_command_test.rb
 - test/unit/wicked_pdf_configuration_test.rb