pdfrb 0.3.0 → 0.7.1

data/lib/pdfrb/model/type/optional_content_properties.rb

@@ -3,9 +3,24 @@
 module Pdfrb
   module Model
     module Type
-      # Alias for OptionalContentProperties — autoload path.
+      # Optional Content Properties (s8.11.1). Catalog /OCProperties.
       class OptionalContentProperties < Pdfrb::Model::Cos::Dictionary
         arlington_object "OptContentProperties"
+
+        def ocgs; self[:OCGs]; end
+        def default_config; self[:D]; end
+        def configs; self[:Configs]; end
+        def list_mode; self[:ListMode]; end
+
+        def has_configs?
+          !!configs
+        end
+
+        def base_state
+          return :ON_UNLESS_OFF unless default_config
+
+          default_config[:BaseState]&.to_sym || :ON_UNLESS_OFF
+        end
       end
     end
   end

data/lib/pdfrb/model/type/outline.rb

@@ -7,13 +7,47 @@ module Pdfrb
       class Outline < Pdfrb::Model::Cos::Dictionary
         arlington_object "Outline"
         register_type :Outlines
-      end
 
-      # One bookmark entry (s12.3.3). Forms a doubly-linked list with
-      # /Next, /Prev, /First, /Last, /Parent; carries /Title, /A or
-      # /Dest for the navigation target.
-      class OutlineItem < Pdfrb::Model::Cos::Dictionary
-        arlington_object "OutlineItem"
+        def type; self[:Type]; end
+        def first; self[:First]; end
+        def last; self[:Last]; end
+        def count; self[:Count]; end
+
+        def empty?
+          !first
+        end
+
+        def has_items?
+          !!first
+        end
+
+        def resolved_first
+          ref = first
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+
+        def resolved_last
+          ref = last
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+
+        def each_item(&block)
+          return enum_for(:each_item) unless block
+          return unless first && document
+
+          cur_ref = first
+          while cur_ref
+            item = document.object(cur_ref)
+            break unless item
+
+            yield item
+            cur_ref = item[:Next]
+          end
+        end
       end
     end
   end

data/lib/pdfrb/model/type/outline_item.rb

@@ -7,6 +7,51 @@ module Pdfrb
       # path matches the TSV-derived class name.
       class OutlineItem < Pdfrb::Model::Cos::Dictionary
         arlington_object "OutlineItem"
+
+        def title; self[:Title]; end
+        def parent; self[:Parent]; end
+        def prev; self[:Prev]; end
+        def next; self[:Next]; end
+        def first; self[:First]; end
+        def last; self[:Last]; end
+        def count; self[:Count]; end
+        def dest; self[:Dest]; end
+        def action; self[:A]; end
+        def se; self[:SE]; end
+        def c; self[:C]; end
+        def f; self[:F]; end
+
+        def color
+          c if c && (!c.is_a?(Array) || !c.empty?)
+        end
+
+        def bold?
+          f&.anybits?(1)
+        end
+
+        def italic?
+          f&.anybits?(2)
+        end
+
+        def has_children?
+          !!(count && count.nonzero?)
+        end
+
+        def open?
+          return true unless count
+
+          count.positive?
+        end
+
+        def child_count
+          return 0 unless count
+
+          count.abs
+        end
+
+        def destination
+          dest || (action && action[:D])
+        end
       end
     end
   end

data/lib/pdfrb/model/type/output_intent.rb

@@ -4,8 +4,38 @@ module Pdfrb
   module Model
     module Type
       # Output intent (s14.11.5) — ICC profile + condition metadata.
+      # Required for PDF/X and PDF/A conformance.
       class OutputIntent < Pdfrb::Model::Cos::Dictionary
         arlington_object "OutputIntents"
+        register_type :OutputIntent
+
+        def type; self[:Type]; end
+        def output_intent_type; self[:S]; end
+        def output_condition; self[:OutputCondition]; end
+        def output_condition_identifier; self[:OutputConditionIdentifier]; end
+        def registry_name; self[:RegistryName]; end
+        def info; self[:Info]; end
+        def dest_output_profile; self[:DestOutputProfile]; end
+        def dest_output_profile_ref; self[:DestOutputProfileRef]; end
+
+        def pdfx?
+          output_intent_type&.to_sym == :GTS_PDFX
+        end
+
+        def pdfa?
+          [:GTS_PDFA1, :GTS_PDFA2, :GTS_PDFA3].include?(output_intent_type&.to_sym)
+        end
+
+        def has_embedded_profile?
+          !!dest_output_profile
+        end
+
+        def resolved_profile
+          ref = dest_output_profile
+          return nil unless ref && document
+
+          document.object(ref)
+        end
       end
     end
   end

