htmlToPdf 0.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 460c5d0faa74e850b1634f92df685cd99e7a3201eeab67303182c65a789c4462
-  data.tar.gz: e526f651e50ce24683d87d286dd2bec2483f19e5ec037c5d3e24545e0a35cc57
+  metadata.gz: eb26af6ab6e2d50a8836366601bfd8fc14c7c4d374a3483c34e2b511d2645634
+  data.tar.gz: 901949e8b9b71ddf2eca72d7c702718710524af5b45744135267e187102fb712
 SHA512:
-  metadata.gz: 69c80ad936b1eb78f152b2ec5736b9b574cc65f51b808b4a0a1f06af0a7b27c2fa7ebbbe9ddd7a5feff20e7236d9b4d21edaa2611d585bc1bc467f41879d8c25
-  data.tar.gz: 542c42c9495d7b26e9930a83daab667abbe5f1961ae98b3bbd5507c7c5bf211a045f33ae4b1e9c26b1d9ac0da954d454218eef6b1eb015d1330b0579ace1d74a
+  metadata.gz: 1a8010ab65b9d32b0361b57442c0b095324eaf2222ccb98b2844723830880e60def0c5aaa32516e6d072dff911cd9a6434b33e997938c4f132820f4a47da4339
+  data.tar.gz: 5fd86086620cd34a5d1b20c1fa4e9f309d1931d04147f8ac43cb23e47020ce68dbcd0a154e06cd90a1331f309a742a342a575d5b9f9e263b3c97b3e1576609a3

data/Gemfile.lock

@@ -1,20 +1,24 @@
 PATH
   remote: .
   specs:
