wicked_pdf 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50ba6bd10f9e6f6a29b3db9d8b6df69bbcea50b76aa3c663f44a42dc0475d60f
-  data.tar.gz: 68639e18162e3d3af6c825a9d72fc35af3f32e3c6e29dedd879be43b40db3d32
+  metadata.gz: db4dbc2079a0b29bddf81631c25ff650634c9d0c8eba113e3e221be3ab07a475
+  data.tar.gz: c585d8856402144601bbdfe0da056702ba2d501b9239a6339836c9389630263e
 SHA512:
-  metadata.gz: d3390768c498abe569a314347239660b3b2e82bae7a28498d0da98085883da680f33fc8ffa01140775cd70f4c0fde1683bbdf1a7bfceec7ae3b2ec63c39db263
-  data.tar.gz: bfa9bfceba95a83d81932729d0cf59db57339b01844c1dfcb94ad244b1b1f8f9e78c279b6811bdb14e9b54d41b1712f61b630c0f60b48d84086326f3ef30c4e8
+  metadata.gz: 6a23f141de26136b65e399a1a2a7281fddc9790ebaeecefdee406372a7859c3e87ba247775ef298a355b48e0cdf9ae4387ef0a8d453764fd0ffe65e2665fa79b
+  data.tar.gz: b16b6ff02dc084f55640c91552300d22afe5b73550feb42ecc036e65c896033fb95969ca4f3c276613aa360fb6dedc5129d0802558492277f7666ba8cd540b74

data/.rubocop_todo.yml

@@ -20,7 +20,7 @@ Metrics/ClassLength:
   Max: 300
 
 Metrics/ModuleLength:
-  Max: 120
+  Max: 160
 
 # Offense count: 5
 Metrics/CyclomaticComplexity:

data/.travis.yml

@@ -44,6 +44,10 @@ matrix:
         - gem install bundler -v '< 2'
     - rvm: 2.4
       gemfile: gemfiles/5.1.gemfile
+      before_install:
+        - "find /home/travis/.rvm/rubies -wholename '*default/bundler-*.gemspec' -delete"
+        - rvm @global do gem uninstall bundler -a -x -I || true
+        - gem install bundler -v '< 2'
     - rvm: 2.5
       gemfile: gemfiles/5.2.gemfile
     - rvm: 2.5

data/CHANGELOG.md

