hexapdf 1.1.1 → 1.3.0

data/test/hexapdf/type/annotations/test_line.rb

@@ -0,0 +1,169 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/document'
+require 'hexapdf/type/annotations/line'
+
+describe HexaPDF::Type::Annotations::Line do
+  before do
+    @doc = HexaPDF::Document.new
+    @line = @doc.add({Type: :Annot, Subtype: :Line, Rect: [0, 0, 0, 0], L: [0, 0, 1, 1]})
+  end
+
+  describe "line" do
+    it "returns the coordinates of the start and end points" do
+      @line[:L] = [10, 20, 30, 40]
+      assert_equal([10, 20, 30, 40], @line.line)
+    end
+
+    it "sets the line points" do
+      assert_equal(@line, @line.line(1, 2, 3, 4))
+      assert_equal([1, 2, 3, 4], @line[:L])
+    end
+
+    it "raises an ArgumentError if not all arguments are provided" do
+      assert_raises(ArgumentError) { @line.line(1, 2, 3) }
+    end
+  end
+
+  describe "line_ending_style" do
+    it "returns the current style" do
+      assert_kind_of(HexaPDF::Type::Annotations::Line::LineEndingStyle, @line.line_ending_style)
+      assert_equal([:none, :none], @line.line_ending_style.to_a)
+      @line[:LE] = [:Diamond, :OpenArrow]
+      assert_equal([:diamond, :open_arrow], @line.line_ending_style.to_a)
+      @line[:LE] = [:Diamond, :Unknown]
+      assert_equal([:diamond, :none], @line.line_ending_style.to_a)
+    end
+
+    it "sets the style" do
+      assert_same(@line, @line.line_ending_style(start_style: :OpenArrow))
+      assert_equal([:OpenArrow, :None], @line[:LE])
+      assert_same(@line, @line.line_ending_style(end_style: :open_arrow))
+      assert_equal([:OpenArrow, :OpenArrow], @line[:LE])
+      assert_same(@line, @line.line_ending_style(start_style: :circle, end_style: :ClosedArrow))
+      assert_equal([:Circle, :ClosedArrow], @line[:LE])
+    end
+
+    it "raises an error for unknown styles" do
+      assert_raises(ArgumentError) { @line.line_ending_style(start_style: :unknown) }
+      assert_raises(ArgumentError) { @line.line_ending_style(end_style: :unknown) }
+    end
+  end
+
+  describe "leader_line_length" do
+    it "returns the leader line length" do
+      assert_equal(0, @line.leader_line_length)
+      @line[:LL] = 10
+      assert_equal(10, @line.leader_line_length)
+    end
+
+    it "sets the leader line length" do
+      assert_equal(@line, @line.leader_line_length(10))
+      assert_equal(10, @line[:LL])
+    end
+  end
+
+  describe "leader_line_extension_length" do
+    it "returns the leader line extension length" do
+      assert_equal(0, @line.leader_line_extension_length)
+      @line[:LLE] = 10
+      assert_equal(10, @line.leader_line_extension_length)
+    end
+
+    it "sets the leader line extension length" do
+      assert_equal(@line, @line.leader_line_extension_length(10))
+      assert_equal(10, @line[:LLE])
+    end
+
+    it "raises an error for negative numbers" do
+      assert_raises(ArgumentError) { @line.leader_line_extension_length(-10) }
+    end
+  end
+
+  describe "leader_line_offset" do
+    it "returns the leader line offset" do
+      assert_equal(0, @line.leader_line_offset)
+      @line[:LLO] = 10
+      assert_equal(10, @line.leader_line_offset)
+    end
+
+    it "sets the leader line offset" do
+      assert_equal(@line, @line.leader_line_offset(10))
+      assert_equal(10, @line[:LLO])
+    end
+  end
+
+  describe "captioned" do
+    it "returns whether a caption is shown" do
+      refute(@line.captioned)
+      @line[:Cap] = true
+      assert(@line.captioned)
+    end
+
+    it "sets whether a caption should be shown" do
+      assert_equal(@line, @line.captioned(true))
+      assert_equal(true, @line[:Cap])
+    end
+  end
+
+  describe "caption_position" do
+    it "returns the caption position" do
+      assert_equal(:inline, @line.caption_position)
+      @line[:CP] = :Top
+      assert_equal(:top, @line.caption_position)
+    end
+
+    it "sets the caption position" do
+      assert_equal(@line, @line.caption_position(:top))
+      assert_equal(:Top, @line[:CP])
+    end
+
+    it "raises an error on invalid caption positions" do
+      assert_raises(ArgumentError) { @line.caption_position(:unknown) }
+    end
+  end
+
+  describe "caption_offset" do
+    it "returns the caption offset" do
+      assert_equal([0, 0], @line.caption_offset)
+      @line[:CO] = [10, 5]
+      assert_equal([10, 5], @line.caption_offset)
+    end
+
+    it "sets the caption offset" do
+      assert_equal(@line, @line.caption_offset(5, 10))
+      assert_equal([5, 10], @line[:CO])
+      assert_equal(@line, @line.caption_offset(5))
+      assert_equal([5, 0], @line[:CO])
+      assert_equal(@line, @line.caption_offset(nil, 5))
+      assert_equal([0, 5], @line[:CO])
+    end
+  end
+
+  describe "perform_validation" do
+    it "validates that leader line length is set if extension length is set" do
+      @line[:LLE] = 10
+      m = nil
+      refute(@line.validate {|msg| m = msg })
+      assert_match(/\/LL required to be non-zero/, m)
+    end
+
+    it "ensures leader line extension length is non-negative" do
+      @line[:LL] = 10
+      @line[:LLE] = -10
+      m = nil
+      assert(@line.validate {|msg| m = msg })
+      assert_equal(10, @line[:LLE])
+      assert_match(/non-negative/, m)
+    end
+
+    it "ensures leader line offset is non-negative" do
+      @line[:LLO] = -10
+      m = nil
+      assert(@line.validate {|msg| m = msg })
+      assert_equal(10, @line[:LLO])
+      assert_match(/\/LLO must be a non-negative/, m)
+    end
+  end
+end

