fontisan 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9f774cfee2477366d97b8954c481262eedd928b1c5abae59f559e570aafb294
-  data.tar.gz: 0f744a6ba709c5e2c6eb0e81e33ec41d4cbe78d0beb6bd3519b395568257d37c
+  metadata.gz: 2323e4d4ba09f0467008c48db7b781015eb9e54a271f42d4c0363d96c5e03c03
+  data.tar.gz: 4d39148567ce1180c0d741523f75aa919e15712b81af9952ddc522ccbf0a0a69
 SHA512:
-  metadata.gz: 59e98be337dc89d359cdb4d7a8a80749d2b89a2d82dda2280550ccd834143f9191752cdc083179907d01f2d3a87695b9a6758b2ad3d910b4a4af79e919479767
-  data.tar.gz: 5913d2f154cbf0961436ac7e85dad4d2f8d64ac4a52d1c9709014a33ed112eaf1a9f3a931a0b7f62e469eba0bd5e87589fe677c0e36c8971f042c850b0abe412
+  metadata.gz: f9e93fd99698903487869f89cfd522819418fcc23e32ecfdaf312393a52fc3ed0c93168a38f88c667561d55b7998d1101dbf5bf509bc4188c9831478b7d87a19
+  data.tar.gz: 4bed6191cdbf93b33792454a806e5fe33b10e99b4ee22f27e4907d5a4b50020fb0f2e6a84fe867183c4163aa6784b4ae341b804e1ecd429c8922ebd48a6dbce1

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-01-15 10:44:19 UTC using RuboCop version 1.82.1.
+# on 2026-01-17 02:13:05 UTC using RuboCop version 1.82.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,48 +11,13 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'fontisan.gemspec'
 
-# Offense count: 94
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLines:
-  Exclude:
-    - 'spec/benchmarks/subroutine_optimization_benchmark.rb'
-    - 'spec/fontisan/converters/extended_woff2_spec.rb'
-    - 'spec/fontisan/lazy_loading_spec.rb'
-    - 'spec/fontisan/loading_modes_spec.rb'
-    - 'spec/integration/subroutine_roundtrip_spec.rb'
-    - 'spec/integration/woff2_conversion_spec.rb'
-
-# Offense count: 25
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: empty_lines, no_empty_lines
-Layout/EmptyLinesAroundBlockBody:
-  Exclude:
-    - 'spec/benchmarks/subroutine_optimization_benchmark.rb'
-    - 'spec/fontisan/converters/woff2_round_trip_spec.rb'
-    - 'spec/fontisan/loading_modes_spec.rb'
-
-# Offense count: 1217
+# Offense count: 1259
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Enabled: false
 
-# Offense count: 100
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'spec/benchmarks/subroutine_optimization_benchmark.rb'
-    - 'spec/fontisan/converters/extended_woff2_spec.rb'
-    - 'spec/fontisan/converters/woff2_round_trip_spec.rb'
-    - 'spec/fontisan/lazy_loading_spec.rb'
-    - 'spec/fontisan/loading_modes_spec.rb'
-    - 'spec/integration/outline_conversion_spec.rb'
-    - 'spec/integration/subroutine_roundtrip_spec.rb'
-    - 'spec/integration/woff2_conversion_spec.rb'
-
 # Offense count: 3
 Lint/CopDirectiveSyntax:
   Exclude:
@@ -111,13 +76,6 @@ Lint/StructNewOverride:
   Exclude:
     - 'lib/fontisan/optimizers/pattern_analyzer.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
-Lint/UnusedBlockArgument:
-  Exclude:
-    - 'spec/benchmarks/subroutine_optimization_benchmark.rb'
-
 # Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
@@ -132,16 +90,7 @@ Lint/UnusedMethodArgument:
     - 'lib/fontisan/woff2/glyf_transformer.rb'
     - 'lib/fontisan/woff_font.rb'
 
-# Offense count: 19
-# This cop supports safe autocorrection (--autocorrect).
-Lint/UselessAssignment:
-  Exclude:
-    - 'spec/benchmarks/subroutine_optimization_benchmark.rb'
-    - 'spec/fontisan/loading_modes_spec.rb'
-    - 'spec/integration/subroutine_roundtrip_spec.rb'
-    - 'spec/integration/woff2_conversion_spec.rb'
-
-# Offense count: 466
+# Offense count: 477
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Enabled: false
@@ -152,17 +101,17 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 80
 
