pdfrb 0.2.1 → 0.6.0

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # ICCBased Color Space (s8.6.5.5). Wrapper for the
+      # [/ICCBased <stream-ref>] array form.
+      class ICCBasedColorSpace < Pdfrb::Model::Cos::Stream
+        def component_count; self[:N]; end
+        def alternate; self[:Alternate]; end
+        def range; self[:Range]; end
+        def metadata_stream; self[:Metadata]; end
+
+        def has_alternate?
+          !!alternate
+        end
+
+        def has_metadata?
+          !!metadata_stream
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # IconFit (s12.5.6.19). Controls positioning/scaling of a button
+      # field's icon within its rectangle.
+      class IconFit < Cos::Dictionary
+        register_type :IconFit
+
+        def type; self[:Type]; end
+        def scale_type; self[:SW]&.to_sym; end
+        def fit; self[:S]&.to_sym; end
+        def always_scaled?; scale_type.nil? || scale_type == :A; end
+        def scale_when_bigger?; scale_type == :B; end
+        def scale_when_smaller?; scale_type == :S; end
+        def never_scale?; scale_type == :N; end
+        def proportional_fit?; fit.nil? || fit == :P; end
+        def non_proportional_fit?; fit == :A; end
+
+        def border_background; self[:BG]; end
+        def border_arrow_left; self[:IF]; end
+        def tp; self[:TP]; end
+
+        def placement_mode
+          tp || 0
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Indexed color space array wrapper. The /Indexed color space is
+      # [/Indexed base hival lookup]; the lookup table is the stream payload
+      # or a string.
+      class Indexed < Pdfrb::Model::Cos::Stream
+        def base_color_space; self[:Base]; end
+        def hival; self[:Hival]; end
+        def lookup; self[:Lookup]; end
+
+        def components
+          return nil unless base_color_space
+
+          case base_color_space.to_sym
+          when :DeviceGray, :CalGray then 1
+          when :DeviceRGB, :CalRGB then 3
+          when :DeviceCMYK then 4
+          end
+        rescue StandardError
+          nil
+        end
+
+        def palette_entries
+          (hival || -1) + 1
+        end
+      end
+    end
+  end
+end

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

@@ -9,6 +9,50 @@ module Pdfrb
       # still widely used.
       class Info < Pdfrb::Model::Cos::Dictionary
         arlington_object "DocInfo"
+        register_type :Info
+
+        def title; self[:Title]; end
+        def author; self[:Author]; end
+        def subject; self[:Subject]; end
+        def keywords; self[:Keywords]; end
+        def creator; self[:Creator]; end
+        def producer; self[:Producer]; end
+        def creation_date; self[:CreationDate]; end
+        def modification_date; self[:ModDate]; end
+        def trapped; self[:Trapped]; end
+
+        def trapped?
+          trapped&.to_sym == :True
+        end
+
+        def creation_time
+          parse_pdf_date(creation_date)
+        end
+
+        def modification_time
+          parse_pdf_date(modification_date)
+        end
+
+        private
+
+        def parse_pdf_date(str)
+          return str if str.is_a?(Time)
+          return nil unless str
+
+          match = str.to_s.match(/^D:(\d{4})(\d{2})(\d{2})(\d{2})?(\d{2})?(\d{2})?/)
+          return nil unless match
+
+          year = match[1].to_i
+          month = match[2].to_i
+          day = match[3].to_i
+          hour = (match[4] || 0).to_i
+          min = (match[5] || 0).to_i
+          sec = (match[6] || 0).to_i
+
+          Time.new(year, month, day, hour, min, sec, "+00:00")
+        rescue StandardError
+          nil
+        end
       end
     end
   end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Ink annotation (s12.5.6.13). Freehand scribble path(s).
+      class InkAnnotation < MarkupAnnotation
+        def ink_list; self[:InkList]; end
+        def interior_color; self[:IC]; end
+        def border_style; self[:BS]; end
+        def border; self[:Border]; end
+
+        def path_count
+          return 0 unless ink_list
+
+          arr = ink_list.is_a?(Pdfrb::Model::PdfArray) ? ink_list.to_a : ink_list
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def path_at(index)
+          return nil unless ink_list
+
+          arr = ink_list.is_a?(Pdfrb::Model::PdfArray) ? ink_list.to_a : ink_list
+          arr && arr[index]
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,42 @@ module Pdfrb
       # AcroForm interactive form root (s12.7.2). Catalog /AcroForm.
       class InteractiveForm < Pdfrb::Model::Cos::Dictionary
         arlington_object "InteractiveForm"
