pdfs2pdf 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f61699303fc3242f39bcf101d33b2fa86e799b14
+  data.tar.gz: 5d59dc62ee411712790a4c6a193e922593b165f9
+SHA512:
+  metadata.gz: d043ab8c3fd081b43ed26bd6ff5a3e36bf8d0834bee39317008ca4b40bac14b93a530ffe6b044b82819460c9820138825d3076317b0cc2928475c64bc497363f
+  data.tar.gz: d61b0241e377d1ebd04e1bc23b5d91181ae080cb8040d42a51ba1772a8c36d31bea28970e78d095d15a1b24a444032882d9fe05162b20c38567803e2613eae29

data/.ruby-version

@@ -1 +1 @@
-1.9.3
+2.1.1

data/CHANGELOGS.md

@@ -0,0 +1,36 @@
+### Changelogs
+
+#### 0.0.6
+
+- Allow options for wkhtmltopdf to be more customizable
+  * page_size: 'A4', 'Letter' can be set via configuration
+  * path to the 'wkhtmltopdf' can be set via configuration
+  * the 'pdfmarks metadata' can be set via configuration
+  * more options will be enabled in upcoming release
+- Remove the changelogs section from README.md to CHANGLOGS.md
+
+#### 0.0.5
+
+- Update to latest dependencies
+- Add links to CodeClimate and Gemnasium
+
+#### 0.0.4
+
+- Remove unused codes
+- Update [agile_utils][] to 0.0.8
+- Update [code_lister][] to 0.0.7
+
+#### 0.0.3
+
+- Update to [agile_utils][] which fix some minor bug
+
+#### 0.0.2
+
+- Fix incorrect version badge
+
+#### 0.0.1
+
+- Initial release
+
+[Ghostscript]: http://www.ghostscript.com/
+[Wkhtmltopdf]: http://wkhtmltopdf.org/

data/README.md

@@ -130,31 +130,6 @@ letters, numbers and/or underscore characters. Any other characters like
   * Solution: try rename your folder to 'something_with_underscore' but not
     'something-with-dash' before running the command.
 