-# Offense count: 6
+# Offense count: 8
 # Configuration parameters: CountBlocks, CountModifierForms.
 Metrics/BlockNesting:
   Max: 5
 
-# Offense count: 231
+# Offense count: 238
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-# Offense count: 771
+# Offense count: 786
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 135
@@ -173,11 +122,19 @@ Metrics/ParameterLists:
   Max: 39
   MaxOptionalParameters: 4
 
-# Offense count: 169
+# Offense count: 175
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Enabled: false
 
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/fontisan/sfnt_font.rb'
+
 # Offense count: 17
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
 # AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
@@ -188,7 +145,7 @@ Naming/MethodParameterName:
     - 'lib/fontisan/tables/glyf/curve_converter.rb'
     - 'lib/fontisan/variation/optimizer.rb'
 
-# Offense count: 11
+# Offense count: 12
 # Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
 # AllowedMethods: call
 # WaywardPredicates: nonzero?
@@ -200,6 +157,7 @@ Naming/PredicateMethod:
     - 'lib/fontisan/converters/table_copier.rb'
     - 'lib/fontisan/converters/woff2_encoder.rb'
     - 'lib/fontisan/optimizers/charstring_rewriter.rb'
+    - 'lib/fontisan/sfnt_table.rb'
     - 'lib/fontisan/subset/options.rb'
     - 'lib/fontisan/validation/collection_validator.rb'
     - 'lib/fontisan/variation/metrics_adjuster.rb'
@@ -211,24 +169,6 @@ Naming/PredicateMethod:
 Naming/VariableNumber:
   Enabled: false
 
-# Offense count: 24
-# Configuration parameters: MinSize.
-Performance/CollectionLiteralInLoop:
-  Exclude:
-    - 'lib/fontisan/collection/builder.rb'
-    - 'lib/fontisan/open_type_font.rb'
-    - 'lib/fontisan/tables/cff/charstring.rb'
-    - 'lib/fontisan/tables/cff2.rb'
-    - 'lib/fontisan/tables/cff2/region_matcher.rb'
-    - 'lib/fontisan/tables/sbix.rb'
-    - 'lib/fontisan/true_type_font.rb'
-    - 'lib/fontisan/variation/validator.rb'
-    - 'lib/fontisan/woff2/table_transformer.rb'
-    - 'spec/fontisan/cli_spec.rb'
-    - 'spec/fontisan/commands/glyphs_command_spec.rb'
-    - 'spec/fontisan/commands/info_command_spec.rb'
-    - 'spec/fontisan/commands/tables_command_spec.rb'
-
 # Offense count: 23
 RSpec/AnyInstance:
   Exclude:
@@ -245,7 +185,7 @@ RSpec/AnyInstance:
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 22
+# Offense count: 23
 # Configuration parameters: IgnoredMetadata.
 RSpec/DescribeClass:
   Enabled: false
@@ -256,7 +196,7 @@ RSpec/DescribeMethod:
     - 'spec/fontisan/collection/variable_font_builder_spec.rb'
     - 'spec/fontisan/converters/woff2_encoder_integration_spec.rb'
 
-# Offense count: 1286
+# Offense count: 1288
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 66
@@ -354,23 +294,10 @@ RSpec/NoExpectationExample:
     - 'spec/fontisan/validators/validator_spec.rb'
     - 'spec/fontisan/variation/variable_svg_generator_spec.rb'
 
-# Offense count: 100
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# RSpec/Output was renamed to RSpec/ExpectOutput in rubocop-rspec 3.0+
-RSpec/ExpectOutput:
-  Exclude:
-    - 'spec/benchmarks/subroutine_optimization_benchmark.rb'
-    - 'spec/fontisan/converters/extended_woff2_spec.rb'
-    - 'spec/fontisan/converters/woff2_round_trip_spec.rb'
-    - 'spec/fontisan/lazy_loading_spec.rb'
-    - 'spec/fontisan/loading_modes_spec.rb'
-    - 'spec/integration/outline_conversion_spec.rb'
-    - 'spec/integration/subroutine_roundtrip_spec.rb'
-    - 'spec/integration/woff2_conversion_spec.rb'
-
-# Offense count: 11
+# Offense count: 13
 RSpec/RepeatedExample:
   Exclude:
