hexapdf 0.6.0 → 0.7.0

data/lib/hexapdf/image_loader/png.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
@@ -162,7 +162,7 @@ module HexaPDF
               if @color_type == INDEXED
                 trns = io.read(length).unpack('C*')
               elsif @color_type == TRUECOLOR || @color_type == GREYSCALE
-                dict[:Mask] = io.read(length).unpack('n*').map {|val| [val, val]}.flatten
+                dict[:Mask] = io.read(length).unpack('n*').map {|val| [val, val] }.flatten
               else
                 io.seek(length, IO::SEEK_CUR)
               end
@@ -179,7 +179,7 @@ module HexaPDF
               end
             when 'cHRM' # PNG s11.3.3.1
               chrm = io.read(length)
-              @chrm = chrm.unpack('N8').map {|v| v / 100_000.0} unless @intent # sRGB trumps cHRM
+              @chrm = chrm.unpack('N8').map {|v| v / 100_000.0 } unless @intent # sRGB trumps cHRM
             else
               io.seek(length, IO::SEEK_CUR)
             end
@@ -320,7 +320,7 @@ module HexaPDF
               length, type = io.read(8).unpack('Na4') # PNG s5.3
               break if type != 'IDAT'
 
-              chunk_size = @document.config['io.chunk_size'.freeze]
+              chunk_size = @document.config['io.chunk_size']
               while length > 0
                 chunk_size = length if chunk_size > length
                 Fiber.yield(io.read(chunk_size))
@@ -363,7 +363,7 @@ module HexaPDF
               mask_data << data.byteslice(i, bytes_per_alpha)
               i += bytes_per_alpha
             end
-            data[0, bytes_per_row] = ''.freeze
+            data[0, bytes_per_row] = ''
           end
         end
 

data/lib/hexapdf/importer.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
@@ -50,16 +50,18 @@ module HexaPDF
   class Importer
 
     class NullableWeakRef < WeakRef #:nodoc:
+
       def __getobj__ #:nodoc:
         super rescue nil
       end
+
     end
 
     # Returns the Importer object for copying objects from the +source+ to the +destination+
     # document.
     def self.for(source:, destination:)
       @map ||= {}
-      @map.keep_if {|_, v| v.source.weakref_alive? && v.destination.weakref_alive?}
+      @map.keep_if {|_, v| v.source.weakref_alive? && v.destination.weakref_alive? }
       source = NullableWeakRef.new(source)
       destination = NullableWeakRef.new(destination)
       @map[[source.hash, destination.hash]] ||= new(source: source, destination: destination)
@@ -108,7 +110,7 @@ module HexaPDF
           obj[k] = duplicate(v)
         end
       when Array
-        object.map {|v| duplicate(v)}
+        object.map {|v| duplicate(v) }
       when HexaPDF::Reference
         import(@source.object(object))
       when HexaPDF::Object

data/lib/hexapdf/layout.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/layout/box.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
@@ -69,8 +69,8 @@ module HexaPDF
       attr_reader :style
 
       # :call-seq:
-      #    Box.new(content_width: 0, content_height: 0, style: Style.new) {|canvas, box| block} -> box
-      #    Box.new(width: 0, height: 0, style: Style.new) {|canvas, box| block} -> box
+      #    Box.new(content_width: 0, content_height: 0, style: Style.new) {|canv, box| block} -> box
+      #    Box.new(width: 0, height: 0, style: Style.new) {|canv, box| block} -> box
       #
       # Creates a new Box object with the given width and height for its content that uses the
       # provided block when it is asked to draw itself on a canvas (see #draw).

data/lib/hexapdf/layout/inline_box.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/layout/line.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
@@ -93,7 +93,7 @@ module HexaPDF
         # Creates a new calculator with the given initial items.
         def initialize(items = [])
           reset
-          items.each {|item| add(item)}
+          items.each {|item| add(item) }
         end
 
         # Adds a new item to be considered when calculating the various dimensions.
@@ -117,7 +117,7 @@ module HexaPDF
           end
           self
         end
-        alias_method :<<, :add
+        alias << add
 
         # Returns the result of the calculations, the array [y_min, y_max, text_y_min, text_y_max].
         #
@@ -182,7 +182,7 @@ module HexaPDF
       # Creates a new Line object, adding all given items to it.
       def initialize(items = [])
         @items = []
-        items.each {|i| add(i)}
+        items.each {|i| add(i) }
         @x_offset = 0
         @y_offset = 0
       end
@@ -207,7 +207,7 @@ module HexaPDF
         end
         self
       end
