hexapdf 0.5.0 → 0.6.0

data/lib/hexapdf/type/font_descriptor.rb

@@ -46,31 +46,33 @@ module HexaPDF
 
       extend Utils::BitField
 
-      define_field :Type,         type: Symbol,        required: true, default: :FontDescriptor
-      define_field :FontName,     type: Symbol,        required: true
+      define_type :FontDescriptor
+
+      define_field :Type,         type: Symbol, required: true, default: self.type
+      define_field :FontName,     type: Symbol, required: true
       define_field :FontFamily,   type: PDFByteString, version: '1.5'
-      define_field :FontStretch,  type: Symbol,        version: '1.5'
-      define_field :FontWeight,   type: Numeric,       version: '1.5'
-      define_field :Flags,        type: Integer,       required: true
+      define_field :FontStretch,  type: Symbol, version: '1.5'
+      define_field :FontWeight,   type: Numeric, version: '1.5'
+      define_field :Flags,        type: Integer, required: true
       define_field :FontBBox,     type: Rectangle
-      define_field :ItalicAngle,  type: Numeric,       required: true
+      define_field :ItalicAngle,  type: Numeric, required: true
       define_field :Ascent,       type: Numeric
       define_field :Descent,      type: Numeric
-      define_field :Leading,      type: Numeric,       default: 0
+      define_field :Leading,      type: Numeric, default: 0
       define_field :CapHeight,    type: Numeric
-      define_field :XHeight,      type: Numeric,       default: 0
+      define_field :XHeight,      type: Numeric, default: 0
       define_field :StemV,        type: Numeric
-      define_field :StemH,        type: Numeric,       default: 0
-      define_field :AvgWidth,     type: Numeric,       default: 0
-      define_field :MaxWidth,     type: Numeric,       default: 0
-      define_field :MissingWidth, type: Numeric,       default: 0
+      define_field :StemH,        type: Numeric, default: 0
+      define_field :AvgWidth,     type: Numeric, default: 0
+      define_field :MaxWidth,     type: Numeric, default: 0
+      define_field :MissingWidth, type: Numeric, default: 0
       define_field :FontFile,     type: Stream
-      define_field :FontFile2,    type: Stream,        version: '1.1'
-      define_field :FontFile3,    type: Stream,        version: '1.2'
-      define_field :CharSet,      type: [String,       PDFByteString], version: '1.1'
+      define_field :FontFile2,    type: Stream, version: '1.1'
+      define_field :FontFile3,    type: Stream, version: '1.2'
+      define_field :CharSet,      type: [String, PDFByteString], version: '1.1'
 
       define_field :Style,        type: Dictionary
-      define_field :Lang,         type: Symbol,        version: '1.5'
+      define_field :Lang,         type: Symbol, version: '1.5'
       define_field :FD,           type: Dictionary
       define_field :CIDSet,       type: Stream
 

data/lib/hexapdf/type/form.rb

@@ -42,7 +42,9 @@ module HexaPDF
     # See: PDF1.7 s8.10
     class Form < Stream
 
-      define_field :Type,          type: Symbol,     default: :XObject
+      define_type :XObject
+
+      define_field :Type,          type: Symbol,     default: self.type
       define_field :Subtype,       type: Symbol,     required: true, default: :Form
       define_field :FormType,      type: Integer,    default: 1
       define_field :BBox,          type: Rectangle,  required: true

data/lib/hexapdf/type/graphics_state_parameter.rb

@@ -45,7 +45,9 @@ module HexaPDF
     # See: PDF1.7 s8.4.5, s8.1
     class GraphicsStateParameter < Dictionary
 
-      define_field :Type,          type: Symbol, required: true, default: :ExtGState
+      define_type :ExtGState
+
+      define_field :Type,          type: Symbol, required: true, default: self.type
       define_field :LW,            type: Numeric, version: "1.3"
       define_field :LC,            type: Integer, version: "1.3"
       define_field :LJ,            type: Integer, version: "1.3"

data/lib/hexapdf/type/image.rb

