gotenberg 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 117763ebd188d065008ebbfa04c29db6d164608356ed6b11f9d4457f5e798d20
-  data.tar.gz: c4d5bb32b5fb9b638384857a3ef264097d368dd23ce976439c52374f123f86f9
+  metadata.gz: 489dc50093dc4d7dfcf8934e4f7f1e66c42c3ee331b8f6712206a4f9e4bb3f95
+  data.tar.gz: 32a0dacebb19c92447cc448ea93fa94de7081cc7fdff11a5fd271d20d262ae1e
 SHA512:
-  metadata.gz: 747de8d3f0e7b8ffe094c77fb3298307c08de8cdfc60b391bf8e91c0cee056ff2cb5bab055751e4df5f88f3c8ce691bf3b1db5430596210f9c6f9bc54dcba61b
-  data.tar.gz: d58c30a3cfb85840ee72bc1104c68307c843b8abccb29d94953a0aed3962926a8dcef424216bd8e078a34e8130f36d04d900b81b85149714dace507a48c126b0
+  metadata.gz: a39d81adfa325e16a1a9e5105103e1e9f68acd22600d6b56fcf951f8a45c97353eb676dc1e36c17f6f9113ef20c4bfe05280cc0fa53552a18f4a6d3d176d6674
+  data.tar.gz: dc6294d7356a315e002eb47e8a311908c541c18b0980e3d29325558fd72612bcb628f999f9b841b88c7e68480796a4adb49437a8bd20690f990c76a2771bb2c9

data/lib/gotenberg/assets.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Gotenberg
+  module Assets
+    ASSET_TYPES = {
+      "js" => "javascripts",
+      "css" => "stylesheets",
+
+      # Fonts
+      "otf" => "fonts",
+      "ttf" => "fonts",
+      "woff" => "fonts",
+      "woff2" => "fonts",
+      "eot" => "fonts",
+      "sfnt" => "fonts",
+      "fnt" => "fonts",
+      "pfa" => "fonts",
+      "pfb" => "fonts",
+      "afm" => "fonts",
+      "pcf" => "fonts",
+      "snf" => "fonts",
+      "bdf" => "fonts",
+
+      # Images
+      "bmp" => "images",
+      "gif" => "images",
+      "jpg" => "images",
+      "jpeg" => "images",
+      "png" => "images",
+      "svg" => "images",
+      "tiff" => "images",
+      "tif" => "images",
+      "webp" => "images",
+      "ico" => "images",
+      "psd" => "images",
+      "heic" => "images"
+    }.freeze
+  end
+end

data/lib/gotenberg/client.rb

@@ -48,7 +48,8 @@ module Gotenberg
     #   client = Gotenberg::Client.new("http://localhost:3000")
     #   pdf_content = client.html(htmls, asset_paths, properties)
     #
-    def html(htmls, asset_paths, properties = {}) # rubocop:disable Metrics/CyclomaticComplexity
+    # Credit: https://github.com/jbd0101/ruby-gotenberg-client/blob/master/lib/gotenberg.rb
+    def html(htmls, asset_paths, properties = {})
       raise GotenbergDownError unless up?
 
       raise IndexFileMissing unless (htmls.keys & ["index", :index]).any?
@@ -66,6 +67,12 @@ module Gotenberg
       # Gotenberg requires all files to be in the same directory
       asset_paths.each do |path|
         FileUtils.cp(path, dir_path)
+        next unless path.split(".").last == "css"
+
+        # This preprocessing is necessary for the gotenberg
+        raw_css = File.read(path)
+        preprocessed = raw_css.gsub("url(/assets/", "url(").gsub("url(/", "url(")
+        File.write(path, preprocessed)
       end
 
       # Rejecting .. and .

data/lib/gotenberg/helper.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "assets"
+
 module Gotenberg
   module Helper # rubocop:disable Style/Documentation
     class ExtensionMissing < StandardError; end
 
-    class PropshaftAsset # rubocop:disable Style/Documentation
+    # Credits: https://github.com/mileszs/wicked_pdf/blob/master/lib/wicked_pdf/wicked_pdf_helper/assets.rb
+    class PropshaftAsset
       attr_reader :asset
 
       def initialize(asset)
@@ -63,6 +66,11 @@ module Gotenberg
       end
     end
 
+    # Returns the base64 encoded content of a static asset.
+    #
+    # @param asset_name [String] the name of the asset
+    # @raise [MissingAsset] if the asset is not found
+    # @return [String] the base64 encoded content of the asset
     def goten_asset_base64(asset_name)
       asset = find_asset(goten_static_asset_path(asset_name))
       raise MissingAsset.new(asset_name, "Could not find asset '#{asset_name}'") if asset.nil?
@@ -71,28 +79,48 @@ module Gotenberg
       "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
     end
 
+    # Returns the static path of an asset based on its extension.
+    #
+    # @param asset_name [String] the name of the asset
+    # @raise [ExtensionMissing] if the asset extension is missing
+    # @return [String] the static path of the asset
     def goten_static_asset_path(asset_name)
       ext = File.extname(asset_name).delete(".")
 
       raise ExtensionMissing if ext.empty?
 
-      asset_type =
-        case ext
-        when "js" then "javascripts"
-        when "css" then "stylesheets"
-        else "images"
-        end
+      asset_type = Assets::ASSET_TYPES.fetch(ext)
 
       determine_static_path(asset_type, asset_name)
     end
 
+    # Returns the compiled path of an asset.
+    #
+    # @param asset_name [String] the name of the asset
+    # @return [String] the compiled path of the asset
     def goten_compiled_asset_path(asset_name)
       Rails.public_path.to_s +
         ActionController::Base.helpers.asset_path(asset_name)
     end
 
+    # Returns the compiled name of an asset.
+    #
+    # @param asset_name [String] the name of the asset
+    # @return [String] the compiled name of the asset
+
+    def goten_compiled_asset_name(asset_name)
+      path = goten_compiled_asset_path(asset_name)
+      path.split("/").last
+    end
+
     private
 
+    # Determines and returns the static path of an asset.
+    #
+    # @param asset_type [String] the type of the asset (e.g., "javascripts", "stylesheets", "images")
+    # @param asset_name [String] the name of the asset
+    # @raise [MissingAsset] if the asset is not found
+    # @return [String] the static path of the asset
     def determine_static_path(asset_type, asset_name)
       asset_root = Rails.root.join("app", "assets")
       path = asset_root.join(asset_type, asset_name)
@@ -107,7 +135,10 @@ module Gotenberg
       path.to_s
     end
 
-    # Thanks WickedPDF 🙏
+    # Finds and returns the asset for the given path.
+    #
+    # @param path [String] the path of the asset
+    # @return [PropshaftAsset, LocalAsset, Sprockets::Asset, nil] the found asset or nil if not found
     def find_asset(path)
       if Rails.application.assets.respond_to?(:find_asset)
         Rails.application.assets.find_asset(path, base_path: Rails.application.root.to_s)

data/lib/gotenberg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gotenberg
-  VERSION = "1.0.1"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gotenberg
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - bugloper
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/gotenberg.rb
+- lib/gotenberg/assets.rb
 - lib/gotenberg/client.rb
 - lib/gotenberg/helper.rb
 - lib/gotenberg/railtie.rb