+    - 'spec/documentation_examples_spec.rb'
     - 'spec/fontisan/hints/truetype_instruction_generator_spec.rb'
     - 'spec/fontisan/metrics_calculator_spec.rb'
     - 'spec/fontisan/tables/os2_spec.rb'
@@ -435,16 +362,6 @@ Style/ComparableClamp:
     - 'lib/fontisan/variable/axis_normalizer.rb'
     - 'lib/fontisan/variation/interpolator.rb'
 
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, AllowComments.
-# SupportedStyles: empty, nil, both
-Style/EmptyElse:
-  Exclude:
-    - 'spec/fontisan/lazy_loading_spec.rb'
-    - 'spec/fontisan/loading_modes_spec.rb'
-    - 'spec/integration/subroutine_roundtrip_spec.rb'
-
 # Offense count: 11
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, MaxUnannotatedPlaceholdersAllowed, Mode, AllowedMethods, AllowedPatterns.

data/CHANGELOG.md

@@ -0,0 +1,116 @@
+# Changelog
+
+All notable changes to Fontisan will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Comprehensive documentation for WOFF/WOFF2 format support
+- Color fonts documentation (COLR/CPAL, sbix, SVG tables)
+- Font validation framework documentation
+- Apple legacy font formats documentation ('true' signature, dfont)
+- Font collection validation documentation
+- Updated font hinting documentation
+- Enhanced README with all v0.2.1-v0.2.7 features
+
+### Changed
+- Improved documentation organization with dedicated feature guides
+- Added more examples for command-line and Ruby API usage
+
+## [0.2.7] - 2026-01-06
+
+### Added
+- Collection validation support with per-font reporting
+- CollectionValidationReport model with overall status
+- FontReport model for individual font validation results
+- ValidateCommand.validate_collection method
+
+### Fixed
+- Windows compatibility for collection extraction
+- Various test fixes unrelated to collection validation
+
+## [0.2.6] - 2026-01-05
+
+### Added
+- Apple dfont collection support
+- DfontParser for reading dfont format
+- DfontBuilder for writing dfont format
+- Proper handling of dfont as collection in info command
+
+### Fixed
+- Spec refactor for rubocop compliance
+- Re-enabled previously skipped specs
+
+## [0.2.5] - 2026-01-03
+
+### Added
+- Font validation framework
+- Validator DSL for defining validation checks
+- Predefined validation profiles (indexability, usability, production, web, spec_compliance)
+- ValidationReport model with structured results
+- 56 validation helper methods across 8 OpenType tables
+- ValidateCommand with comprehensive CLI options
+
+### Changed
+- Improved lazy loading performance
+- Removed page size alignment (was causing performance issues)
+
+## [0.2.4] - 2026-01-03
+
+### Fixed
+- Subroutine-related issues
+- Spec fixes
+- Glyph builder fixes
+- Test font fixtures for validation testing
+
+### Added
+- Color fonts support (COLR/CPAL tables)
+- WOFF/WOFF2 conversion support
+- WOFF/WOFF2 info command support
+- WOFF2 validation support
+- ColorGlyph, ColorLayer, ColorPalette models
+- BitmapGlyph, BitmapStrike models
+- SvgGlyph model
+- CBLC, CBDT, COLR, CPAL, sbix, SVG table support
+
+## [0.2.3] - 2025-12-30
+
+### Added
+- WOFF/WOFF2 font version display
+- WOFF2 validation checks
+- Proper TTC/OTC content info handling
+- Collection info displays all fonts with metadata
+
+## [0.2.2] - 2025-12-30
+
+### Added
+- Brief mode for font info command (`--brief` flag)
+- 5x faster font indexing using metadata loading mode
+- Only 13 essential attributes in brief mode
+- Support for 5x performance improvement in batch processing
+
+### Changed
+- README refactor for better organization
+
+## [0.2.1] - 2025-12-28
+
+### Added
+- Proper font hinting implementation
+- Bidirectional TrueType <-> PostScript hint conversion
+- HintValidator for validating converted hints
+- TrueTypeInstructionAnalyzer for analyzing instructions
+- TrueTypeInstructionGenerator for generating instructions
+- Hint round-trip validation
+- CFF2 variable font support for PostScript hints
+
+## [0.2.0] - 2025-12-17
+
+### Added
+- Initial release of Fontisan
+- Basic font conversion capabilities
+- Font information display
+- TTC/OTC collection support
+- Basic validation framework

