adzap-wicked_pdf 2.0.0.beta1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56cc9f21233c4aa590afe1bf5577c967a56abeec26c3fccbd302effe839c3421
-  data.tar.gz: 9b0d47a24d5c9fe990efc2290fc64606b9177862217107186bea786955f93ac0
+  metadata.gz: a4ea1861662d27d078f0687835542b048648b15237258699e266f0ab018fd608
+  data.tar.gz: 47dc57c0ed8a638a3ab3921ad746248c6c2a72f2ab355b2448f2188ac2718388
 SHA512:
-  metadata.gz: ee172642130eedcb6fbfed05656e9f420625e5fcd9be1763dec387b76d4b21051581bf7ba7dd9a4499b6941462a347e08c7bf8b279d100e56378610762d5dc5d
-  data.tar.gz: 687d4369110d2c14e8d08fe4bad877fca2fc38182ab5632efb3dd903c341619e66bdc864e3a10f27f96a87f9c1444aa6022e59ead5bec20e176251778a9739fb
+  metadata.gz: 2a41b903e2d397afcf0f20fc0b72f5a9fbecf97f3e6f75f974fe0a827fa8f961dd09d9d0a29828c3b5cb3fd30f2c9066016eb9f88c3eb64892c4fa5a4a8606d7
+  data.tar.gz: 4730471489cd16958963fabacdf9bb25c4509539491c20ec9706ffecb0a678f8b5e8cf34e9aacfafc04ceb2b17ab670039e4558cc3b2639bcca35e2a4f11bbbe

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+dist: xenial
 git:
   depth: 1
   quiet: true
@@ -10,9 +11,9 @@ before_install:
 bundler_args: --verbose
 before_script:
   - bundle list
-  - sudo apt-get install -y wkhtmltopdf
+  - sudo apt-get install -y xvfb wkhtmltopdf
   - "export DISPLAY=:99.0"
-  - "sh -e /etc/init.d/xvfb start"
+  - "sudo systemctl start xvfb"
 env: WKHTMLTOPDF_BIN=/usr/bin/wkhtmltopdf
 script:
   - bundle exec rake

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
+gem 'byebug'
+
 gemspec

data/README.md

@@ -1,12 +1,12 @@
 # Wicked PDF [![Gem Version](https://badge.fury.io/rb/adzap-wicked_pdf.svg)](http://badge.fury.io/rb/adzap-wicked_pdf) [![Build Status](https://secure.travis-ci.org/adzap/wicked_pdf.svg)](http://travis-ci.org/adzap/wicked_pdf) 
 
