Module: Ucode

Defined in:
lib/ucode.rb,
lib/ucode/cli.rb,
lib/ucode/repo.rb,
lib/ucode/site.rb,
lib/ucode/audit.rb,
lib/ucode/cache.rb,
lib/ucode/error.rb,
lib/ucode/fetch.rb,
lib/ucode/index.rb,
lib/ucode/config.rb,
lib/ucode/glyphs.rb,
lib/ucode/models.rb,
lib/ucode/parsers.rb,
lib/ucode/version.rb,
lib/ucode/commands.rb,
lib/ucode/database.rb,
lib/ucode/aggregator.rb,
lib/ucode/code_chart.rb,
lib/ucode/db_builder.rb,
lib/ucode/fetch/http.rb,
lib/ucode/repo/paths.rb,
lib/ucode/coordinator.rb,
lib/ucode/glyphs/grid.rb,
lib/ucode/range_entry.rb,
lib/ucode/audit/differ.rb,
lib/ucode/models/audit.rb,
lib/ucode/models/block.rb,
lib/ucode/models/plane.rb,
lib/ucode/parsers/base.rb,
lib/ucode/repo/writers.rb,
lib/ucode/audit/browser.rb,
lib/ucode/audit/context.rb,
lib/ucode/audit/emitter.rb,
lib/ucode/audit/release.rb,
lib/ucode/commands/site.rb,
lib/ucode/fetch/ucd_zip.rb,
lib/ucode/glyphs/source.rb,
lib/ucode/glyphs/writer.rb,
lib/ucode/index_builder.rb,
lib/ucode/models/script.rb,
lib/ucode/audit/registry.rb,
lib/ucode/commands/audit.rb,
lib/ucode/commands/build.rb,
lib/ucode/commands/cache.rb,
lib/ucode/commands/fetch.rb,
lib/ucode/commands/parse.rb,
lib/ucode/glyphs/sources.rb,
lib/ucode/parsers/blocks.rb,
lib/ucode/parsers/unihan.rb,
lib/ucode/site/generator.rb,
lib/ucode/commands/glyphs.rb,
lib/ucode/commands/lookup.rb,
lib/ucode/glyphs/pipeline.rb,
lib/ucode/glyphs/resolver.rb,
lib/ucode/parsers/scripts.rb,
lib/ucode/audit/extractors.rb,
lib/ucode/audit/formatters.rb,
lib/ucode/commands/release.rb,
lib/ucode/fetch/unihan_zip.rb,
lib/ucode/glyphs/path_bbox.rb,
lib/ucode/models/codepoint.rb,
lib/ucode/version_resolver.rb,
lib/ucode/code_chart/writer.rb,
lib/ucode/fetch/code_charts.rb,
lib/ucode/glyphs/real_fonts.rb,
lib/ucode/models/name_alias.rb,
lib/ucode/parsers/auxiliary.rb,
lib/ucode/site/search_index.rb,
lib/ucode/audit/face_auditor.rb,
lib/ucode/code_chart/sidecar.rb,
lib/ucode/fetch/font_fetcher.rb,
lib/ucode/glyphs/last_resort.rb,
lib/ucode/glyphs/pdf_fetcher.rb,
lib/ucode/models/cjk_radical.rb,
lib/ucode/parsers/names_list.rb,
lib/ucode/repo/atomic_writes.rb,
lib/ucode/audit/emitter/paths.rb,
lib/ucode/commands/block_feed.rb,
lib/ucode/coordinator/indices.rb,
lib/ucode/models/build_report.rb,
lib/ucode/models/glyph_source.rb,
lib/ucode/models/relationship.rb,
lib/ucode/models/unihan_entry.rb,
lib/ucode/models/unihan_field.rb,
lib/ucode/parsers/derived_age.rb,
lib/ucode/site/config_emitter.rb,
lib/ucode/code_chart/extractor.rb,
lib/ucode/glyphs/grid_detector.rb,
lib/ucode/glyphs/page_renderer.rb,
lib/ucode/glyphs/source_config.rb,
lib/ucode/glyphs/universal_set.rb,
lib/ucode/models/audit/hinting.rb,
lib/ucode/models/audit/metrics.rb,
lib/ucode/parsers/case_folding.rb,
lib/ucode/parsers/cjk_radicals.rb,
lib/ucode/parsers/name_aliases.rb,
lib/ucode/parsers/unicode_data.rb,
lib/ucode/repo/build_validator.rb,
lib/ucode/audit/extractors/base.rb,
lib/ucode/audit/library_auditor.rb,
lib/ucode/audit/release/emitter.rb,
lib/ucode/code_chart/provenance.rb,
lib/ucode/glyphs/cell_extractor.rb,
lib/ucode/glyphs/embedded_fonts.rb,
lib/ucode/glyphs/source_builder.rb,
lib/ucode/models/audit/baseline.rb,
lib/ucode/models/bidi_mirroring.rb,
lib/ucode/models/codepoint/bidi.rb,
lib/ucode/models/named_sequence.rb,
lib/ucode/models/property_alias.rb,
lib/ucode/parsers/bidi_brackets.rb,
lib/ucode/repo/aggregate_writer.rb,
lib/ucode/repo/codepoint_writer.rb,
lib/ucode/audit/block_aggregator.rb,
lib/ucode/audit/browser/template.rb,
lib/ucode/audit/extractors/style.rb,
lib/ucode/audit/formatters/color.rb,
lib/ucode/audit/plane_aggregator.rb,
lib/ucode/commands/font_coverage.rb,
lib/ucode/commands/universal_set.rb,
lib/ucode/glyphs/last_resort/svg.rb,
lib/ucode/glyphs/mutool_renderer.rb,
lib/ucode/models/audit/licensing.rb,
lib/ucode/models/codepoint/emoji.rb,
lib/ucode/models/codepoint/glyph.rb,
lib/ucode/models/codepoint/indic.rb,
lib/ucode/models/specialist_font.rb,
lib/ucode/parsers/bidi_mirroring.rb,
lib/ucode/parsers/special_casing.rb,
lib/ucode/audit/browser/face_page.rb,
lib/ucode/audit/reference_factory.rb,
lib/ucode/audit/release/face_card.rb,
lib/ucode/audit/script_aggregator.rb,
lib/ucode/glyphs/dvisvgm_renderer.rb,
lib/ucode/glyphs/last_resort/glif.rb,
lib/ucode/glyphs/pdf2svg_renderer.rb,
lib/ucode/models/audit/audit_axis.rb,
lib/ucode/models/audit/audit_diff.rb,
lib/ucode/models/audit/gasp_range.rb,
lib/ucode/models/codepoint/casing.rb,
lib/ucode/models/codepoint/hangul.rb,
lib/ucode/models/glyph_source_map.rb,
lib/ucode/models/names_list_entry.rb,
lib/ucode/parsers/named_sequences.rb,
lib/ucode/repo/block_feed_emitter.rb,
lib/ucode/audit/coverage_reference.rb,
lib/ucode/audit/extractors/hinting.rb,
lib/ucode/audit/extractors/metrics.rb,
lib/ucode/audit/library_aggregator.rb,
lib/ucode/audit/ucd_only_reference.rb,
lib/ucode/commands/canonical_build.rb,
lib/ucode/glyphs/monolith_page_map.rb,
lib/ucode/glyphs/real_fonts/writer.rb,
lib/ucode/models/audit/discrepancy.rb,
lib/ucode/models/bidi_bracket_pair.rb,
lib/ucode/models/case_folding_rule.rb,
lib/ucode/models/codepoint/display.rb,
lib/ucode/models/codepoint/joining.rb,
lib/ucode/models/validation_report.rb,
lib/ucode/parsers/property_aliases.rb,
lib/ucode/repo/build_report_writer.rb,
lib/ucode/audit/browser/glyph_panel.rb,
lib/ucode/audit/extractors/coverage.rb,
lib/ucode/audit/extractors/identity.rb,
lib/ucode/fetch/font_fetcher/result.rb,
lib/ucode/glyphs/embedded_fonts/svg.rb,
lib/ucode/glyphs/last_resort/source.rb,
lib/ucode/glyphs/last_resort/writer.rb,
lib/ucode/models/audit/audit_report.rb,
lib/ucode/models/audit/field_change.rb,
lib/ucode/models/audit/release_face.rb,
lib/ucode/parsers/script_extensions.rb,
lib/ucode/repo/writers/enums_writer.rb,
lib/ucode/audit/browser/library_page.rb,
lib/ucode/audit/discrepancy_detector.rb,
lib/ucode/audit/extractors/licensing.rb,
lib/ucode/glyphs/pdftocairo_renderer.rb,
lib/ucode/models/audit/block_summary.rb,
lib/ucode/models/audit/plane_summary.rb,
lib/ucode/models/special_casing_rule.rb,
lib/ucode/models/universal_set_entry.rb,
lib/ucode/repo/writers/blocks_writer.rb,
lib/ucode/repo/writers/planes_writer.rb,
lib/ucode/audit/emitter/block_emitter.rb,
lib/ucode/audit/emitter/glyph_emitter.rb,
lib/ucode/audit/emitter/index_emitter.rb,
lib/ucode/audit/emitter/plane_emitter.rb,
lib/ucode/audit/extractors/provenance.rb,
lib/ucode/audit/formatters/audit_text.rb,
lib/ucode/commands/audit/font_command.rb,
lib/ucode/glyphs/last_resort/contents.rb,
lib/ucode/glyphs/last_resort/renderer.rb,
lib/ucode/models/audit/embedding_type.rb,
lib/ucode/models/audit/named_instance.rb,
lib/ucode/models/audit/script_summary.rb,
lib/ucode/models/codepoint/identifier.rb,
lib/ucode/models/property_value_alias.rb,
lib/ucode/models/standardized_variant.rb,
lib/ucode/repo/writers/indexes_writer.rb,
lib/ucode/repo/writers/scripts_writer.rb,
lib/ucode/audit/emitter/face_directory.rb,
lib/ucode/audit/emitter/script_emitter.rb,
lib/ucode/audit/release/formula_audits.rb,
lib/ucode/glyphs/embedded_fonts/source.rb,
lib/ucode/glyphs/embedded_fonts/writer.rb,
lib/ucode/glyphs/real_fonts/cmap_cache.rb,
lib/ucode/glyphs/universal_set/builder.rb,
lib/ucode/models/audit/codepoint_range.rb,
lib/ucode/models/audit/duplicate_group.rb,
lib/ucode/models/audit/library_summary.rb,
lib/ucode/models/audit/opentype_layout.rb,
lib/ucode/models/audit/release_formula.rb,
lib/ucode/models/audit/script_features.rb,
lib/ucode/models/relationship/footnote.rb,
lib/ucode/parsers/extracted_properties.rb,
lib/ucode/repo/writers/manifest_writer.rb,
lib/ucode/audit/emitter/library_emitter.rb,
lib/ucode/audit/extractors/aggregations.rb,
lib/ucode/audit/universal_set_reference.rb,
lib/ucode/fetch/specialist_font_fetcher.rb,
lib/ucode/glyphs/embedded_fonts/catalog.rb,
lib/ucode/glyphs/last_resort/cmap_index.rb,
lib/ucode/models/audit/codepoint_detail.rb,
lib/ucode/models/audit/release_manifest.rb,
lib/ucode/models/audit/variation_detail.rb,
lib/ucode/models/codepoint/case_folding.rb,
lib/ucode/models/universal_set_manifest.rb,
lib/ucode/parsers/standardized_variants.rb,
lib/ucode/repo/build_report_accumulator.rb,
lib/ucode/audit/release/manifest_builder.rb,
lib/ucode/commands/audit/browser_command.rb,
lib/ucode/commands/audit/compare_command.rb,
lib/ucode/commands/audit/library_command.rb,
lib/ucode/glyphs/embedded_fonts/renderer.rb,
lib/ucode/glyphs/real_fonts/font_locator.rb,
lib/ucode/glyphs/sources/tier1_real_font.rb,
lib/ucode/glyphs/universal_set/validator.rb,
lib/ucode/models/codepoint/decomposition.rb,
lib/ucode/models/codepoint/normalization.rb,
lib/ucode/models/codepoint/numeric_value.rb,
lib/ucode/parsers/property_value_aliases.rb,
lib/ucode/audit/codepoint_range_coalescer.rb,
lib/ucode/audit/emitter/codepoint_emitter.rb,
lib/ucode/audit/formatters/text_formatter.rb,
lib/ucode/glyphs/embedded_fonts/tounicode.rb,
lib/ucode/glyphs/source_config/gap_report.rb,
lib/ucode/models/audit/codepoint_set_diff.rb,
lib/ucode/models/audit/color_capabilities.rb,
lib/ucode/models/audit/fs_selection_flags.rb,
lib/ucode/models/specialist_font_manifest.rb,
lib/ucode/parsers/derived_core_properties.rb,
lib/ucode/audit/browser/missing_glyph_page.rb,
lib/ucode/audit/emitter/collection_emitter.rb,
lib/ucode/audit/extractors/opentype_layout.rb,
lib/ucode/audit/formatters/audit_diff_text.rb,
lib/ucode/glyphs/embedded_fonts/font_entry.rb,
lib/ucode/glyphs/real_fonts/block_coverage.rb,
lib/ucode/glyphs/universal_set/idempotency.rb,
lib/ucode/models/audit/script_coverage_row.rb,
lib/ucode/models/relationship/compat_equiv.rb,
lib/ucode/parsers/unicode_data/hangul_name.rb,
lib/ucode/audit/extractors/variation_detail.rb,
lib/ucode/commands/audit/collection_command.rb,
lib/ucode/models/audit/codepoint_provenance.rb,
lib/ucode/models/binary_property_assignment.rb,
lib/ucode/repo/writers/relationships_writer.rb,
lib/ucode/glyphs/real_fonts/coverage_auditor.rb,
lib/ucode/glyphs/sources/pillar3_last_resort.rb,
lib/ucode/models/audit/release_universal_set.rb,
lib/ucode/models/relationship/informal_alias.rb,
lib/ucode/audit/extractors/color_capabilities.rb,
lib/ucode/audit/release/library_index_builder.rb,
lib/ucode/glyphs/real_fonts/unicode_17_blocks.rb,
lib/ucode/models/codepoint/break_segmentation.rb,
lib/ucode/models/relationship/cross_reference.rb,
lib/ucode/models/relationship/sample_sequence.rb,
lib/ucode/repo/writers/named_sequences_writer.rb,
lib/ucode/glyphs/universal_set/coverage_report.rb,
lib/ucode/glyphs/universal_set/manifest_writer.rb,
lib/ucode/glyphs/universal_set/pre_build_check.rb,
lib/ucode/audit/formatters/library_summary_text.rb,
lib/ucode/glyphs/real_fonts/font_coverage_report.rb,
lib/ucode/models/relationship/variation_sequence.rb,
lib/ucode/glyphs/source_config/coverage_assertion.rb,
lib/ucode/glyphs/sources/pillar1_embedded_tounicode.rb,
lib/ucode/glyphs/universal_set/manifest_accumulator.rb,
lib/ucode/glyphs/embedded_fonts/content_stream_correlator.rb