data/README.adoc

@@ -56,40 +56,52 @@ gem install fontisan
 
 == Features
 
+Color fonts and collections::
+* Color font support: COLR/CPAL layered glyphs, sbix bitmap glyphs, and SVG table (see link:docs/COLOR_FONTS.adoc[Color Fonts Guide])
+* Font collection validation with per-font reporting (see link:docs/COLLECTION_VALIDATION.adoc[Collection Validation Guide])
+
+Font analysis and information::
 * Bidirectional font hint conversion (see link:docs/FONT_HINTING.adoc[Font Hinting Guide])
 * Extract comprehensive font metadata (name, version, designer, license, etc.)
+* Brief mode for fast font indexing (5x faster, metadata-only loading)
 * List OpenType tables with checksums and offsets
 * Extract glyph names from post table
 * Display Unicode codepoint to glyph index mappings
 * Analyze variable font axes and named instances
-* Generate static font instances from variable fonts
 * Display optical size information
 * List supported scripts from GSUB/GPOS tables
 * List OpenType features (ligatures, kerning, etc.) by script
 * Dump raw binary table data for analysis
+
+Font operations::
+* Generate static font instances from variable fonts
 * Font subsetting with multiple profiles (PDF, web, minimal)
-* Font validation with multiple severity levels
-* Collection management (pack/unpack TTC/OTC files with table deduplication)
-* Support for TTF, OTF, TTC, OTC font formats (production ready)
-* Apple legacy font support: 'true' signature TrueType fonts and dfont (Data Fork Font) format
-* WOFF format support (reading complete, writing functional, pending full integration)
-* WOFF2 format support (reading complete with table transformations, writing planned)
+* Font validation framework with multiple profiles (indexability, usability, production, web, spec_compliance) (see link:docs/VALIDATION.adoc[Validation Guide])
+* Collection management (pack/unpack TTC/OTC/dfont files with table deduplication)
+
+Font format support::
+* TTF, OTF, TTC, OTC font formats (production ready)
+* WOFF/WOFF2 format support with reading, writing, and conversion (see link:docs/WOFF_WOFF2_FORMATS.adoc[WOFF/WOFF2 Guide])
+* Apple legacy font support: 'true' signature TrueType fonts and dfont format (see link:docs/APPLE_LEGACY_FONTS.adoc[Apple Legacy Fonts Guide])
 * SVG font generation (complete)
-* TTX/YAML/JSON export (complete)
-* Command-line interface with 18 commands
-* Ruby library API for programmatic access
-* Structured output in YAML, JSON, and text formats
-* Universal outline model for format-agnostic glyph representation (complete)
+
+Font engineering::
+* Universal outline model for format-agnostic glyph representation
 * CFF CharString encoding/decoding (complete)
 * CFF INDEX structure building (complete)
 * CFF DICT structure building (complete)
 * TrueType curve converter for bi-directional quadratic/cubic conversion (complete)
 * Compound glyph decomposition with transformation support (complete)
 * CFF subroutine optimization for space-efficient OTF generation (preview mode)
-* Various loading modes for high-performance font indexing (5x faster)
 * Bidirectional hint conversion (TrueType ↔ PostScript) with validation (complete)
 * CFF2 variable font support for PostScript hint conversion (complete)
 
+Export and interfaces::
+* TTX/YAML/JSON export (complete)
+* Command-line interface with 18 commands
+* Ruby library API for programmatic access
+* Structured output in YAML, JSON, and text formats
+
 
 == Font information
 

data/docs/APPLE_LEGACY_FONTS.adoc

