hexapdf 1.2.0 → 1.3.0

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

@@ -395,4 +395,88 @@ describe HexaPDF::Type::Annotations::AppearanceGenerator do
       end
     end
   end
+
+  describe "square/circle" do
+    before do
+      @square = @doc.add({Type: :Annot, Subtype: :Square, Rect: [100, 100, 200, 150], C: [0],
+                          BS: {W: 2}})
+      @generator = HexaPDF::Type::Annotations::AppearanceGenerator.new(@square)
+    end
+
+    it "sets the print flag and unsets the hidden flag" do
+      @square.flag(:hidden)
+      @generator.create_appearance
+      assert(@square.flagged?(:print))
+      refute(@square.flagged?(:hidden))
+    end
+
+    it "creates the /RD entry if it doesn't exist and adjusts the /Rect" do
+      @generator.create_appearance
+      assert_equal([99, 99, 201, 151], @square[:Rect])
+      assert_equal([0, 0, 102, 52], @square.appearance[:BBox])
+      assert_operators(@square.appearance.stream,
+                       [[:set_line_width, [2]],
+                        [:append_rectangle, [1, 1, 100, 50]],
+                        [:stroke_path]])
+    end
+
+    it "uses an existing /RD entry" do
+      @square[:RD] = [2, 4, 6, 8]
+      @generator.create_appearance
+      assert_equal([100, 100, 200, 150], @square[:Rect])
+      assert_equal([0, 0, 100, 50], @square.appearance[:BBox])
+      assert_operators(@square.appearance.stream,
+                       [[:set_line_width, [2]],
+                        [:append_rectangle, [3, 9, 90, 36]],
+                        [:stroke_path]])
+    end
+
+    it "can apply just a fill color without a stroke color" do
+      @square.delete(:C)
+      @square.interior_color(255, 0, 0)
+      @generator.create_appearance
+      assert_operators(@square.appearance.stream,
+                       [[:set_device_rgb_non_stroking_color, [1, 0, 0]],
+                        [:set_line_width, [2]],
+                        [:append_rectangle, [1, 1, 100, 50]],
+                        [:fill_path_non_zero]])
+    end
+
+    it "applies all set styling options" do
+      @square.border_style(color: [255, 0, 0], width: 10, style: [2, 1])
+      @square.interior_color(0, 255, 0)
+      @square.opacity(fill_alpha: 0.5, stroke_alpha: 0.5)
+      @generator.create_appearance
+      assert_operators(@square.appearance.stream,
+                       [[:set_graphics_state_parameters, [:GS1]],
+                        [:set_device_rgb_stroking_color, [1, 0, 0]],
+                        [:set_device_rgb_non_stroking_color, [0, 1, 0]],
+                        [:set_line_width, [10]],
+                        [:set_line_dash_pattern, [[2, 1], 0]],
+                        [:append_rectangle, [5, 5, 100, 50]],
+                        [:fill_and_stroke_path_non_zero]])
+    end
+
+    it "doesn't draw anything if neither stroke nor fill color is set" do
+      @square.delete(:C)
+      @generator.create_appearance
+      assert_operators(@square.appearance.stream, [])
+    end
+
+    it "draws an ellipse" do
+      @square[:Subtype] = :Circle
+      @generator.create_appearance
+      assert_operators(@square.appearance.stream,
+                       [[:set_line_width, [2]],
+                        [:move_to, [101.0, 26.0]],
+                        [:curve_to, [101.0, 34.920552, 91.45085, 43.190359, 76.0, 47.650635]],
+                        [:curve_to, [60.54915, 52.110911, 41.45085, 52.110911, 26.0, 47.650635]],
+                        [:curve_to, [10.54915, 43.190359, 1.0, 34.920552, 1.0, 26.0]],
+                        [:curve_to, [1.0, 17.079448, 10.54915, 8.809641, 26.0, 4.349365]],
+                        [:curve_to, [41.45085, -0.110911, 60.54915, -0.110911, 76.0, 4.349365]],
+                        [:curve_to, [91.45085, 8.809641, 101.0, 17.079448, 101.0, 26.0]],
+                        [:close_subpath],
+                        [:stroke_path]])
+    end
+  end
 end

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

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/document'
+require 'hexapdf/type/annotations/border_effect'
+
+describe HexaPDF::Type::Annotations::BorderEffect do
+  class TestAnnot < HexaPDF::Type::Annotation
+    define_field :BE, type: :XXBorderEffect
+    include HexaPDF::Type::Annotations::BorderEffect
+  end
+
+  before do
+    @doc = HexaPDF::Document.new
+    @annot = @doc.wrap({Type: :Annot}, type: TestAnnot)
+  end
+
+  describe "border_effect" do
+    it "returns :none if no border effect is set" do
+      assert_equal(:none, @annot.border_effect)
+      @annot[:BE] = {}
+      assert_equal(:none, @annot.border_effect)
+      @annot[:BE] = {S: :S}
+      assert_equal(:none, @annot.border_effect)
+      @annot[:BE] = {S: :K}
+      assert_equal(:none, @annot.border_effect)
+    end
+
+    it "returns cloud(y|ier|iest) if /S is /C and depending on /I" do
+      @annot[:BE] = {S: :C}
+      assert_equal(:cloudy, @annot.border_effect)
+      @annot[:BE][:I] = 0
+      assert_equal(:cloudy, @annot.border_effect)
+      @annot[:BE][:I] = 1
+      assert_equal(:cloudier, @annot.border_effect)
+      @annot[:BE][:I] = 2
+      assert_equal(:cloudiest, @annot.border_effect)
+      @annot[:BE][:I] = 3
+      assert_equal(:cloudy, @annot.border_effect)
+    end
+
+    it "sets the /BE entry appropriately" do
+      @annot.border_effect(:none)
+      refute(@annot.key?(:BE))
+      @annot.border_effect(nil)
+      refute(@annot.key?(:BE))
+      @annot.border_effect(:cloudy)
+      assert_equal({S: :C, I: 0}, @annot[:BE])
+      @annot.border_effect(:cloudier)
+      assert_equal({S: :C, I: 1}, @annot[:BE])
+      @annot.border_effect(:cloudiest)
+      assert_equal({S: :C, I: 2}, @annot[:BE])
+    end
+
+    it "raises an error if the given type is unknown" do
+      assert_raises(ArgumentError) { @annot.border_effect(:unknown) }
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+require 'test_helper'
+require 'hexapdf/document'
+require 'hexapdf/type/annotations/interior_color'
+
+describe HexaPDF::Type::Annotations::InteriorColor do
+  class TestAnnot < HexaPDF::Type::Annotation
+    define_field :IC, type: HexaPDF::PDFArray
+    include HexaPDF::Type::Annotations::InteriorColor
+  end
+
+  before do
+    @doc = HexaPDF::Document.new
+    @annot = @doc.wrap({Type: :Annot}, type: TestAnnot)
+  end
+
+  describe "interior_color" do
+    it "returns the interior color" do
+      assert_nil(@annot.interior_color)
+      @annot[:IC] = []
+      assert_nil(@annot.interior_color)
+      @annot[:IC] = [0.5]
+      assert_equal(HexaPDF::Content::ColorSpace.device_color_from_specification(0.5),
+                   @annot.interior_color)
+    end
+
+    it "sets the interior color" do
+      @annot.interior_color(255)
+      assert_equal([1.0], @annot[:IC])
+      @annot.interior_color(255, 255, 0)
+      assert_equal([1.0, 1.0, 0], @annot[:IC])
+      @annot.interior_color(:transparent)
+      assert_equal([], @annot[:IC])
+    end
+  end
+end

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

@@ -51,26 +51,6 @@ describe HexaPDF::Type::Annotations::Line do
     end
   end
 
-  describe "interior_color" do
-    it "returns the interior color" do
-      assert_nil(@line.interior_color)
-      @line[:IC] = []
-      assert_nil(@line.interior_color)
-      @line[:IC] = [0.5]
-      assert_equal(HexaPDF::Content::ColorSpace.device_color_from_specification(0.5),
-                   @line.interior_color)
-    end
-
-    it "sets the interior color" do
-      @line.interior_color(255)
-      assert_equal([1.0], @line[:IC])
-      @line.interior_color(255, 255, 0)
-      assert_equal([1.0, 1.0, 0], @line[:IC])
-      @line.interior_color(:transparent)
-      assert_equal([], @line[:IC])
-    end
-  end
-
   describe "leader_line_length" do
     it "returns the leader line length" do
       assert_equal(0, @line.leader_line_length)

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

@@ -98,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
@@ -144,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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hexapdf
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Thomas Leitner
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse
@@ -509,10 +509,15 @@ files:
 - 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
@@ -791,7 +796,9 @@ files:
 - 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