-_This is a fork of the [original](https://github.com/milesz/wicked_pdf) to redesign the internals for a much lighter footprint on your app and offer greater extensibility_
+_This is a fork of the [original](https://github.com/milesz/wicked_pdf) that modernises all dependencies and redesign the internals for a much lighter footprint on your app and offer greater extensibility._
 
 ## A PDF generation plugin for Ruby on Rails
 
-Wicked PDF uses the shell utility [wkhtmltopdf](http://wkhtmltopdf.org) to serve a PDF file to a user from HTML.  In other words, rather than dealing with a PDF generation DSL of some sort, you simply write an HTML view as you would normally, then let Wicked PDF take care of the hard stuff.
+Wicked PDF uses the shell utility [wkhtmltopdf](http://wkhtmltopdf.org) v0.12.x to serve a PDF file to a user from HTML. In other words, rather than dealing with a PDF generation DSL of some sort, you simply write an HTML view as you would normally, then let Wicked PDF take care of the hard stuff.
 
-_Wicked PDF has been verified to work on Ruby versions 2.3 through 2.6; Rails 4.2 through 5.2_
+_Wicked PDF has been verified to work on Ruby versions 2.3 through 2.6; Rails 4.2 through 5.2; Minimum supported version of wkhtmltopdf is 0.12.0._
 
 ### Installation
 
@@ -20,7 +20,7 @@ Then create the initializer with
 
     rails generate wicked_pdf
 
-Because `wicked_pdf` is a wrapper for  [wkhtmltopdf](http://wkhtmltopdf.org/), you'll need to install that, too.
+Because `wicked_pdf` is a wrapper for [wkhtmltopdf](http://wkhtmltopdf.org/), you'll need to install that, too.
 
 The simplest way to install all of the binaries on most Linux or OSX systems is through the gem [wkhtmltopdf-binary](https://github.com/zakird/wkhtmltopdf_binary_gem). Builds for other systems are available [here](https://wkhtmltopdf.org/downloads.html)
 To install that gem, add this:
@@ -31,7 +31,7 @@ gem 'wkhtmltopdf-binary'
 
 To your Gemfile and run `bundle install`.
 
-This gem currently installs version 0.12.x of `wkhtmltopdf`. Some of the options listed below are specific 0.9 or below, and others are for 0.12 and up.
+This gem currently installs version 0.12.x of `wkhtmltopdf`. Support for some of the options listed below may vary with release.
 
 You can see what flags are supported for the current version in [wkhtmltopdf's auto-generated manual](https://wkhtmltopdf.org/usage/wkhtmltopdf.txt)
 

data/lib/wicked_pdf/binary.rb

@@ -1,29 +1,26 @@
 module WickedPdf
   class Binary
     EXE_NAME = 'wkhtmltopdf'.freeze
-    DEFAULT_BINARY_VERSION = Gem::Version.new('0.9.9')
+    MINIMUM_BINARY_VERSION = Gem::Version.new('0.12.0')
 
-    attr_reader :path, :default_version
+    attr_reader :path, :version
 
-    def initialize(binary_path = nil, default_version = DEFAULT_BINARY_VERSION)
+    def initialize(binary_path = nil)
       @path = binary_path || find_binary_path
-      @default_version = default_version
+      @version = retrieve_binary_version
 
+      raise "Minimum version of wkhtmltopdf is #{MINIMUM_BINARY_VERSION}. Version found was #{@version}." if @version < MINIMUM_BINARY_VERSION
       raise "Location of #{EXE_NAME} unknown" if @path.empty?
       raise "Bad #{EXE_NAME}'s path: #{@path}" unless File.exist?(@path)
       raise "#{EXE_NAME} is not executable" unless File.executable?(@path)
     end
 
-    def version
-      @version ||= retrieve_binary_version
-    end
-
     def parse_version_string(version_info)
       match_data = /wkhtmltopdf\s*(\d*\.\d*\.\d*\w*)/.match(version_info)
       if match_data && (match_data.length == 2)
         Gem::Version.new(match_data[1])
       else
-        default_version
+        MINIMUM_BINARY_VERSION
       end
     end
 
@@ -33,7 +30,7 @@ module WickedPdf
       _stdin, stdout, _stderr = Open3.popen3(@path + ' -V')
       parse_version_string(stdout.gets(nil))
     rescue StandardError
-      default_version
+      MINIMUM_BINARY_VERSION
     end
 
     def find_binary_path
@@ -49,7 +46,7 @@ module WickedPdf
       possible_locations = (ENV['PATH'].split(':') + %w[/usr/bin /usr/local/bin]).uniq
       possible_locations += %w[~/bin] if ENV.key?('HOME')
 
-      exe_path ||= possible_locations.map { |l| File.expand_path("#{l}/#{EXE_NAME}") }.find { |location| File.exist?(location) }
+      exe_path = possible_locations.map { |l| File.expand_path("#{l}/#{EXE_NAME}") }.find { |location| File.exist?(location) }
       exe_path || ''
     end
   end

data/lib/wicked_pdf/command.rb

@@ -2,9 +2,9 @@ module WickedPdf
   class Command
     attr_reader :binary, :option_parser
 
-    def initialize(binary: Binary.new, option_parser: nil)
+    def initialize(binary: Binary.new, option_parser: OptionParser.new)
       @binary = binary
-      @option_parser = option_parser || OptionParser.new(@binary.version)
+      @option_parser = option_parser
     end
 
     def execute(options, *args)

data/lib/wicked_pdf/option_parser.rb

@@ -1,13 +1,5 @@
 module WickedPdf
   class OptionParser
-    BINARY_VERSION_WITHOUT_DASHES = Gem::Version.new('0.12.0')
-
-    attr_reader :binary_version
-
-    def initialize(binary_version = WickedPdf::Binary::DEFAULT_BINARY_VERSION)
-      @binary_version = binary_version
-    end
-
     def parse(options)
       [
         parse_extra(options),
@@ -23,14 +15,6 @@ module WickedPdf
       ].flatten
     end
 
-    def format_option(name)
-      if binary_version < BINARY_VERSION_WITHOUT_DASHES
-        "--#{name}"
-      else
-        name
-      end
-    end
-
     private
 
     def parse_extra(options)
@@ -78,19 +62,19 @@ module WickedPdf
       return [] if arg.blank?
       # Filesystem path or URL - hand off to wkhtmltopdf
       if argument.is_a?(Pathname) || (arg[0, 4] == 'http')
-        [format_option('cover'), arg]
+        ['cover', arg]
       else # HTML content
         @hf_tempfiles ||= []
         @hf_tempfiles << tf = WickedPdf::Tempfile.new('wicked_cover_pdf.html')
         tf.write arg
         tf.flush
-        [format_option('cover'), tf.path]
+        ['cover', tf.path]
       end
     end
 
     def parse_toc(options)
       return [] if options.nil?
-      r = [format_option('toc')]
+      r = ['toc']
       unless options.blank?
         r += make_options(options, [:font_name, :header_text], 'toc')
         r += make_options(options, [:xsl_style_sheet])

data/lib/wicked_pdf/version.rb

@@ -1,3 +1,3 @@
 module WickedPdf
-  VERSION = '2.0.0.beta1'.freeze
+  VERSION = '2.0.0.beta2'.freeze
 end

data/test/test_helper.rb

@@ -2,6 +2,7 @@
 ENV['RAILS_ENV'] = 'test'
 
 require 'combustion'
+require 'byebug'
 
 Combustion.path = 'test/dummy'
 Combustion.initialize!(:all) do

data/test/unit/wicked_pdf_binary_test.rb

@@ -1,23 +1,32 @@
 require 'test_helper'
 
 class WickedPdfBinaryTest < ActiveSupport::TestCase
+  setup do
+    @saved_config = WickedPdf.config
+    WickedPdf.config = {}
+  end
+
+  teardown do
+    WickedPdf.config = @saved_config
+  end
+
   test 'should extract old wkhtmltopdf version' do
-    version_info_sample = "Name:\n  wkhtmltopdf 0.9.9\n\nLicense:\n  Copyright (C) 2008,2009 Wkhtmltopdf Authors.\n\n\n\n  License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n  This is free software: you are free to change and redistribute it. There is NO\n  WARRANTY, to the extent permitted by law.\n\nAuthors:\n  Written by Jakob Truelsen. Patches by Mrio Silva, Benoit Garret and Emmanuel\n  Bouthenot.\n"
-    assert_equal WickedPdf::Binary::DEFAULT_BINARY_VERSION, binary.parse_version_string(version_info_sample)
+    version_info_sample = "Name:V\n  wkhtmltopdf 0.9.9\n\nLicense:\n  Copyright (C) 2008,2009 Wkhtmltopdf Authors.\n\n\n\n  License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n  This is free software: you are free to change and redistribute it. There is NO\n  WARRANTY, to the extent permitted by law.\n\nAuthors:\n  Written by Jakob Truelsen. Patches by Mrio Silva, Benoit Garret and Emmanuel\n  Bouthenot.\n"
+    assert_equal Gem::Version.new('0.9.9'), binary.parse_version_string(version_info_sample)
   end
 
   test 'should extract new wkhtmltopdf version' do
-    version_info_sample = "Name:\n  wkhtmltopdf 0.11.0 rc2\n\nLicense:\n  Copyright (C) 2010 wkhtmltopdf/wkhtmltoimage Authors.\n\n\n\n  License LGPLv3+: GNU Lesser General Public License version 3 or later\n  <http://gnu.org/licenses/lgpl.html>. This is free software: you are free to\n  change and redistribute it. There is NO WARRANTY, to the extent permitted by\n  law.\n\nAuthors:\n  Written by Jan Habermann, Christian Sciberras and Jakob Truelsen. Patches by\n  Mehdi Abbad, Lyes Amazouz, Pascal Bach, Emmanuel Bouthenot, Benoit Garret and\n  Mario Silva."
-    assert_equal Gem::Version.new('0.11.0'), binary.parse_version_string(version_info_sample)
+    version_info_sample = "Name:\n  wkhtmltopdf 0.12.0 rc2\n\nLicense:\n  Copyright (C) 2010 wkhtmltopdf/wkhtmltoimage Authors.\n\n\n\n  License LGPLv3+: GNU Lesser General Public License version 3 or later\n  <http://gnu.org/licenses/lgpl.html>. This is free software: you are free to\n  change and redistribute it. There is NO WARRANTY, to the extent permitted by\n  law.\n\nAuthors:\n  Written by Jan Habermann, Christian Sciberras and Jakob Truelsen. Patches by\n  Mehdi Abbad, Lyes Amazouz, Pascal Bach, Emmanuel Bouthenot, Benoit Garret and\n  Mario Silva."
+    assert_equal Gem::Version.new('0.12.0'), binary.parse_version_string(version_info_sample)
   end
 
   test 'should extract wkhtmltopdf version with nondigit symbols' do
-    version_info_sample = "Name:\n  wkhtmltopdf 0.10.4b\n\nLicense:\n  Copyright (C) 2008,2009 Wkhtmltopdf Authors.\n\n\n\n  License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n  This is free software: you are free to change and redistribute it. There is NO\n  WARRANTY, to the extent permitted by law.\n\nAuthors:\n  Written by Jakob Truelsen. Patches by Mrio Silva, Benoit Garret and Emmanuel\n  Bouthenot.\n"
-    assert_equal Gem::Version.new('0.10.4b'), binary.parse_version_string(version_info_sample)
+    version_info_sample = "Name:\n  wkhtmltopdf 0.12.4b\n\nLicense:\n  Copyright (C) 2008,2009 Wkhtmltopdf Authors.\n\n\n\n  License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n  This is free software: you are free to change and redistribute it. There is NO\n  WARRANTY, to the extent permitted by law.\n\nAuthors:\n  Written by Jakob Truelsen. Patches by Mrio Silva, Benoit Garret and Emmanuel\n  Bouthenot.\n"
+    assert_equal Gem::Version.new('0.12.4b'), binary.parse_version_string(version_info_sample)
   end
 
-  test 'should fallback to default version on parse error' do
-    assert_equal WickedPdf::Binary::DEFAULT_BINARY_VERSION, binary.parse_version_string('')
+  test 'should fallback to minimum version on parse error' do
+    assert_equal WickedPdf::Binary::MINIMUM_BINARY_VERSION, binary.parse_version_string('')
   end
 
   test 'should raise exception when no path to wkhtmltopdf' do
@@ -46,6 +55,53 @@ class WickedPdfBinaryTest < ActiveSupport::TestCase
     end
   end
 
+  test 'should raise exception if binary version is less than minimum' do
+    version_info_sample = "Name:V\n  wkhtmltopdf 0.9.9\n\nLicense:\n  Copyright (C) 2008,2009 Wkhtmltopdf Authors.\n\n\n\n  License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n  This is free software: you are free to change and redistribute it. There is NO\n  WARRANTY, to the extent permitted by law.\n\nAuthors:\n  Written by Jakob Truelsen. Patches by Mrio Silva, Benoit Garret and Emmanuel\n  Bouthenot.\n"
+    Open3.expects(:popen3).returns([nil, mock('stdout', :gets => version_info_sample), nil])
+
+    assert_raise RuntimeError do
+      WickedPdf::Binary.new
+    end
+  end
+
+  test 'should correctly locate wkhtmltopdf without bundler' do
+    bundler_module = Bundler
+    Object.send(:remove_const, :Bundler)
+
+    assert_nothing_raised do
+      WickedPdf::Binary.new
+    end
+
+    Object.const_set(:Bundler, bundler_module)
+  end
+
+  test 'should correctly locate wkhtmltopdf with bundler' do
+    assert_nothing_raised do
+      WickedPdf::Binary.new
+    end
+  end
+
+  class LocationNonWritableTest < ActiveSupport::TestCase
+    setup do
+      @saved_config = WickedPdf.config
+      WickedPdf.config = {}
+
+      @old_home = ENV['HOME']
+      ENV['HOME'] = '/not/a/writable/directory'
+    end
+
+    teardown do
+      WickedPdf.config = @saved_config
+      ENV['HOME'] = @old_home
+    end
+
+    test 'should correctly locate wkhtmltopdf with bundler while HOME is set to a non-writable directory' do
+      assert_nothing_raised do
+        WickedPdf::Binary.new
+      end
+    end
+  end
+
   def binary(path = nil)
     WickedPdf::Binary.new(path)
   end

data/test/unit/wicked_pdf_option_parser_test.rb

@@ -21,7 +21,7 @@ class WickedPdfOptionParserTest < ActiveSupport::TestCase
   end
 
   test 'should parse toc options' do
-    toc_option = option_parser.format_option('toc')
+    toc_option = 'toc'
 
     [:font_name, :header_text].each do |o|
       assert_equal "#{toc_option} --toc-#{o.to_s.tr('_', '-')} toc",
@@ -60,7 +60,7 @@ class WickedPdfOptionParserTest < ActiveSupport::TestCase
   end
 
   test 'should parse cover' do
-    cover_option = option_parser.format_option('cover')
+    cover_option = 'cover'
 
     pathname = Rails.root.join('app', 'views', 'pdf', 'file.html')
     assert_equal "#{cover_option} http://example.org", parse_options(:cover => 'http://example.org').strip, 'URL'
@@ -96,33 +96,13 @@ class WickedPdfOptionParserTest < ActiveSupport::TestCase
     end
   end
 
-  test 'should not use double dash options for version without dashes' do
-    op = option_parser(WickedPdf::OptionParser::BINARY_VERSION_WITHOUT_DASHES)
-
-    %w[toc cover].each do |name|
-      assert_equal op.format_option(name), name
-    end
-  end
-
-  test 'should use double dash options for version with dashes' do
-    op = option_parser(Gem::Version.new('0.11.0'))
-
-    %w[toc cover].each do |name|
-      assert_equal op.format_option(name), "--#{name}"
-    end
-  end
-
   test '-- options should not be given after object' do
     options = { :header => { :center => 3 }, :cover => 'http://example.org', :disable_javascript => true }
-    cover_option = option_parser.format_option('cover')
+    cover_option = 'cover'
     assert_equal parse_options(options), "--disable-javascript --header-center 3 #{cover_option} http://example.org"
   end
 
-  def parse_options(options, version = WickedPdf::Binary::DEFAULT_BINARY_VERSION)
-    option_parser(version).parse(options).join(' ')
-  end
-
-  def option_parser(version = WickedPdf::Binary::DEFAULT_BINARY_VERSION)
-    WickedPdf::OptionParser.new(version)
+  def parse_options(options)
+    WickedPdf::OptionParser.new.parse(options).join(' ')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adzap-wicked_pdf
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Miles Z. Sterrett
@@ -196,7 +196,6 @@ files:
 - test/unit/wicked_pdf_option_parser_test.rb
 - test/unit/wicked_pdf_renderer_test.rb
 - test/unit/wicked_pdf_test.rb
-- test/unit/wkhtmltopdf_location_test.rb
 - wicked_pdf.gemspec
 homepage: https://github.com/adzap/wicked_pdf
 licenses:
@@ -246,4 +245,3 @@ test_files:
 - test/unit/wicked_pdf_option_parser_test.rb
 - test/unit/wicked_pdf_renderer_test.rb
 - test/unit/wicked_pdf_test.rb
-- test/unit/wkhtmltopdf_location_test.rb

data/test/unit/wkhtmltopdf_location_test.rb

@@ -1,50 +0,0 @@
-
-
-class WkhtmltopdfLocationTest < ActiveSupport::TestCase
-  setup do
-    @saved_config = WickedPdf.config
-    WickedPdf.config = {}
-  end
-
-  teardown do
-    WickedPdf.config = @saved_config
-  end
-
-  test 'should correctly locate wkhtmltopdf without bundler' do
-    bundler_module = Bundler
-    Object.send(:remove_const, :Bundler)
-
-    assert_nothing_raised do
-      WickedPdf.new
-    end
-
-    Object.const_set(:Bundler, bundler_module)
-  end
-
-  test 'should correctly locate wkhtmltopdf with bundler' do
-    assert_nothing_raised do
-      WickedPdf.new
-    end
-  end
-
-  class LocationNonWritableTest < ActiveSupport::TestCase
-    setup do
-      @saved_config = WickedPdf.config
-      WickedPdf.config = {}
-
-      @old_home = ENV['HOME']
-      ENV['HOME'] = '/not/a/writable/directory'
-    end
-
-    teardown do
-      WickedPdf.config = @saved_config
-      ENV['HOME'] = @old_home
-    end
-
-    test 'should correctly locate wkhtmltopdf with bundler while HOME is set to a non-writable directory' do
-      assert_nothing_raised do
-        WickedPdf.new
-      end
-    end
-  end
-end