html2pdf 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4890d94669f7ee299c9c75a8596d8c796b1e79db
-  data.tar.gz: 5b36b98c6a042f47031688c535d952d01b5092ad
+  metadata.gz: d51f99366f1cdaef945c9e434fdc1a14647380c0
+  data.tar.gz: f4ebe2bc4f9d4fc410883cecce69227219e01e99
 SHA512:
-  metadata.gz: a5bfa0b847188cd3bfe22821cb5d7e1e16fb958694961a00bc2e31c4687c44ae2c7c3706311d7dc4e02c9350aa89a5b91c231a031ba87f091ad23bb95b404f50
-  data.tar.gz: 58157010f9e34b141244d6b31fd4406719beefccaebab78e33a21476a4160b6c02980945407bcdbfe936b38366c574df2780d316b18b0f99d7926e2d1cf20650
+  metadata.gz: 82969eb4ccba80407ff5438d3feb237884fbfbd686a8a5d442c76763d85564e41b36ae1393b190b2a78890c334dd53a81e78e7d7cb16098c390f990007caff0a
+  data.tar.gz: 8d7001ccc60907d7199a2959fba38e92efd970302fc23ed3fb0e253d90275717740d57e3caa66f3956cc2a41418798d4bfb23a6a8e7b65014e858362e99ec2c7

data/.rubocop.yml

@@ -48,9 +48,9 @@ Documentation:
 HashSyntax:
   Enabled: true
 
-# No spaces inside hash literals
+# spaces inside hash literals
 SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
+  EnforcedStyle: space
 
 # Allow dots at the end of lines
 DotPosition:

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ### Changelogs for html2pdf
 
+#### 0.1.7
+
+- Add `--disable-smart-shrinking` option in wkhtmltopdf
+- Update `rubocop` to 0.23.x version
+- Allow the customization through configuration
+
 #### 0.1.6
 
 - Make use of the starting directory in the output filename

data/README.md