-### Changelogs
-
-#### 0.0.5
-
-- Update to latest dependencies
-- Add links to CodeClimate and Gemnasium
-
-#### 0.0.4
-
-- Remove unused codes
-- Update [agile_utils][] to 0.0.8
-- Update [code_lister][] to 0.0.7
-
-#### 0.0.3
-
-- Update to [agile_utils][] which fix some minor bug
-
-#### 0.0.2
-
-- Fix incorrect version badge
-
-#### 0.0.1
-
-- Initial release
-
 ### Contributing
 
 1. Fork it ( http://github.com/agilecreativity/pdfs2pdf/fork )

data/bin/pdfs2pdf

@@ -1,4 +1,9 @@
 #!/usr/bin/env ruby
 require_relative '../lib/pdfs2pdf'
+
+# The default configuration
+require_relative '../config/initializers/pdfs2pdf'
+Pdfs2Pdf.update_config()
+
 include Pdfs2Pdf
 Pdfs2Pdf::CLI.start(ARGV)

data/config/initializers/pdfs2pdf.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+module Pdfs2Pdf
+  class << self
+    # Customize the configuration for specific system (Ubuntu/OSX/etc)
+    # See: ./lib/pdfs2pdf/configuration.rb for available options
+    def update_config
+      Pdfs2Pdf.configure do |config|
+        # config.wkhtmltopdf     = '/usr/bin/wkhtmltopdf'
+        # config.default_options = {
+        #   paper_size: 'Letter',
+        #   ..
+        # }
+        # config.pdfmarks_meta   = ..
+      end
+    end
+  end
+end

data/lib/pdfs2pdf/cli.rb

@@ -1,12 +1,13 @@
+# coding: utf-8
 require 'thor'
 require 'tmpdir'
 require 'fileutils'
 require_relative '../pdfs2pdf'
 require_relative './utils'
-
 module Pdfs2Pdf
   include AgileUtils::Options
   include CodeLister
+
   class CLI < Thor
     desc 'merge', 'Combine multiple pdfs into one file with bookmarks'
     method_option *AgileUtils::Options::BASE_DIR
@@ -58,7 +59,7 @@ Combine multiple pdfs into one file with bookmarks
 
     def merge_pdfs(pdf_files)
       elapsed = AgileUtils::FileUtil.time do
-        Pdfs2Pdf::Utils.merge_pdfs(pdf_files, 'pdfmarks', 'final_output.pdf')
+        Utils.merge_pdfs(pdf_files, 'pdfmarks', 'final_output.pdf')
       end
       puts "Combine pdf files took #{elapsed} ms"
       puts "Your combine pdf is available at #{File.absolute_path('final_output.pdf')}"

data/lib/pdfs2pdf/configuration.rb

@@ -0,0 +1,52 @@
+# coding: utf-8
+module Pdfs2Pdf
+  class Configuration
+    attr_accessor :default_options,
+                  :pdfmarks_meta,
+                  :wkhtmltopdf
+
+    def initialize
+      # see: http://wkhtmltopdf.org/usage/wkhtmltopdf.txt
+      @default_options = {
+        paper_size: 'A4', # 'Letter'
+        # Note: placeholder values, will be added in the up coming release!
+        margin_top: '0.75in',
+        margin_right: '0.75in',
+        margin_bottom: '0.75in',
+        margin_left: '0.75in',
+        encoding: 'UTF-8'
+      }
+
+      # see: http://partners.adobe.com/public/developer/en/acrobat/sdk/pdf/pdf_creation_apis_and_specs/pdfmarkReference.pdf
+      @pdfmarks_meta = <<-END.gsub(/^\s+\|/, '')
+        |[ /Title (My Combined Pdf)
+        |  /Author (Burin Choomnuan)
+        |  /Keywords (fun, witty, interesting)
+        |  /DOCINFO pdfmark
+      END
+
+      @wkhtmltopdf = (defined?(Bundler::GemfileError) ? `bundle exec which wkhtmltopdf` : `which wkhtmltopdf`).chomp
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    # Configure Pdfs2Pdf someplace sensible, like
+    # config/initializers/pdfs2pdf.rb
+    #
+    # @example
+    #
+    # Pdfs2pdf.configure do |config|
+    #   # set the path to wkhtmltopdf
+    #   config.wkhtmltopdf = '/usr/bin/wkhtmltopdf'
+    # end
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/pdfs2pdf/utils.rb

@@ -1,9 +1,11 @@
+# coding: utf-8
 require 'open3'
 require 'fileutils'
 require 'pdf-reader'
 require_relative '../pdfs2pdf'
+require_relative './configuration'
 module Pdfs2Pdf
-  module Utils
+  class Utils
     class << self
       # Create the 'pdfmarks' file for use with 'gs' utility
       #
@@ -12,7 +14,7 @@ module Pdfs2Pdf
       # @param [String] base_dir the base directory (TODO: review this code!)
       def create_pdfmarks(pdf_files, pdfmarks_file = 'pdfmarks', base_dir = Dir.pwd)
         File.open(pdfmarks_file, 'w') do |out_file|
-          out_file.write(title)
+          out_file.write(Pdfs2Pdf.configuration.pdfmarks_meta)
           current_page = 1
           pdf_files.each do |pdf_file|
             filename = if base_dir
@@ -22,36 +24,25 @@ module Pdfs2Pdf
                          pdf_file
                        end
             out_file.write "[ /Page #{current_page} /Title (#{filename}) /OUT pdfmark\n"
-            current_page += Pdfs2Pdf::Utils.page_count(pdf_file)
+            current_page += page_count(pdf_file)
           end
         end
       end
 
-      # Simple title for use in 'pdfmarks' file
-      #
-      # @todo allow the customization.
-      def title
-        <<-END.gsub(/^\s+\|/, '')
-          |[ /Title (My Sample Book)
-          |  /Author (Agile Creativity)
-          |  /Keywords (fun, witty, interesting)
-          |  /DOCINFO pdfmark
-        END
-      end
-
-      # Merge list of files using 'gs' command
+      # Merge/combine list of pdf files using Ghostscript's `gs` command
       #
       # @param [Array<String>] list input file list
       # @param [String] pdfmarks the pdfmarks file default to 'pdfmarks'
       # @param [String] output_file the output pdf file
       def merge_pdfs(list, pdfmarks = 'pdfmarks', output_file = 'output.pdf')
+        paper_size = Pdfs2Pdf.configuration.default_options[:paper_size]
         _stdin, _stderr, status = Open3.capture3(
           'gs',
           '-q',
           '-dNOPAUSE',
           '-dBATCH',
           '-sDEVICE=pdfwrite',
-          '-sPAPERSIZE=a4',
+          "-sPAPERSIZE=#{paper_size}",
           "-sOutputFile=#{output_file}",
           *list,
           pdfmarks)

data/lib/pdfs2pdf/version.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 module Pdfs2Pdf
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/pdfs2pdf.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'agile_utils'
 require 'code_lister'
 require_relative 'pdfs2pdf/version'
@@ -6,4 +7,3 @@ require_relative 'pdfs2pdf/utils'
 include AgileUtils::Options
 include CodeLister
 include Pdfs2Pdf
-include Pdfs2Pdf::Utils

data/pdfmarks

@@ -1,5 +1,5 @@
-[ /Title (My Sample Book)
-  /Author (Agile Creativity)
+[ /Title (My Combined Pdf)
+  /Author (Burin Choomnuan)
   /Keywords (fun, witty, interesting)
   /DOCINFO pdfmark
 [ /Page 1 /Title (demo1_xxx.rb.xhtml.pdf/demo1_xxx.rb.xhtml.pdf) /OUT pdfmark

metadata

@@ -1,222 +1,195 @@
 --- !ruby/object:Gem::Specification
 name: pdfs2pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: agile_utils
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.9
 - !ruby/object:Gem::Dependency
   name: code_lister
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.8
 - !ruby/object:Gem::Dependency
   name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: gem-ctags
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
 - !ruby/object:Gem::Dependency
   name: minitest-spec-context
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 description: Combine multiple pdfs into a single file with bookmarks for easy navigation
@@ -227,16 +200,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .ruby-version
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOGS.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/pdfs2pdf
+- config/initializers/pdfs2pdf.rb
 - demo1.png
 - demo2.png
 - demo3.png
@@ -244,6 +219,7 @@ files:
 - final_output.png
 - lib/pdfs2pdf.rb
 - lib/pdfs2pdf/cli.rb
+- lib/pdfs2pdf/configuration.rb
 - lib/pdfs2pdf/utils.rb
 - lib/pdfs2pdf/version.rb
 - pdfmarks
@@ -258,27 +234,26 @@ files:
 homepage: https://github.com/agilecreativity/pdfs2pdf
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Combine multiple pdfs into one pdf with proper bookmarks for easy navigation
 test_files:
 - test/fixtures/samples/demo1_xxx.rb.xhtml.pdf