sghtmltopdf 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccb7358464b7e2b54de35755d1aaf2a278b59dddee9716101cdf3715eebf51cc
-  data.tar.gz: 4c653cda8ba36f061a2d2253f59b4877ee39e2f9f7157cc84e05ab4ec978ad1f
+  metadata.gz: d1f9d3e5d0ef7f52bf2b132763152947790daa86174b4062a7d9a6b84d1997f3
+  data.tar.gz: 7dce2ae788b4118bb6567288b2087a4391deda2a1afffae79c287c1743ce818b
 SHA512:
-  metadata.gz: 1f861dc645c65f74dee61b47a000395e10da29746bb27941079bdb0e34a69828fd424b2033f67692679f3500f6386ee0c2c5ada72bb048fdae593a167f35051a
-  data.tar.gz: 616b41944d6a37a7110cf807dab0d2feaf3aeda1861d5c254276d6c59ace03e530c29c03a07b10cff4131ed6f04e4dcd2f284abb6cfcf1c6ff48d87a8f3c6170
+  metadata.gz: d87d0e85c84e21a7f0f0df3a0564f56db2019ea32fcd164ade94066f2484e12f29e6d4a827d694cf490c1e56bb54df564da024da743b2e915eca7735d3b2c1d7
+  data.tar.gz: a22c3f77c40762e0da9170c174b2c233dcf5a1041fc952ca3476b5c3941657c89674604ffcd28ca4a512b6ef8f9a2377fe83909e0e759c4535084a2820bf01b1

data/Cargo.lock