@@ -48,7 +48,9 @@ module HexaPDF
       Info = Struct.new(:type, :width, :height, :color_space, :indexed, :components,
                         :bits_per_component, :writable, :extension)
 
-      define_field :Type,             type: Symbol,          default: :XObject
+      define_type :XObject
+
+      define_field :Type,             type: Symbol,          default: self.type
       define_field :Subtype,          type: Symbol,          required: true, default: :Image
       define_field :Width,            type: Integer,         required: true
       define_field :Height,           type: Integer,         required: true
@@ -238,7 +240,7 @@ module HexaPDF
         if filter == :FlateDecode && self[:DecodeParms] && self[:DecodeParms][:Predictor].to_i >= 10
           data = stream_source
         else
-          flate_decode = GlobalConfiguration.constantize('filter.map', :FlateDecode)
+          flate_decode = config.constantize('filter.map', :FlateDecode)
           data = flate_decode.encoder(stream_decoder, Predictor: 15, Colors: 1, Columns: info.width,
                                       BitsPerComponent: info.bits_per_component)
         end

data/lib/hexapdf/type/info.rb

@@ -44,6 +44,8 @@ module HexaPDF
     # See: PDF1.7 s14.3.3, Trailer
     class Info < Dictionary
 
+      define_type :XXInfo
+
       define_field :Title,        type: String, version: '1.1'
       define_field :Author,       type: String
       define_field :Subject,      type: String, version: '1.1'
@@ -59,11 +61,6 @@ module HexaPDF
         true
       end
 
-      # Returns +:XXInfo+.
-      def type
-        :XXInfo
-      end
-
     end
 
   end

data/lib/hexapdf/type/names.rb

@@ -47,6 +47,8 @@ module HexaPDF
     # See: PDF1.7 s7.7.4, HexaPDF::Catalog, HexaPDF::NameTreeNode
     class Names < Dictionary
 
+      define_type :XXNames
+
       define_field :Dests,                  type: NameTreeNode, version: '1.2'
       define_field :AP,                     type: NameTreeNode, version: '1.3'
       define_field :JavaScript,             type: NameTreeNode, version: '1.3'
@@ -58,11 +60,6 @@ module HexaPDF
       define_field :AlternatePresentations, type: NameTreeNode, version: '1.4'
       define_field :Renditions,             type: NameTreeNode, version: '1.5'
 
-      # Returns +:XXNames+.
-      def type
-        :XXNames
-      end
-
     end
 
   end

data/lib/hexapdf/type/object_stream.rb

@@ -95,8 +95,9 @@ module HexaPDF
 
       end
 
+      define_type :ObjStm
 
-      define_field :Type,    type: Symbol, required: true, default: :ObjStm, version: '1.5'
+      define_field :Type,    type: Symbol, required: true, default: self.type, version: '1.5'
       define_field :N,       type: Integer # not required, will be auto-filled on #write_objects
       define_field :First,   type: Integer # not required, will be auto-filled on #write_objects
       define_field :Extends, type: Stream

data/lib/hexapdf/type/page.rb

@@ -31,6 +31,7 @@
 # is created or manipulated using HexaPDF.
 #++
 
+require 'hexapdf/error'
 require 'hexapdf/dictionary'
 require 'hexapdf/stream'
 require 'hexapdf/type/page_tree_node'
@@ -99,14 +100,26 @@ module HexaPDF
         Executive: [0, 0, 522, 756].freeze,
       }.freeze
 
+      # Returns the media box for the given paper size. See PAPER_SIZE for the defined paper sizes.
+      def self.media_box(paper_size, orientation: :portrait)
+        unless PAPER_SIZE.key?(paper_size)
+          raise HexaPDF::Error, "Invalid paper size specified: #{paper_size}"
+        end
+
+        media_box = PAPER_SIZE[paper_size].dup
+        media_box[2], media_box[3] = media_box[3], media_box[2] if orientation == :landscape
+        media_box
+      end
+
       # The inheritable fields.
       INHERITABLE_FIELDS = [:Resources, :MediaBox, :CropBox, :Rotate].freeze
 
       # The required inheritable fields.
       REQUIRED_INHERITABLE_FIELDS = [:Resources, :MediaBox].freeze
 