+        register_type :AcroForm
+
+        def fields; self[:Fields]; end
+        def need_appearances; self[:NeedAppearances]; end
+        def sig_flags; self[:SigFlags]; end
+        def co; self[:CO]; end
+        def dr; self[:DR]; end
+        def da; self[:DA]; end
+        def q; self[:Q]; end
+
+        def need_appearances?
+          !!need_appearances
+        end
+
+        def field_count
+          return 0 unless fields
+
+          arr = fields.is_a?(Pdfrb::Model::PdfArray) ? fields.to_a : fields
+          arr.is_a?(Array) ? arr.size : 0
+        end
+
+        def append_only_signatures?
+          sig_flags&.anybits?(1)
+        end
+
+        def contains_signature_dr_usage?
+          sig_flags&.anybits?(2)
+        end
+
+        def text_alignment
+          case q
+          when 0 then :left
+          when 1 then :center
+          when 2 then :right
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class InteriorColor < Cos::Dictionary
+        register_type :InteriorColor
+        def color; self[:IC]; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # JBIG2 Globals stream (s7.4.7). Holds shared JBIG2 segment
+      # data referenced by /DecodeParms /JBIG2Globals.
+      class JBIG2Globals < Pdfrb::Model::Cos::Stream
+        def globals_data
+          decoded_stream&.force_encoding(Encoding::BINARY)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Lab color space dictionary (s8.6.3.4). CIE L*a*b*:
+      # [/Lab <dict>].
+      class Lab < Pdfrb::Model::Cos::Dictionary
+        def white_point; self[:WhitePoint]; end
+        def black_point; self[:BlackPoint]; end
+        def range; self[:Range]; end
+
+        def components; 3; end
+
+        # /Range is [a_min a_max b_min b_max]; defaults per spec are
+        # [-100 100 -100 100].
+        def a_range
+          range ? [range[0], range[1]] : [-100, 100]
+        end
+
+        def b_range
+          range ? [range[2], range[3]] : [-100, 100]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Line annotation (s12.5.6.7). Line between two coordinate pairs.
+      class LineAnnotation < MarkupAnnotation
+        def line; self[:L]; end
+        def le; self[:LE]; end
+        def line_endings; le; end
+        def interior_color; self[:IC]; end
+        def caption; self[:Cap]; end
+        def measure; self[:Measure]; end
+        def border_style; self[:BS]; end
+        def border; self[:Border]; end
+        def co; self[:CO]; end
+        def cp; self[:CP]; end
+        def ll; self[:LL]; end
+        def lle; self[:LLE]; end
+        def it; self[:IT]; end
+
+        def start_point
+          return nil unless line.is_a?(Array) && line.size >= 2
+
+          line[0..1]
+        end
+
+        def end_point
+          return nil unless line.is_a?(Array) && line.size >= 4
+
+          line[2..3]
+        end
+
+        def has_caption?
+          !!caption
+        end
+
+        def has_measure?
+          !!measure
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # LineEndingStyling (s12.5.5). /LE array of line-ending styles
+      # (None, OpenArrow, ClosedArrow, Butt, Diamond, Square, etc.).
+      class LineEndingStyling < Cos::Dictionary
+        register_type :LineEndingStyling
+
+        def type; self[:Type]; end
+        def line_endings; self[:LE]; end
+
+        def line_start
+          return nil unless line_endings
+
+          arr = line_endings.is_a?(Pdfrb::Model::PdfArray) ? line_endings.to_a : line_endings
+          arr.is_a?(Array) ? arr[0] : nil
+        end
+
+        def line_end
+          return nil unless line_endings
+
+          arr = line_endings.is_a?(Pdfrb::Model::PdfArray) ? line_endings.to_a : line_endings
+          arr.is_a?(Array) ? arr[1] : nil
+        end
+
+        def symmetric?
+          line_start == line_end
+        end
+
+        def has_arrows?
+          [:OpenArrow, :ClosedArrow].include?(line_start&.to_sym) ||
+            [:OpenArrow, :ClosedArrow].include?(line_end&.to_sym)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class LinkAnnotation < Annotation
+        def action; self[:A]; end
+        def destination; self[:Dest]; end
+        def highlight_mode; self[:H]; end
+        def uri_action; self[:PA]; end
+        def quad_points; self[:QuadPoints]; end
+        def border; self[:Border]; end
+        def bs; self[:BS]; end
+
+        def has_action?
+          !!action
+        end
+
+        def has_destination?
+          !!destination
+        end
+
+        def uri_link?
+          has_action? && action && action[:S]&.to_sym == :URI
+        end
+
+        def goto_link?
+          has_action? && action && action[:S]&.to_sym == :GoTo
+        end
+
+        def launch_link?
+          has_action? && action && action[:S]&.to_sym == :Launch
+        end
+
+        def highlight
+          (highlight_mode || :Invert).to_sym
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class LinkAppearance < GenericAppearance; end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # MarkInformation (s14.7.1). Catalog /MarkInfo — flags whether
+      # the document is tagged and structural metadata is reliable.
+      class MarkInformation < Cos::Dictionary
+        register_type :MarkInfo
+
+        def type; self[:Type]; end
+
+        def marked?; truthy?(self[:Marked]); end
+        def user_properties?; truthy?(self[:UserProperties]); end
+        def suspects?; truthy?(self[:Suspects]); end
+
+        def tagged?
+          marked? && !suspects?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Marked-Content Reference (s14.7.6.2). Refers to a marked-content
+      # sequence on a page by MCID.
+      class MarkedContentReference < Cos::Dictionary
+        register_type :MCR
+
+        def type; self[:Type]; end
+        def page; self[:Pg]; end
+        def content_item; self[:MCID]; end
+
+        def resolved_page
+          ref = page
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      class MarkupAnnotation < Annotation
+        def title; self[:T]; end
+        def popup; self[:Popup]; end
+        def rich_contents; self[:RC]; end
+        def creation_date; self[:CreationDate]; end
+        def subject; self[:Subj]; end
+        def intent; self[:IT]; end
+        def in_reply_to; self[:IRT]; end
+        def reply_type; self[:RT]; end
+        def external_data; self[:ExData]; end
+        def opacity; self[:CA]; end
+        def interior_color; self[:IC]; end
+
+        def open?
+          return false unless popup
+
+          obj = popup.is_a?(Pdfrb::Model::Reference) && document ? document.object(popup) : popup
+          obj && obj[:Open]
+        end
+
+        def reply?
+          !!in_reply_to
+        end
+
+        def group_reply?
+          reply_type&.to_sym == :Group
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # MDP (Modification Detection and Prevention) dict (s12.8.2.2).
+      # The /Reference entry on a Signature, with /TransformMethod /DocMDP
+      # or /UR (Usage Rights).
+      class MDPDict < Pdfrb::Model::Cos::Dictionary
+        def type; self[:Type]; end
+        def transform_method; self[:TransformMethod]&.to_sym; end
+        def transform_params; self[:TransformParams]; end
+
+        def doc_mdp?; transform_method == :DocMDP; end
+        def ur?; transform_method == :UR; end
+        def field_mdp?; transform_method == :FieldMDP; end
+        def identity?; transform_method == :Identity; end
+
+        def resolved_transform_params
+          ref = transform_params
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Measure dictionary (s11.4). Used by line/poly annotations and
+      # XObjects to map PDF units to real-world units.
+      class Measure < Cos::Dictionary
+        register_type :Measure
+
+        def type; self[:Type]; end
+        def subtype; self[:Subtype]; end
+        def scale_ratio; self[:R]; end
+        def x_scale; self[:X]; end
+        def y_scale; self[:Y]; end
+        def cyxy; self[:CYX]; end
+        def cyy; self[:CYY]; end
+        def distance_format; self[:D]; end
+        def area_format; self[:A]; end
+        def angular_format; self[:T]; end
+        def slope_format; self[:S]; end
+        def origin; self[:O]; end
+        def ctp; self[:CYX]; end
+
+        def rectilinear?
+          subtype&.to_sym == :RL
+        end
+
+        def geographic?
+          subtype&.to_sym == :GEO
+        end
+
+        def has_area_format?
+          !!area_format
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pdfrb
+  module Model
+    module Type
+      # Media Clip Data stream (s13.3.3). Carries actual media payload.
+      class MediaClip < Pdfrb::Model::Cos::Stream
+        def type; self[:Type]; end
+        def subtype; self[:S]&.to_sym; end
+
+        def must_use_honest?
+          subtype == :MIMEType
+        end
+
+        def file_spec; self[:D]; end
+        def mime_type; self[:CT]; end
+        def data_size; self[:S]; end
+
+        def resolved_file_spec
+          ref = file_spec
+          return nil unless ref && document
+
+          document.object(ref)
+        end
+      end
+    end
+  end
+end