hexapdf 0.12.1 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0354d0b129396ae7c479e806b3115f0be7a7f7d74d47df13f9ad82e5f93df50
-  data.tar.gz: 15f8a80efbffea1724ffdd54bc2f204816def3980ba59986336b742eed3ce6b3
+  metadata.gz: d95e6e2abba7581aab78e449bf860c3955170d4c266850373296300495236c44
+  data.tar.gz: '0950af72d8864e98a70367ee28bdf09bc09aa83cace38933aa613bc8d476263d'
 SHA512:
-  metadata.gz: dc132b215e6d6bd2ab6684e269c559e1d55301403c2c035e32eb7fc213572b86e993f1307c219f6e0aec6bbd8da36ab6d10146c82b89e52f68ca5c90949ef819
-  data.tar.gz: 9bd6252238d418844de0d9e08250dc6b7d8a620fc1e4f232bea6870986764ced86dadc0e4794512ae6abc347a6cf95569b5af7ff35c54833d57b2c2513a0d987
+  metadata.gz: c3c4ad1073d3ea9b820dc129348cf2d571159ea129aa65a10546552ae52e19cf29d74a4716e3fcefac10b34f9d2ad7e833bb90355c81564a152c853e0a406ea4
+  data.tar.gz: 637e17817d1aa8eb3b75035aa5d654f5bdbd7b531fb16776da49945c5100ab0705ab7d59b300f192b865d75ded43edae48d2f15541c2a93edbdedba9318f896a

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.12.2 - 2020-08-17
+
+### Fixed
+
+- Wrong origin for page canvases when bottom left corner of media box doesn't
+  coincide with origin of coordinate system
+- Wrong origin for Form XObject canvas when bottom left corner of bounding box
+  doesn't coincide with origin of coordinate system
+
+
 ## 0.12.1 - 2020-08-16
 
 ### Added

data/lib/hexapdf/type/form.rb

@@ -126,13 +126,22 @@ module HexaPDF
       # The canvas object is cached once it is created so that its graphics state is correctly
       # retained without the need for parsing its contents.
       #
+      # If the bounding box of the form XObject doesn't have its origin at (0, 0), the canvas origin
+      # is translated into the bottom left corner so that this detail doesn't matter when using the
+      # canvas. This means that the canvas' origin is always at the bottom left corner of the
+      # bounding box.
+      #
       # *Note* that a canvas can only be retrieved for initially empty form XObjects!
       def canvas
         document.cache(@data, :canvas) do
           unless stream.empty?
             raise HexaPDF::Error, "Cannot create a canvas for a form XObjects with contents"
           end
+
           canvas = Content::Canvas.new(self)
+          if box.left != 0 || box.bottom != 0
+            canvas.save_graphics_state.translate(box.left, box.bottom)
+          end
           self.stream = canvas.stream_data
           set_filter(:FlateDecode)
           canvas

data/lib/hexapdf/type/page.rb

@@ -358,6 +358,11 @@ module HexaPDF
       # The canvas object is cached once it is created so that its graphics state is correctly
       # retained without the need for parsing its contents.
       #
+      # If the media box of the page doesn't have its origin at (0, 0), the canvas origin is
+      # translated into the bottom left corner so that this detail doesn't matter when using the
+      # canvas. This means that the canvas' origin is always at the bottom left corner of the media
+      # box.
+      #
       # type::
       #    Can either be
       #    * :page for getting the canvas for the page itself (only valid for initially empty pages)
@@ -374,16 +379,25 @@ module HexaPDF
           raise HexaPDF::Error, "Cannot get the canvas for a page with contents"
         end
 
+        create_canvas = lambda do
+          Content::Canvas.new(self).tap do |canvas|
+            media_box = box(:media)
+            if media_box.left != 0 || media_box.bottom != 0
+              canvas.translate(media_box.left, media_box.bottom)
+            end
+          end
+        end
+
         contents = self[:Contents]
         if contents.nil?