+      define_type :Page
 
-      define_field :Type,                 type: Symbol, required: true, default: :Page
+      define_field :Type,                 type: Symbol, required: true, default: self.type
       define_field :Parent,               type: :Pages, required: true, indirect: true
       define_field :LastModified,         type: PDFDate, version: '1.3'
       define_field :Resources,            type: :XXResources

data/lib/hexapdf/type/page_tree_node.rb

@@ -59,7 +59,9 @@ module HexaPDF
     # See: PDF1.7 s7.7.3.2, Page
     class PageTreeNode < Dictionary
 
-      define_field :Type,   type: Symbol, required: true, default: :Pages
+      define_type :Pages
+
+      define_field :Type,   type: Symbol, required: true, default: self.type
       define_field :Parent, type: Dictionary, indirect: true
       define_field :Kids,   type: Array, required: true, default: []
       define_field :Count,  type: Integer, required: true, default: 0
@@ -212,12 +214,13 @@ module HexaPDF
 
       private
 
-      # Returns a new page object, correctly initialized using the document's configuration
-      # options.
+      # Returns a new page object, correctly initialized using the document's configuration options.
       def new_page
-        media_box = config['page.default_media_box']
-        media_box = Page::PAPER_SIZE[media_box].dup if Page::PAPER_SIZE.key?(media_box)
-        document.add(Type: :Page, MediaBox: media_box)
+        box = config['page.default_media_box']
+        if box.kind_of?(Symbol)
+          box = Page.media_box(box, orientation: config['page.default_media_orientation'])
+        end
+        document.add(Type: :Page, MediaBox: box)
       end
 
       # Ensures that the /Count and /Parent fields of the whole page tree are set up correctly and

data/lib/hexapdf/type/resources.rb

@@ -44,6 +44,8 @@ module HexaPDF
     # See: PDF1.7 s7.8.3
     class Resources < Dictionary
 
+      define_type :XXResources
+
       define_field :ExtGState, type: Dictionary
       define_field :ColorSpace, type: Dictionary
       define_field :Pattern, type: Dictionary
@@ -53,11 +55,6 @@ module HexaPDF
       define_field :ProcSet, type: Array
       define_field :Properties, type: Dictionary, version: '1.2'
 
-      # Returns +:XXResources+.
-      def type
-        :XXResources
-      end
-
       # Returns the color space stored under the given name.
       #
       # If the color space is not found, an error is raised.

data/lib/hexapdf/type/trailer.rb

@@ -55,6 +55,8 @@ module HexaPDF
     #      XRefStream
     class Trailer < Dictionary
 
+      define_type :XXTrailer
+
       define_field :Size,    type: Integer, indirect: false # will be auto-set when written
       define_field :Prev,    type: Integer
       define_field :Root,    type: :Catalog, indirect: true
@@ -63,11 +65,6 @@ module HexaPDF
       define_field :ID,      type: Array
       define_field :XRefStm, type: Integer, version: '1.5'
 
-      # Returns +:XXTrailer+.
-      def type
-        :XXTrailer
-      end
-
       # Returns the document's Catalog (see Type::Catalog), creating it if needed.
       def catalog
         self[:Root] ||= document.add(Type: :Catalog)

data/lib/hexapdf/type/viewer_preferences.rb

@@ -44,6 +44,8 @@ module HexaPDF
     # See: PDF1.7 s12.2, Catalog
     class ViewerPreferences < Dictionary
 
+      define_type :XXViewerPreferences
+
       define_field :HideToolbar,           type: Boolean, default: false
       define_field :HideMenubar,           type: Boolean, default: false
       define_field :HideWindowUI,          type: Boolean, default: false
@@ -62,11 +64,6 @@ module HexaPDF
       define_field :PrintPageRange,        type: Array,   version: '1.7'
       define_field :NumCopies,             type: Integer, version: '1.7'
 
-      # Returns +:XXViewerPreferences+.
-      def type
-        :XXViewerPreferences
-      end
-
     end
 
   end

