hexapdf 0.6.0 → 0.7.0

data/lib/hexapdf/layout/text_layouter.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
@@ -113,6 +113,11 @@ module HexaPDF
           @shrinkability = shrinkability
         end
 
+        # The width of the item.
+        def width
+          @item.width
+        end
+
         # Returns :glue.
         def type
           :glue
@@ -219,38 +224,39 @@ module HexaPDF
                 end
 
                 # A hyphen belongs to the text fragment
-                box_items << glyph if glyph && !glyph.kind_of?(Numeric) && glyph.str == '-'.freeze
+                box_items << glyph if glyph && !glyph.kind_of?(Numeric) && glyph.str == '-'
 
                 unless box_items.empty?
-                  result << Box.new(TextFragment.new(items: box_items.freeze, style: item.style))
+                  result << Box.new(TextFragment.new(box_items.freeze, item.style))
                 end
 
                 if glyph
                   case glyph.str
                   when ' '
                     glues[item.style] ||=
-                      Glue.new(TextFragment.new(items: [glyph].freeze, style: item.style))
+                      Glue.new(TextFragment.new([glyph].freeze, item.style))
                     result << glues[item.style]
                   when "\n", "\v", "\f", "\u{85}", "\u{2029}"
                     result << Penalty::MandatoryParagraphBreak
                   when "\u{2028}"
                     result << Penalty::MandatoryLineBreak
                   when "\r"
-                    if item.items[i + 1]&.kind_of?(Numeric) || item.items[i + 1].str != "\n"
+                    if !item.items[i + 1] || item.items[i + 1].kind_of?(Numeric) ||
+                        item.items[i + 1].str != "\n"
                       result << Penalty::MandatoryParagraphBreak
                     end
                   when '-'
                     result << Penalty::Standard
                   when "\t"
                     spaces = [item.style.font.decode_utf8(" ").first] * 8
-                    result << Glue.new(TextFragment.new(items: spaces.freeze, style: item.style))
+                    result << Glue.new(TextFragment.new(spaces.freeze, item.style))
                   when "\u{00AD}"
                     hyphen = item.style.font.decode_utf8("-").first
-                    frag = TextFragment.new(items: [hyphen].freeze, style: item.style)
+                    frag = TextFragment.new([hyphen].freeze, item.style)
                     result << Penalty.new(Penalty::Standard.penalty, frag.width, item: frag)
                   when "\u{00A0}"
                     space = item.style.font.decode_utf8(" ").first
-                    frag = TextFragment.new(items: [space].freeze, style: item.style)
+                    frag = TextFragment.new([space].freeze, item.style)
                     result << Penalty.new(Penalty::ProhibitedBreak.penalty, frag.width, item: frag)
                   when "\u{200B}"
                     result << Penalty.new(0)
@@ -358,7 +364,7 @@ module HexaPDF
                 if item_fits_on_line?(item)
                   next_index = index + 1
                   next_item = @items[next_index]
-                  next_item = @items[next_index += 1] while next_item && next_item.type == :penalty
+                  next_item = @items[next_index += 1] while next_item&.type == :penalty
                   if next_item && !item_fits_on_line?(next_item)
                     @line_items.concat(@glue_items).push(item.item)
                     @width += item.width
@@ -421,7 +427,7 @@ module HexaPDF
                 if item_fits_on_line?(item)
                   next_index = index + 1
                   next_item = @items[next_index]
-                  next_item = @items[n_index += 1] while next_item && next_item.type == :penalty
+                  next_item = @items[next_index += 1] while next_item&.type == :penalty
                   new_height = @height_calc.simulate_height(next_item.item)
                   if next_item && @width + next_item.width > @width_block.call(new_height)
                     @line_items.concat(@glue_items).push(item.item)
@@ -521,7 +527,6 @@ module HexaPDF
 
       end
 
-
       # Creates a new TextLayouter object for the given text and returns it.
       #
       # See ::new for information on +height+.