-          page_canvas = document.cache(@data, :page_canvas, Content::Canvas.new(self))
+          page_canvas = document.cache(@data, :page_canvas, create_canvas.call)
           self[:Contents] = document.add({Filter: :FlateDecode},
                                          stream: page_canvas.stream_data)
         end
 
         if type == :overlay || type == :underlay
-          underlay_canvas = document.cache(@data, :underlay_canvas, Content::Canvas.new(self))
-          overlay_canvas = document.cache(@data, :overlay_canvas, Content::Canvas.new(self))
+          underlay_canvas = document.cache(@data, :underlay_canvas, create_canvas.call)
+          overlay_canvas = document.cache(@data, :overlay_canvas, create_canvas.call)
 
           stream = HexaPDF::StreamData.new do
             Fiber.yield(" q ")
@@ -396,11 +410,12 @@ module HexaPDF
           underlay = document.add({Filter: :FlateDecode}, stream: stream)
 
           stream = HexaPDF::StreamData.new do
-            Fiber.yield(" Q ")
+            Fiber.yield(" Q q ")
             fiber = overlay_canvas.stream_data.fiber
             while fiber.alive? && (data = fiber.resume)
               Fiber.yield(data)
             end
+            " Q "
           end
           overlay = document.add({Filter: :FlateDecode}, stream: stream)
 

data/lib/hexapdf/version.rb

@@ -37,6 +37,6 @@
 module HexaPDF
 
   # The version of HexaPDF.
-  VERSION = '0.12.1'
+  VERSION = '0.12.2'
 
 end

data/test/hexapdf/layout/test_style.rb

@@ -537,7 +537,7 @@ describe HexaPDF::Layout::Style::LinkLayer do
     end
 
     it "does nothing if the context is not a page object" do
-      @canvas = HexaPDF::Document.new.add({Type: :XObject, Subtype: :Form}).canvas
+      @canvas = HexaPDF::Document.new.add({Type: :XObject, Subtype: :Form, BBox: [0, 0, 1, 1]}).canvas
       assert_nil(call_link(dest: true))
     end
 

data/test/hexapdf/test_writer.rb

@@ -40,7 +40,7 @@ describe HexaPDF::Writer do
       219
       %%EOF
       3 0 obj
-      <</Producer(HexaPDF version 0.12.1)>>
+      <</Producer(HexaPDF version 0.12.2)>>
       endobj
       xref
       3 1
@@ -72,7 +72,7 @@ describe HexaPDF::Writer do
       141
       %%EOF
       6 0 obj
-      <</Producer(HexaPDF version 0.12.1)>>
+      <</Producer(HexaPDF version 0.12.2)>>
       endobj
       2 0 obj
       <</Length 10>>stream

data/test/hexapdf/type/test_form.rb

@@ -82,9 +82,27 @@ describe HexaPDF::Type::Form do
   end
 
   describe "canvas" do
+    # Asserts that the form's contents contains the operators.
+    def assert_operators(form, operators)
+      processor = TestHelper::OperatorRecorder.new
+      form.process_contents(processor)
+      assert_equal(operators, processor.recorded_ops)
+    end
+
     it "always returns the same Canvas instance" do
+      @form[:BBox] = [0, 0, 100, 100]
       canvas = @form.canvas
       assert_same(canvas, @form.canvas)
+      assert_operators(@form, [])
+    end
+
+    it "always moves the origin to the bottom left corner of the bounding box" do
+      @form[:BBox] = [-10, -5, 100, 300]
+      @form.canvas.line_width = 5
+      assert_operators(@form, [[:save_graphics_state],
+                               [:concatenate_matrix, [1, 0, 0, 1, -10, -5]],
+                               [:set_line_width, [5]],
+                               [:restore_graphics_state]])
     end
 
     it "fails if the form XObject already has data" do

data/test/hexapdf/type/test_page.rb

