fontisan 0.4.47 → 0.4.48

data/scripts/tier_fallback.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+# Tier fallback checks with strict mode OFF (fontist/fontisan#156 card 3a).
+#
+#   ruby scripts/tier_fallback.rb TIERS [CORPUS_ROOT [SCENARIO]]
+#
+# TIERS is the comma list of non-Ruby tiers this platform is expected to have
+# (native,ffi | ffi | none). Without SCENARIO it runs every scenario below, each
+# in a fresh child process (a tier cannot be un-loaded), against the ci-tier
+# corpus with FONTISAN_ENGINE_STRICT unset:
+#
+#   no_native, no_ffi            the forced tier removed -> every row served by
+#                                ruby, rows equal the scan goldens
+#   native_missing_symbol,       the extension / library lacks a symbol, or speaks
+#   native_abi_mismatch,         another ABI: the tier probes unavailable, nothing
+#   ffi_missing_symbol,          raises (no NameError) and ruby serves golden rows
+#   ffi_abi_mismatch
+#   mixed                        dfont and Type 1 rows are served by ruby, the
+#                                rest by the forced tier
+#   auto_all, auto_no_native,    `auto` resolves native, then ffi with native
+#   auto_none                    removed, then ruby with both removed
+#
+# A scenario about a tier the platform lacks is skipped. Run it against an
+# INSTALLED gem on the CI matrix (outside the checkout), or locally with
+# `bundle exec ruby scripts/tier_fallback.rb ...` from a checkout.
+# Exit status 0 only when every scenario holds.
+require "json"
+require "rbconfig"
+require "tmpdir"
+require "fileutils"
+
+SCENARIOS = %w[no_native no_ffi native_missing_symbol native_abi_mismatch
+               ffi_missing_symbol ffi_abi_mismatch mixed
+               auto_all auto_no_native auto_none].freeze
+
+usage = "usage: tier_fallback.rb native,ffi|ffi|none [corpus root [scenario]]"
+tiers = ARGV.fetch(0) { abort usage }.split(",") - ["none"]
+root = File.expand_path(ARGV.fetch(1, File.join(__dir__, "..", "corpus")))
+scenario = ARGV[2]
+abort "unknown tiers #{tiers.inspect}" unless (tiers - %w[native ffi]).empty?
+
+unless scenario
+  results = SCENARIOS.to_h do |name|
+    [name, system(RbConfig.ruby, __FILE__, tiers.join(",").then { |t| t.empty? ? "none" : t }, root, name)]
+  end
+  failed = results.reject { |_, ok| ok }.keys
+  puts failed.empty? ? "all #{SCENARIOS.size} fallback scenarios hold" : "FAILED: #{failed.join(', ')}"
+  exit(failed.empty? ? 0 : 1)
+end
+
+abort "unknown scenario #{scenario.inspect}" unless SCENARIOS.include?(scenario)
+
+# --- sabotage that must happen before the gem loads -----------------------
+
+module Sabotage
+  # Takes the native extension away through the probe's own require.
+  module BlockNative
+    def require(name)
+      raise LoadError, "native extension removed for the test" if name.to_s.include?("fontisan_native")
+
+      super
+    end
+  end
+
+  # A library lacking the fontisan_call symbol.
+  module MissingFfiSymbol
+    def attach_function(name, *rest)
+      raise FFI::NotFoundError.new(name.to_s, "library") if name == :fontisan_call
+
+      super
+    end
+  end
+end
+
+ENV["FONTISAN_ENGINE"] = "auto"
+ENV.delete("FONTISAN_ENGINE_STRICT")
+case scenario
+when "no_native", "auto_no_native", "auto_none" then Object.prepend(Sabotage::BlockNative)
+end
+case scenario
+when "no_ffi", "auto_none" then ENV["FONTISAN_CDYLIB"] = File.join(Dir.tmpdir, "fontisan-no-such-dir", "libfontisan_cdylib.none")
+end
+require "ffi" if scenario == "ffi_missing_symbol" && tiers.include?("ffi")
+FFI::Library.prepend(Sabotage::MissingFfiSymbol) if defined?(FFI::Library) && scenario == "ffi_missing_symbol"
+require "fontisan"
+Fontisan::Reference # autoloading it installs the engine gates
+
+needs = { "no_native" => "native", "native_missing_symbol" => "native", "native_abi_mismatch" => "native",
+          "no_ffi" => "ffi", "ffi_missing_symbol" => "ffi", "ffi_abi_mismatch" => "ffi",
+          "auto_no_native" => "native" }[scenario]
+if needs && !tiers.include?(needs)
+  puts "skip #{scenario}: no #{needs} tier on this platform"
+  exit 0
+end
+
+case scenario
+when "native_missing_symbol"
+  Fontisan::Native.send(:load_extension)
+  Fontisan::Native.singleton_class.send(:undef_method, :extension_abi_version)
+when "native_abi_mismatch"
+  Fontisan::Native.send(:remove_const, :ABI_VERSION)
+  Fontisan::Native.const_set(:ABI_VERSION, 999)
+when "ffi_abi_mismatch"
+  require "fontisan/ffi/client"
+  Fontisan::Ffi::Client.send(:remove_const, :ABI_VERSION)
+  Fontisan::Ffi::Client.const_set(:ABI_VERSION, 999)
+end
+
+# --- checks ---------------------------------------------------------------
+
+HANDED_TO_RUBY = %w[.dfont .pfa .pfb].freeze
+manifest = JSON.parse(File.read(File.join(root, "manifest.json"))).fetch("fonts")
+entries = manifest.select { |f| f["tier"] == "ci" }.sort_by { |f| f["id"] }
+problems = []
+
+font_path = lambda do |entry|
+  File.join(root, entry["type"] == "derived" ? "derived" : File.join("fonts", entry["id"]), entry["file"])
+end
+golden = lambda do |entry|
+  JSON.parse(File.read(File.join(root, "goldens", "scan", "#{entry['id']}.json"))).fetch("rows")
+end
+plain = lambda do |rows|
+  JSON.parse(JSON.generate(rows.map { |r| r.except("served_by").merge("path" => File.basename(r["path"])) }))
+end
+
+# Scan every font; rows equal the goldens, served_by is in allowed.(path).
+scan_corpus = lambda do |allowed|
+  served = Hash.new(0)
+  entries.each do |entry|
+    path = font_path.call(entry)
+    # The java gem has no brotli: with the ffi tier sabotaged nothing can read a WOFF2,
+    # and the engine says so instead of falling back to a Ruby that cannot serve it.
+    if File.extname(path).casecmp?(".woff2") && allowed.call(path) == ["ruby"] && !Fontisan::Utilities::BrotliWrapper.available?
+      begin
+        Fontisan::Engine.scan([path])
+        problems << "#{entry['id']}: WOFF2 scan with no ffi tier and no brotli did not raise Woff2Unavailable"
+      rescue Fontisan::Engine::Woff2Unavailable
+        served["unavailable"] += 1
+      end
+      next
+    end
+    rows = Fontisan::Engine.scan([path])
+    problems << "#{entry['id']}: rows differ from the golden" unless plain.call(rows) == golden.call(entry)
+    rows.each do |row|
+      served[row["served_by"]] += 1
+      want = allowed.call(path)
+      problems << "#{entry['id']}: served_by #{row['served_by']}, expected #{want.join('|')}" unless want.include?(row["served_by"])
+    end
+  end
+  served
+end
+resolved = lambda do
+  Fontisan::Engine.resolve(:scan, font_path.call(entries.find { |e| e["id"] == "fonttools-test-ttf" })).to_s
+end
+all_ruby = ->(_path) { ["ruby"] }
+
+# The scenarios that sabotage nothing first check the platform has the tiers it claims.
+if %w[mixed auto_all].include?(scenario)
+  ENV["FONTISAN_ENGINE"] = "auto"
+  Fontisan::Engine.reset!
+  have = %w[native ffi].select { |t| Fontisan::Engine.send(:available?, t.to_sym) }
+  problems << "available tiers are #{have.inspect}, expected #{tiers.inspect}" unless have == tiers
+end
+
+begin
+  case scenario
+  when "no_native", "no_ffi", "native_missing_symbol", "native_abi_mismatch", "ffi_missing_symbol", "ffi_abi_mismatch"
+    tier = scenario[/native|ffi/]
+    ENV["FONTISAN_ENGINE"] = tier
+    Fontisan::Engine.reset!
+    problems << "#{tier} probes available" if Fontisan::Engine.send(:available?, tier.to_sym)
+    served = scan_corpus.call(all_ruby)
+    problems << "no ruby row served" if served["ruby"].zero?
+  when "mixed"
+    tiers.each do |tier|
+      ENV["FONTISAN_ENGINE"] = tier
+      Fontisan::Engine.reset!
+      # dfont and PFB must be ruby's. Ruby's detect_format does not recognise a
+      # PFA (nil), so the tier may take it; its error row equals the golden either way.
+      scan_corpus.call(lambda { |path|
+        case File.extname(path).downcase
+        when ".dfont", ".pfb" then ["ruby"]
+        when ".pfa" then ["ruby", tier]
+        else [tier]
+        end
+      })
+    end
+    # dfont and Type 1 in one audit_dir: ruby serves those entries, the tier the rest.
+    Dir.mktmpdir("fontisan-mixed") do |dir|
+      %w[fonttools-test-ttf fonttools-test-dfont fonttools-test-t1-pfb].each do |id|
+        entry = entries.find { |e| e["id"] == id }
+        FileUtils.cp(font_path.call(entry), dir)
+      end
+      tiers.each do |tier|
+        ENV["FONTISAN_ENGINE"] = tier
+        Fontisan::Engine.reset!
+        by_file = Fontisan::Engine.audit_dir(dir).to_h { |e| [e["path"], e["served_by"]] }
+        want = { "TestTTF.ttf" => tier, "TestDFONT.dfont" => "ruby", "TestT1-Regular.pfb" => "ruby" }
+        problems << "#{tier} audit_dir served #{by_file.inspect}, expected #{want.inspect}" unless by_file == want
+      end
+    end
+    problems << "mixed scenario needs a native or ffi tier" if tiers.empty?
+  when "auto_all", "auto_no_native", "auto_none"
+    ENV["FONTISAN_ENGINE"] = "auto"
+    Fontisan::Engine.reset!
+    want = { "auto_all" => tiers.first || "ruby",
+             "auto_no_native" => tiers.include?("ffi") ? "ffi" : "ruby",
+             "auto_none" => "ruby" }.fetch(scenario)
+    problems << "auto resolved #{resolved.call}, expected #{want}" unless resolved.call == want
+    served = scan_corpus.call(->(path) { [want, *("ruby" if HANDED_TO_RUBY.include?(File.extname(path).downcase))] })
+    problems << "no #{want} row served" if served[want].zero?
+  end
+rescue StandardError => e # NameError included: a fallback must never raise it
+  problems << "raised #{e.class}: #{e.message[0, 200]}"
+end
+
+puts "#{problems.empty? ? 'ok  ' : 'FAIL'} #{scenario} (tiers: #{tiers.join(',')})"
+problems.each { |p| puts "       #{p}" }
+exit(problems.empty? ? 0 : 1)

