hexapdf 0.11.9 → 0.13.0

data/lib/hexapdf/font/type1/afm_parser.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/font/type1/character_metrics.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/font/type1/font.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/font/type1/font_metrics.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/font/type1/pfb_parser.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/font/type1_wrapper.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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
@@ -104,23 +104,33 @@ module HexaPDF
       # Returns the wrapped Type1 font object.
       attr_reader :wrapped_font
 
-      # The PDF font dictionary representing the wrapped font.
-      attr_reader :dict
+      # Returns the PDF object associated with the wrapper.
+      attr_reader :pdf_object
 
-      # Creates a new object wrapping the Type1 font for the PDF document.
+      # Creates a new Type1Wrapper object wrapping the Type1 font.
       #
-      # The optional argument +custom_encoding+ can be set to +true+ so that a custom encoding
-      # instead of the WinAnsiEncoding is used.
-      def initialize(document, font, custom_encoding: false)
-        @document = document
+      # The optional argument +pdf_object+ can be used to set the PDF font object that this wrapper
+      # should be associated with. If no object is set, a suitable one is automatically created.
+      #
+      # If +pdf_object+ is provided, the PDF object's encoding is used. Otherwise, the
+      # WinAnsiEncoding or, for 'Special' fonts, the font's internal encoding is used. The optional
+      # argument +custom_encoding+ can be set to +true+ so that a custom encoding is used (only
+      # respected if +pdf_object+ is not provided).
+      def initialize(document, font, pdf_object: nil, custom_encoding: false)
         @wrapped_font = font
+        @pdf_object = pdf_object || create_pdf_object(document)
+        @missing_glyph_callable = document.config['font.on_missing_glyph']
 
-        @dict = build_font_dict
-        @document.register_listener(:complete_objects, &method(:complete_font_dict))
-        if @wrapped_font.metrics.character_set == 'Special' || custom_encoding
+        if pdf_object
+          @encoding = pdf_object.encoding
+          @max_code = 255 # Encoding is not modified
+        elsif custom_encoding
           @encoding = Encoding::Base.new
           @encoding.code_to_name[32] = :space
           @max_code = 32 # 32 = space
+        elsif @wrapped_font.metrics.character_set == 'Special'
+          @encoding = @wrapped_font.encoding
+          @max_code = 255 # Encoding is not modified
         else
           @encoding = Encoding.for_name(:WinAnsiEncoding)
           @max_code = 255 # Encoding is not modified
@@ -150,17 +160,25 @@ module HexaPDF
             if @wrapped_font.metrics.character_metrics.key?(name)
               Glyph.new(@wrapped_font, name, str)
             else
-              @document.config['font.on_missing_glyph'].call(str, font_type, @wrapped_font)
+              @missing_glyph_callable.call(str, font_type, @wrapped_font)
             end
           end
       end
 
       # Returns an array of glyph objects representing the characters in the UTF-8 encoded string.
+      #
+      # If a Unicode codepoint is not available as glyph object, it is tried to map the codepoint
+      # using the font's internal encoding. This is useful, for example, for the ZapfDingbats font
+      # to use ASCII characters for accessing the glyphs.
       def decode_utf8(str)
         str.codepoints.map! do |c|
           @codepoint_to_glyph[c] ||=
             begin
               name = Encoding::GlyphList.unicode_to_name(+'' << c, **@zapf_dingbats_opt)
+              if @wrapped_font.metrics.character_set == 'Special' &&
+                  (name == :'.notdef' || !@wrapped_font.metrics.character_metrics.key?(name))
+                name = @encoding.name(c)
+              end
               name = +"u" << c.to_s(16).rjust(6, '0') if name == :'.notdef'
               glyph(name)
             end
@@ -174,7 +192,7 @@ module HexaPDF
             if glyph.name == @wrapped_font.missing_glyph_id
               raise HexaPDF::Error, "Glyph for #{glyph.str.inspect} missing"
             end
-            code = @encoding.code_to_name.key(glyph.name)
+            code = @encoding.code(glyph.name)
             if code
               code.chr.freeze
             elsif @max_code < 255
@@ -189,49 +207,47 @@ module HexaPDF
 
       private
 
-      # Builds a generic Type1 font dictionary for the wrapped font.
-      #
-      # Generic in the sense that no information regarding the encoding or widths is included.
-      def build_font_dict
-        unless defined?(@fd)
-          @fd = @document.wrap({Type: :FontDescriptor,
-                                FontName: @wrapped_font.font_name.intern,
-                                FontWeight: @wrapped_font.weight_class,
-                                FontBBox: @wrapped_font.bounding_box,
-                                ItalicAngle: @wrapped_font.italic_angle || 0,
-                                Ascent: @wrapped_font.ascender || 0,
-                                Descent: @wrapped_font.descender || 0,
-                                CapHeight: @wrapped_font.cap_height,
-                                XHeight: @wrapped_font.x_height,
-                                StemH: @wrapped_font.dominant_horizontal_stem_width,
-                                StemV: @wrapped_font.dominant_vertical_stem_width || 0})
-          @fd.flag(:fixed_pitch) if @wrapped_font.metrics.is_fixed_pitch
-          @fd.flag(@wrapped_font.metrics.character_set == 'Special' ? :symbolic : :nonsymbolic)
-          @fd.must_be_indirect = true
-        end
-
-        @document.wrap({Type: :Font, Subtype: :Type1,
-                        BaseFont: @wrapped_font.font_name.intern, Encoding: :WinAnsiEncoding,
-                        FontDescriptor: @fd})
-      end
-
       # Array of valid encoding names in PDF
       VALID_ENCODING_NAMES = [:WinAnsiEncoding, :MacRomanEncoding, :MacExpertEncoding].freeze
 