-      alias :<< :add
+      alias << add
 
       # :call-seq:
       #   line.each {|item, x, y| block }

data/lib/hexapdf/layout/numeric_refinements.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/layout/style.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
@@ -466,7 +466,8 @@ module HexaPDF
           @border_color = border_color
         end
 
-        # Creates the needed link annotation if possible, i.e. if the context of the canvas is a page.
+        # Creates the needed link annotation if possible, i.e. if the context of the canvas is a
+        # page.
         def call(canvas, box)
           return unless canvas.context.type == :Page
           page = canvas.context
@@ -493,16 +494,25 @@ module HexaPDF
 
       # Creates a new Style object.
       #
-      # The +options+ hash may be used to set the initial values of properties by using keys
+      # The +properties+ hash may be used to set the initial values of properties by using keys
       # equivalent to the property names.
       #
       # Example:
       #   Style.new(font_size: 15, align: :center, valign: center)
-      def initialize(**options)
-        options.each {|key, value| send(key, value)}
+      def initialize(**properties)
+        update(properties)
         @scaled_item_widths = {}
       end
 
+      # :call-seq:
+      #   style.update(**properties)    -> style
+      #
+      # Updates the style's properties using the key-value pairs specified by the +properties+ hash.
+      def update(**properties)
+        properties.each {|key, value| send(key, value) }
+        self
+      end
+
       ##
       # :method: font
       # :call-seq:
@@ -799,7 +809,6 @@ module HexaPDF
         alias_method("#{name}=", name)
       end
 
-
       ##
       # :method: text_segmentation_algorithm
       # :call-seq:
@@ -945,7 +954,7 @@ module HexaPDF
 
       # Returns the default color for an empty PDF page, i.e. black.
       def default_color
-        GlobalConfiguration.constantize('color_space.map'.freeze, :DeviceGray).new.default_color
+        GlobalConfiguration.constantize('color_space.map', :DeviceGray).new.default_color
       end
 
     end

data/lib/hexapdf/layout/text_fragment.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
@@ -58,10 +58,12 @@ module HexaPDF
 
       # Creates a new TextFragment object for the given text, shapes it and returns it.
       #
-      # The style of the text fragment can be specified using additional options, of which font is
-      # mandatory.
-      def self.create(text, font:, **options)
-        fragment = new(items: font.decode_utf8(text), style: Style.new(font: font, **options))
+      # The needed style of the text fragment can either be specified by the +style+ argument or via
+      # the +options+ (in which case a new Style object is created). Regardless of the way, the
+      # resulting style object needs at least the font set.
+      def self.create(text, style = nil, **options)
+        style = (style.nil? ? Style.new(options) : style)
+        fragment = new(style.font.decode_utf8(text), style)
         TextShaper.new.shape_text(fragment)
       end
 
@@ -99,64 +101,100 @@ module HexaPDF
       # Creates a new TextFragment object with the given items and style.
       #
       # The argument +style+ can either be a Style object or a hash of style options.
-      def initialize(items:, style: Style.new)
-        @items = items || []
+      def initialize(items, style)
+        @items = items
         @style = (style.kind_of?(Style) ? style : Style.new(style))
       end
 
+      # The precision used to determine whether two floats represent the same value.
+      PRECISION = 0.000001 # :nodoc:
+
       # Draws the text onto the canvas at the given position.
       #
-      # Before the text is drawn using HexaPDF::Content;:Canvas#show_glyphs, the text properties
-      # mentioned in the description of #style are set.
-      def draw(canvas, x, y)
-        return if items.empty?
-
+      # This method is the main styled text drawing facility and therefore some optimizations are
+      # done:
+      #
+      # * The text is drawn using HexaPDF::Content;:Canvas#show_glyphs_only which means that the
+      #   text matrix is *not* updated. Therefore the caller must *not* rely on it!
+      #
+      # * All text style properties mentioned in the description of #style are set except if
+      #   +ignore_text_properties+ is set to +true+. Note that this only applies to style properties
+      #   that directly affect text drawing, so, for example, underlays/overlays and
+      #   underlining/strikeout is always done.
+      #
+      #   The caller should set +ignore_text_properties+ to +true+ if the graphics state hasn't been
+      #   changed. This is the case, for example, if the last thing drawn was a text fragment with
+      #   the same style.
+      #
+      # * It is assumed that the text matrix is not rotated, skewed, etc. so that setting the text
+      #   position can be done using the optimal method.
+      def draw(canvas, x, y, ignore_text_properties: false)
         style.underlays.draw(canvas, x, y + y_min, self)
 