data/lib/pdfrb/model/type/page.rb

@@ -61,10 +61,137 @@ module Pdfrb
           inheritable(:Resources)
         end
 
+        def media_box=(box)
+          value[:MediaBox] = box
+        end
+
+        def bleed_box=(box)
+          value[:BleedBox] = box
+        end
+
+        def trim_box=(box)
+          value[:TrimBox] = box
+        end
+
+        def art_box=(box)
+          value[:ArtBox] = box
+        end
+
+        def crop_box=(box)
+          value[:CropBox] = box
+        end
+
+        def bleed_box
+          value[:BleedBox]
+        end
+
+        def trim_box
+          value[:TrimBox]
+        end
+
+        def art_box
+          value[:ArtBox]
+        end
+
         def rotate
           inheritable(:Rotate) || 0
         end
 
+        def parent
+          ref = value[:Parent]
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+
+        def annotations
+          self[:Annots]
+        end
+
+        def has_annotations?
+          !!annotations
+        end
+
+        def user_unit
+          self[:UserUnit] || 1.0
+        end
+
+        def duration
+          self[:Dur]
+        end
+
+        def transition
+          self[:Trans]
+        end
+
+        def thumbnail
+          self[:Thumb]
+        end
+
+        def tab_order
+          self[:Tabs]&.to_sym
+        end
+
+        def structural_parent
+          self[:StructParents]
+        end
+
+        def metadata
+          self[:Metadata]
+        end
+
+        def associated_files
+          self[:AF]
+        end
+
+        def output_intents
+          self[:OutputIntents]
+        end
+
+        def group
+          self[:Group]
+        end
+
+        def has_group?
+          !!group
+        end
+
+        def rotated?
+          rotate != 0
+        end
+
+        def landscape?
+          mb = media_box
+          return false unless mb.is_a?(Array) && mb.size >= 4
+
+          width = mb[2].to_f - mb[0].to_f
+          height = mb[3].to_f - mb[1].to_f
+          width > height
+        end
+
+        def portrait?
+          mb = media_box
+          return false unless mb.is_a?(Array) && mb.size >= 4
+
+          width = mb[2].to_f - mb[0].to_f
+          height = mb[3].to_f - mb[1].to_f
+          height > width
+        end
+
+        def each_annotation
+          return enum_for(:each_annotation) unless block_given?
+          return unless annotations && document
+
+          arr = annotations.is_a?(Pdfrb::Model::Reference) ?
+                  document.object(annotations) : annotations
+          return unless arr.is_a?(Array) || arr.is_a?(Pdfrb::Model::PdfArray)
+
+          arr.each do |entry|
+            obj = entry.is_a?(Pdfrb::Model::Reference) ? document.object(entry) : entry
+            yield obj if obj
+          end
+        end
+
         private
 
         def inheritable(key)

