mergepdfs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8114d29c8330650423d9b4fc55831a271c4458db49b52997fa4028cbbd508d89
+  data.tar.gz: 5aaa651c281a803af3719840aa2faa026a70f5e50e4c3f381762fa958ddf8a31
+SHA512:
+  metadata.gz: 4347bfabd9237fddadec1f7d8441effebd9a04ee704cfbbbf01301d034f08bd041690cc47d896c7f01d08d9c33fa06acfe5890716919428e8d9f5df3ec19030a
+  data.tar.gz: 4c76e69266b62ccf49bec832802f0e25159e48695e31cab4af64c3810eb3fc51721cf5601889fcce6fe862852394b0dca3e5993b9a2f3f12c2106b48b7622f88

data/bin/mergepdfs

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+###
+# mergepdfs combines multiple PDF files into one output PDF file. Empty pages
+# are added to ensure that each merged PDF file starts at an odd page number
+# in the output file. When printed double-sided, pages of the merged PDF files
+# are never printed on the same sheet.
+#
+# Copyright (c) 2020 Huub de Beer <huub@campinecomputing.eu>
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License
+# for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+##
+require "mergepdfs" 
+MergePDFs.merge(MergePDFs.parse(ARGV))

data/lib/mergepdfs.rb

@@ -0,0 +1,149 @@
+##
+# mergepdfs combines multiple PDF files into one output PDF file. Empty pages
+# are added to ensure that each merged PDF file starts at an odd page number
+# in the output file. When printed double-sided, pages of the merged PDF files
+# are never printed on the same sheet.
+#
+# Copyright (c) 2020 Huub de Beer <huub@campinecomputing.eu>
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License
+# for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+##
+module MergePDFs
+    require "hexapdf"
+    require "optparse"
+
+    VERSION = "0.1.0"
+
+    RELEASE_DATE = "2020-04-24"
+
+    VERSION_MESSAGE = <<~END
+        mergepdfs #{VERSION} (#{RELEASE_DATE})
+        Copyright (C) Huub de Beer <huub@campinecomputing.eu>
+        mergepdfs is free software; mergepdfs is released under the AGPL 3.0
+    END
+
+    DEFAULT_OPTIONS = {
+        pdfs: [],
+        continue_on_error: false,
+        show_diagnostics: false
+    }
+
+    DEFAULT_OUTPUT_FILENAME = "output.pdf"
+
+    class Error < StandardError; end
+
+    ##
+    # Merge multiple PDF files into a single PDF file, starting each PDF file
+    # at an odd page.
+    #
+    # @param output [String] the filename to write the merged PDFs to
+    # @param pdfs [Array<String>] the filenames of the PDF files to merge
+    # @param continue_on_error [Boolean] if an input PDF file cannot be
+    #   merged, continue merging the other input PDF files
+    # @param show_diagnostics [Boolean] show more detailed error information
+    def self.merge(output:, pdfs: [], continue_on_error: false, show_diagnostics: false)
+        merged_pdf = HexaPDF::Document.new
+
+        pdfs.each do |pdf|
+            # invariant: merged_pdf.pages.count.even?
+            begin
+                pdf_file = HexaPDF::Document.open(pdf)
+                pdf_file.pages.each do |page| 
+                    merged_page = merged_pdf.import(page)
+                    merged_pdf.pages.add(merged_page)
+                end
+                merged_pdf.pages.add() if pdf_file.pages.count.odd?
+            rescue => e
+                warn "ERROR\t Unable to open or read '#{pdf}'. Make sure this file is readable, unencrypted, and a PDF file."
+                warn e.full_message() if show_diagnostics
+                return unless continue_on_error
+            end
+        end
+
+        begin
+            merged_pdf.write(output, optimize: true)
+        rescue => e
+            warn "ERROR\t Unable to write the merged PDF to the output file '#{output}'."
+            warn e.full_message() if show_diagnostics
+        end
+    end
+
+    ##
+    # Parse command-line parameters
+    #
+    # @param args [Array<String>] a list with command-line parameters
+    # @return [Hash] a map with options matching the parameters for #merge.
+    def self.parse(args = ARGV)
+        options = DEFAULT_OPTIONS
+
+        begin
+            OptionParser.new do |parser|
+                parser.banner = "Usage: mergepdfs --output FILENAME [OPTIONS] file1.pdf file2.pdf ... fileN.pdf"
+
+                parser.separator("");
+                parser.separator("Required:")
+
+                parser.on("-o FILENAME", "--output FILENAME",
+                          "The name of the output PDF file. If no filename is specified,",
+                          "'#{DEFAULT_OUTPUT_FILENAME}' is used by default.") do |output|
+                    options[:output] = output
+                end
+
+                parser.separator("");
+                parser.separator("Optional:")
+
+                parser.on("-c", "--continue-on-error", 
+                          "When an error occurs merging a PDF file, mergepdfs tries",
+                          "to continue merging the other PDF files. Default is false.") do
+                    options[:continue_on_error] = true
+                end
+
+                parser.on("-d", "--diagnostics",
+                          "Show detailed error messages. Default is false.") do
+                    options[:show_diagnostics] = true
+                end
+
+                parser.separator("");
+                parser.separator("Common:")
+
+                parser.on_tail("-v", "--version", "Show the version.") do
+                    puts VERSION_MESSAGE
+                    exit
+                end
+
+                parser.on_tail("-h", "--help", "Show this help message.") do
+                    puts parser
+                    exit
+                end
+            end.parse!(args)
+
+        rescue OptionParser::InvalidOption => e
+            warn "ERROR\t #{e}."
+            warn e.full_message if options[:show_diagnostics]
+        rescue OptionParser::ParseError => e
+            warn "ERROR\t Problem while parsing the command-line parameters: #{e}."
+            warn e.full_message if options[:show_diagnostics]
+        end
+
+        if not options.key? :output
+            options[:output] = DEFAULT_OUTPUT_FILENAME
+            warn "ERROR\t No output filename specified. Defaulting to '#{DEFAULT_OUTPUT_FILENAME}'." if options[:show_diagnostics]
+        end
+
+        # The rest of the command-line options are treated as the input PDF
+        # files. 
+        options[:pdfs] = args
+        options
+    end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: mergepdfs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Huub de Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hexapdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.5
+description: mergepdfs combines multiple PDF files into one output PDF file. Empty
+  pages are added to ensure that each merged PDF file starts at an odd page number
+  in the output file. When printed double-sided, pages of the merged PDF files are
+  never printed on the same sheet.
+email:
+- huub@campinecomputing.eu
+executables:
+- mergepdfs
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/mergepdfs
+- lib/mergepdfs.rb
+homepage: https://gitlab.com/CampineComputing/mergepdfs
+licenses: []
+metadata:
+  homepage_uri: https://gitlab.com/CampineComputing/mergepdfs
+  source_code_uri: https://gitlab.com/CampineComputing/mergepdfs
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: mergepdfs combines multiple PDF files into one output PDF file, each starting
+  at an odd page.
+test_files: []