data/scripts/tier_smoke.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Installed-gem smoke test (fontist/fontisan#156 card 2e).
+#
+#   ruby scripts/tier_smoke.rb EXPECTED_TIER [CORPUS_ROOT]
+#
+# Run it against an INSTALLED fontisan gem (never the checkout's lib/). It scans
+# every `ci`-tier corpus font through Fontisan::Engine under the default engine (FONTISAN_ENGINE unset = auto),
+# then checks that
+#   * the tier auto resolves to is EXPECTED_TIER (native, ffi or ruby);
+#   * every row equals the committed scan golden (minus the served_by key);
+#   * served_by is EXPECTED_TIER, except for files the engine hands to Ruby
+#     (dfont, Type 1), which may say ruby; with EXPECTED_TIER=ruby nothing else.
+# Exit status 0 only when all hold.
+require "json"
+
+expected = ARGV.fetch(0) { abort "usage: tier_smoke.rb native|ffi|ruby [corpus root]" }
+root = File.expand_path(ARGV.fetch(1, File.join(__dir__, "..", "corpus")))
+abort "unknown tier #{expected.inspect}" unless %w[native ffi ruby].include?(expected)
+
+ENV.delete("FONTISAN_ENGINE") # the default (auto) is what is under test
+ENV.delete("FONTISAN_ENGINE_STRICT")
+require "fontisan"
+Fontisan::Reference # autoloading it installs the engine gates
+
+lib_dir = Gem.loaded_specs.fetch("fontisan").full_gem_path
+abort "smoke must run an installed gem, loaded #{lib_dir}" unless File.basename(File.dirname(lib_dir)) == "gems"
+
+HANDED_TO_RUBY = %w[.dfont .pfa .pfb].freeze
+
+manifest = JSON.parse(File.read(File.join(root, "manifest.json"))).fetch("fonts")
+entries = manifest.select { |f| f["tier"] == "ci" }.sort_by { |f| f["id"] }
+problems = []
+served = Hash.new(0)
+
+entries.each do |entry|
+  dir = entry["type"] == "derived" ? "derived" : File.join("fonts", entry["id"])
+  path = File.join(root, dir, entry["file"])
+  golden = JSON.parse(File.read(File.join(root, "goldens", "scan", "#{entry['id']}.json"))).fetch("rows")
+  rows = Fontisan::Engine.scan([path])
+  rows.each { |row| served[row["served_by"]] += 1 }
+
+  actual = rows.map { |r| r.except("served_by").merge("path" => File.basename(r["path"])) }
+  problems << "#{entry['id']}: rows differ from golden" unless JSON.parse(JSON.generate(actual)) == golden
+
+  allowed = [expected]
+  allowed << "ruby" if expected != "ruby" && HANDED_TO_RUBY.include?(File.extname(path).downcase)
+  rows.each do |row|
+    problems << "#{entry['id']}: served_by #{row['served_by']}, expected #{allowed.join('|')}" unless allowed.include?(row["served_by"])
+  end
+end
+
+resolved = Fontisan::Engine.resolve(:scan, File.join(root, "fonts", "fonttools-test-ttf", "TestTTF.ttf")).to_s
+problems << "auto resolves scan to #{resolved}, expected #{expected}" unless resolved == expected
+problems << "no #{expected} row served" if served[expected].zero?
+
+puts "fontisan #{Fontisan::VERSION} from #{lib_dir}"
+puts "ruby #{RUBY_VERSION} #{RUBY_PLATFORM}; fonts scanned: #{entries.size}; served_by: #{served.inspect}"
+if problems.empty?
+  puts "OK: auto resolved to #{resolved}; rows equal the goldens"
+else
+  warn problems
+  exit 1
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fontisan
 version: !ruby/object:Gem::Version
-  version: 0.4.47
+  version: 0.4.48
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-11-03 00:00:00.000000000 Z
+date: 2026-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -119,16 +133,20 @@ email:
 - open.source@ribose.com
 executables:
 - fontisan
-extensions: []
+extensions:
+- ext/fontisan_native/extconf.rb
 extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- BENCHMARKS.md
 - BUG-stitcher-drops-isolated-cps.md
 - BUG-stitcher-drops-plane1-codepoints.md
 - BUG-stitcher-gid-cap-65535.md
 - CHANGELOG.md
+- Cargo.lock
+- Cargo.toml
 - Gemfile
 - LICENSE
 - README.adoc
@@ -180,7 +198,15 @@ files:
 - TODO.improvements/14-rubocop-baseline-chip.md
 - TODO.improvements/15-cff-cff2-subsetter-strategy.md
 - TODO.improvements/README.md
+- benchmark/baseline.json
+- benchmark/ci_gate.rb
 - benchmark/compile_benchmark.rb
+- benchmark/corpus/harness.rb
+- benchmark/corpus/ops.rb
+- benchmark/corpus/run.rb
+- benchmark/corpus/scan_child.rb
+- benchmark/corpus/tiers.rb
+- benchmark/tier_baseline.json
 - benchmark/variation_quick_bench.rb
 - docs/.gitignore
 - docs/.vitepress/config.ts
@@ -268,6 +294,7 @@ files:
 - docs/guide/conversion/ttf-otf.md
 - docs/guide/conversion/type1.md
 - docs/guide/conversion/web.md
+- docs/guide/engines.md
 - docs/guide/formats/collections.md
 - docs/guide/formats/dfont.md
 - docs/guide/formats/index.md
@@ -320,8 +347,19 @@ files:
 - docs/public/site.webmanifest
 - docs/public/web-app-manifest-192x192.png
 - docs/public/web-app-manifest-512x512.png
+- docs/reference-facade.md
 - docs/scripts/post-build.mjs
 - exe/fontisan
+- ext/fontisan_cdylib/Cargo.lock
+- ext/fontisan_cdylib/Cargo.toml
+- ext/fontisan_cdylib/build.rs
+- ext/fontisan_cdylib/extconf.rb
+- ext/fontisan_cdylib/src/lib.rs
+- ext/fontisan_native/Cargo.toml
+- ext/fontisan_native/build.rs
+- ext/fontisan_native/clippy.toml
+- ext/fontisan_native/extconf.rb
+- ext/fontisan_native/src/lib.rs
 - lib/fontisan.rb
 - lib/fontisan/audit.rb
 - lib/fontisan/audit/check.rb
@@ -352,6 +390,7 @@ files:
 - lib/fontisan/binary.rb
 - lib/fontisan/binary/base_record.rb
 - lib/fontisan/binary/structures.rb
+- lib/fontisan/byte_ops.rb
 - lib/fontisan/cli.rb
 - lib/fontisan/collection.rb
 - lib/fontisan/collection/builder.rb
@@ -411,6 +450,7 @@ files:
 - lib/fontisan/converters/woff2_encoder.rb
 - lib/fontisan/converters/woff_writer.rb
 - lib/fontisan/dfont_collection.rb
+- lib/fontisan/engine.rb
 - lib/fontisan/error.rb
 - lib/fontisan/export.rb
 - lib/fontisan/export/exporter.rb
@@ -425,6 +465,9 @@ files:
 - lib/fontisan/export/transformers/post_transformer.rb
 - lib/fontisan/export/ttx_generator.rb
 - lib/fontisan/export/ttx_parser.rb
+- lib/fontisan/ffi.rb
+- lib/fontisan/ffi/client.rb
+- lib/fontisan/ffi_platform.rb
 - lib/fontisan/font_loader.rb
 - lib/fontisan/font_writer.rb
 - lib/fontisan/formatters.rb
@@ -482,6 +525,7 @@ files:
 - lib/fontisan/models/unicode_mappings.rb
 - lib/fontisan/models/validation_report.rb
 - lib/fontisan/models/variable_font_info.rb
+- lib/fontisan/native.rb
 - lib/fontisan/open_type_collection.rb
 - lib/fontisan/open_type_font.rb
 - lib/fontisan/open_type_font_extensions.rb
@@ -506,7 +550,11 @@ files:
 - lib/fontisan/pipeline/strategies/preserve_strategy.rb
 - lib/fontisan/pipeline/transformation_pipeline.rb
 - lib/fontisan/pipeline/variation_resolver.rb
+- lib/fontisan/reference.rb
+- lib/fontisan/reference/table_digests.rb
+- lib/fontisan/scan.rb
 - lib/fontisan/sfnt_builder.rb
+- lib/fontisan/sfnt_directory.rb
 - lib/fontisan/sfnt_font.rb
 - lib/fontisan/sfnt_source.rb
 - lib/fontisan/sfnt_table.rb
@@ -864,9 +912,26 @@ files:
 - lib/fontisan/woff2/uint255.rb
 - lib/fontisan/woff2_collection.rb
 - lib/fontisan/woff2_font.rb
+- lib/fontisan/woff_container.rb
 - lib/fontisan/woff_font.rb
+- rakelib/bench.rake
+- rakelib/cdylib.rake
+- rakelib/corpus.rake
+- rakelib/corpus_convert.rake
+- rakelib/corpus_goldens.rake
+- rakelib/corpus_malformed.rake
+- rakelib/corpus_scan.rake
+- rakelib/java.rake
+- rakelib/native.rake
+- scripts/build-woff2.sh
 - scripts/compare_stack_aware.rb
+- scripts/corpus/generate_convert_goldens.rb
+- scripts/corpus/generate_goldens.rb
+- scripts/corpus/generate_malformed_goldens.rb
+- scripts/corpus/generate_scan_goldens.rb
 - scripts/measure_optimization.rb
+- scripts/tier_fallback.rb
+- scripts/tier_smoke.rb
 homepage: https://github.com/fontist/fontisan
 licenses:
 - BSD-2-Clause