data/lib/pdfrb/model/type/page_label.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # PageLabel (s12.4.2). Catalog /PageLabels /Nums entry. Defines
+      # how page numbers are displayed in the viewer.
+      class PageLabel < Cos::Dictionary
+        register_type :PageLabel
+
+        def type; self[:Type]; end
+        def style; self[:S]; end
+        def prefix; self[:P]; end
+        def start; self[:St] || 1; end
+
+        def decimal_style?; style&.to_sym == :D; end
+        def uppercase_roman_style?; style&.to_sym == :R; end
+        def lowercase_roman_style?; style&.to_sym == :r; end
+        def uppercase_letters_style?; style&.to_sym == :A; end
+        def lowercase_letters_style?; style&.to_sym == :a; end
+
+        def label_for(page_index)
+          return prefix.to_s unless style
+
+          number = start + page_index
+          case style.to_sym
+          when :D then "#{prefix}#{number}"
+          when :R then "#{prefix}#{to_roman(number).upcase}"
+          when :r then "#{prefix}#{to_roman(number).downcase}"
+          when :A then "#{prefix}#{to_letters(number).upcase}"
+          when :a then "#{prefix}#{to_letters(number).downcase}"
+          else prefix.to_s
+          end
+        end
+
+        private
+
+        def to_roman(n)
+          return "0" if n <= 0
+
+          mappings = [
+            [1000, "M"], [900, "CM"], [500, "D"], [400, "CD"],
+            [100, "C"], [90, "XC"], [50, "L"], [40, "XL"],
+            [10, "X"], [9, "IX"], [5, "V"], [4, "IV"], [1, "I"]
+          ]
+          result = +""
+          mappings.each do |value, symbol|
+            while n >= value
+              result << symbol
+              n -= value
+            end
+          end
+          result
+        end
+
+        def to_letters(n)
+          result = +""
+          n -= 1
+          while n >= 0
+            result = (65 + (n % 26)).chr + result
+            n = (n / 26) - 1
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/page_piece_info.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Page-piece dictionary (s14.5). Per-page metadata recording
+      # application-specific private data. The dictionary hangs off
+      # a page's /PieceInfo key and is keyed by application name;
+      # each value carries /LastModified, /Private, and (optionally)
+      # an /ASFStream reference for a stream-encoded private payload.
+      #
+      # Conforming readers MUST NOT interpret application-private
+      # data; it survives round-trips and incremental updates intact.
+      class PagePieceInfo < Pdfrb::Model::Cos::Dictionary
+        # The application-name key (e.g. :Adobe, :Pdfrb). Multiple
+        # applications may each have their own entry in the same
+        # /PieceInfo dict.
+        def application_name
+          value.key?(:Application) ? value[:Application] : nil
+        end
+
+        # /LastModified — PDF date string, parsed to a Time.
+        def last_modified
+          v = value[:LastModified]
+          return nil unless v.is_a?(::String)
+
+          Pdfrb::Model::Date.parse(v)
+        end
+
+        # /Private — application-private dict. Untyped on purpose:
+        # the contents are app-defined.
+        def private_data
+          value[:Private]
+        end
+
+        # Set the application's /LastModified to +time+. +time+ is
+        # converted to a PDF date string.
+        def last_modified=(time)
+          value[:LastModified] = Pdfrb::Model::Date.format(time)
+        end
+
+        # Merge +hash+ into /Private. If /Private is absent, it is
+        # created from the hash.
+        def merge_private!(hash)
+          existing = value[:Private]
+          if existing.is_a?(Pdfrb::Model::Cos::Dictionary)
+            existing.value.merge!(hash)
+          elsif existing.is_a?(::Hash)
+            existing.merge!(hash)
+          else
+            value[:Private] = hash
+          end
+          self
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/page_tree_node.rb

@@ -12,16 +12,39 @@ module Pdfrb
         arlington_object "PageTreeNode"
         register_type :Pages
 
-        # Walk all leaf PageObjects under this node.
-        def each_page(&block)
-          return enum_for(:each_page) unless block_given?
+        def kids; self[:Kids]; end
+        def count; self[:Count] || 0; end
+        def parent; self[:Parent]; end
+        def media_box; self[:MediaBox]; end
+        def crop_box; self[:CropBox]; end
+        def resources; self[:Resources]; end
+        def rotate; self[:Rotate]; end
+
+        def root?
+          parent.nil?
+        end
+
+        def leaf?
+          false
+        end
+
+        def each_child
+          return enum_for(:each_child) unless block_given?
+          return unless kids && document
 
-          kids = self[:Kids] || []
-          kids.each do |kid_ref|
-            kid = kid_ref.is_a?(Pdfrb::Model::Reference) ?
-                    document&.object(kid_ref) : kid_ref
-            next unless kid
+          arr = kids.is_a?(Pdfrb::Model::Reference) ? document.object(kids) : kids
+          return unless arr.is_a?(Array)
+
+          arr.each do |kid_ref|
+            obj = kid_ref.is_a?(Pdfrb::Model::Reference) ? document.object(kid_ref) : kid_ref
+            yield obj if obj
+          end
+        end
+
+        def each_page(&block)
+          return enum_for(:each_page) unless block
 
+          each_child do |kid|
             case kid[:Type]
             when :Pages then kid.each_page(&block)
             when :Page then yield kid
@@ -29,17 +52,29 @@ module Pdfrb
           end
         end
 
+        def pages
+          each_page.to_a
+        end
+
         def page_count
