wicked_pdf 1.0.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3a9bd19353fd98c1329694e7e28958e05dd01d97
-  data.tar.gz: 33413fa1202def89fa910d38996ea732ac86b706
+SHA256:
+  metadata.gz: b6fc82b54d2e17d53f2e9c8b23d4987dccb18e38a20f8aadaa57cd2b7c263bcb
+  data.tar.gz: bb936e81af7719b89e6878c891b9bb2d5a3fd8742a24640e2508773c9b2be0dc
 SHA512:
-  metadata.gz: a7c925ec176e0976cede93924098016466bd8627a99af611b89c283792ccbd9a154a450a2d9370079d9f6f72d1d48c8c57e0ef5ab3d25f235b242222aa4deabe
-  data.tar.gz: 44b674f5bc1efd1bdb54354f0cc05d13442af7427c53c903821951491f17923466d9d8223303e0519d6b37ba8e2fce8ba534b1d88fcda33c139f61db9d7e1b61
+  metadata.gz: 3fe8ce87aa78a2d6d1d1e6590d1f069762b56f363aad561c255f7d1f0ba461fabcfb63177a34a547d4de7f1d6bebc9d3f2a17fa0095b7f36d0fb7a0f1c28a657
+  data.tar.gz: d2a74408e9a7b90046c3c6ecada7af16f7ccacf0fbe787a25b99b218c17ba42945d5854cd4c0631d2c73b2b306e55ca97a424ee6d313fc357d20378696a4945a

data/.github/issue_template.md