@@ -331,31 +331,36 @@ describe HexaPDF::Type::Page do
       @page.canvas(type: :overlay).line_width = 5
       assert_operators(@page, [[:save_graphics_state], [:restore_graphics_state],
                                [:save_graphics_state], [:set_line_width, [10]],
-                               [:restore_graphics_state], [:set_line_width, [5]]])
+                               [:restore_graphics_state], [:save_graphics_state],
+                               [:set_line_width, [5]], [:restore_graphics_state]])
 
       @page.canvas(type: :underlay).line_width = 2
       assert_operators(@page, [[:save_graphics_state], [:set_line_width, [2]],
                                [:restore_graphics_state], [:save_graphics_state],
                                [:set_line_width, [10]],
-                               [:restore_graphics_state], [:set_line_width, [5]]])
+                               [:restore_graphics_state], [:save_graphics_state],
+                               [:set_line_width, [5]], [:restore_graphics_state]])
     end
 
     it "works correctly if invoked on an empty page, using type :underlay in first invocation" do
       @page.canvas(type: :underlay).line_width = 2
       assert_operators(@page, [[:save_graphics_state], [:set_line_width, [2]],
+                               [:restore_graphics_state], [:save_graphics_state],
                                [:restore_graphics_state], [:save_graphics_state],
                                [:restore_graphics_state]])
 
       @page.canvas.line_width = 10
       assert_operators(@page, [[:save_graphics_state], [:set_line_width, [2]],
                                [:restore_graphics_state], [:save_graphics_state],
-                               [:set_line_width, [10]], [:restore_graphics_state]])
+                               [:set_line_width, [10]], [:restore_graphics_state],
+                               [:save_graphics_state], [:restore_graphics_state]])
 
       @page.canvas(type: :overlay).line_width = 5
       assert_operators(@page, [[:save_graphics_state], [:set_line_width, [2]],
                                [:restore_graphics_state], [:save_graphics_state],
                                [:set_line_width, [10]],
-                               [:restore_graphics_state], [:set_line_width, [5]]])
+                               [:restore_graphics_state], [:save_graphics_state],
+                               [:set_line_width, [5]], [:restore_graphics_state]])
     end
 
     it "works correctly if invoked on a page with existing contents" do
@@ -364,13 +369,39 @@ describe HexaPDF::Type::Page do
       @page.canvas(type: :overlay).line_width = 5
       assert_operators(@page, [[:save_graphics_state], [:restore_graphics_state],
                                [:save_graphics_state], [:set_line_width, [10]],
-                               [:restore_graphics_state], [:set_line_width, [5]]])
+                               [:restore_graphics_state],
+                               [:save_graphics_state], [:set_line_width, [5]],
+                               [:restore_graphics_state]])
 
       @page.canvas(type: :underlay).line_width = 2
       assert_operators(@page, [[:save_graphics_state], [:set_line_width, [2]],
                                [:restore_graphics_state], [:save_graphics_state],
                                [:set_line_width, [10]],
-                               [:restore_graphics_state], [:set_line_width, [5]]])
+                               [:restore_graphics_state],
+                               [:save_graphics_state], [:set_line_width, [5]],
+                               [:restore_graphics_state]])
+    end
+
+    it "works correctly if the page has its origin not at (0,0)" do
+      @page.box(:media, [-10, -5, 100, 300])
+      @page.canvas(type: :underlay).line_width = 2
+      @page.canvas(type: :page).line_width = 2
+      @page.canvas(type: :overlay).line_width = 2
+
+      assert_operators(@page, [[:save_graphics_state],
+                               [:concatenate_matrix, [1, 0, 0, 1, -10, -5]],
+                               [:set_line_width, [2]],
+                               [:restore_graphics_state],
+
+                               [:save_graphics_state],
+                               [:concatenate_matrix, [1, 0, 0, 1, -10, -5]],
+                               [:set_line_width, [2]],
+                               [:restore_graphics_state],
+
+                               [:save_graphics_state],
+                               [:concatenate_matrix, [1, 0, 0, 1, -10, -5]],
+                               [:set_line_width, [2]],
+                               [:restore_graphics_state]])
     end
 
     it "fails if the page canvas is requested for a page with existing contents" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.2
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-16 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse
@@ -653,7 +653,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: HexaPDF - A Versatile PDF Creation and Manipulation Library For Ruby