-      # Completes the font dictionary by filling in the values that depend on the used encoding.
-      def complete_font_dict
-        min, max = @encoding.code_to_name.keys.minmax
-        @dict[:FirstChar] = min
-        @dict[:LastChar] = max
-        @dict[:Widths] = (min..max).map {|code| glyph(@encoding.name(code)).width }
-
-        if VALID_ENCODING_NAMES.include?(@encoding.encoding_name)
-          @dict[:Encoding] = @encoding.encoding_name
-        else
-          differences = [min]
-          (min..max).each {|code| differences << @encoding.name(code) }
-          @dict[:Encoding] = {Differences: differences}
+      # Creates a PDF object representing the wrapped font for the given PDF document.
+      def create_pdf_object(document)
+        fd = document.wrap({Type: :FontDescriptor,
+                            FontName: @wrapped_font.font_name.intern,
+                            FontWeight: @wrapped_font.weight_class,
+                            FontBBox: @wrapped_font.bounding_box,
+                            ItalicAngle: @wrapped_font.italic_angle || 0,
+                            Ascent: @wrapped_font.ascender || 0,
+                            Descent: @wrapped_font.descender || 0,
+                            CapHeight: @wrapped_font.cap_height,
+                            XHeight: @wrapped_font.x_height,
+                            StemH: @wrapped_font.dominant_horizontal_stem_width,
+                            StemV: @wrapped_font.dominant_vertical_stem_width || 0})
+        fd.flag(:fixed_pitch) if @wrapped_font.metrics.is_fixed_pitch
+        fd.flag(@wrapped_font.metrics.character_set == 'Special' ? :symbolic : :nonsymbolic)
+        fd.must_be_indirect = true
+
+        dict = document.wrap({Type: :Font, Subtype: :Type1,
+                              BaseFont: @wrapped_font.font_name.intern,
+                              FontDescriptor: fd})
+        dict.font_wrapper = self
+
+        document.register_listener(:complete_objects) do
+          min, max = @encoding.code_to_name.keys.minmax
+          dict[:FirstChar] = min
+          dict[:LastChar] = max
+          dict[:Widths] = (min..max).map {|code| glyph(@encoding.name(code)).width }
+
+          if VALID_ENCODING_NAMES.include?(@encoding.encoding_name)
+            dict[:Encoding] = @encoding.encoding_name
+          elsif @encoding != @wrapped_font.encoding
+            differences = [min]
+            (min..max).each {|code| differences << @encoding.name(code) }
+            dict[:Encoding] = {Differences: differences}
+          end
         end
+
+        dict
       end
 
     end

data/lib/hexapdf/font_loader.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/font_loader/from_configuration.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/font_loader/from_file.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/font_loader/standard14.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/image_loader.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/image_loader/jpeg.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/image_loader/pdf.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/image_loader/png.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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
@@ -162,9 +162,10 @@ module HexaPDF
                 io.seek(length, IO::SEEK_CUR)
               end
             when 'tRNS' # PNG s11.3.2
-              if @color_type == INDEXED
+              case @color_type
+              when INDEXED
                 trns = io.read(length).unpack('C*')
-              elsif @color_type == TRUECOLOR || @color_type == GREYSCALE
+              when TRUECOLOR, GREYSCALE
                 dict[:Mask] = io.read(length).unpack('n*').map {|val| [val, val] }.flatten
               else
                 io.seek(length, IO::SEEK_CUR)

data/lib/hexapdf/importer.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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
@@ -109,9 +109,7 @@ module HexaPDF
     def duplicate(object)
       case object
       when Hash
-        object.each_with_object({}) do |(k, v), obj|
-          obj[k] = duplicate(v)
-        end
+        object.transform_values {|v| duplicate(v) }
       when Array
         object.map {|v| duplicate(v) }
       when HexaPDF::Reference

data/lib/hexapdf/layout.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/layout/box.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/layout/frame.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/layout/image_box.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/layout/inline_box.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/layout/line.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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
@@ -198,7 +198,7 @@ module HexaPDF
       # Note: The cache is not cleared!
       def add(item)
         last = @items.last
-        if last.class == item.class && item.kind_of?(TextFragment) && last.style == item.style
+        if last.instance_of?(item.class) && item.kind_of?(TextFragment) && last.style == item.style
           if last.items.frozen?
             @items[-1] = last = last.dup
             last.items = last.items.dup

