hexapdf 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7d800154c0525b724aa0b1a91e360aff2d443bd56e260b5b051a06d605cdb9c
-  data.tar.gz: d658fa5ff09f12a169156ee091f66b189874ae4b847cb4effa8d2c60b5f836b1
+  metadata.gz: d9c9409476d9ff9efaf2a8c0fb2b2623f660676c19e0d920659f6d719a783ee1
+  data.tar.gz: cb266922c5cdb6749e7a9954141e2b8b2094fcd44968bfa384e62478a184161c
 SHA512:
-  metadata.gz: b600fb0c600a0093e08d5ed3a4d16c2bfee637b0d338783c663f664aa7b4eb5384b20f064137c26d83f4269ed213b5d46c390421946d747f16be9d7e5600f381
-  data.tar.gz: 31f7c75f80db9b467f0fe8582616a9d136b9da86995cd6c57c76678a4e916fef0e73a4ad22ef53d8e8c36ce7ab620e303d6d05268d3ce6d551bbc33b67c7f959
+  metadata.gz: 7c7d5fb9e817d5a4a8fc7ad3f26deb075afa9dd504fda9dd7801dabbb76bcf819734cb86918ecb1c553e767125edfd47672cfeacdd648afbda81ab198e02f96f
+  data.tar.gz: bafff7b14203d534cacf94fdfaf493657c05255fb1caf431fd0cc8b7ebdcfb4470d49a0d02a5d72c96fea51f0c4bc0fa6b9aaca89caf0a190e6879be1b49fbb3

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+## 0.11.0 - 2019-11-19
+
+### Added
+
+* [HexaPDF::PDFArray] to wrap arrays and allow automatic resolution of
+  references like with [HexaPDF::Dictionary] - MAY BREAK THINGS!
+* CLI command `hexapdf watermark` to apply a watermark PDF as background or
+  stamp onto another PDF file
+* CLI command `hexapdf image2pdf` to convert images into a PDF file
+* [HexaPDF::DictionaryFields::Field#allowed_values] to allow constraining a
+  field to certain allowed values
+* [HexaPDF::Document::Fonts#configured_fonts] to return all font variants that
+  are configured and available for adding to a document
+* [HexaPDF::Type::Annotations::Widget] and associated classes
+* [HexaPDF::Type::AcroForm::Form] and [HexaPDF::Type::AcroForm::Field] for basic
+  AcroForm support
+
+### Changed
+
+* Use Reline for interactive mode of `hexapdf inspect` if available
+* [HexaPDF::DictionaryFields::Field::new] to use keyword arguments
+* Update the field information for implemented PDF types to include the allowed
+  values where possible
+* Interface of font loader objects to allow another method `available_fonts` for
+  returning all available fonts
+* [HexaPDF::Layout::Style] to check for valid values where possible
+
+### Fixed
+
+* Line spacing of empty lines for [HexaPDF::Layout::TextLayouter]
+* Handling of `/DecodeParms` when exporting to PNG images
+
+
 ## 0.10.0 - 2019-10-02
 
 ### Added

data/CONTRIBUTERS

@@ -1,5 +1,5 @@
   Count Name
 ======= ====
-   1069 Thomas Leitner <t_leitner@gmx.at>
+   1089 Thomas Leitner <t_leitner@gmx.at>
       1 Stanislav (Stas) Katkov <sk@skylup.com>
       1 Daniel Kraus <bovender@bovender.de>

data/Rakefile

@@ -1,9 +1,9 @@
+# -*- coding: utf-8 -*-
 require 'rake/testtask'
 require 'rake/clean'
 require 'rubygems/package_task'
 
-$:.unshift('lib')
-require 'hexapdf'
+require_relative 'lib/hexapdf/version'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
@@ -13,19 +13,6 @@ Rake::TestTask.new do |t|
 end
 
 namespace :dev do
-  PKG_FILES = FileList.new([
-    'Rakefile',
-    'LICENSE', 'agpl-3.0.txt',
-    'README.md', 'CHANGELOG.md',
-    'VERSION', 'CONTRIBUTERS',
-    'bin/*',
-    'lib/**/*.rb',
-    'man/man1/hexapdf.1',
-    'data/**/*',
-    'examples/*',
-    'test/**/*'
-  ])
-
   CLOBBER << "man/man1/hexapdf.1"
   file 'man/man1/hexapdf.1' => ['man/man1/hexapdf.1.md'] do
     puts "Generating hexapdf man page"
@@ -35,7 +22,7 @@ namespace :dev do
   CLOBBER << "VERSION"
   file 'VERSION' do
     puts "Generating VERSION file"
-    File.open('VERSION', 'w+') {|file| file.write(HexaPDF::VERSION + "\n")}
+    File.open('VERSION', 'w+') {|file| file.write(HexaPDF::VERSION + "\n") }
   end
 
   CLOBBER << 'CONTRIBUTERS'
@@ -46,35 +33,8 @@ namespace :dev do
     `git log | grep ^Author: | sed 's/^Author: //' | sort | uniq -c | sort -nr >> CONTRIBUTERS`
   end
 
-  spec = Gem::Specification.new do |s|
-    s.name = 'hexapdf'
-    s.version = HexaPDF::VERSION
-    s.summary = "HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby"
-    s.description = "HexaPDF is a pure Ruby library with an accompanying application for " \
-      "working with PDF files.\n\nIn short, it allows creating new PDF files, manipulating " \
-      "existing PDF files, merging multiple PDF files into one, extracting meta information, " \
-      "text, images and files from PDF files, securing PDF files by encrypting them and " \
-      "optimizing PDF files for smaller file size or other criteria.\n\nHexaPDF was designed " \
-      "with ease of use and performance in mind. It uses lazy loading and lazy computing when " \
-      "possible and tries to produce small PDF files by default."
-    s.license = 'AGPL-3.0'
-
-    s.files = PKG_FILES.to_a
-
-    s.require_path = 'lib'
-    s.executables = ['hexapdf']
-    s.add_dependency('cmdparse', '~> 3.0', '>= 3.0.3')
-    s.add_dependency('geom2d', '~> 0.2')
-    s.add_development_dependency('kramdown', '~> 1.0', '>= 1.13.0')
-    s.add_development_dependency('rubocop', '~> 0.58', '>= 0.58.2')
-    s.required_ruby_version = '>= 2.4'
-
-    s.author = 'Thomas Leitner'
-    s.email = 't_leitner@gmx.at'
-    s.homepage = "https://hexapdf.gettalong.org"
-  end
-
-  Gem::PackageTask.new(spec) do |pkg|
+  ENV['REAL_GEM'] = "true"
+  Gem::PackageTask.new(eval(File.read('hexapdf.gemspec'), binding, 'hexapdf.gemspec')) do |pkg|
     pkg.need_zip = true
     pkg.need_tar = true
   end
@@ -88,11 +48,36 @@ namespace :dev do
   desc 'Release HexaPDF version ' + HexaPDF::VERSION
   task release: [:clobber, :package, :publish_files]
 
-  CLOBBER << 'hexapdf.gemspec'
-  task :gemspec do
-    puts "Generating Gemspec"
-    contents = spec.to_ruby
-    File.open("hexapdf.gemspec", 'w+') {|f| f.puts(contents)}
+  desc "Set-up everything for development"
+  task :setup do
+    puts "Installing required runtime and development gems:"
+    resolver = Gem::Resolver.for_current_gems(spec.dependencies)
+    resolver.ignore_dependencies = true
+    resolver.soft_missing = true
+    resolver.resolve
+    spec.dependencies.each do |dependency|
+      if resolver.missing.find {|dep_request| dep_request.dependency == dependency }
+        print "✗ #{dependency.name} - installing it..."
+        Gem.install(dependency.name, dependency.requirement, prerelease: true)
+        puts " done"
+      else
+        puts "✓ #{dependency.name}"
+      end
+    end
+
+    puts
+    puts "The following binaries are needed for the tests:"
+    {
+      'pngtopnm' => 'sudo apt install netpbm',
+      'pngcheck' => 'sudo apt install pngcheck',
+    }.each do |name, install_command|
+      `which #{name} 2>&1`
+      if $?.exitstatus == 0
+        puts "✓ #{name}"
+      else
+        puts "✗ #{name} (#{install_command})"
+      end
+    end
   end
 
   CODING_LINE = "# -*- encoding: utf-8; frozen_string_literal: true -*-\n"

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.11.0

data/lib/hexapdf/cli.rb

@@ -44,6 +44,8 @@ require 'hexapdf/cli/optimize'
 require 'hexapdf/cli/images'
 require 'hexapdf/cli/batch'
 require 'hexapdf/cli/split'
+require 'hexapdf/cli/watermark'
+require 'hexapdf/cli/image2pdf'
 require 'hexapdf/version'
 require 'hexapdf/document'
 
@@ -95,6 +97,8 @@ module HexaPDF
         add_command(HexaPDF::CLI::Merge.new)
         add_command(HexaPDF::CLI::Batch.new)
         add_command(HexaPDF::CLI::Split.new)
+        add_command(HexaPDF::CLI::Watermark.new)
+        add_command(HexaPDF::CLI::Image2PDF.new)
         add_command(CmdParse::HelpCommand.new)
         version_command = CmdParse::VersionCommand.new(add_switches: false)
         add_command(version_command)

data/lib/hexapdf/cli/command.rb

@@ -57,7 +57,7 @@ module HexaPDF
 
       include Extensions
 
-      def initialize(*args, &block) #:nodoc:
+      def initialize(*args, **kwargs, &block) #:nodoc:
         super
         @out_options = OpenStruct.new
         @out_options.compact = true
@@ -82,7 +82,7 @@ module HexaPDF
       # If +out_file+ is given, the document is written to it after yielding.
       def with_document(file, password: nil, out_file: nil) #:yield: document
         if file == out_file
-          doc = HexaPDF::Document.open(file, pdf_options(password))
+          doc = HexaPDF::Document.open(file, **pdf_options(password))
         else
           file_io = File.open(file, 'rb')
           doc = HexaPDF::Document.new(io: file_io, **pdf_options(password))
@@ -143,6 +143,8 @@ module HexaPDF
       #
       # See: #out_options, #apply_optimization_options
       def define_optimization_options
+        options.separator("")
+        options.separator("Optimization options:")
         options.on("--[no-]compact", "Delete unnecessary PDF objects (default: " \
                    "#{@out_options.compact})") do |c|
           @out_options.compact = c
@@ -176,6 +178,8 @@ module HexaPDF
       #
       # See: #out_options, #apply_encryption_options
       def define_encryption_options
+        options.separator("")
+        options.separator("Encryption options:")
         options.on("--decrypt", "Remove any encryption") do
           @out_options.encryption = :remove
         end

data/lib/hexapdf/cli/image2pdf.rb

@@ -0,0 +1,141 @@
+# -*- encoding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# This file is part of HexaPDF.
+#
+# HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
+# Copyright (C) 2014-2019 Thomas Leitner
+#
+# HexaPDF is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation with the addition of the
+# following permission added to Section 15 as permitted in Section 7(a):
+# FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
+# THOMAS LEITNER, THOMAS LEITNER DISCLAIMS THE WARRANTY OF NON
+# INFRINGEMENT OF THIRD PARTY RIGHTS.
+#
+# HexaPDF 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 HexaPDF. If not, see <http://www.gnu.org/licenses/>.
+#
+# The interactive user interfaces in modified source and object code
+# versions of HexaPDF must display Appropriate Legal Notices, as required
+# under Section 5 of the GNU Affero General Public License version 3.
+#
+# In accordance with Section 7(b) of the GNU Affero General Public
+# License, a covered work must retain the producer line in every PDF that
+# is created or manipulated using HexaPDF.
+#
+# If the GNU Affero General Public License doesn't fit your need,
+# commercial licenses are available at <https://gettalong.at/hexapdf/>.
+#++
+
+require 'hexapdf/cli/command'
+
+module HexaPDF
+  module CLI
+
+    # Converts one or more images into a PDF file.
+    class Image2PDF < Command
+
+      def initialize #:nodoc:
+        super('image2pdf', takes_commands: false)
+        short_desc("Convert one or more images into a PDF file")
+        long_desc(<<~EOF)
+          This command converts one or more images into a single PDF file. The various options allow
+          setting a page size, scaling the images and defining margins.
+        EOF
+
+        options.on("-p", "--page-size SIZE", "The PDF page size. Either auto which chooses a " \
+                   "size based on the image size or a valid page size like A4, A4-landscape " \
+                   "or 595x842. Default: auto") do |page_size|
+          @media_box = case page_size
+                       when 'auto'
+                         :auto
+                       when /(\d+(?:\.\d+)?)x(\d+(?:\.\d+)?)/
+                         [0, 0, $1.to_f, $2.to_f]
+                       else
+                         orientation = :portrait
+                         if page_size.end_with?('-landscape')
+                           orientation = :landscape
+                           page_size.delete_suffix!('-landscape')
+                         end
+                         HexaPDF::Type::Page.media_box(page_size.to_sym, orientation: orientation)
+                       end
+        end
+        options.on("--[no-]auto-rotate", "Automatically rotate pages based on image dimesions. " \
+                   "Default: true") do |auto_rotate|
+          @auto_rotate = auto_rotate
+        end
+        options.on("-s", "--scale SCALE", Integer, "Defines how the images should be scaled. " \
+                   "Either fit to fit the image to the page size or a number specifying the " \
+                   "minimum pixels per inch. Default: fit") do |scale|
+          @scale = case scale
+                   when 'fit' then :fit
+                   else scale.to_f
+                   end
+        end
+        options.on("-m", "--margins MARGINS", Array, "Defines the margins around the image, " \
+                   "either with a single number or four numbers (top, right, bottom, left) " \
+                   "separated by commas. Default: 0") do |margins|
+          @margins = case margins.size
+                     when 1 then margins.map!(&:to_f) * 4
+                     when 4 then margins.map!(&:to_f)
+                     else
+                       raise OptionParser::InvalidArgument, "#{margins.join(',')} (1 or 4 " \
+                         "numbers needed)"
+                     end
+        end
+        define_optimization_options
+        define_encryption_options
+
+        @media_box = :auto
+        @auto_rotate = true
+        @scale = :fit
+        @margins = [0, 0, 0, 0]
+      end
+
+      def execute(out_file, *images) #:nodoc:
+        maybe_raise_on_existing_file(out_file)
+
+        out = HexaPDF::Document.new
+
+        images.each do |image_file|
+          image = out.images.add(image_file)
+          iw = image.info.width.to_f
+          ih = image.info.height.to_f
+          if @scale != :fit
+            iw *= 72 / @scale
+            ih *= 72 / @scale
+          end
+
+          media_box = (@media_box == :auto ? [0, 0, iw, ih] : @media_box.dup)
+          if @auto_rotate && (ih > iw) != (media_box[3] > media_box[2]) &&
+              (iw > media_box[2] || ih > media_box[3])
+            media_box[2], media_box[3] = media_box[3], media_box[2]
+          end
+          page = out.pages.add(media_box)
+
+          pw = page.box(:media).width.to_f - @margins[1] - @margins[3]
+          ph = page.box(:media).height.to_f - @margins[0] - @margins[2]
+          if @scale == :fit || iw > pw || ih > ph
+            ratio = [pw / iw, ph / ih].min
+            iw, ih = iw * ratio, ih * ratio
+          end
+          x, y = @margins[3] + (pw - iw) / 2, @margins[2] + (ph - ih) / 2
+          page.canvas.image(image, at: [x, y], width: iw, height: ih)
+        end
+
+        apply_encryption_options(out)
+        apply_optimization_options(out)
+        write_document(out, out_file)
+      end
+
+    end
+
+  end
+end

data/lib/hexapdf/cli/info.rb

@@ -78,7 +78,7 @@ module HexaPDF
       def output_info(file) # :nodoc:
         options = pdf_options(@password)
         options[:config]['document.auto_decrypt'] = @auto_decrypt
-        HexaPDF::Document.open(file, options) do |doc|
+        HexaPDF::Document.open(file, **options) do |doc|
           output_line("File name", file)
           output_line("File size", File.stat(file).size.to_s + " bytes")
           @auto_decrypt && INFO_KEYS.each do |name|

data/lib/hexapdf/cli/inspect.rb

@@ -70,9 +70,17 @@ module HexaPDF
         with_document(file, password: @password) do |doc|
           @doc = doc
           if commands.empty?
+            begin
+              require 'reline'
+              Reline.completion_proc = RELINE_COMPLETION_PROC
+              Reline.completion_append_character = " "
+            rescue LoadError
+              if command_parser.verbosity_info?
+                $stderr.puts("Library reline not available, history and line editing not available")
+              end
+            end
             while true
-              print "cmd> "
-              input = $stdin.gets
+              input = read_input
               (puts; break) unless input
               commands = input.scan(/(["'])(.+?)\1|(\S+)/).map {|a| a[1] || a[2] }
               break if execute_commands(commands)
@@ -85,6 +93,28 @@ module HexaPDF
 
       private
 
+      # :nodoc:
+      COMMAND_LIST = %w[object recursive stream raw-stream xref catalog trailer pages
+                        page-count search quit help]
+      # :nodoc:
+      RELINE_COMPLETION_PROC = proc do |s|
+        if s.empty?
+          COMMAND_DESCRIPTIONS.map {|cmd, desc| cmd.ljust(35) << desc }
+        else
+          COMMAND_LIST.grep(/^#{Regexp.escape(s)}/)
+        end
+      end
+
+      # Returns one line of input, using Reline if available.
+      def read_input
+        if Object.const_defined?("Reline")
+          Reline.readline("cmd> ", true)
+        else
+          print "cmd> "
+          $stdin.gets
+        end
+      end
+
       def execute_commands(data) #:nodoc:
         data.map! {|item| item == ";" ? nil : item }
         until data.empty?

data/lib/hexapdf/cli/modify.rb

@@ -93,7 +93,7 @@ module HexaPDF
       # Arranges the pages of the document as specified with the --pages option.
       def arrange_pages(doc)
         all_pages = doc.pages.to_a
-        new_page_tree = doc.add(Type: :Pages)
+        new_page_tree = doc.add({Type: :Pages})
         parse_pages_specification(@pages, all_pages.length).each do |index, rotation|
           page = all_pages[index]
           page.value.update(page.copy_inherited_values)

data/lib/hexapdf/cli/optimize.rb

@@ -81,7 +81,7 @@ module HexaPDF
 
       # Optimizes the page tree by flattening it and deleting unsed objects.
       def optimize_page_tree(doc)
-        page_tree = doc.add(Type: :Pages)
+        page_tree = doc.add({Type: :Pages})
         retained = {page_tree.data => true}
         doc.pages.each do |page|
           page.value.update(page.copy_inherited_values)