class PDF::Reader::ValidatingReceiver

Page#walk will execute the content stream of a page, calling methods on a receiver class provided by the user. Each operator has a specific set of parameters it expects, and we wrap the users receiver class in this one to verify the PDF uses valid parameters.

Without these checks, users can’t be confident about the number of parameters they’ll receive for an operator, or what the type of those parameters will be. Everyone ends up building their own type safety guard clauses and it’s tedious.

Not all operators have type safety implemented yet, but we can expand the number over time.

Public Class Methods

new(wrapped) click to toggle source

: (untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 20
def initialize(wrapped)
  @wrapped = wrapped
end

Public Instance Methods

begin_inline_image(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 248
def begin_inline_image(*args)
  call_wrapped(:begin_inline_image)
end

begin_inline_image_data(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 253
def begin_inline_image_data(*args)
  # We can't use call_wrapped() here because sorbet won't allow splat args with a dynamic
  # number of elements
  @wrapped.begin_inline_image_data(*args) if @wrapped.respond_to?(:begin_inline_image_data)
end

begin_text_object(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 65
def begin_text_object(*args)
  call_wrapped(:begin_text_object)
end

concatenate_matrix(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 47
def concatenate_matrix(*args)
  a, b, c, d, e, f = *args
  call_wrapped(
    :concatenate_matrix,
    TypeCheck.cast_to_numeric!(a),
    TypeCheck.cast_to_numeric!(b),
    TypeCheck.cast_to_numeric!(c),
    TypeCheck.cast_to_numeric!(d),
    TypeCheck.cast_to_numeric!(e),
    TypeCheck.cast_to_numeric!(f),
  )
end

end_inline_image(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 260
def end_inline_image(*args)
  data, _ = *args

  call_wrapped(
    :end_inline_image,
    TypeCheck.cast_to_string!(data)
  )
end

end_text_object(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 70
def end_text_object(*args)
  call_wrapped(:end_text_object)
end

invoke_xobject(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 234
def invoke_xobject(*args)
  label, _ = *args

  call_wrapped(
    :invoke_xobject,
    TypeCheck.cast_to_symbol(label)
  )
end

method_missing(methodname, *args) click to toggle source

: (Symbol, *untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 279
def method_missing(methodname, *args)
  @wrapped.send(methodname, *args)
end

move_text_position(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 146
def move_text_position(*args) # Td
  x, y, _ = *args
  call_wrapped(
    :move_text_position,
    TypeCheck.cast_to_numeric!(x),
    TypeCheck.cast_to_numeric!(y)
  )
end

move_text_position_and_set_leading(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 156
def move_text_position_and_set_leading(*args) # TD
  x, y, _ = *args
  call_wrapped(
    :move_text_position_and_set_leading,
    TypeCheck.cast_to_numeric!(x),
    TypeCheck.cast_to_numeric!(y)
  )
end

move_to_next_line_and_show_text(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 210
def move_to_next_line_and_show_text(*args) # '
  string, _ = *args
  call_wrapped(
    :move_to_next_line_and_show_text,
    TypeCheck.cast_to_string!(string)
  )
end

move_to_start_of_next_line(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 180
def move_to_start_of_next_line(*args) # T*
  call_wrapped(:move_to_start_of_next_line)
end

page=(page) click to toggle source

: (PDF::Reader::Page) -> void

# File lib/pdf/reader/validating_receiver.rb, line 25
def page=(page)
  call_wrapped(:page=, page)
end

respond_to?(meth) click to toggle source

: (untyped) -> bool

# File lib/pdf/reader/validating_receiver.rb, line 274
def respond_to?(meth)
  @wrapped.respond_to?(meth)
end

restore_graphics_state(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 38
def restore_graphics_state(*args)
  call_wrapped(:restore_graphics_state)
end

save_graphics_state(*args) click to toggle source

Graphics State Operators

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 33
def save_graphics_state(*args)
  call_wrapped(:save_graphics_state)
end

set_character_spacing(*args) click to toggle source

Text State Operators

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 78
def set_character_spacing(*args)
  char_spacing, _ = *args
  call_wrapped(
    :set_character_spacing,
    TypeCheck.cast_to_numeric!(char_spacing)
  )
end

set_horizontal_text_scaling(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 87
def set_horizontal_text_scaling(*args)
  h_scaling, _ = *args
  call_wrapped(
    :set_horizontal_text_scaling,
    TypeCheck.cast_to_numeric!(h_scaling)
  )
end

set_spacing_next_line_show_text(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 219
def set_spacing_next_line_show_text(*args) # "
  aw, ac, string = *args
  call_wrapped(
    :set_spacing_next_line_show_text,
    TypeCheck.cast_to_numeric!(aw),
    TypeCheck.cast_to_numeric!(ac),
    TypeCheck.cast_to_string!(string)
  )
end

set_text_font_and_size(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 96
def set_text_font_and_size(*args)
  label, size, _ = *args
  call_wrapped(
    :set_text_font_and_size,
    TypeCheck.cast_to_symbol(label),
    TypeCheck.cast_to_numeric!(size)
  )
end

set_text_leading(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 106
def set_text_leading(*args)
  leading, _ = *args
  call_wrapped(
    :set_text_leading,
    TypeCheck.cast_to_numeric!(leading)
  )
end

set_text_matrix_and_text_line_matrix(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 166
def set_text_matrix_and_text_line_matrix(*args) # Tm
  a, b, c, d, e, f = *args
  call_wrapped(
    :set_text_matrix_and_text_line_matrix,
    TypeCheck.cast_to_numeric!(a),
    TypeCheck.cast_to_numeric!(b),
    TypeCheck.cast_to_numeric!(c),
    TypeCheck.cast_to_numeric!(d),
    TypeCheck.cast_to_numeric!(e),
    TypeCheck.cast_to_numeric!(f),
  )
end

set_text_rendering_mode(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 115
def set_text_rendering_mode(*args)
  mode, _ = *args
  call_wrapped(
    :set_text_rendering_mode,
    TypeCheck.cast_to_numeric!(mode)
  )
end

set_text_rise(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 124
def set_text_rise(*args)
  rise, _ = *args
  call_wrapped(
    :set_text_rise,
    TypeCheck.cast_to_numeric!(rise)
  )
end

set_word_spacing(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 133
def set_word_spacing(*args)
  word_spacing, _ = *args
  call_wrapped(
    :set_word_spacing,
    TypeCheck.cast_to_numeric!(word_spacing)
  )
end

show_text(*args) click to toggle source

Text Showing Operators

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 188
def show_text(*args) # Tj (AWAY)
  string, _ = *args
  call_wrapped(
    :show_text,
    TypeCheck.cast_to_string!(string)
  )
end

show_text_with_positioning(*args) click to toggle source

: (*untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 197
def show_text_with_positioning(*args) # TJ [(A) 120 (WA) 20 (Y)]
  params, _ = *args
  unless params.is_a?(Array)
    raise MalformedPDFError, "TJ operator expects a single Array argument"
  end

  call_wrapped(
    :show_text_with_positioning,
    params
  )
end

Private Instance Methods

call_wrapped(methodname, *args) click to toggle source

: (untyped, *untyped) -> void

# File lib/pdf/reader/validating_receiver.rb, line 286
def call_wrapped(methodname, *args)
  @wrapped.send(methodname, *args) if @wrapped.respond_to?(methodname)
end