@@ -0,0 +1,173 @@
+= Apple Legacy Font Format Support
+
+== General
+
+Fontisan provides support for Apple's legacy font formats that predate modern
+OpenType standards:
+
+* **'true' signature TrueType fonts** - Older Mac fonts with 'true' sfnt version
+* **dfont (Data Fork Font)** - Mac suitcase format with fonts in data fork
+
+These formats require special handling due to their unique structures and
+historical platform-specific conventions.
+
+=== 'true' signature TrueType fonts
+
+Traditional TrueType fonts use 'true' (0x74727565) as the SFNT version instead
+of the modern 0x00010000. These were common on classic Mac OS.
+
+[source,shell]
+----
+$ fontisan info legacy_font.ttf
+
+Font type:                TrueType (Not Variable)
+SFNT Version:             'true' (legacy)
+Family:                   Legacy Font
+...
+
+Detection:
+  Fontisan automatically detects 'true' signature fonts
+  Treats them as standard TrueType for all operations
+  Preserves signature format when writing
+----
+
+=== dfont (Data Fork Font) format
+
+The dfont format stores complete Mac font suitcases in the data fork, supporting
+multiple fonts in a single file with resource-fork style structure.
+
+[source,shell]
+----
+$ fontisan ls family.dfont
+
+Font 0: Arial
+  Family: Arial
+  Subfamily: Regular
+
+Font 1: Arial
+  Family: Arial
+  Subfamily: Bold
+
+Font 2: Arial
+  Family: Arial
+  Subfamily: Italic
+----
+
+.dfont structure
+[example]
+====
+[source,text]
+----
+dfont format structure:
+
+Data Fork Map:
+  Resource data: Contains all font resources
+  Resource map: Index of resources by type and ID
+  Postscript names: Font name mapping
+
+Supported fonts in dfont:
+  - TrueType fonts ('true' signature)
+  - OpenType fonts (CFF or TrueType outlines)
+  - Mixed formats in single dfont
+
+Features:
+  - Automatic resource fork extraction
+  - Font list with metadata
+  - Extract individual fonts by index
+  - Unpack all fonts to directory
+  - Validate fonts within dfont
+====
+----
+
+=== Working with dfont files
+
+==== List fonts in dfont
+
+[source,shell]
+----
+$ fontisan ls family.dfont
+
+Font 0: Arial Regular
+  Family: Arial
+  Subfamily: Regular
+  PostScript: Arial
+
+Font 1: Arial Bold
+  Family: Arial
+  Subfamily: Bold
+  PostScript: Arial-Bold
+----
+
+==== Show dfont info
+
+[source,shell]
+----
+$ fontisan info family.dfont
+
+Collection: family.dfont
+Type: dfont
+Fonts: 3
+
+Font 0 (offset: 256):
+  Font type:                TrueType (Not Variable)
+  Family:                   Arial
+  Subfamily:                Regular
+  ...
+----
+
+==== Extract fonts from dfont
+
+[source,shell]
+----
+# Extract all fonts
+$ fontisan unpack family.dfont extracted_fonts/
+
+# Extract specific font
+$ fontisan unpack family.dfont --font-index 0 Arial.ttf
+----
+
+==== Validate dfont
+
+[source,shell]
+----
+$ fontisan validate family.dfont -t indexability
+
+Collection: family.dfont
+Type: dfont
+Fonts: 3
+
+Summary:
+  Total Errors: 0
+  Total Warnings: 2
+
+=== Font 0: Arial Regular ===
+Font: family.dfont:0
+Status: VALID_WITH_WARNINGS
+...
+----
+
+=== Ruby API for dfont
+
+[source,ruby]
+----
+require 'fontisan'
+
+# Load dfont collection
+dfont = Fontisan::FontLoader.load('family.dfont')
+
+# Access as collection
+puts "Font count: #{dfont.font_count}"
+File.open('family.dfont', 'rb') do |io|
+  fonts = dfont.extract_fonts(io)
+  fonts.each_with_index do |font, i|
+    puts "Font #{i}: #{font.family_name}"
+  end
+end
+
+# Extract specific font
+font = Fontisan::FontLoader.load('family.dfont', font_index: 0)
+
+# Validate dfont
+report = Fontisan.validate('family.dfont')
+puts report.valid?  # => true/false
+----