@@ -1050,7 +1050,7 @@ dependencies = [
 
 [[package]]
 name = "sghtmltopdf"
-version = "0.7.0"
+version = "0.8.0"
 dependencies = [
  "base64",
  "clap",
@@ -1077,7 +1077,7 @@ dependencies = [
 
 [[package]]
 name = "sghtmltopdf-ruby"
-version = "0.7.0"
+version = "0.8.0"
 dependencies = [
  "magnus",
  "rb-sys",

data/README.md

@@ -113,6 +113,7 @@ That is enough for a precompiled production app; in development the digested `/a
 ```
 
 `sghtmltopdf_stylesheet_link_tag` does not copy the CSS verbatim: it points every `url()` at a file the engine can read and splices in every `@import`.
+With Sprockets, it uses the compiled CSS, so SCSS imports, variables and nesting are resolved by the application's Sass processor before embedding.
 The asset pipeline rewrites `url()` through `asset_path` while precompiling, which turns a `@font-face` source into a digested `/assets/…` path, or into an absolute URL once `asset_host` is set — neither can be fetched while rendering, and a `@font-face` that fails to load falls back to the engine default rather than to the next `font-family`.
 
 A file `allow_path` does not cover is embedded as a `data:` URI instead, so that it cannot silently vanish from the PDF; pass `inline: true` to embed unconditionally.

data/ext/sghtmltopdf/Cargo.toml

@@ -2,7 +2,7 @@
 # The package name differs from the library name on purpose: the core crate is published as
 # `sghtmltopdf`, and two packages with the same name cannot be written to one lockfile.
 name = "sghtmltopdf-ruby"
-version = "0.7.0"
+version = "0.8.0"
 edition = "2021"
 publish = false
 description = "Ruby binding for sghtmltopdf (see bindings/ruby)"

data/lib/sghtmltopdf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sghtmltopdf
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/sghtmltopdf/view_helpers.rb

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 
 module Sghtmltopdf
+  # Sprockets' filename still points at the source (e.g. invoice.scss),
+  # while its to_s holds the compiled CSS. Keep both so references can be
+  # resolved without reading the uncompiled source again.
+  # Keep this outside ViewHelpers to avoid shadowing application constants in views.
+  ResolvedAsset = Struct.new(:path, :compiled_asset) do
+    def read
+      compiled_asset ? compiled_asset.to_s : File.read(path)
+    end
+  end
+  private_constant :ResolvedAsset
+
   # Action View helpers.
   #
   # Rendering a PDF never goes through an HTTP server, so a URL such as
@@ -30,14 +41,7 @@ module Sghtmltopdf
     # in that order. The pipeline lookup goes through `respond_to?` so that
     # neither gem becomes a dependency (best effort).
     def sghtmltopdf_asset_path(source)
-      path = source.to_s
-      # A source that is already a URL (or a `data:` URI) is not an asset of
-      # this application. Without this, `from_public_dir` would strip the host
-      # off `https://example.com/logo.png` and hand back `public/logo.png`.
-      return nil if path.match?(%r{\A(?:[a-z][a-z0-9+.\-]*:|//)}i)
-      return path if path.start_with?("/") && File.file?(path)
-
-      from_public_dir(path) || from_asset_pipeline(path)
+      resolve_sghtmltopdf_asset(source)&.path
     end
 
     # Expands the CSS itself into a `<style>`. Takes several sources; any that
@@ -48,8 +52,8 @@ module Sghtmltopdf
     # [#inline_stylesheet].
     def sghtmltopdf_stylesheet_link_tag(*sources)
       css = sources.flatten.filter_map do |source|
-        path = sghtmltopdf_asset_path(with_extension(source, ".css"))
-        inline_stylesheet(path) if path
+        asset = resolve_sghtmltopdf_asset(with_extension(source, ".css"))
+        inline_stylesheet(asset) if asset
       end
       return "".html_safe if css.empty?
 
@@ -93,8 +97,19 @@ module Sghtmltopdf
 
     private
 
-    # `path` read as CSS, with every `url()` pointed at a file the engine can
-    # read and every `@import` spliced in.
+    def resolve_sghtmltopdf_asset(source)
+      path = source.to_s
+      # A source that is already a URL (or a `data:` URI) is not an asset of
+      # this application. Without this, `from_public_dir` would strip the host
+      # off `https://example.com/logo.png` and hand back `public/logo.png`.
+      return nil if path.match?(%r{\A(?:[a-z][a-z0-9+.\-]*:|//)}i)
+      return ResolvedAsset.new(path) if path.start_with?("/") && File.file?(path)
+
+      from_public_dir(path) || from_asset_pipeline(path)
+    end
+
+    # The asset's CSS, with every `url()` pointed at a file the engine can read
+    # and every remaining CSS `@import` spliced in.
     #
     # Both have to happen here because the engine keeps one base for the whole
     # document: every CSS source is concatenated before it is parsed, so a
@@ -110,8 +125,9 @@ module Sghtmltopdf
     # fetched.
     #
     # `chain` holds the files already being expanded, innermost last.
-    def inline_stylesheet(path, chain = [])
-      css = File.read(path)
+    def inline_stylesheet(asset, chain = [])
+      css = asset.read
+      path = asset.path
       dir = File.dirname(path)
       chain += [real_path(path)].compact
       comments = comment_ranges(css)
@@ -141,7 +157,7 @@ module Sghtmltopdf
       target = css_url_target(unquote(href), dir)
       return nil if target.nil?
 
-      real = real_path(target)
+      real = real_path(target.path)
       return nil if real.nil? || chain.include?(real)
 
       inline_stylesheet(target, chain)
@@ -163,11 +179,11 @@ module Sghtmltopdf
       css.gsub(CSS_URL) do
         match = Regexp.last_match
         target = css_url_target(unquote(match[:href]), dir)
-        target ? css_url(engine_readable_src(target) || data_uri(target)) : match[0]
+        target ? css_url(engine_readable_src(target.path) || data_uri(target.path)) : match[0]
       end
     end
 
-    # The local file a CSS reference names, or `nil` when it names none.
+    # The local asset a CSS reference names, or `nil` when it names none.
     def css_url_target(ref, dir)
       path = ref.split(/[?#]/, 2).first.to_s
       return nil if path.empty? || path.match?(/\Adata:/i)
@@ -194,7 +210,7 @@ module Sghtmltopdf
       root = ::Rails.application.config.try(:relative_url_root).to_s
       path = path.delete_prefix(root) unless root.empty?
       candidate = File.join(::Rails.public_path.to_s, path)
-      return candidate if File.file?(candidate)
+      return ResolvedAsset.new(candidate) if File.file?(candidate)
 
       # Nothing is precompiled in development, so the load path is asked as
       # well. The mount point is not part of a logical path either.
@@ -212,7 +228,7 @@ module Sghtmltopdf
     # same way but is looked up across every root.
     def from_stylesheet_dir(path, dir)
       candidate = File.expand_path(path, dir)
-      return candidate if File.file?(candidate)
+      return ResolvedAsset.new(candidate) if File.file?(candidate)
 
       from_asset_pipeline(path.delete_prefix("./"))
     end
@@ -236,8 +252,10 @@ module Sghtmltopdf
 
     # `@import` up to its terminating `;`, in both the `url()` and the bare
     # string form. Media conditions are matched so they are consumed, not kept.
+    # CSS compressors can omit whitespace before a quoted URL. Keep the token
+    # boundary so an unrelated at-rule such as `@importurl` is not expanded.
     IMPORT_STATEMENT = /
-      @import \s+
+      @import \b \s*
       (?: url\( \s* (?<href> "[^"]*" | '[^']*' | [^)"'\s]* ) \s* \)
         | (?<href> "[^"]*" | '[^']*' ) )
       [^;]* ;
@@ -258,7 +276,7 @@ module Sghtmltopdf
       return nil if relative.empty?
 
       candidate = File.join(::Rails.public_path.to_s, relative)
-      File.file?(candidate) ? candidate : nil
+      File.file?(candidate) ? ResolvedAsset.new(candidate) : nil
     end
 
     # `asset_path` for `source`, falling back to `source` itself.
@@ -282,12 +300,20 @@ module Sghtmltopdf
       # Propshaft
       if assets.respond_to?(:load_path)
         found = assets.load_path.find(source)
-        return found.path.to_s if found.respond_to?(:path)
+        return ResolvedAsset.new(found.path.to_s) if found.respond_to?(:path)
       end
       # Sprockets
       if assets.respond_to?(:[])
         found = assets[source]
-        return found.filename.to_s if found.respond_to?(:filename)
+        # Compiled CSS can contain digested URLs even in development, where
+        # no such file exists under public/. Sprockets looks up logical names;
+        # verify the digest before using the corresponding source file.
+        if found.nil?
+          logical = source.sub(/-[0-9a-f]+(?=\.[^.]+\z)/i, "")
+          candidate = assets[logical] unless logical == source
+          found = candidate if candidate.respond_to?(:digest_path) && candidate.digest_path == source
+        end
+        return ResolvedAsset.new(found.filename.to_s, found) if found.respond_to?(:filename)
       end
       nil
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sghtmltopdf
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - yo_waka