Class: Ucode::Audit::Context

Inherits:
Object
  • Object
show all
Defined in:
lib/ucode/audit/context.rb

Overview

Value object carrying everything an extractor needs to do its job.

Extractors never reach back into AuditCommand state — they read exclusively from the Context. Shared derived data (codepoints, UCD baseline, source format) is memoized here so multiple extractors don't recompute it.

ucode deltas vs fontisan's Context:

  • Drops cldr and the entire CLDR resolution path (out of scope).
  • Replaces fontisan's ucd memoizer with baseline, a struct carrying version + database + metadata.
  • Adds optional renderer for --with-glyphs mode (nil otherwise).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(font:, font_path:, font_index:, num_fonts_in_source:, options:, renderer: nil, reference: nil) ⇒ Context

Returns a new instance of Context.

Parameters:

  • font (Fontisan::Font) —

    parsed font handle (has_table?, table).

  • font_path (Pathname, String) —

    source path for format detection.

  • font_index (Integer) —

    0-based face index within a collection.

  • num_fonts_in_source (Integer) —

    total faces in the source file.

  • options (Hash{Symbol=>Object}) —

    audit options (ucd_version, all_codepoints, with_glyphs, etc.).

  • renderer (Object, nil) (defaults to: nil) —

    glyph renderer for --with-glyphs mode.

  • reference (CoverageReference, nil) (defaults to: nil) —

    the baseline the audit compares the font's cmap against. When nil, defaults to a UcdOnlyReference built from the resolved baseline database (TODO 25). Passing a UniversalSetReference attaches per-codepoint provenance to every missing-codepoint row.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/ucode/audit/context.rb', line 48

def initialize(font:, font_path:, font_index:, num_fonts_in_source:,
               options:, renderer: nil, reference: nil)
  @font = font
  @font_path = font_path
  @font_index = font_index
  @num_fonts_in_source = num_fonts_in_source
  @options = options
  @renderer = renderer
  @reference_override = reference
end

Instance Attribute Details

#font ⇒ Object (readonly)

Returns the value of attribute font.



32
33
34
 
# File 'lib/ucode/audit/context.rb', line 32

def font
  @font
end

#font_index ⇒ Object (readonly)

Returns the value of attribute font_index.



32
33
34
 
# File 'lib/ucode/audit/context.rb', line 32

def font_index
  @font_index
end

#font_path ⇒ Object (readonly)

Returns the value of attribute font_path.



32
33
34
 
# File 'lib/ucode/audit/context.rb', line 32

def font_path
  @font_path
end

#num_fonts_in_source ⇒ Object (readonly)

Returns the value of attribute num_fonts_in_source.



32
33
34
 
# File 'lib/ucode/audit/context.rb', line 32

def num_fonts_in_source
  @num_fonts_in_source
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



32
33
34
 
# File 'lib/ucode/audit/context.rb', line 32

def options
  @options
end

#renderer ⇒ Object (readonly)

Returns the value of attribute renderer.



32
33
34
 
# File 'lib/ucode/audit/context.rb', line 32

def renderer
  @renderer
end

Instance Method Details

#all_codepoints? ⇒ Boolean

True when the user asked for every codepoint (including unassigned) in the report's codepoints field.

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/ucode/audit/context.rb', line 94

def all_codepoints?
  @options[:all_codepoints] == true
end

#baseline ⇒ Baseline

Pre-resolved baseline (UCD version + database + metadata). Memoized. When resolution fails, returns a Baseline with a warning and nil database so extractors can degrade gracefully.

Returns:

  • (Baseline) 


69
70
71
 
# File 'lib/ucode/audit/context.rb', line 69

def baseline
  @baseline ||= resolve_baseline
end

#codepoints ⇒ Array<Integer>

Codepoints the font's cmap actually maps. Memoized.

Returns:

  • (Array<Integer>) 


61
62
63
 
# File 'lib/ucode/audit/context.rb', line 61

def codepoints
  @codepoints ||= extract_codepoints
end

#reference ⇒ CoverageReference?

The Ucode::Audit::CoverageReference the audit compares against. Defaults to a UcdOnlyReference built from the resolved baseline database. When the caller supplied a reference at construction (typically a UniversalSetReference), that one is used verbatim. Memoized.

Returns:

  • (CoverageReference, nil) —

    nil when the baseline itself couldn't be resolved (database missing).



81
82
83
 
# File 'lib/ucode/audit/context.rb', line 81

def reference
  @reference ||= @reference_override || build_default_reference
end

#source_format ⇒ String?

Detected source format string ("ttf", "otf", "ttc", ...). Memoized.

Returns:

  • (String, nil) 


87
88
89
 
# File 'lib/ucode/audit/context.rb', line 87

def source_format
  @source_format ||= Fontisan::FontLoader.detect_format(@font_path)&.to_s
end

#with_glyphs? ⇒ Boolean

True when glyph rendering is requested (--with-glyphs).

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/ucode/audit/context.rb', line 100

def with_glyphs?
  @options[:with_glyphs] == true && !@renderer.nil?
end