@@ -18,12 +18,7 @@ Note: starting from version `0.1.0` this gem will be release based on [Semantic
 
 - [wkhtmltopdf][] - please see [wkhtmltopdf installation][] for detail
 
-### Dependencies
-
-- wkhtmltopdf (Linux/OSX)
-- OSX or Linux
-
-## Usage
+### Usage
 
 ```sh
 gem install html2pdf
@@ -91,6 +86,80 @@ the pdf version of it.
 
 - Then combine the generated pdf files using [pdfs2pdf][] gem to produce one pdf file
 
+### Customization
+
+If you like to adjust the output for pdf you can override the default settings by
+set your own configuration in the file `config/initializers/html2pdf.rb`
+
+For more customization please see the [wkhtmltopdf manual][] page for detail.
+
+```ruby
+require_relative "../../lib/html2pdf/configuration"
+module Html2Pdf
+  class << self
+    # rubocop:disable MethodLength
+    def update_config
+      Html2Pdf.configure do |config|
+        # Note: or add your own path here if `wkhtmltopdf` is not in the $PATH environment
+        config.options[:wkhtmltopdf]   = (defined?(Bundler::GemfileError) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+        config.options[:page_settings] = [
+          "--margin-top 8",
+          "--margin-bottom 8",
+          "--margin-left 8",
+          "--margin-right 8",
+          '--header-center "[webpage] :: [page]/[topage]"',
+          "--header-spacing 1",
+          "--header-font-size 8",
+          "--header-line",
+          "--footer-spacing 1",
+          "--footer-font-size 8",
+          "--footer-line"
+        ]
+      end
+    end
+    # rubocop:enable All
+  end
+end
+```
+
+You can use the custom settings by loading it in the `bin/html2pdf` like:
+
+```ruby
+#!/usr/bin/env ruby
+require_relative "../lib/html2pdf"
+# Note: if you like to customize the settings for `wkhtmltopdf` then
+# uncomment the next two lines
+# -----------------------------------------------------------------#
+require_relative "../config/initializers/html2pdf"
+Html2Pdf.update_config
+# -----------------------------------------------------------------#
+if ARGV.empty?
+  Html2Pdf::CLI.start(%w[usage])
+else
+  Html2Pdf::CLI.start(%w[export].concat(ARGV))
+end
+```
+
+Note: by default the above configuration is configured in
+the file `./lib/html2pdf/configuration.rb`. Which contain the following values
+
+```ruby
+wkhtmltopdf = (defined?(Bundler::GemfileError) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp,
+page_settings = [
+  "--margin-top 4",
+  "--margin-bottom 4",
+  "--margin-left 4",
+  "--margin-right 4",
+  '--header-center "[webpage] :: [page]/[topage]"',
+  "--header-spacing 1",
+  "--header-font-size 8",
+  "--header-line",
+  "--footer-spacing 1",
+  "--footer-font-size 8",
+  "--footer-line"
+]
+```
+
 ### Contributing
 
 1. Fork it ( http://github.com/agilecreativity/html2pdf/fork )
@@ -103,4 +172,5 @@ the pdf version of it.
 [pdfs2pdf]: https://github.com/agilecreativity/pdfs2pdf
 [wkhtmltopdf]: http://wkhtmltopdf.org/
 [wkhtmltopdf installation]: https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF
+[wkhtmltopdf manual]: http://wkhtmltopdf.org/usage/wkhtmltopdf.txt
 [Semantic Versioning]: http://semver.org

data/Rakefile

@@ -20,7 +20,7 @@ end
 
 require "rubocop/rake_task"
 desc "Run RuboCop on the lib directory"
-Rubocop::RakeTask.new(:rubocop) do |task|
+RuboCop::RakeTask.new(:rubocop) do |task|
   task.patterns = ["lib/**/*.rb"]
   # only show the files with failures
   task.formatters = ["files"]

data/bin/html2pdf

@@ -1,6 +1,11 @@
 #!/usr/bin/env ruby
 require_relative "../lib/html2pdf"
-include Html2Pdf
+# If you like to customize the settings for `wkhtmltopdf` then
+# edit the file `config/initializers/html2pdf.rb` and enable it in the next 2 lines
+# -----------------------------------------------------------------#
+# require_relative "../config/initializers/html2pdf"
+# Html2Pdf.update_config
+# -----------------------------------------------------------------#
 if ARGV.empty?
   Html2Pdf::CLI.start(%w[usage])
 else

data/config/initializers/html2pdf.rb

@@ -0,0 +1,28 @@
+require_relative "../../lib/html2pdf/configuration"
+module Html2Pdf
+  class << self
+    # Customize the configuration for specific system (Ubuntu/OSX/etc)
+    # See: ./lib/html2pdf/configuration.rb for available options
+    # rubocop:disable MethodLength
+    def update_config
+      Html2Pdf.configure do |config|
+        # Note: or add your own path here if `wkhtmltopdf` is not in the $PATH environment
+        config.options[:wkhtmltopdf]   = (defined?(Bundler::GemfileError) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+        config.options[:page_settings] = [
+          "--margin-top 8",
+          "--margin-bottom 8",
+          "--margin-left 8",
+          "--margin-right 8",
+          '--header-center "[webpage] :: [page]/[topage]"',
+          "--header-spacing 1",
+          "--header-font-size 8",
+          "--header-line",
+          "--footer-spacing 1",
+          "--footer-font-size 8",
+          "--footer-line"
+        ]
+      end
+    end
+    # rubocop:enable All
+  end
+end

data/html2pdf.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q(Export list of html or xhtml files to pdfs with 'wkhtmltopdf')
   spec.homepage      = "https://github.com/agilecreativity/html2pdf"
   spec.license       = "MIT"
-  spec.files         = Dir.glob("{bin,lib}/**/*") + %w[Gemfile
+  spec.files         = Dir.glob("{bin,lib,config}/**/*") + %w[Gemfile
                                                        Rakefile
                                                        html2pdf.gemspec
                                                        README.md
@@ -35,6 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest-spec-context", "~> 0.0.3"
   spec.add_development_dependency "pry", "~> 0.9"
   spec.add_development_dependency "rake", "~> 10.1"
-  spec.add_development_dependency "rubocop", "~> 0.20"
+  spec.add_development_dependency "rubocop", "~> 0.23"
   spec.add_development_dependency "yard", "~> 0.8"
 end

data/lib/html2pdf/cli.rb

@@ -4,6 +4,7 @@ require "fileutils"
 require_relative "../html2pdf"
 module Html2Pdf
   class CLI < Thor
+    # rubocop:disable AmbiguousOperator, MethodLength
     desc "export", "export multiple html files to pdfs"
     method_option *AgileUtils::Options::BASE_DIR
     method_option *AgileUtils::Options::RECURSIVE
@@ -38,6 +39,7 @@ module Html2Pdf
       puts "Convert files to pdfs took #{elapsed} ms"
       puts "Your final output is '#{File.absolute_path(output_file)}'"
     end
+    # rubocop:enable All
 
     desc "usage", "Display usage information"
     def usage

data/lib/html2pdf/configuration.rb

@@ -0,0 +1,49 @@
+module Html2Pdf
+  class Configuration
+    attr_accessor :options
+    # rubocop:disable MethodLength
+    def initialize
+      # see: http://wkhtmltopdf.org/usage/wkhtmltopdf.txt
+      @options = {
+        wkhtmltopdf: (defined?(Bundler::GemfileError) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp,
+        page_settings: [
+          "--margin-top 4",
+          "--margin-bottom 4",
+          "--margin-left 4",
+          "--margin-right 4",
+          '--header-center "[webpage] :: [page]/[topage]"',
+          "--header-spacing 1",
+          "--header-font-size 8",
+          "--header-line",
+          "--footer-spacing 1",
+          "--footer-font-size 8",
+          "--footer-line"
+        ]
+      }
+    end
+    # rubocop:enable All
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    # Configure Pdfs2Pdf someplace sensible, like
+    # config/initializers/html2pdf.rb
+    #
+    # Html2Pdf.configure do |config|
+    #   # set appropriate options
+    #   config.options[:wkhtmltopdf]   = '/usr/bin/wkhtmltopdf'
+    #   config.options[:page_settings] = [ "--margin-top 4",
+    #                                      "--margin-bottom 4",
+    #                                      ..
+    #                                    ]
+    # end
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/html2pdf/html2pdf.rb

@@ -1,6 +1,7 @@
 require "open3"
 require "fileutils"
 require_relative "../html2pdf"
+require_relative "./configuration"
 module Html2Pdf
   class << self
     # Batch convert to pdf using `wkhtmltopdf` tool
@@ -19,23 +20,15 @@ module Html2Pdf
     # @param filename input filename
     def to_pdf(filename)
       fail "Invalid input file #{filename}" unless File.exist?(filename)
-      # TODO: allow custom configuration
+      wkhtmltopdf   = Html2Pdf.configuration.options[:wkhtmltopdf]
+      page_settings = Html2Pdf.configuration.options[:page_settings]
       command = [
-        "wkhtmltopdf",
-        "--margin-top 4",
-        "--margin-bottom 4",
-        "--margin-left 4",
-        "--margin-right 4",
-        '--header-center "[webpage] :: [page]/[topage]"',
-        "--header-spacing 1",
-        "--header-font-size 8",
-        "--header-line",
-        "--footer-spacing 1",
-        "--footer-font-size 8",
-        "--footer-line",
-        "#{filename}",
+        wkhtmltopdf,
+        *page_settings,
+        filename,
         "#{filename}.pdf",
-        "> /dev/null"]
+        "> /dev/null"
+      ]
       _stdin, _stderr, status = Open3.capture3(command.join(" "))
       fail "Problem processing #{filename}" unless status.success?
     end

data/lib/html2pdf/version.rb

@@ -1,3 +1,3 @@
 module Html2Pdf
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html2pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-01 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -222,9 +222,11 @@ files:
 - README.md
 - Rakefile
 - bin/html2pdf
+- config/initializers/html2pdf.rb
 - html2pdf.gemspec
 - lib/html2pdf.rb
 - lib/html2pdf/cli.rb
+- lib/html2pdf/configuration.rb
 - lib/html2pdf/html2pdf.rb
 - lib/html2pdf/version.rb
 - test/fixtures/samples/demo1_xxx.rb