data/test/hexapdf/type/annotations/test_widget.rb

@@ -69,87 +69,6 @@ describe HexaPDF::Type::Annotations::Widget do
     end
   end
 
-  describe "border_style" do
-    before do
-      @widget[:MK] = {BC: [1, 0, 1]}
-      @color = HexaPDF::Content::ColorSpace.prenormalized_device_color([1, 0, 1])
-    end
-
-    describe "getter" do
-      it "no /Border, /BS or /MK set" do
-        @widget.delete(:MK)
-        assert_equal([1, nil, :solid, 0, 0], @widget.border_style.to_a)
-      end
-
-      it "no /Border, /BS but with /MK empty" do
-        @widget[:MK].delete(:BC)
-        assert_equal([1, nil, :solid, 0, 0], @widget.border_style.to_a)
-      end
-
-      it "uses the color from /MK" do
-        assert_equal([1, @color, :solid, 0, 0], @widget.border_style.to_a)
-        @widget[:MK][:BC] = []
-        assert_equal([1, nil, :solid, 0, 0], @widget.border_style.to_a)
-      end
-
-      it "uses the data from /Border" do
-        @widget[:Border] = [1, 2, 3, [1, 2]]
-        assert_equal([3, @color, [1, 2], 1, 2], @widget.border_style.to_a)
-      end
-
-      it "uses the data from /BS, overriding /Border values" do
-        @widget[:Border] = [1, 2, 3, [1, 2]]
-        @widget[:BS] = {W: 5, S: :D, D: [5, 6]}
-        assert_equal([5, @color, [5, 6], 0, 0], @widget.border_style.to_a)
-
-        [[:S, :solid], [:D, [5, 6]], [:B, :beveled], [:I, :inset],
-         [:U, :underlined], [:Unknown, :solid]].each do |val, result|
-          @widget[:BS] = {S: val, D: [5, 6]}
-          assert_equal([1, @color, result, 0, 0], @widget.border_style.to_a)
-        end
-      end
-    end
-
-    describe "setter" do
-      it "returns self" do
-        assert_equal(@widget, @widget.border_style(width: 1))
-      end
-
-      it "sets the color" do
-        @widget.border_style(color: [1.0, 51, 1.0])
-        assert_equal([1, 0.2, 1], @widget[:MK][:BC].value)
-
-        @widget.border_style(color: :transparent)
-        assert_equal([], @widget[:MK][:BC].value)
-      end
-
-      it "sets the width" do
-        @widget.border_style(width: 2)
-        assert_equal(2, @widget[:BS][:W])
-      end
-
-      it "sets the style" do
-        [[:solid, :S], [[5, 6], :D], [:beveled, :B], [:inset, :I], [:underlined, :U]].each do |val, r|
-          @widget.border_style(style: val)
-          assert_equal(r, @widget[:BS][:S])
-          assert_equal(val, @widget[:BS][:D].value) if r == :D
-        end
-      end
-
-      it "overrides all priorly set values" do
-        @widget.border_style(width: 3, style: :inset, color: [1])
-        @widget.border_style(width: 5)
-        border_style = @widget.border_style
-        assert_equal(:solid, border_style.style)
-        assert_equal([0], border_style.color.components)
-      end
-
-      it "raises an error for an unknown style" do
-        assert_raises(ArgumentError) { @widget.border_style(style: :unknown) }
-      end
-    end
-  end
-
   describe "marker_style" do
     before do
       @chars = %w[4 l 8 u n H S]