data/lib/hexapdf/layout/numeric_refinements.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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/layout/style.rb

@@ -4,7 +4,7 @@
 # This file is part of HexaPDF.
 #
 # HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby
-# Copyright (C) 2014-2019 Thomas Leitner
+# Copyright (C) 2014-2020 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
@@ -524,7 +524,7 @@ module HexaPDF
       #   Style.new(font_size: 15, align: :center, valign: center)
       def initialize(**properties)
         update(**properties)
-        @scaled_item_widths = {}
+        @scaled_item_widths = {}.compare_by_identity
       end
 
       # Duplicates the complex properties that can be modified, as well as the cache.
@@ -883,41 +883,41 @@ module HexaPDF
         [:text_rise, 0],
         [:font_features, {}],
         [:text_rendering_mode, "Content::TextRenderingMode::FILL",
-         setter: "Content::TextRenderingMode.normalize(value)"],
+         {setter: "Content::TextRenderingMode.normalize(value)"}],
         [:subscript, false,
-         setter: "value; superscript(false) if superscript",
-         valid_values: [true, false]],
+         {setter: "value; superscript(false) if superscript",
+          valid_values: [true, false]}],
         [:superscript, false,
-         setter: "value; subscript(false) if subscript",
-         valid_values: [true, false]],
-        [:underline, false, valid_values: [true, false]],
-        [:strikeout, false, valid_values: [true, false]],
+         {setter: "value; subscript(false) if subscript",
+          valid_values: [true, false]}],
+        [:underline, false, {valid_values: [true, false]}],
+        [:strikeout, false, {valid_values: [true, false]}],
         [:fill_color, "default_color"],
         [:fill_alpha, 1],
         [:stroke_color, "default_color"],
         [:stroke_alpha, 1],
         [:stroke_width, 1],
         [:stroke_cap_style, "Content::LineCapStyle::BUTT_CAP",
-         setter: "Content::LineCapStyle.normalize(value)"],
+         {setter: "Content::LineCapStyle.normalize(value)"}],
         [:stroke_join_style, "Content::LineJoinStyle::MITER_JOIN",
-         setter: "Content::LineJoinStyle.normalize(value)"],
+         {setter: "Content::LineJoinStyle.normalize(value)"}],
         [:stroke_miter_limit, 10.0],
         [:stroke_dash_pattern, "Content::LineDashPattern.new",
-         setter: "Content::LineDashPattern.normalize(value, phase)", extra_args: ", phase = 0"],
-        [:align, :left, valid_values: [:left, :center, :right, :justify]],
-        [:valign, :top, valid_values: [:top, :center, :bottom]],
+         {setter: "Content::LineDashPattern.normalize(value, phase)", extra_args: ", phase = 0"}],
+        [:align, :left, {valid_values: [:left, :center, :right, :justify]}],
+        [:valign, :top, {valid_values: [:top, :center, :bottom]}],
         [:text_indent, 0],
         [:line_spacing, "LineSpacing.new(type: :single)",
-         setter: "LineSpacing.new(**(value.kind_of?(Symbol) ? {type: value, value: extra_arg} : value))",
-         extra_args: ", extra_arg = nil"],
-        [:last_line_gap, false, valid_values: [true, false]],
+         {setter: "LineSpacing.new(**(value.kind_of?(Symbol) ? {type: value, value: extra_arg} : value))",
+          extra_args: ", extra_arg = nil"}],
+        [:last_line_gap, false, {valid_values: [true, false]}],
         [:background_color, nil],
-        [:padding, "Quad.new(0)", setter: "Quad.new(value)"],
-        [:margin, "Quad.new(0)", setter: "Quad.new(value)"],
-        [:border, "Border.new", setter: "Border.new(**value)"],
-        [:overlays, "Layers.new", setter: "Layers.new(value)"],
-        [:underlays, "Layers.new", setter: "Layers.new(value)"],
-        [:position, :default, valid_values: [:default, :float, :flow, :absolute]],
+        [:padding, "Quad.new(0)", {setter: "Quad.new(value)"}],
+        [:margin, "Quad.new(0)", {setter: "Quad.new(value)"}],
+        [:border, "Border.new", {setter: "Border.new(**value)"}],
+        [:overlays, "Layers.new", {setter: "Layers.new(value)"}],
+        [:underlays, "Layers.new", {setter: "Layers.new(value)"}],
+        [:position, :default, {valid_values: [:default, :float, :flow, :absolute]}],
         [:position_hint, nil],
       ].each do |name, default, options = {}|
         default = default.inspect unless default.kind_of?(String)
@@ -1075,7 +1075,7 @@ module HexaPDF
       # The item may be a (singleton) glyph object or an integer/float, i.e. items that can appear
       # inside a TextFragment.
       def scaled_item_width(item)
-        @scaled_item_widths[item.object_id] ||=
+        @scaled_item_widths[item] ||=
           begin
             if item.kind_of?(Numeric)
               -item * scaled_font_size