-          self[:Count] || 0
+          count
+        end
+
+        def first_page
+          each_page.first
         end
-      end
 
-      # The root of the page tree — same shape as PageTreeNode but
-      # linked directly from the Catalog's /Pages. Tracked separately
-      # so type-dispatch can distinguish root from interior nodes
-      # (some validation rules apply only to the root).
-      class PageTreeNodeRoot < PageTreeNode
-        arlington_object "PageTreeNodeRoot"
+        def last_page
+          each_page.to_a.last
+        end
+
+        def page_at(index)
+          return nil if index.negative? || index >= page_count
+
+          each_page.with_index do |page, i|
+            return page if i == index
+          end
+        end
       end
     end
   end

data/lib/pdfrb/model/type/page_tree_node_root.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # The root of the page tree — same shape as PageTreeNode but
+      # linked directly from the Catalog's /Pages. Tracked separately
+      # so type-dispatch can distinguish root from interior nodes
+      # (some validation rules apply only to the root).
+      class PageTreeNodeRoot < PageTreeNode
+        arlington_object "PageTreeNodeRoot"
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/pattern.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Pattern dictionary base (s8.7.2). Patterns tile or shade to fill
+      # graphics. Two pattern types: tiling (Type 1) and shading (Type 2).
+      class Pattern < Pdfrb::Model::Cos::Dictionary
+        def pattern_type; self[:PatternType]; end
+
+        def tiling?; pattern_type == 1; end
+        def shading?; pattern_type == 2; end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/pattern_shading.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Type 2 shading pattern (s8.7.4.1). Fills with a Shading dict.
+      class PatternShading < Pattern
+        def shading; self[:Shading]; end
+        def matrix; self[:Matrix]; end
+        def ext_g_state; self[:ExtGState]; end
+
+        def has_matrix?
+          !!matrix
+        end
+
+        def resolved_shading
+          ref = shading
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/pattern_tiling.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Type 1 tiling pattern (s8.7.3). Repeats a graphical cell.
+      class PatternTiling < Pattern
+        def paint_type; self[:PaintType]; end
+        def tiling_type; self[:TilingType]; end
+        def bbox; self[:BBox]; end
+        def x_step; self[:XStep]; end
+        def y_step; self[:YStep]; end
+        def resources; self[:Resources]; end
+        def matrix; self[:Matrix]; end
+
+        def colored?; paint_type == 1; end
+        def uncolored?; paint_type == 2; end
+
+        def constant_spacing?; tiling_type == 1; end
+        def no_distortion?; tiling_type == 2; end
+        def constant_spacing_no_distortion?; tiling_type == 3; end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/polygon_annotation.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Polygon annotation (s12.5.6.9). Closed polygon shape.
+      class PolygonAnnotation < MarkupAnnotation
+        def vertices; self[:Vertices]; end
+        def line_endings; self[:LE]; end
+        def interior_color; self[:IC]; end
+        def border_style; self[:BS]; end
+        def border; self[:Border]; end
+        def measure; self[:Measure]; end
+        def intent; self[:IT]; end
+
+        def vertex_count
+          return 0 unless vertices
+
+          arr = vertices.is_a?(Pdfrb::Model::PdfArray) ? vertices.to_a : vertices
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def has_measure?
+          !!measure
+        end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/polygon_polyline.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class PolygonPolyline < Annotation
+        def vertices; self[:Vertices]; end
+        def line_ending_styling; self[:LE]; end
+        def interior_color; self[:IC]; end
+        def fill?; self[:Subtype] == :Polygon; end
+      end
+    end
+  end
+end

data/lib/pdfrb/model/type/polyline_annotation.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Polyline annotation (s12.5.6.9). Open polyline (not closed).
+      class PolylineAnnotation < MarkupAnnotation
+        def vertices; self[:Vertices]; end
+        def line_endings; self[:LE]; end
+        def interior_color; self[:IC]; end
+        def border_style; self[:BS]; end
+        def border; self[:Border]; end
+        def measure; self[:Measure]; end
+        def intent; self[:IT]; end
+
+        def vertex_count
+          return 0 unless vertices
+
+          arr = vertices.is_a?(Pdfrb::Model::PdfArray) ? vertices.to_a : vertices
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def has_measure?
+          !!measure
+        end
+      end
+    end
+  end
+end