« Changelog History


Wicked Pdf v1.0.0 Release Notes

Release Date: 2015-11-03 // over 8 years ago

  • 💥 Breaking Changes

    • Accepted that WickedPDF cannot guarantee backwards compatibility with older versions of wkthmltopdf, and decided to publish a new version with the MAJOR number incremented, signaling that this may have breaking changes for some people, but providing a path forward for progress. This release number also signals that this is a mature (and relatively stable) project, and should be deemed ready for production (since it has been used in production since ~2009, and downloaded over a million times on RubyGems.org).
    • 🚀 Stopped attempting to track with version number of wkhtmltopdf binary releases (wkhtmltopdf v9.x == WickedPDF v9.x)
    • 🚀 Adopted Semantic Versioning for release numbering
    • ➕ Added a CHANGELOG (based on keepachangelog.com)
    • Misc code tweaks as suggested by RuboCop

    🆕 New Features

    • Check version of wkhtmltopdf before deciding to pass arguments with or without dashes
    • New arguments and options for the table of contents supported in newer versions of wkhtmltopdf: text_size_shrink, level_indentation, disable_dotted_lines, disable_toc_links, xsl_style_sheet
    • Merge in global options to pdf_from_html_file and pdf_from_string
    • Add ability to generate pdf from a web resource: pdf_from_url(url)
    • ✂ Removed explicit dependency on Rails, since parts of this library may be used without it.

    🛠 Fixes

    • 0️⃣ Comment out the :exe_path option in the generated initializer by default (since many systems won't have wkthmltopdf installed in that specific location)
    • 🏁 Issues with file:// paths on Windows-based systems
    • 📜 Issues with parsed options/argument ordering on versions of wkthmltopdf > 0.9
    • 🚅 Issues with middleware headers when running Rails app mounted in a subdirectory
    • Issues with options that have a key: 'value' syntax when passed to wkthmltopdf
    • Issue with :temp_path option being deleted from original options hash
    • Issue with header/footer :content being deleted after the first page
    • Issues with options being modified during processing (including global config options)
    • 🍱 Issues with asset helpers recognizing assets specified without a protocol
    • Issues with url() references and embedded data:base64 assets in stylesheets rendered with wicked_pdf_stylesheet_link_tag
    • Asset helpers no longer add a file extension if it already is specified with one