@@ -179,6 +98,20 @@ describe HexaPDF::Type::Annotations::Widget do
         end
       end
 
+      it "uses the correct default style" do
+        @widget.form_field.initialize_as_check_box
+        @widget.marker_style(size: 10)
+        assert_equal('4', @widget[:MK][:CA])
+
+        @widget.form_field.initialize_as_radio_button
+        @widget.marker_style(size: 10)
+        assert_equal('l', @widget[:MK][:CA])
+
+        @widget.form_field.initialize_as_push_button
+        @widget.marker_style(size: 10)
+        assert_equal('', @widget[:MK][:CA])
+      end
+
       it "fails if an invalid argument is provided" do
         assert_raises(ArgumentError) { @widget.marker_style(style: 5) }
       end
@@ -225,5 +158,26 @@ describe HexaPDF::Type::Annotations::Widget do
         assert_equal([1, 0.2, 1, 1], @widget.marker_style.color.components)
       end
     end
+
+    describe "font_name" do
+      it "returns the font_name" do
+        @widget.form_field[:DA] = "/F1 15 Tf"
+        assert_equal(:F1, @widget.marker_style.font_name)
+        @widget[:DA] = "/F2 10 Tf"
+        assert_equal(:F2, @widget.marker_style.font_name)
+      end
+
+      it "returns nil if none is set" do
+        assert_nil(@widget.marker_style.font_name)
+        @widget.form_field[:DA] = "0.0 g"
+        assert_nil(@widget.marker_style.font_name)
+      end
+
+      it "sets the given font_name" do
+        @widget.form_field.initialize_as_push_button
+        @widget.marker_style(font_name: 'Helvetica', size: 10)
+        assert_equal('/F1 10 Tf 0.0 g', @widget[:DA])
+      end
+    end
   end
 end

data/test/hexapdf/type/test_annotation.rb

@@ -113,6 +113,14 @@ describe HexaPDF::Type::Annotation do
     end
   end
 
+  describe "regenerate_appearance" do
+    it "regenerates the appearance using the data from the annotation object" do
+      @annot[:Subtype] = :Unknown
+      error = assert_raises(HexaPDF::Error) { @annot.regenerate_appearance }
+      assert_match(/Unknown.*not.*supported/, error.message)
+    end
+  end
+
   describe "flags" do
     it "returns all flags" do
       assert_equal([:invisible, :hidden, :no_view], @annot.flags)
@@ -139,6 +147,53 @@ describe HexaPDF::Type::Annotation do
     end
   end
 