-        # Set general font related graphics state
-        canvas.move_text_cursor(offset: [x, y])
-        canvas.font(style.font, size: style.calculated_font_size).
-          horizontal_scaling(style.horizontal_scaling).
-          character_spacing(style.character_spacing).
-          word_spacing(style.word_spacing).
-          text_rise(style.calculated_text_rise).
-          text_rendering_mode(style.text_rendering_mode)
-
-        # Set fill and/or stroke related graphics state
-        canvas.opacity(fill_alpha: style.fill_alpha, stroke_alpha: style.stroke_alpha)
-        trm = canvas.text_rendering_mode
-        if trm.value.even? # text is filled
-          canvas.fill_color(style.fill_color)
-        end
-        if trm == :stroke || trm == :fill_stroke || trm == :stroke_clip || trm == :fill_stroke_clip
-          canvas.stroke_color(style.stroke_color).
-            line_width(style.stroke_width).
-            line_cap_style(style.stroke_cap_style).
-            line_join_style(style.stroke_join_style).
-            miter_limit(style.stroke_miter_limit).
-            line_dash_pattern(style.stroke_dash_pattern)
+        # Set general font related graphics state if necessary
+        unless ignore_text_properties
+          canvas.font(style.font, size: style.calculated_font_size).
+            horizontal_scaling(style.horizontal_scaling).
+            character_spacing(style.character_spacing).
+            word_spacing(style.word_spacing).
+            text_rise(style.calculated_text_rise).
+            text_rendering_mode(style.text_rendering_mode)
+
+          # Set fill and/or stroke related graphics state
+          canvas.opacity(fill_alpha: style.fill_alpha, stroke_alpha: style.stroke_alpha)
+          trm = canvas.text_rendering_mode
+          if trm.value.even? # text is filled
+            canvas.fill_color(style.fill_color)
+          end
+          if trm == :stroke || trm == :fill_stroke || trm == :stroke_clip || trm == :fill_stroke_clip
+            canvas.stroke_color(style.stroke_color).
+              line_width(style.stroke_width).
+              line_cap_style(style.stroke_cap_style).
+              line_join_style(style.stroke_join_style).
+              miter_limit(style.stroke_miter_limit).
+              line_dash_pattern(style.stroke_dash_pattern)
+          end
         end
 
+        canvas.begin_text
+        tlm = canvas.graphics_state.tlm
+        tx = x - tlm.e
+        ty = y - tlm.f
+        if tx.abs < PRECISION
+          if (ty + canvas.graphics_state.leading).abs < PRECISION
+            canvas.move_text_cursor
+          else
+            canvas.move_text_cursor(offset: [0, ty], absolute: false)
+          end
+        elsif ty.abs < PRECISION
+          canvas.move_text_cursor(offset: [tx, 0], absolute: false)
+        else
+          canvas.move_text_cursor(offset: [x, y])
+        end
         canvas.show_glyphs_only(items)
 
         if style.underline
           y_offset = style.calculated_underline_position
-          canvas.stroke_color(style.fill_color).
-            line_width(style.calculated_underline_thickness).
-            line_cap_style(:butt).
-            line_dash_pattern(0).
-            line(x, y + y_offset, x + width, y + y_offset).
-            stroke
+          canvas.save_graphics_state do
+            canvas.stroke_color(style.fill_color).
+              line_width(style.calculated_underline_thickness).
+              line_cap_style(:butt).
+              line_dash_pattern(0).
+              line(x, y + y_offset, x + width, y + y_offset).
+              stroke
+          end
         end
 
         if style.strikeout
           y_offset = style.calculated_strikeout_position
-          canvas.stroke_color(style.fill_color).
-            line_width(style.calculated_strikeout_thickness).
-            line_cap_style(:butt).
-            line_dash_pattern(0).
-            line(x, y + y_offset, x + width, y + y_offset).
-            stroke
+          canvas.save_graphics_state do
+            canvas.stroke_color(style.fill_color).
+              line_width(style.calculated_strikeout_thickness).
+              line_cap_style(:butt).
+              line_dash_pattern(0).
+              line(x, y + y_offset, x + width, y + y_offset).
+              stroke
+          end
         end
 
         style.overlays.draw(canvas, x, y + y_min, self)
@@ -200,7 +238,7 @@ module HexaPDF
       # in PDF1.7 s9.4.4. By using kerning values as the first and/or last items, the text contained
       # in the fragment may spill over the left and/or right boundary.
       def width
-        @width ||= @items.sum {|item| style.scaled_item_width(item)}
+        @width ||= @items.sum {|item| style.scaled_item_width(item) }
       end
 
       # The height of the text fragment.