-    htmlToPdf (0.1.0)
+    htmlToPdf (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rake (10.3.1)
+    rake (13.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
+  bundler (>= 2.4)
   htmlToPdf!
-  rake
+  rake (>= 13.0)
+
+CHECKSUMS
+  htmlToPdf (2.0.0)
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
 
 BUNDLED WITH
-   2.3.26
+  4.0.6

data/README.md

@@ -1,6 +1,8 @@
 # HtmlToPdf
 
-Description : this gem will generate pdf of the action's html requested as pdf.
+This gem will generate pdf of the action's html requested as pdf. 
+
+Supports Rails 7.x and Rails 8.x (latest).
 
 ## Installation
 #### Install and setup `wkhtmltopdf`. Please refer https://wkhtmltopdf.org for more details. 
@@ -33,6 +35,49 @@ you can customize pdf like you can give the name and layout for the pdf.to custo
 
     <%= link_to 'download', your_action_path(:format => 'pdf',:pdf_options => {title: 'pdf_name', layout: 'layout_name'}) %>
 
- this will generate the pdf of your_action named "pdf_name.pdf" with layout "layout_name".
+ this will generate the pdf of your_action named `pdf_name.pdf` with layout `layout_name`.
 
  one can call any action as pdf and he get the pdf file of that action's html.
+
+customizing page padding and wkhtmltopdf options:
+
+    <%= link_to 'download', your_action_path(:format => 'pdf', :pdf_options => {
+      title: 'pdf_name',
+      layout: 'layout_name',
+      padding: '10mm',
+      wkhtmltopdf_options: {
+        orientation: 'Landscape',
+        page_size: 'A4',
+        margin_top: '15mm',
+        grayscale: true
+      }
+    }) %>
+
+ `padding` is a shorthand that sets all four margins at once. `wkhtmltopdf_options` accepts **any** option the `wkhtmltopdf` CLI supports (underscores or dashes both work, e.g. `margin_top`, `page_size`, `orientation`, `dpi`, `zoom`, `encoding`, `javascript_delay`, `disable_smart_shrinking`, ...) — see https://wkhtmltopdf.org for the full list. Boolean-style flags (e.g. `grayscale: true`) are passed as bare flags; anything else is passed as `--flag value`.
+
+ ##### Security note: `pdf_options` is read from the request's query params and forwarded verbatim as CLI flags to `wkhtmltopdf`. If `your_action_path` is publicly reachable, anyone can pass arbitrary `wkhtmltopdf` flags to it. Only expose the pdf format on actions where that's acceptable, or filter `pdf_options` yourself before it reaches `html_to_pdf` (e.g. in a `before_action` that runs earlier).
+
+## Configuration
+
+Set gem-wide defaults in an initializer (e.g. `config/initializers/html_to_pdf.rb`):
+
+    HtmlToPdf.configure do |config|
+      # Path to the wkhtmltopdf binary. Defaults to "wkhtmltopdf" (resolved via $PATH).
+      # Useful when it's installed via the wkhtmltopdf-binary gem or a custom location.
+      config.wkhtmltopdf_path = Wkhtmltopdf.path # or an absolute path string
+
+      # Layout used when pdf_options[:layout] isn't given. Defaults to "application".
+      config.default_layout = "pdf"
+
+      # wkhtmltopdf options applied to every PDF, merged under any per-request
+      # padding/wkhtmltopdf_options. Defaults to {}.
+      config.default_options = { dpi: 300, margin_top: "10mm" }
+
+      # Directory temporary .html/.pdf files are written to. Defaults to Rails.root/tmp.
+      config.tmp_dir = Rails.root.join("tmp", "pdfs")
+    end
+
+ ##### Make sure you have configured your `asset_host` in application's Rails environment, otherwise assets might not be loaded properly.
+
+`config.action_controller.asset_host = "YOUR_ASSETS_HOST"`
+

data/htmlToPdf.gemspec

@@ -8,14 +8,15 @@ Gem::Specification.new do |spec|
   spec.version       = HtmlToPdf::VERSION
   spec.authors       = ["Ram Laxman Yadav"]
   spec.email         = ["yadavramlaxman@gmail.com"]
-  spec.summary       = %q{html to pdf converter gem}
-  spec.description   = %q{this gem will generate pdf of given html using wkhtmltopdf}
-  spec.homepage      = ""
+  spec.summary       = %q{Render Rails controller actions to PDF using wkhtmltopdf}
+  spec.description   = %q{HtmlToPdf lets any Rails controller action be downloaded as a PDF. Request the action with a PDF format and the gem renders the view exactly as the browser would, then converts it to PDF via wkhtmltopdf. Supports Rails 7.x and 8.x.}
+  spec.homepage      = "https://github.com/ramlaxmanyadav/htmlToPdf"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", ">= 2.4"
+  spec.add_development_dependency "rake", ">= 13.0"
 end

data/lib/htmlToPdf/configuration.rb

@@ -0,0 +1,28 @@
+module HtmlToPdf
+  class Configuration
+    attr_accessor :wkhtmltopdf_path, :default_layout, :default_options, :tmp_dir
+
+    def initialize
+      @wkhtmltopdf_path = 'wkhtmltopdf'
+      @default_layout   = 'application'
+      @default_options  = {}
+      @tmp_dir          = nil
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/htmlToPdf/version.rb

@@ -1,3 +1,3 @@
 module HtmlToPdf
-  VERSION = "0.1.0"
+  VERSION = "2.0.0"
 end

data/lib/htmlToPdf.rb

@@ -1,43 +1,87 @@
+require "securerandom"
 require "htmlToPdf/version"
+require "htmlToPdf/configuration"
 
 module HtmlToPdf
 
   def html_to_pdf()
-    pdf_options = params[:pdf_options] ? params[:pdf_options] : {} 
+    pdf_options = params[:pdf_options] ? params[:pdf_options] : {}
     if request.format == 'application/pdf'
       initialize_downloads(pdf_options)
-      FileUtils.mkdir_p(File.join(Rails.root, 'tmp'))
-      _source_file = File.join(Rails.root, 'tmp', "#{Time.now.to_i.to_s}.html")
-      _destination_file = File.join(Rails.root, 'tmp', "#{@name}.pdf")
+      _tmp_dir = HtmlToPdf.configuration.tmp_dir || File.join(Rails.root, 'tmp')
+      FileUtils.mkdir_p(_tmp_dir)
+      _unique_id = "#{Time.now.to_i}_#{SecureRandom.hex(8)}"
+      _source_file = File.join(_tmp_dir, "#{_unique_id}.html")
+      _destination_file = File.join(_tmp_dir, "#{_unique_id}.pdf")
       _controller = ("#{controller_name}Controller").camelize.constantize.new
+      _controller.request = request
+      _controller.response = response
+      _controller.params = params
       _controller.method(action_name).call
-      _assigns = {}
+
       _controller.instance_variables.each do |var|
-        _assigns[var] = _controller.instance_variable_get(var)
+        instance_variable_set(var, _controller.instance_variable_get(var))
       end
-      _assigns.merge!({url: Rails.application.routes.url_helpers})
-      
-      _html = render_to_string(template: "#{controller_name}/#{action_name}", :layout => @layout, locals: _assigns)
+
+      _html = render_to_string(template: "#{controller_name}/#{action_name}", :layout => @layout, locals: { url: Rails.application.routes.url_helpers })
       file_content = _html.gsub(/\\"/, "")
 
 
       File.open(_source_file, "w+") do |f|
         f.write(file_content)
       end
-      system("wkhtmltopdf #{_source_file} #{_destination_file}")
+      system(HtmlToPdf.configuration.wkhtmltopdf_path, *wkhtmltopdf_args, _source_file, _destination_file)
       File.delete(_source_file) if File.exist?(_source_file)
-      send_data File.open(_destination_file, "rb") { |f| f.read }, :disposition => 'attachment',:filename => "#{@name}.pdf"
+      send_data File.open(_destination_file, "rb") { |f| f.read }, :disposition => 'attachment', :filename => "#{sanitized_pdf_name}.pdf"
       File.delete(_destination_file)
     end
   end
 
   def initialize_downloads(pdf_options = {})
-    if pdf_options
-      @name = pdf_options[:title].nil? ? "#{Time.now.to_i.to_s}" : pdf_options[:title]
-      @layout = pdf_options[:layout].nil? ? 'application' : pdf_options[:layout]
-    else
-      @name = "#{Time.now.to_i.to_s}"
-      @layout = 'application'
+    pdf_options ||= {}
+    @name = pdf_options[:title].nil? ? "#{Time.now.to_i.to_s}" : pdf_options[:title]
+    @layout = pdf_options[:layout].nil? ? HtmlToPdf.configuration.default_layout : pdf_options[:layout]
+    @wkhtmltopdf_options = build_wkhtmltopdf_options(pdf_options)
+  end
+
+  def sanitized_pdf_name
+    @name.to_s.gsub(/[^a-zA-Z0-9_\- ]/, '').strip.presence || Time.now.to_i.to_s
+  end
+
+  # Merges, in increasing precedence: HtmlToPdf.configuration.default_options,
+  # pdf_options[:padding] (shorthand applied to all four margins), then
+  # pdf_options[:wkhtmltopdf_options] (any wkhtmltopdf flag, e.g. orientation:
+  # 'Landscape', page_size: 'A4', grayscale: true). Keys are dasherized so
+  # either underscore or dash form works.
+  def build_wkhtmltopdf_options(pdf_options)
+    options = dasherize_keys(HtmlToPdf.configuration.default_options)
+
+    if pdf_options[:padding].present?
+      padding = pdf_options[:padding].to_s
+      %w[margin-top margin-bottom margin-left margin-right].each { |flag| options[flag] = padding }
+    end
+
+    options.merge!(dasherize_keys(pdf_options[:wkhtmltopdf_options] || {}))
+    options
+  end
+
+  def dasherize_keys(hash)
+    hash.each_with_object({}) { |(key, value), acc| acc[key.to_s.tr('_', '-')] = value }
+  end
+
+  # Query-string values arrive as strings (e.g. grayscale: true serializes to
+  # "true" in a link_to href and comes back as that literal string), so plain
+  # booleans aren't enough to detect a falsy/truthy flag.
+  FALSEY_VALUES = [nil, false, '', '0', 'false', 'off'].freeze
+  TRUTHY_FLAG_VALUES = [true, 'true'].freeze
+
+  def wkhtmltopdf_args
+    (@wkhtmltopdf_options || {}).each_with_object([]) do |(flag, value), args|
+      normalized = value.is_a?(String) ? value.downcase : value
+      next if FALSEY_VALUES.include?(normalized)
+
+      args << "--#{flag}"
+      args << value.to_s unless TRUTHY_FLAG_VALUES.include?(normalized)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: htmlToPdf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ram Laxman Yadav
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2026-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,29 +16,31 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: this gem will generate pdf of given html using wkhtmltopdf
+        version: '13.0'
+description: HtmlToPdf lets any Rails controller action be downloaded as a PDF. Request
+  the action with a PDF format and the gem renders the view exactly as the browser
+  would, then converts it to PDF via wkhtmltopdf. Supports Rails 7.x and 8.x.
 email:
 - yadavramlaxman@gmail.com
 executables: []
@@ -52,12 +54,13 @@ files:
 - Rakefile
 - htmlToPdf.gemspec
 - lib/htmlToPdf.rb
+- lib/htmlToPdf/configuration.rb
 - lib/htmlToPdf/version.rb
-homepage: ''
+homepage: https://github.com/ramlaxmanyadav/htmlToPdf
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,15 +68,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
-summary: html to pdf converter gem
+summary: Render Rails controller actions to PDF using wkhtmltopdf
 test_files: []