@@ -0,0 +1,15 @@
+## Issue description
+
+## Expected or desired behavior
+
+## System specifications
+
+wicked_pdf gem version (output of `cat Gemfile.lock | grep wicked_pdf`):
+
+wkhtmltopdf version (output of `wkhtmltopdf --version`):
+
+whtmltopdf [provider gem](https://rubygems.org/search?utf8=%E2%9C%93&query=wkhtmltopdf) and version if one is used:
+
+platform/distribution and version (e.g. Windows 10 / Ubuntu 16.04 / Heroku cedar):
+
+

data/.rubocop.yml

@@ -1,9 +1,14 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
+  TargetRubyVersion: 1.9
   Exclude:
     - 'test/dummy/**/*'
 
+Metrics/BlockLength:
+  Exclude:
+    - 'wicked_pdf.gemspec'
+
 # I'd like wicked_pdf to keep Ruby 1.8 compatibility for now
 Style/HashSyntax:
   EnforcedStyle: hash_rockets

data/.rubocop_todo.yml

@@ -5,13 +5,6 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-
-# Offense count: 2
-Lint/HandleExceptions:
-  Enabled: false
 
 # Offense count: 9
 Metrics/AbcSize:
@@ -24,11 +17,14 @@ Metrics/BlockNesting:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 279
+  Max: 300
+
+Metrics/ModuleLength:
+  Max: 160
 
 # Offense count: 5
 Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 11
 
 # Offense count: 92
 # Configuration parameters: AllowURI, URISchemes.
@@ -44,8 +40,8 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Max: 12
 
-# Offense count: 5
-Style/AccessorMethodName:
+# Offense count: 2
+Naming/AccessorMethodName:
   Enabled: false
 
 # Offense count: 1

data/.travis.yml

@@ -1,18 +1,12 @@
 language:
   - ruby
+git:
+  depth: 1
+  quiet: true
+before_install:
+  - sudo apt-get update -qq
 bundler_args: --verbose
 sudo: required
-rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - ruby-head
-gemfile:
-  - gemfiles/3.0.gemfile
-  - gemfiles/3.1.gemfile
-  - gemfiles/3.2.gemfile
 before_script:
   - bundle list
   - sudo apt-get install -y wkhtmltopdf
@@ -20,38 +14,67 @@ before_script:
   - "sh -e /etc/init.d/xvfb start"
 env: WKHTMLTOPDF_BIN=/usr/bin/wkhtmltopdf
 script:
-  - bundle exec rake dummy_generate
-  - bundle exec rake test
+  - bundle exec rake
 matrix:
   include:
     - rvm: 1.8.7
       before_install:
+        - sudo apt-get update -qq
         - gem update --system 1.8.25
         - gem --version
       gemfile: gemfiles/2.3.gemfile
+    - rvm: 1.9.2
+      gemfile: gemfiles/3.0.gemfile
     - rvm: 1.9.3
+      gemfile: gemfiles/3.1.gemfile
+    - rvm: 2.0
+      gemfile: gemfiles/3.2.gemfile
+    - rvm: 2.0
       gemfile: gemfiles/4.0.gemfile
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails_edge.gemfile
-    - rvm: 2.0.0
-      gemfile: gemfiles/4.0.gemfile
-    - rvm: 2.0.0
-      gemfile: gemfiles/rails_edge.gemfile
-    - rvm: 2.2.0
+    - rvm: 2.1
       gemfile: gemfiles/4.1.gemfile
-    - rvm: 2.2.0
+    - rvm: 2.2
       gemfile: gemfiles/4.2.gemfile
-    - rvm: 2.2.0
+    - rvm: 2.3
+      gemfile: gemfiles/5.0.gemfile
+      before_install:
+        # https://github.com/danmayer/coverband/issues/162
+        - "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.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
       gemfile: gemfiles/rails_edge.gemfile
-  allow_failures:
-    - rvm: 1.9.2
-      gemfile: gemfiles/3.1.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/3.2.gemfile
-    - rvm: 1.9.3
+    - rvm: 2.6
+      gemfile: gemfiles/5.2.gemfile
+      before_install:
+        - gem update --system
+        - gem install bundler
+    - rvm: 2.6
       gemfile: gemfiles/rails_edge.gemfile
-    - rvm: 2.0.0
+      before_install:
+        - gem update --system
+        - gem install bundler
+    - rvm: ruby-head
+      gemfile: gemfiles/5.2.gemfile
+      before_install:
+        - gem install bundler -v '~> 2'
+    - rvm: ruby-head
+      gemfile: gemfiles/rails_edge.gemfile
+      before_install:
+        - gem install bundler -v '~> 2'
+  allow_failures:
+    - rvm: 2.5
       gemfile: gemfiles/rails_edge.gemfile
-    - rvm: 2.2.0
+    - rvm: 2.6
       gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.5.3
+      gemfile: gemfiles/3.0.gemfile
     - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,148 @@
+# Change Log
+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.4.0] - 2019-05-23
+### New Features
+- [Add support for `log_level` and `quiet` options](https://github.com/mileszs/wicked_pdf/pull/834)
+
+## [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
+### Fixes
+- [Fix `SystemStackError` in some setups](https://github.com/mileszs/wicked_pdf/pull/813)
+
+## [1.2.0] - 2019-03-16
+### 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.
+
+### 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)
+- [Fix error when the `Rails` constant is defined but not actually using Rails](https://github.com/mileszs/wicked_pdf/pull/613)
+- [Fix compatibility issue with Sprockets 4](https://github.com/mileszs/wicked_pdf/pull/615)
+- [Fix compatibility issue with `Mime::JS` in Rails 5.1+](https://github.com/mileszs/wicked_pdf/pull/627)
+- [Fix deprecation warning by using `after_action` instead of `after_filter` when available](https://github.com/mileszs/wicked_pdf/pull/663)
+- [Provide Rails `base_path` to `find_asset` calls for Sprockets file lookup](https://github.com/mileszs/wicked_pdf/pull/688)
+- Logger changes:
+    - [Use `Rails.logger.debug` instead of `p`](https://github.com/mileszs/wicked_pdf/pull/575)
+    - [Change logger message to prepend `[wicked_pdf]` instead of nonstandard `****************WICKED****************`](https://github.com/mileszs/wicked_pdf/pull/589)
+- Documentation changes:
+    - [Update link to wkhtmltopdf homepage](https://github.com/mileszs/wicked_pdf/pull/582)
+    - [Update link to `wkhtmltopdf_binary_gem`](https://github.com/mileszs/wicked_pdf/commit/59e6c5fca3985f2fa2f345089596250df5da2682)
+    - [Update documentation for usage with the Asset Pipeline](https://github.com/mileszs/wicked_pdf/commit/690d00157706699a71b7dcd71834759f4d84702f)
+    - [Document `default_protocol` option](https://github.com/mileszs/wicked_pdf/pull/585)
+    - [Document `image` and `no_image` options](https://github.com/mileszs/wicked_pdf/pull/689)
+    - [Document issue with DPI/scaling on various platforms](https://github.com/mileszs/wicked_pdf/pull/715)
+    - [Document creating and attaching a PDF in a mailer](https://github.com/mileszs/wicked_pdf/pull/746)
+    - [Document dependency on `wkhtmltopdf` with RubyGems](https://github.com/mileszs/wicked_pdf/pull/656)
+    - [Add example using WickedPDF with Rails in an API-only configuration](https://github.com/mileszs/wicked_pdf/pull/796)
+    - [Add example for rending a template as a header/footer](https://github.com/mileszs/wicked_pdf/pull/603)
+    - [Add GitHub issue template](https://github.com/mileszs/wicked_pdf/pull/805)
+    - [Add CodeClimate Badge](https://github.com/mileszs/wicked_pdf/pull/646)
+- RuboCop cleanup
+- Updates to Travis CI pipeline to support newer versions of Ruby & Rails
+
+## [1.1.0] - 2016-08-30
+### 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)
+
+### 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)
+
+## [1.0.6] - 2016-04-04
+### 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
+### 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!
+- 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
+### 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`.
+- [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
+### 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
+### 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
+### Fixes
+- Made minor RuboCop style tweaks.
+- Added default [RuboCop](https://github.com/bbatsov/rubocop) config and run after test suite.
+- Issue with `nil.basename` from asset helpers.
+
+## [1.0.0] - 2015-11-03
+### 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)
+
+### 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.
+
+### 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)
+- 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` assests in stylesheets rendered with `wicked_pdf_stylesheet_link_tag`
+- Asset helpers no longer add a file extension if it already is specified with one
+
+# 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)
+- [1.0.6...1.1.0](https://github.com/mileszs/wicked_pdf/compare/1.0.6...1.1.0)
+- [1.0.5...1.0.6](https://github.com/mileszs/wicked_pdf/compare/1.0.5...1.0.6)
+- [1.0.4...1.0.5](https://github.com/mileszs/wicked_pdf/compare/1.0.4...1.0.5)
+- [1.0.3...1.0.4](https://github.com/mileszs/wicked_pdf/compare/1.0.3...1.0.4)
+- [1.0.2...1.0.3](https://github.com/mileszs/wicked_pdf/compare/1.0.2...1.0.3)
+- [1.0.1...1.0.2](https://github.com/mileszs/wicked_pdf/compare/1.0.1...1.0.2)
+- [1.0.0...1.0.1](https://github.com/mileszs/wicked_pdf/compare/1.0.0...1.0.1)
+- [0.11.0...1.0.0](https://github.com/mileszs/wicked_pdf/compare/0.11.0...1.0.0)
+- [0.10.2...0.11.0](https://github.com/mileszs/wicked_pdf/compare/0.10.2...0.11.0)
+- [0.10.1...0.10.2](https://github.com/mileszs/wicked_pdf/compare/0.10.1...0.10.2)
+- [0.10.0...0.10.1](https://github.com/mileszs/wicked_pdf/compare/0.10.0...0.10.1)
+- [0.9.10...0.10.0](https://github.com/mileszs/wicked_pdf/compare/0.9.10...0.10.0)