@@ -2,22 +2,34 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [master branch] - Unreleased
+### Breaking Changes
+- None
+### New Features
+- None
+### Fixes
+- None
+
+## [1.3.0] - 2019-05-20
+### New Features
+- [Add support for Webpacker provided bundles](https://github.com/mileszs/wicked_pdf/pull/739)
+
 ## [1.2.2] - 2019-04-13
 ### Fixes
 - [Fix issue loading Pty on Windows](https://github.com/mileszs/wicked_pdf/pull/820)
 - [Fix conflict with remotipart causing SystemStackError](https://github.com/mileszs/wicked_pdf/pull/821)
 
 ## [1.2.1] - 2019-03-16
-### Changed
+### Fixes
 - [Fix `SystemStackError` in some setups](https://github.com/mileszs/wicked_pdf/pull/813)
 
 ## [1.2.0] - 2019-03-16
-### Added
+### New Features
 - [Add `raise_on_all_errors: true` option to raise on any error that prints to STDOUT during PDF generation](https://github.com/mileszs/wicked_pdf/pull/751)
 - [Add ability to use the `assigns` option to `render` to assign instance variables to a PDF template](https://github.com/mileszs/wicked_pdf/pull/801)
 - [Add ability to track console progress](https://github.com/mileszs/wicked_pdf/pull/804) with `progress: -> (output) { puts output }`. This is useful to add reporting hooks to show your frontend what page number is being generated.
 
-### Changed
+### Fixes
 - [Fix conflict with other gems that hook into `render`](https://github.com/mileszs/wicked_pdf/pull/574) and avoid using `alias_method_chain` where possible
 - [Fix issue using the shell to locate `wkhtmltopdf` in a Bundler environment](https://github.com/mileszs/wicked_pdf/pull/728)
 - [Fix `wkhtmltopdf` path detection when HOME environment variable is unset](https://github.com/mileszs/wicked_pdf/pull/568)
@@ -46,71 +58,61 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Updates to Travis CI pipeline to support newer versions of Ruby & Rails
 
 ## [1.1.0] - 2016-08-30
-### Added
+### New Features
 - Support Rails 5.x and Sprockets 3.x
 - Support `window_status: 'somestring'` option, to instruct wkhtmltopdf to wait until the browser `window.status` is equal to the supplied string. This can be useful to force rendering to wait [as explained quite well here](https://spin.atomicobject.com/2015/08/29/ember-app-done-loading/)
 - Support `no_stop_slow_scripts: true` to let slow running scripts delay rendering
+- [Changes to asset finding to support Rails 5](https://github.com/mileszs/wicked_pdf/pull/561)
 
-### Changed
+### Fixes
 - [Improved error handling](https://github.com/mileszs/wicked_pdf/pull/543)
 - [Namespace helper classes under WickedPdf namespace](https://github.com/mileszs/wicked_pdf/pull/538)
-- [Changes to asset finding to support Rails 5](https://github.com/mileszs/wicked_pdf/pull/561)
 
 ## [1.0.6] - 2016-04-04
-### Changed
+### Fixes
 - Revert shellescaping of options. The fix was causing more issues than it solved (like "[page] of [topage]" being escaped, and thus not parsed by `wkhtmltopdf`). See #514 for details.
 
 ## [1.0.5] - 2016-03-28
-### Changed
+### Fixes
 - Numerous RuboCop style violation fixes, spelling errors, and test-setup issues from [indyrb.org](http://indyrb.org/) hack night. Thank you all for your contributions!
-
-### Fixed
 - Shellescape options. A stray quote in `header` or `footer` would cause PDF to fail to generate, and this should close down many potential attack vectors if you allow user-supplied values to be passed into `wicked_pdf` render options.
 
 ## [1.0.4] - 2016-01-26
-### Changed
+### Fixes
 - Check that logger responds to info before calling it. It was possible to have a `logger` method defined as a controller helper that would override `Rails.logger`.
-
-### Fixed
 - [Issue with Sprockets 3.0](https://github.com/mileszs/wicked_pdf/issues/476) where an asset referenced in a stylesheet not existing would raise an exception `read_asset` on nil.
 
 ## [1.0.3] - 2015-12-02
-### Changed
+### Fixes
 - Revert default DPI. Some installs of `wkhtmltopdf` would experience major slowdowns or crashes with it set to 72. It is suggested that a DPI of 75 may be better, but I'm holding off on making it a default without more information.
 
 ## [1.0.2] - 2015-11-30
-### Changed
+### Fixes
 - The default dpi is now 72. Previously the default would be whatever your `wkhtmltopdf` version specified as the default. This change [speeds up generation of documents that contain `border-radius` dramatically](https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1510)
 
 ## [1.0.1] - 2015-11-19
-### Changed
+### Fixes
 - Made minor RuboCop style tweaks.
-
-### Added
 - Added default [RuboCop](https://github.com/bbatsov/rubocop) config and run after test suite.
-
-### Fixed
 - Issue with `nil.basename` from asset helpers.
 
 ## [1.0.0] - 2015-11-03
-### Changed
+### 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](https://rubygems.org/gems/wicked_pdf)).
 - Stopped attempting to track with version number of `wkhtmltopdf` binary releases (`wkhtmltopdf` v9.x == `WickedPDF` v9.x)
 - Adopted [Semantic Versioning](http://semver.org/) for release numbering
 - Added a CHANGELOG (based on [keepachangelog.com](http://keepachangelog.com/))
 - Misc code tweaks as suggested by [RuboCop](https://github.com/bbatsov/rubocop)
 
-### Added
+### 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 wkhtmltopf: `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](https://github.com/rails/rails), since parts of this library may be used without it.
 
-### Removed
-- Explicit dependency on [Rails](https://github.com/rails/rails), since parts of this library may be used without it.
+### Fixes
 - Comment out the `:exe_path` option in the generated initalizer by default (since many systems won't have `wkthmltopdf` installed in that specific location)
-
-### Fixed
 - 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
@@ -124,6 +126,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 # Compare Releases
 - [1.2.2...HEAD](https://github.com/mileszs/wicked_pdf/compare/1.2.2...HEAD)
+- [1.2.2...1.3.0](https://github.com/mileszs/wicked_pdf/compare/1.2.2...1.3.0)
 - [1.2.1...1.2.2](https://github.com/mileszs/wicked_pdf/compare/1.2.1...1.2.2)
 - [1.2.0...1.2.1](https://github.com/mileszs/wicked_pdf/compare/1.1.0...1.2.0)
 - [1.1.0...1.2.0](https://github.com/mileszs/wicked_pdf/compare/1.1.0...1.2.0)

data/README.md

@@ -85,7 +85,6 @@ The wkhtmltopdf binary is run outside of your Rails application; therefore, your
   </body>
 </html>
 ```
-
 Using wicked_pdf_helpers with asset pipeline raises `Asset names passed to helpers should not include the "/assets/" prefix.` error. To work around this, you can use `wicked_pdf_asset_base64` with the normal Rails helpers, but be aware that this will base64 encode your content and inline it in the page. This is very quick for small assets, but large ones can take a long time.
 
 ```html
@@ -108,6 +107,13 @@ Using wicked_pdf_helpers with asset pipeline raises `Asset names passed to helpe
 </html>
 ```
 
+#### Webpacker usage
+
+wicked_pdf supports webpack stylesheets and javascript assets.
+
+Use `wicked_pdf_stylesheet_pack_tag` for stylesheets
+Use `wicked_pdf_javascript_pack_tag` for javascripts
+
 #### Asset pipeline usage
 
 It is best to precompile assets used in PDF views. This will help avoid issues when it comes to deploying, as Rails serves asset files differently between development and production (`config.assets.compile = false`), which can make it look like your PDFs work in development, but fail to load assets in production.
@@ -126,6 +132,9 @@ In this case, you can use that standard Rails helpers and point to the current C
 ```
 
 ### Advanced Usage with all available options
+
+_NOTE: Certain options are only supported in specific versions of wkhtmltopdf._
+
 ```ruby
 class ThingsController < ApplicationController
   def show

data/lib/wicked_pdf/version.rb

@@ -1,3 +1,3 @@
 class WickedPdf
-  VERSION = '1.2.2'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/lib/wicked_pdf/wicked_pdf_helper/assets.rb

@@ -1,4 +1,6 @@
 require 'open-uri'
+# If webpacker is used, need to check for version
+require 'webpacker/version' if defined?(Webpacker)
 
 class WickedPdf
   module WickedPdfHelper
@@ -27,6 +29,32 @@ class WickedPdf
         end.html_safe
       end
 
+      def wicked_pdf_stylesheet_pack_tag(*sources)
+        return unless defined?(Webpacker)
+        if running_in_development?
+          stylesheet_pack_tag(*sources)
+        else
+          css_text = sources.collect do |source|
+            source = WickedPdfHelper.add_extension(source, 'css')
+            wicked_pdf_stylesheet_link_tag(webpacker_source_url(source))
+          end.join("\n")
+          css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
+        end
+      end
+
+      def wicked_pdf_javascript_pack_tag(*sources)
+        return unless defined?(Webpacker)
+
+        if running_in_development?
+          javascript_pack_tag(*sources)
+        else
+          sources.collect do |source|
+            source = WickedPdfHelper.add_extension(source, 'js')
+            "<script type='text/javascript'>#{read_asset(webpacker_source_url(source))}</script>"
+          end.join("\n").html_safe
+        end
+      end
+
       def wicked_pdf_image_tag(img, options = {})
         image_tag wicked_pdf_asset_path(img), options
       end
@@ -130,6 +158,28 @@ class WickedPdf
       rescue Zlib::GzipFile::Error
         nil
       end
+
+      def webpacker_source_url(source)
+        return unless defined?(Webpacker) && defined?(Webpacker::VERSION)
+        # In Webpacker 3.2.0 asset_pack_url is introduced
+        if Webpacker::VERSION >= '3.2.0'
+          asset_pack_url(source)
+        else
+          source_path = asset_pack_path(source)
+          # Remove last slash from root path
+          root_url[0...-1] + source_path
+        end
+      end
+
+      def running_in_development?
+        return unless defined?(Webpacker)
+        # :dev_server method was added in webpacker 3.0.0
+        if Webpacker.respond_to?(:dev_server)
+          Webpacker.dev_server.running?
+        else
+          Rails.env.development? || Rails.env.test?
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wicked_pdf
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Miles Z. Sterrett
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -199,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - wkhtmltopdf
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: PDF generator (from HTML) gem for Ruby on Rails