Overview

Autoload hub for the Ucode::Audit::Formatters namespace.

Presentation-only: every class here takes a model instance (Models::Audit::AuditReport, Models::Audit::AuditDiff, or Models::Audit::LibrarySummary) and returns a human-readable string. No font parsing, no I/O.

MECE with the model layer: formatters READ from models; they never mutate them or carry audit logic. Adding a new output format (e.g. Markdown) = one new file here + one autoload line.

Defined Under Namespace

Modules: Aggregator, Audit, Cache, CodeChart, Commands, DbBuilder, Fetch, Glyphs, Models, Parsers, Repo, Site, VersionResolver Classes: ChecksumError, Cli, CodeChartNotFoundError, Config, Coordinator, Database, DatabaseMissingError, DatabaseSchemaError, EmbeddedFontsMissingError, Error, FetchError, FontChecksumError, FontExtractMemberMissingError, FontLicenseError, GlyphError, GridDetectionError, Index, IndexBuilder, LastResortMissingError, LookupError, MalformedLineError, NetworkError, ParseError, PdfRenderError, RangeEntry, UniversalSetPreBuildError, UnknownBlockError, UnknownPropertyError, UnknownVersionError

Constant Summary collapse

VERSION =
"0.2.1"

Class Method Summary collapse

Class Method Details

.configurationUcode::Config

Returns:



66
67
68
# File 'lib/ucode.rb', line 66

def configuration
  @configuration ||= Config.new
end

.configure {|config| ... } ⇒ void

This method returns an undefined value.

Yields:

  • (config)

Yield Parameters:



73
74
75
# File 'lib/ucode.rb', line 73

def configure
  yield(configuration)
end