@@ -622,7 +627,7 @@ module HexaPDF
           too_wide_box = nil
 
           rest = style.text_line_wrapping_algorithm.call(rest, width_block) do |line, item|
-            line << TextFragment.new(items: [], style: style) if item&.type != :box && line.items.empty?
+            line << TextFragment.new([], style) if item&.type != :box && line.items.empty?
             new_height = @actual_height + line.height +
               (@lines.empty? ? 0 : style.line_spacing.gap(@lines.last, line))
 
@@ -667,10 +672,10 @@ module HexaPDF
             end
           end
 
-          if too_wide_box && too_wide_box.item.kind_of?(TextFragment) &&
-              too_wide_box.item.items.size > 1
+          if too_wide_box && (too_wide_box.item.kind_of?(TextFragment) &&
+                              too_wide_box.item.items.size > 1)
             rest[0..rest.index(too_wide_box)] = too_wide_box.item.items.map do |item|
-              Box.new(TextFragment.new(items: [item], style: too_wide_box.item.style))
+              Box.new(TextFragment.new([item], too_wide_box.item.style))
             end
             too_wide_box = nil
           else
@@ -682,6 +687,9 @@ module HexaPDF
         [rest, reason]
       end
 
+      # :call-seq:
+      #   tl.draws(canvas, x, y, fit: :if_needed) -> [remaining_items, reason] or nil
+      #
       # Draws the layed out text onto the canvas with the top-left corner being at [x, y].
       #
       # Depending on the value of +fit+ the text may also be fitted:
@@ -689,26 +697,37 @@ module HexaPDF
       # * If +true+, then #fit is always called.
       # * If +:if_needed+, then #fit is only called if it has not been called before.
       # * If +false+, then #fit is never called.
+      #
+      # If #fit was called, its return value is returned. Otherwise +nil+ is returned.
       def draw(canvas, x, y, fit: :if_needed)
-        self.fit if fit == true || (!@actual_height && fit == :if_needed)
-        return if @lines.empty?
+        fit_result = self.fit if fit == true || (!@actual_height && fit == :if_needed)
+        return fit_result if @lines.empty?
 
+        last_item = nil
         canvas.save_graphics_state do
+          if @lines.size > 1
+            canvas.leading(style.line_spacing.baseline_distance(@lines[0], @lines[1]))
+          end
           y -= initial_baseline_offset + @lines.first.y_offset
           @lines.each_with_index do |line, index|
             line_x = x + line.x_offset
             line.each do |item, item_x, item_y|
               if item.kind_of?(TextFragment)
-                item.draw(canvas, line_x + item_x, y + item_y)
+                item.draw(canvas, line_x + item_x, y + item_y,
+                          ignore_text_properties: last_item&.style == item.style)
+                last_item = item
               elsif !item.empty?
                 canvas.restore_graphics_state
                 item.draw(canvas, line_x + item_x, y + item_y)
                 canvas.save_graphics_state
+                last_item = nil
               end
             end
             y -= @lines[index + 1].y_offset if @lines[index + 1]
           end
         end
+
+        fit_result
       end
 
       private
@@ -750,7 +769,7 @@ module HexaPDF
         line.items.each_with_index do |item, item_index|
           next if item.kind_of?(InlineBox)
           item.items.each_with_index do |glyph, glyph_index|
-            if !glyph.kind_of?(Numeric) && glyph.str == ' '.freeze
+            if !glyph.kind_of?(Numeric) && glyph.str == ' '
               sum += glyph.width * item.style.scaled_font_size
               indexes << item_index << glyph_index
             end
@@ -764,7 +783,7 @@ module HexaPDF
             frag = line.items[indexes[i]]
             value = -frag.items[indexes[i + 1]].width * adjustment
             if frag.items.frozen?