data/lib/hexapdf/type/xref_stream.rb

@@ -65,7 +65,9 @@ module HexaPDF
     # See: PDF1.7 s7.5.8
     class XRefStream < HexaPDF::Stream
 
-      define_field :Type,  type: Symbol, default: :XRef, required: true, indirect: false, version: '1.5'
+      define_type :XRef
+
+      define_field :Type,  type: Symbol, default: self.type, required: true, indirect: false, version: '1.5'
       # Size is not required because it will be auto-filled before the object is written
       define_field :Size,  type: Integer, indirect: false
       define_field :Index, type: Array, indirect: false

data/lib/hexapdf/version.rb

@@ -34,6 +34,6 @@
 module HexaPDF
 
   # The version of HexaPDF.
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 
 end

data/test/hexapdf/common_tokenizer_tests.rb

@@ -206,6 +206,8 @@ module CommonTokenizerTests
 
   it "next_xref_entry: fails on invalidly formatted entries" do
     create_tokenizer("0000000001 00001 g \n")
-    assert_raises(HexaPDF::MalformedPDFError) { @tokenizer.next_xref_entry }
+    assert_raises(RuntimeError) { @tokenizer.next_xref_entry { raise }}
+    create_tokenizer("0000000001 00001 n\n")
+    assert_raises(RuntimeError) { @tokenizer.next_xref_entry { raise }}
   end
 end

data/test/hexapdf/content/test_canvas.rb

@@ -87,6 +87,17 @@ describe HexaPDF::Content::Canvas do
       assert_operators(@canvas.contents, [[:save_graphics_state], [:restore_graphics_state]])
     end
 
+    it "saves needed font state information not stored in the graphics state" do
+      @canvas.save_graphics_state do
+        @canvas.font("Times", size: 12)
+        @canvas.save_graphics_state do
+          @canvas.font("Helvetica")
+        end
+        assert_equal("Times-Roman", @canvas.font.wrapped_font.font_name)
+      end
+      assert_nil(@canvas.font)
+    end
+
     it "fails if invoked while in an unsupported graphics objects" do
       assert_raises_in_graphics_object(:path, :clipping_path) { @canvas.save_graphics_state }
     end
@@ -999,9 +1010,9 @@ describe HexaPDF::Content::Canvas do
     it "returns the set font" do
       assert_nil(@canvas.font)
       @canvas.font("Times", size: 10)
-      assert_same(@doc.fonts.load("Times"), @canvas.font)
+      assert_same(@doc.fonts.add("Times"), @canvas.font)
       @canvas.font(@canvas.font)
-      assert_same(@doc.fonts.load("Times"), @canvas.font)
+      assert_same(@doc.fonts.add("Times"), @canvas.font)
       @canvas.font("Helvetica", size: 10)
       assert_operators(@canvas.contents, [[:set_font_and_size, [:F1, 10]],
                                           [:set_leading, [12.0]],
@@ -1010,7 +1021,7 @@ describe HexaPDF::Content::Canvas do
 
     it "sets the font and optionally the font size" do
       @canvas.font("Times", size: 12, variant: :italic)
-      assert_same(@doc.fonts.load("Times", variant: :italic), @canvas.font)
+      assert_same(@doc.fonts.add("Times", variant: :italic), @canvas.font)
       assert_equal(12, @canvas.font_size)
       @canvas.font("Helvetica")
       assert_equal(12, @canvas.font_size)
@@ -1066,6 +1077,11 @@ describe HexaPDF::Content::Canvas do
                                           [:show_text_with_positioning, [["Hal"]]],
                                          ])
     end
+
+    it "fails if no valid font is set" do
+      error = assert_raises(HexaPDF::Error) { @canvas.show_glyphs([]) }
+      assert_match(/if a font is set/, error.message)
+    end
   end
 
   describe "show_glyphs_only" do
@@ -1081,6 +1097,11 @@ describe HexaPDF::Content::Canvas do
                                           [:show_text_with_positioning, [["Ha", -35, "l lo"]]],
                                          ])
     end