+  describe "contents" do
+    it "returns the contents value" do
+      assert_nil(@annot.contents)
+      @annot[:Contents] = "test"
+      assert_equal("test", @annot.contents)
+    end
+
+    it "sets the contents value" do
+      assert_same(@annot, @annot.contents("Test"))
+      assert_equal("Test", @annot[:Contents])
+      @annot.contents(nil)
+      assert_nil(@annot[:Contents])
+    end
+  end
+
+  describe "opacity" do
+    it "returns the opacity values" do
+      opacity = @annot.opacity
+      assert_equal(1, opacity.fill_alpha)
+      assert_equal(1, opacity.stroke_alpha)
+
+      @annot[:CA] = 0.5
+      opacity = @annot.opacity
+      assert_equal(0.5, opacity.fill_alpha)
+      assert_equal(0.5, opacity.stroke_alpha)
+
+      @annot[:ca] = 0.3
+      opacity = @annot.opacity
+      assert_equal(0.3, opacity.fill_alpha)
+      assert_equal(0.5, opacity.stroke_alpha)
+    end
+
+    it "sets the opacity values" do
+      @annot.opacity(fill_alpha: 0.3)
+      refute(@annot.key?(:CA))
+      assert_equal(0.3, @annot[:ca])
+
+      @annot.opacity(stroke_alpha: 0.5)
+      assert_equal(0.3, @annot[:ca])
+      assert_equal(0.5, @annot[:CA])
+
+      @annot.opacity(stroke_alpha: 0.1, fill_alpha: 0.2)
+      assert_equal(0.1, @annot[:CA])
+      assert_equal(0.2, @annot[:ca])
+    end
+  end
+
   describe "validation" do
     it "makes sure that empty appearance stream dictionaries don't cause validation errors" do
       assert(@annot.validate)

data/test/hexapdf/type/test_form.rb

@@ -125,6 +125,12 @@ describe HexaPDF::Type::Form do
                                [:restore_graphics_state]])
     end
 
+    it "doesn't move the origin if translate is false" do
+      @form[:BBox] = [-10, -5, 100, 300]
+      @form.canvas(translate: false).line_width = 5
+      assert_operators(@form, [[:set_line_width, [5]]])
+    end
+
     it "fails if the form XObject already has data" do
       @form.stream = '10 w'
       assert_raises(HexaPDF::Error) { @form.canvas }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Thomas Leitner
 bindir: bin
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2025-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse
@@ -371,6 +371,7 @@ files:
 - lib/hexapdf/digital_signature/signing/timestamp_handler.rb
 - lib/hexapdf/digital_signature/verification_result.rb
 - lib/hexapdf/document.rb
+- lib/hexapdf/document/annotations.rb
 - lib/hexapdf/document/destinations.rb
 - lib/hexapdf/document/files.rb
 - lib/hexapdf/document/fonts.rb
@@ -507,8 +508,16 @@ files:
 - lib/hexapdf/type/actions/uri.rb
 - lib/hexapdf/type/annotation.rb
 - lib/hexapdf/type/annotations.rb
+- lib/hexapdf/type/annotations/appearance_generator.rb
+- lib/hexapdf/type/annotations/border_effect.rb
+- lib/hexapdf/type/annotations/border_styling.rb
+- lib/hexapdf/type/annotations/circle.rb
+- lib/hexapdf/type/annotations/interior_color.rb
+- lib/hexapdf/type/annotations/line.rb
 - lib/hexapdf/type/annotations/link.rb
 - lib/hexapdf/type/annotations/markup_annotation.rb
+- lib/hexapdf/type/annotations/square.rb
+- lib/hexapdf/type/annotations/square_circle.rb
 - lib/hexapdf/type/annotations/text.rb
 - lib/hexapdf/type/annotations/widget.rb
 - lib/hexapdf/type/catalog.rb
@@ -661,6 +670,7 @@ files:
 - test/hexapdf/digital_signature/test_signatures.rb
 - test/hexapdf/digital_signature/test_signing.rb
 - test/hexapdf/digital_signature/test_verification_result.rb
+- test/hexapdf/document/test_annotations.rb
 - test/hexapdf/document/test_destinations.rb
 - test/hexapdf/document/test_files.rb
 - test/hexapdf/document/test_fonts.rb
@@ -785,6 +795,11 @@ files:
 - test/hexapdf/type/actions/test_launch.rb
 - test/hexapdf/type/actions/test_set_ocg_state.rb
 - test/hexapdf/type/actions/test_uri.rb
+- test/hexapdf/type/annotations/test_appearance_generator.rb
+- test/hexapdf/type/annotations/test_border_effect.rb
+- test/hexapdf/type/annotations/test_border_styling.rb
+- test/hexapdf/type/annotations/test_interior_color.rb
+- test/hexapdf/type/annotations/test_line.rb
 - test/hexapdf/type/annotations/test_markup_annotation.rb
 - test/hexapdf/type/annotations/test_text.rb
 - test/hexapdf/type/annotations/test_widget.rb