hexapdf 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 401d9b20b7b9305c334bad4951cb403ea6f4c919
-  data.tar.gz: 40cd8335bd517c1f772c3a26ebf8bb0c7a257492
+SHA256:
+  metadata.gz: ffd1dd41128f1ef75e1caf26f415e908509f881bfdf1595da9b45c633c26bb59
+  data.tar.gz: ef1ae7147fa94bcf361beae3a340acdd1f6f2a72cc3fdbad0d5e46766957c9b7
 SHA512:
-  metadata.gz: 1697291f44f1b7882d0b489af252b8b9cdcaae9416c770f88f325833e75f18ac6d1ef0f8fd03a47af76f1b1451475a97993f97381117e3d3c4df6a592b1e4d4d
-  data.tar.gz: a52680e4ad7f3a7568115e8d4657a1c934f9273e0ef513b023d48570d887ba4b748be4ac91ed2162a0d88f07ca08e63ae7dba7b1fa8c33692e7d6e8bc63dd09d
+  metadata.gz: dc5242710665cf697db8085fcaf0e5096fce0179308a427e4dccbba3a9067db7713a22f1e83a6732ba943b4aa120eb1df69472b32fdcbae7f430c2cfc7364250
+  data.tar.gz: b700fb5ce735aa6ff38cb33b88f37cb4a7eece29979f0be5abaab884f8aef2f1fcf23336b47e9218ea237d04d27012a46df3fd5154f92b33b6a635d31139a180

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+## 0.7.0 - 2018-06-19
+
+### Changed
+
+* All Ruby source files use frozen string literal pragma
+* [HexaPDF::MalformedPDFError::new] method signature
+* [HexaPDF::Layout::TextFragment::new] and
+  [HexaPDF::Layout::TextFragment::create] method signatures
+* [HexaPDF::Encryption::SecurityHandler#set_up_encryption] argument `force_V4`
+  to `force_v4`
+* [HexaPDF::Layout::TextLayouter#draw] to return result of #fit if possible
+
+### Removed
+
+* Optional `leading` argument to HexaPDF::Content::Canvas#font_size method
+
+### Fixed
+
+* Misspelt variable name in [HexaPDF::Layout::TextLayouter::SimpleLineWrapping]
+* [HexaPDF::Layout::TextLayouter::SimpleTextSegmentation] to work if the last
+  character in a text fragment is \r
+* [HexaPDF::Layout::TextLayouter] to work if an optional break point (think
+  soft-hyphen) is followed by whitespace
+* [HexaPDF::Font::TrueType::Builder] to correctly order the entries in the
+  table directory
+* [HexaPDF::Font::TrueType::Builder] to pad the table data to achieve the
+  correct alignment
+* [HexaPDF::Filter::FlateDecode] by removing the Zlib pools since ther were
+  not thread safe
+* All color space classes to accept the color space definition as argument to
+  `::new`
+
+
 ## 0.6.0 - 2017-10-27
 
 ### Added

data/CONTRIBUTERS

@@ -1,3 +1,3 @@
   Count Name
 ======= ====
-    882 Thomas Leitner <t_leitner@gmx.at>
+    928 Thomas Leitner <t_leitner@gmx.at>

data/LICENSE

@@ -1,5 +1,5 @@
 HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-Copyright (C) 2014-2017 Thomas Leitner
+Copyright (C) 2014-2018 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

data/Rakefile

@@ -94,7 +94,7 @@ namespace :dev do
     File.open("hexapdf.gemspec", 'w+') {|f| f.puts(contents)}
   end
 
-  CODING_LINE = "# -*- encoding: utf-8 -*-\n"
+  CODING_LINE = "# -*- encoding: utf-8; frozen_string_literal: true -*-\n"
 
   desc "Insert/Update copyright notice"
   task :update_copyright do

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/bin/hexapdf

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'hexapdf/cli'
 
 HexaPDF::CLI.run
-

data/examples/text_layouter_styling.rb

@@ -25,8 +25,7 @@ in voluptate velit esse cillum dolore eu fugiat nulla pariatur.".tr("\n", ' ')
 
 # Wraps the text in a TextFragment using the given style.
 def fragment(text, style)
-  style = Style.new(style)
-  TextFragment.new(items: style.font.decode_utf8(text), style: style)
+  TextFragment.create(text, style)
 end
 
 # Draws the text at the given [x, y] position onto the canvas and returns the

data/lib/hexapdf.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- 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-2017 Thomas Leitner
+# Copyright (C) 2014-2018 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

data/lib/hexapdf/cli.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- 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-2017 Thomas Leitner
+# Copyright (C) 2014-2018 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
@@ -52,7 +52,7 @@ module HexaPDF
     # Runs the CLI application.
     def self.run(args = ARGV)
       Application.new.parse(args)
-    rescue => e
+    rescue StandardError => e
       $stderr.puts "Problem encountered: #{e.message}"
       exit(1)
     end

data/lib/hexapdf/cli/batch.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- 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-2017 Thomas Leitner
+# Copyright (C) 2014-2018 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
@@ -43,7 +43,7 @@ module HexaPDF
       def initialize #:nodoc:
         super('batch', takes_commands: false)
         short_desc("Execute a single command on multiple files")
-        long_desc(<<-EOF.gsub!(/^ */, ''))
+        long_desc(<<~EOF)
           This command allows executing a single command for multiple input files, thereby reducing
           the overall execution time.
 
@@ -57,8 +57,8 @@ module HexaPDF
         args = Shellwords.split(command)
         files.each do |file|
           begin
-            HexaPDF::CLI::Application.new.parse(args.map {|a| a.gsub(/{}/, file)})
-          rescue
+            HexaPDF::CLI::Application.new.parse(args.map {|a| a.gsub(/{}/, file) })
+          rescue StandardError
             if command_parser.verbosity_warning?
               $stderr.puts "Error processing '#{file}': #{$!.message}"
             end

data/lib/hexapdf/cli/command.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- 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-2017 Thomas Leitner
+# Copyright (C) 2014-2018 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
@@ -47,8 +47,8 @@ module HexaPDF
       module Extensions #:nodoc:
         def help_banner #:nodoc:
           "hexapdf #{HexaPDF::VERSION} - Versatile PDF Manipulation Tool\n" \
-            "Copyright (c) 2014-2017 Thomas Leitner; licensed under the AGPLv3\n\n" <<
-            format(usage, indent: 7) << "\n\n"
+            "Copyright (c) 2014-2017 Thomas Leitner; licensed under the AGPLv3\n\n" \
+            "#{format(usage, indent: 7)}\n\n"
         end
       end
 
@@ -243,7 +243,7 @@ module HexaPDF
       # Applies the chosen stream mode to the given object.
       def optimize_stream(obj)
         return if @out_options.streams == :preserve || !obj.respond_to?(:set_filter) ||
-          Array(obj[:Filter]).any? {|f| IGNORED_FILTERS[f]}
+            Array(obj[:Filter]).any? {|f| IGNORED_FILTERS[f] }
 
         obj.set_filter(@out_options.streams == :compress ? :FlateDecode : nil)
       end
@@ -251,9 +251,9 @@ module HexaPDF
       # Optimize the object if it is a font object.
       def optimize_font(obj)
         return unless @out_options.optimize_fonts && obj.kind_of?(HexaPDF::Type::Font) &&
-          (obj[:Subtype] == :TrueType ||
-           (obj[:Subtype] == :Type0 && obj.descendant_font[:Subtype] == :CIDFontType2)) &&
-          obj.embedded?
+            (obj[:Subtype] == :TrueType ||
+             (obj[:Subtype] == :Type0 && obj.descendant_font[:Subtype] == :CIDFontType2)) &&
+            obj.embedded?
 
         font = HexaPDF::Font::TrueType::Font.new(StringIO.new(obj.font_file.stream))
         data = HexaPDF::Font::TrueType::Optimizer.build_for_pdf(font)
@@ -268,7 +268,7 @@ module HexaPDF
         if @out_options.encryption == :add
           doc.encrypt(algorithm: @out_options.enc_algorithm,
                       key_length: @out_options.enc_key_length,
-                      force_V4: @out_options.enc_force_v4,
+                      force_v4: @out_options.enc_force_v4,
                       permissions: @out_options.enc_permissions,
                       owner_password: @out_options.enc_owner_pwd,
                       user_password: @out_options.enc_user_pwd)
@@ -277,7 +277,7 @@ module HexaPDF
         end
       end
 
-      PAGE_NUMBER_SPEC = "([1-9]\\d*|e)".freeze #:nodoc:
+      PAGE_NUMBER_SPEC = "([1-9]\\d*|e)" #:nodoc:
       ROTATE_MAP = {'l' => -90, 'r' => 90, 'd' => 180, 'n' => :none}.freeze #:nodoc:
 
       # Parses the pages specification string and returns an array of tuples containing a page
@@ -295,12 +295,12 @@ module HexaPDF
             page_num = ($1 == 'e' ? count : str.to_i)
             next if page_num > count
             arr << [page_num - 1, ROTATE_MAP[$2]]
-          when /\A#{PAGE_NUMBER_SPEC}-#{PAGE_NUMBER_SPEC}(?:\/([1-9]\d*))?(l|r|d|n)?\z/
+          when /\A#{PAGE_NUMBER_SPEC}-#{PAGE_NUMBER_SPEC}(?:\/([1-9]\d*))?(l|r|d|n)?\z/o
             start_nr = ($1 == 'e' ? count : [$1.to_i, count].min) - 1
             end_nr = ($2 == 'e' ? count : [$2.to_i, count].min) - 1
             step = ($3 ? $3.to_i : 1) * (start_nr > end_nr ? -1 : 1)
             rotation = ROTATE_MAP[$4]
-            start_nr.step(to: end_nr, by: step) {|n| arr << [n, rotation]}
+            start_nr.step(to: end_nr, by: step) {|n| arr << [n, rotation] }
           else
             raise OptionParser::InvalidArgument, "invalid page range format: #{str}"
           end
@@ -315,15 +315,13 @@ module HexaPDF
         if $stdin.tty?
           read_from_console(prompt)
         else
-          pwd = $stdin.gets
-          pwd = read_from_console(prompt) unless pwd
-          pwd.chomp
+          ($stdin.gets || read_from_console(prompt)).chomp
         end
       end
 
       # Removes unused pages and page tree nodes from the document.
       def remove_unused_pages(doc)
-        retained = doc.pages.each_with_object({}) {|page, h| h[page.data] = true}
+        retained = doc.pages.each_with_object({}) {|page, h| h[page.data] = true }
         retained[doc.pages.root.data] = true
         doc.each(current: false) do |obj|
           next unless obj.kind_of?(HexaPDF::Dictionary)
@@ -338,7 +336,7 @@ module HexaPDF
       # Displays the given prompt, reads from the console without echo and returns the read string.
       def read_from_console(prompt)
         IO.console.write("#{prompt}: ")
-        str = IO.console.noecho {|io| io.gets.chomp}
+        str = IO.console.noecho {|io| io.gets.chomp }
         puts
         str
       end

data/lib/hexapdf/cli/files.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- 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-2017 Thomas Leitner
+# Copyright (C) 2014-2018 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
@@ -44,7 +44,7 @@ module HexaPDF
       def initialize #:nodoc:
         super('files', takes_commands: false)
         short_desc("List or extract embedded files from a PDF file")
-        long_desc(<<-EOF.gsub!(/^ */, ''))
+        long_desc(<<~EOF)
           If the option --extract is not given, the available files are listed with their names and
           indices. The --extract option can then be used to extract one or more files.
         EOF

data/lib/hexapdf/cli/images.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- 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-2017 Thomas Leitner
+# Copyright (C) 2014-2018 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
@@ -45,7 +45,7 @@ module HexaPDF
       def initialize #:nodoc:
         super('images', takes_commands: false)
         short_desc("List or extract images from a PDF file")
-        long_desc(<<-EOF.gsub!(/^ */, ''))
+        long_desc(<<~EOF)
           If the option --extract is not given, the available images are listed with their index and
           additional information, sorted by page number. The --extract option can then be used to
           extract one or more images, saving them to files called `prefix-n.ext` where the prefix
@@ -104,7 +104,6 @@ module HexaPDF
         end
       end
 
-
       # Extracts the images with the given indices.
       def extract_images(doc)
         done = Set.new

data/lib/hexapdf/cli/info.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- 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-2017 Thomas Leitner
+# Copyright (C) 2014-2018 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
@@ -49,7 +49,7 @@ module HexaPDF
       def initialize #:nodoc:
         super('info', takes_commands: false)
         short_desc("Show document information")
-        long_desc(<<-EOF.gsub!(/^ */, ''))
+        long_desc(<<~EOF)
           This command extracts information from the Info dictionary of a PDF file as well
           as some other useful information like the used PDF version and encryption information.
         EOF
@@ -78,10 +78,10 @@ module HexaPDF
         HexaPDF::Document.open(file, options) do |doc|
           output_line("File name", file)
           output_line("File size", File.stat(file).size.to_s + " bytes")
-          INFO_KEYS.each do |name|
+          @auto_decrypt && INFO_KEYS.each do |name|
             next unless doc.trailer.info.key?(name)
             output_line(name.to_s, doc.trailer.info[name].to_s)
-          end if @auto_decrypt
+          end
 
           if doc.encrypted? && @auto_decrypt
             details = doc.security_handler.encryption_details

data/lib/hexapdf/cli/inspect.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- 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-2017 Thomas Leitner
+# Copyright (C) 2014-2018 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
@@ -42,7 +42,7 @@ module HexaPDF
       def initialize #:nodoc:
         super('inspect', takes_commands: false)
         short_desc("Dig into the internal structure of a PDF file")
-        long_desc(<<-EOF.gsub!(/^ */, ''))
+        long_desc(<<~EOF)
           Inspects a PDF file for debugging or testing purposes. This command is useful when one
           needs to inspect the internal object structure or a stream of a PDF file. A PDF object is
           always shown in the PDF syntax.
@@ -94,7 +94,7 @@ module HexaPDF
       end
 
       def execute(file) #:nodoc:
-        with_document(file, password: @password) {|doc| send("do_#{@exec}", doc)}
+        with_document(file, password: @password) {|doc| send("do_#{@exec}", doc) }
       end
 
       private
@@ -116,8 +116,8 @@ module HexaPDF
         page_list = doc.pages.to_a
         pages.each do |index, _|
           page = page_list[index]
-          str = "page #{index + 1} (#{page.oid},#{page.gen}): "
-          str << Array(page[:Contents]).map {|c| "#{c.oid},#{c.gen}"}.join(" ")
+          str = +"page #{index + 1} (#{page.oid},#{page.gen}): "
+          str << Array(page[:Contents]).map {|c| "#{c.oid},#{c.gen}" }.join(" ")
           puts str
         end
       end

data/lib/hexapdf/cli/merge.rb

@@ -1,10 +1,10 @@
-# -*- encoding: utf-8 -*-
+# -*- 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-2017 Thomas Leitner
+# Copyright (C) 2014-2018 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
@@ -44,7 +44,7 @@ module HexaPDF
       def initialize #:nodoc:
         super('merge', takes_commands: false)
         short_desc("Merge multiple PDF files")
-        long_desc(<<-EOF.gsub!(/^ */, ''))
+        long_desc(<<~EOF)
           This command merges pages from multiple PDFs into one output file which can optionally be
           encrypted/decrypted and optimized in various ways.
 
@@ -144,14 +144,14 @@ module HexaPDF
         @files.each do |s|
           page_list = s.file.pages.to_a
           s.pages = parse_pages_specification(s.pages, s.file.pages.count)
-          s.pages.each {|arr| arr[0] = page_list[arr[0]]}
+          s.pages.each {|arr| arr[0] = page_list[arr[0]] }
         end
 
         if @interleave
           max_pages_per_file = 0
           all = @files.each_with_index.map do |spec, findex|
             list = []
-            spec.pages.each {|index, rotation| list << [spec.file, findex, index, rotation]}
+            spec.pages.each {|index, rotation| list << [spec.file, findex, index, rotation] }
             max_pages_per_file = list.size if list.size > max_pages_per_file
             list
           end
@@ -165,7 +165,7 @@ module HexaPDF
           end
         else
           @files.each_with_index do |s, findex|
-            s.pages.each {|page, rotation| import_page(page_tree, findex, page, rotation)}
+            s.pages.each {|page, rotation| import_page(page_tree, findex, page, rotation) }
           end
         end
       end