-              value = HexaPDF::Layout::TextFragment.new(items: [value], style: frag.style)
+              value = HexaPDF::Layout::TextFragment.new([value], frag.style)
               line.items.insert(indexes[i], value)
             else
               frag.items.insert(indexes[i + 1], value)

data/lib/hexapdf/layout/text_shaper.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/name_tree_node.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/number_tree_node.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/object.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
@@ -64,7 +64,6 @@ module HexaPDF
 
   end
 
-
   # Objects of the PDF object system.
   #
   # == Overview
@@ -130,9 +129,9 @@ module HexaPDF
     def self.deep_copy(object)
       case object
       when Hash
-        object.each_with_object({}) {|(key, val), memo| memo[key] = deep_copy(val)}
+        object.each_with_object({}) {|(key, val), memo| memo[key] = deep_copy(val) }
       when Array
-        object.map {|o| deep_copy(o)}
+        object.map {|o| deep_copy(o) }
       when HexaPDF::Object
         (object.indirect? || object.must_be_indirect? ? object : deep_copy(object.value))
       when HexaPDF::Reference
@@ -144,7 +143,6 @@ module HexaPDF
       end
     end
 
-
     # The wrapped HexaPDF::PDFData value.
     #
     # This attribute is not part of the public API!
@@ -365,9 +363,9 @@ module HexaPDF
       if obj.kind_of?(HexaPDF::Object) && !obj.indirect?
         obj.validate(&block)
       elsif obj.kind_of?(Hash)
-        obj.each_value {|val| validate_nested(val, &block)}
+        obj.each_value {|val| validate_nested(val, &block) }
       elsif obj.kind_of?(Array)
-        obj.each {|val| validate_nested(val, &block)}
+        obj.each {|val| validate_nested(val, &block) }
       end
     end
 

data/lib/hexapdf/parser.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
@@ -96,11 +96,11 @@ module HexaPDF
       gen = @tokenizer.next_token
       tok = @tokenizer.next_token
       unless oid.kind_of?(Integer) && gen.kind_of?(Integer) &&
-          tok.kind_of?(Tokenizer::Token) && tok == 'obj'.freeze
+          tok.kind_of?(Tokenizer::Token) && tok == 'obj'
         raise_malformed("No valid object found", pos: offset)
       end
 
-      if (tok = @tokenizer.peek_token) && tok.kind_of?(Tokenizer::Token) && tok == 'endobj'.freeze
+      if (tok = @tokenizer.peek_token) && tok.kind_of?(Tokenizer::Token) && tok == 'endobj'
         maybe_raise("No indirect object value between 'obj' and 'endobj'", pos: @tokenizer.pos)
         object = nil
       else
@@ -109,7 +109,7 @@ module HexaPDF
 
       tok = @tokenizer.next_token
 
-      if tok.kind_of?(Tokenizer::Token) && tok == 'stream'.freeze
+      if tok.kind_of?(Tokenizer::Token) && tok == 'stream'
         unless object.kind_of?(Hash)
           raise_malformed("A stream needs a dictionary, not a(n) #{object.class}", pos: offset)
         end
@@ -135,7 +135,7 @@ module HexaPDF
         @tokenizer.pos = pos + length
 
         tok = @tokenizer.next_token
-        unless tok.kind_of?(Tokenizer::Token) && tok == 'endstream'.freeze
+        unless tok.kind_of?(Tokenizer::Token) && tok == 'endstream'
           maybe_raise("Invalid stream length, keyword endstream not found", pos: @tokenizer.pos)
           @tokenizer.pos = pos
           if @tokenizer.scan_until(/(?=\n?endstream)/)
@@ -154,7 +154,7 @@ module HexaPDF
                                 decode_parms: @document.unwrap(object[:DecodeParms]))
       end
 
-      unless tok.kind_of?(Tokenizer::Token) && tok == 'endobj'.freeze
+      unless tok.kind_of?(Tokenizer::Token) && tok == 'endobj'
         maybe_raise("Indirect object must be followed by keyword endobj", pos: @tokenizer.pos)
       end
 