+
+    it "fails if no valid font is set" do
+      error = assert_raises(HexaPDF::Error) { @canvas.show_glyphs([]) }
+      assert_match(/if a font is set/, error.message)
+    end
   end
 
   describe "text" do
@@ -1112,6 +1133,11 @@ describe HexaPDF::Content::Canvas do
                                           [:show_text_with_positioning, [["H"]]],
                                          ])
     end
+
+    it "fails if no valid font is set" do
+      error = assert_raises(HexaPDF::Error) { @canvas.show_glyphs([]) }
+      assert_match(/if a font is set/, error.message)
+    end
   end
 
   describe "marked_content_point" do

data/test/hexapdf/content/test_graphics_state.rb

@@ -77,6 +77,17 @@ class GraphicsStateWrapper < Minitest::Spec
   end
 
   describe LineDashPattern do
+    it "returns a normalized line dash pattern from various values" do
+      assert_equal([[], 0], LineDashPattern.normalize(0).to_operands)
+      assert_equal([[5], 0], LineDashPattern.normalize(5).to_operands)
+      assert_equal([[5, 3], 2], LineDashPattern.normalize([5, 3], 2).to_operands)
+      assert_equal([[5], 1], LineDashPattern.normalize(LineDashPattern.normalize(5, 1)).to_operands)
+    end
+
+    it "fails on normalization if an invalid array argument is provided" do
+      assert_raises(ArgumentError) { LineDashPattern.normalize(:bla) }
+    end
+
     it "fails on initialization if the phase is negative" do
       assert_raises(ArgumentError) { LineDashPattern.new([], -1) }
     end

data/test/hexapdf/content/test_operator.rb

@@ -463,8 +463,9 @@ end
 
 describe_operator :SetTextRenderingMode, :Tr do
   it "modifies the text rendering mode" do
-    invoke(127)
-    assert_equal(127, @processor.graphics_state.text_rendering_mode)
+    invoke(HexaPDF::Content::TextRenderingMode::FILL_STROKE)
+    assert_equal(HexaPDF::Content::TextRenderingMode::FILL_STROKE,
+                 @processor.graphics_state.text_rendering_mode)
   end
 end
 

data/test/hexapdf/document/test_fonts.rb

@@ -9,7 +9,7 @@ describe HexaPDF::Document::Fonts do
     @doc.config['font_loader'] = []
   end
 
-  describe "load" do
+  describe "add" do
     before do
       @doc.config['font_loader'] << lambda do |doc, name, **options|
         assert_equal(@doc, doc)
@@ -26,23 +26,23 @@ describe HexaPDF::Document::Fonts do
     end
 
     it "loads the specified font" do
-      assert_equal(:NormalFont, @doc.fonts.load(:TestFont).name)
-      assert_equal(:BoldFont, @doc.fonts.load(:TestFont, variant: :bold).name)
+      assert_equal(:NormalFont, @doc.fonts.add(:TestFont).name)
+      assert_equal(:BoldFont, @doc.fonts.add(:TestFont, variant: :bold).name)
     end
 
     it "caches loaded fonts" do
-      font = @doc.fonts.load(:TestFont)
-      assert_same(font, @doc.fonts.load(:TestFont))
-      assert_same(font, @doc.fonts.load(:TestFont, variant: :none))
+      font = @doc.fonts.add(:TestFont)
+      assert_same(font, @doc.fonts.add(:TestFont))
+      assert_same(font, @doc.fonts.add(:TestFont, variant: :none))
     end
 
     it "fails if the requested font is not found"  do
-      assert_raises(HexaPDF::Error) { @doc.fonts.load("Unknown") }
+      assert_raises(HexaPDF::Error) { @doc.fonts.add("Unknown") }
     end
 
     it "raises an error if a font loader cannot be correctly retrieved" do
       @doc.config['font_loader'][0] = 'UnknownFontLoader'
-      assert_raises(HexaPDF::Error) { @doc.fonts.load(:Other) }
+      assert_raises(HexaPDF::Error) { @doc.fonts.add(:Other) }
     end
   end
 end