@@ -234,7 +234,7 @@ module HexaPDF
           end
           if xref.entry?(oid)
             next
-          elsif type == 'n'.freeze
+          elsif type == 'n'
             if pos == 0 || gen > 65535
               maybe_raise("Invalid in use cross-reference entry in cross-reference section",
                           pos: @tokenizer.pos)
@@ -255,7 +255,7 @@ module HexaPDF
 
       trailer = @tokenizer.next_object
       unless trailer.kind_of?(Hash)
-        raise_malformed("Trailer is a #{trailer.class} instead of a dictionary ", pos: @tokenizer.pos)
+        raise_malformed("Trailer is #{trailer.class} instead of dictionary ", pos: @tokenizer.pos)
       end
 
       [xref, trailer]
@@ -339,7 +339,7 @@ module HexaPDF
     # HexaPDF::MalformedPDFError. Otherwise the error is corrected and parsing continues.
     #
     # If the option +force+ is used, the block is not called and the error is raised immediately.
-    def maybe_raise(msg, pos: nil, force: false)
+    def maybe_raise(msg, pos:, force: false)
       if force || @document.config['parser.on_correctable_error'].call(@document, msg, pos)
         error = HexaPDF::MalformedPDFError.new(msg, pos: pos)
         error.set_backtrace(caller(1))

data/lib/hexapdf/rectangle.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
@@ -87,7 +87,7 @@ module HexaPDF
     # upper-right corner.
     def after_data_change
       super
-      unless value.kind_of?(Array) && value.size == 4 && value.all? {|i| i.kind_of?(Numeric)}
+      unless value.kind_of?(Array) && value.size == 4 && value.all? {|i| i.kind_of?(Numeric) }
         raise ArgumentError, "A PDF rectangle structure must contain an array of four numbers"
       end
       value[0], value[2] = value[2], value[0] if value[0] > value[2]
@@ -96,7 +96,7 @@ module HexaPDF
 
     def perform_validation #:nodoc:
       super
-      unless value.kind_of?(Array) && value.size == 4 && value.all? {|i| i.kind_of?(Numeric)}
+      unless value.kind_of?(Array) && value.size == 4 && value.all? {|i| i.kind_of?(Numeric) }
         yield("A PDF rectangle structure must contain an array of four numbers", false)
       end
     end

data/lib/hexapdf/reference.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/revision.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
@@ -175,10 +175,10 @@ module HexaPDF
       return to_enum(__method__) unless block_given?
 
       if defined?(@all_objects_loaded)
-        @objects.each {|_oid, _gen, data| yield(data)}
+        @objects.each {|_oid, _gen, data| yield(data) }
       else
         seen = {}
-        @objects.each {|oid, _gen, data| seen[oid] = true; yield(data)}
+        @objects.each {|oid, _gen, data| seen[oid] = true; yield(data) }
         @xref_section.each do |oid, _gen, data|
           next if seen.key?(oid)
           yield(@objects[oid] || load_object(data))

data/lib/hexapdf/revisions.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
@@ -61,7 +61,7 @@ module HexaPDF
         return new(document) if io.nil?
 
         parser = Parser.new(io, document)
-        object_loader = lambda {|xref_entry| parser.load_object(xref_entry)}
+        object_loader = lambda {|xref_entry| parser.load_object(xref_entry) }
 
         revisions = []
         xref_section, trailer = parser.load_revision(parser.startxref_offset)
@@ -116,7 +116,7 @@ module HexaPDF
     def revision(index)
       @revisions[index]
     end
-    alias :[] :revision
+    alias [] revision
 
     # Returns the current revision.
     def current
@@ -181,7 +181,7 @@ module HexaPDF
         end
       end
       _first, *other = *@revisions[range]
-      other.each {|rev| @revisions.delete(rev)}
+      other.each {|rev| @revisions.delete(rev) }
       self
     end