Repository navigation
Breaking changes
-
The pinned Unicode version moved from 16.0.0 to 17.0.0, and the profile
token is nowuts46-nontransitional-std3-v2. A call that names no
unicode_versionnow normalizes against Unicode 17.0.0 data. The change is
accept-only in practice: across both vendored IdnaTestV2 corpora and all 8
flag combinations, the new default matches an explicit"17.0.0"in all
102,448 comparisons and differs from"16.0.0"on 3 rows (16.0.0 corpus) and
5 rows (17.0.0 corpus) --- every one of themNAbecoming a value, with zero
changed values. Nothing that normalized before stops normalizing.The
-v1→-v2bump is deliberate and is the part to act on. The bare token
means "whatever the pin is", so without the bump one string would have denoted
16.0.0 before this release and 17.0.0 after. Anything using the token as a
cache or reproducibility key must re-key: a stale key now misses loudly
instead of colliding silently. Callers who want the old data can pass
unicode_version = "16.0.0", which is still shipped and returns identical
results to 1.2.1 --- their token becomes
uts46-nontransitional-std3-v2+unicode-16.0.0.pslrdetects the move on its
own (it compares bothnormalization_profileandunicode_version, and
rebuilds its index on either mismatch), so the effect there is a one-time
rebuild on load until it reships, not a stale answer.This release also fixes the shipped-versions policy: punycoder ships the
current and the previous Unicode version, and a version is deprecated for
one release cycle --- announced here, still shipped and selectable --- before
it is dropped (ADR-017). -
The deprecated URL surface ---
url_encode(),url_decode(), and
parse_url()--- has been removed, one release after the.Deprecated()
warning cycle introduced in 1.2.0. These were always best-effort host
extraction/rewriting, never an RFC 3986 / WHATWG URL parser or canonicalizer.
Use therurlpackage for URL parsing and canonicalization, or pass the host
alone tohost_normalize()/puny_encode()/puny_decode()for host-only
needs.puny_encode()/puny_decode()continue to reject URL-shaped input
with an actionable error pointing atrurl::get_host(). The internal URL
parser (punycoder_url.cpp) and thepunycoder_parsed_urlprint method are
gone with the surface. -
is_punycode()andis_idn()now agree on input that is not well-formed
UTF-8, and both reportFALSEfor it. Previouslyis_punycode()reported
TRUEsilently for such input --- steering callers intopuny_decode()
for a string every other function in the package refuses to process --- while
is_idn()warned and reportedFALSE. The split was not deliberate:
is_punycode()matches with R's default TRE engine, which matches bytewise,
andis_idn()usedperl = TRUE, where PCRE validates UTF-8 first. Both now
share one gate, so the spuriousis_idn()warning is gone too. The predicates
remain total and strictly logical --- neverNA, never an error --- so
if (is_punycode(x))is always safe; callvalidUTF8(x)to distinguish "not
punycode" from "not well-formed text". Answers for well-formed input,
including strings markedlatin1, are unchanged.
New features
-
The Unicode table set is now selectable per call.
host_normalize(x, unicode_version = )and
normalization_profile_info(unicode_version = )accept any version this
build ships, and a newunicode_versions()reports what that is (currently
"16.0.0"and"17.0.0").NULL, the default, means the pinned version ---
which this release moves to 17.0.0, see Breaking changes above;NULLnever
means "newest", so a later release compiling in another table set will not
change results underneath a caller. Selecting another version appends
+unicode-<version>to that token, on the same rule as a relaxed flag, so
two normalizations that genuinely differ can never mintidentical()tokens.
Naming a version the build does not ship is an error listing what is
available, never a silent fall back to the pin --- a fallback would let a
caller record a profile identity describing a normalization that never ran.
There is deliberately no global option for this: unlike
punycoder.strict, which is an error-policy preference, the Unicode version
is part of profile identity, and making identity ambient would let the same
code mint different reproducibility keys in different sessions
(ADR-016). -
validate_domain()results are now readable at scale.print()opens with a
count header (12 domains: 5 valid, 7 invalid (strict = TRUE)), stops after
10 per-domain blocks with a... and N morefooter instead of dumping one
block per element, and shows each error's machine-readable code alongside its
message. A newsummary()method condenses the whole vector into a data
frame oferror_code/nsorted by count descending, carryingn,
n_valid,n_invalid, andstrictas attributes, so failures across a
large batch can be tallied programmatically. -
host_normalise()andnormalisation_profile_info()are now exported as
British-spelling aliases ofhost_normalize()and
normalization_profile_info(). Each alias is the same function as its
US-spelled primary and is documented on the primary's help page; the US
spellings stay the canonical names (SEOR-qwomlgjd).
Bug fixes
-
The tracker links a reader clicks --- in
codemeta.json,SECURITY.md,
.bestpractices.jsonand the intro vignette --- now point at the GitLab
tracker'swork_itemspath. The path they used before returns 404 across
gitlab.com since GitLab moved issues platform-wide, so the address shipped in
those files no longer resolved for an anonymous reader.DESCRIPTION's
BugReports:is deliberately not repointed and keeps naming
https://gitlab.com/bart-turczynski/punycoder/-/issues(see the next entry):
CRAN's incoming check accepts a gitlab.comBugReports:only when the path
ends in/-/issues, and the NOTE it emits otherwise archived a sibling
package at the pretest. That check readsDESCRIPTIONalone, so the two
audiences are served independently; the URL check's 404 on the/-/issues
address is expected and is explained incran-comments.md
(PUNY-uixamcbp, PUNY-fxwavtvu). -
BugReports:points at the GitLab tracker's/-/issuespath, the form
CRAN's incoming check requires (a browser is redirected to/-/work_items)
(PUNY-yomemdzz). -
puny_decode()now rejects malformed A-label input consistently across
backends. The in-tree fallback decoder previously accepted non
letter-digit-hyphen (LDH) characters in a label's literal section (e.g.
xn--(o)-...) and echoed an empty Bootstring payload (xn---) back unchanged,
where libidn2 rejected both. It now applies the documented LDH check to decode
input and reports these as an error understrict = TRUE/NAunder
strict = FALSE, so the two backends agree on every input. -
puny_encode(),puny_decode(), andvalidate_domain()now transcode
character input to UTF-8 before dispatching to native code, and Unicode
output is explicitly marked as UTF-8. Previously onlyhost_normalize()
transcoded, so a Latin-1-marked (or non-UTF-8 native) host reached the UTF-8
decoder as ill-formed bytes and the same string produced different answers
depending on how R happened to mark it (#67).
Performance
-
host_normalize()no longer normalizes input that is already normalized ---
1.22x on all-ASCII hosts, 1.21x at 20% non-ASCII, 1.22x at 50%, and 1.19x
when every host is non-ASCII. Unicode NFC ran unconditionally, so a host that
was already in NFC --- which nearly all real host text is --- paid for a full
decompose, canonical-reorder and recompose pass to produce a byte-identical
copy of itself. An all-ASCII host was making 295,792 pointless composition
attempts per 20,000 hosts.nfc()now applies the UAX #15 quick check
(NFC_Quick_Checkplus a combining-class ordering test) and returns its input
untouched when it passes; below U+0300 that costs one comparison per character
and no table read at all.This is the largest single normalizer win in this release, and unlike the
table work below it helps ASCII input most, because that input was paying the
most for nothing. Input that genuinely needs normalizing does not regress: on
a corpus transformed to NFD, so the check always fails, throughput is still
1.13x/1.07x/1.01x, because the check abandons at the first character that
fails rather than scanning to the end.NFC_Quick_Check=Maybeis treated as a
real third value and falls through to the full pipeline. Output is unchanged
on every input in the UTS #46 conformance corpus under all supported flag
combinations, andnfc()was verified against the pipeline it skips over all
19,965 rows of the official UAX #15 normalization corpus, every single code
point, and 280 million code-point pairs. -
host_normalize()is faster again on non-ASCII hosts --- 1.05x when every
host is non-ASCII, 1.04x at 50%, 1.03x at 20%, unchanged on all-ASCII input
--- with the last Unicode table still on a binary search converted. Canonical
composition is keyed on a pair of code points, so it could not become a trie
the way the four accessors below did; it is now a trie on the first element
with a short scan over that starter's partners behind it. Keying on the first
element is measured rather than assumed: the 961 pairs hold 391 distinct first
elements but only 72 distinct second ones, so the runs to scan are a median of
1 long instead of 3, and it is the first element that answers the common
reject --- a starter that never composes, such as any CJK ideograph, used to
walk the whole 961-pair search only to conclude 0. The accessor is 6.1x faster
on that reject path and 2.5x on a successful composition, and its share of self
time falls from 5.3% to 1.9%.The end-to-end figure is smaller than either of those because most attempted
compositions never reach the table at all: 87% of them are answered by the
bound on the second element, since that element is just the next character
after a starter and ordinary text is not combining marks. That bound is now
exposedinlinefrom the generated header and applied before the call
rather than inside it, which is what makes the ASCII-heavy end of the range
faster rather than merely unchanged. Output is unchanged on every input in the
UTS #46 conformance corpus under all supported flag combinations. -
host_normalize()is faster on non-ASCII hosts --- 1.25x when every host
is non-ASCII, 1.16x at 50%, 1.08x at 20%, and unchanged on all-ASCII input
--- and the installed shared object is 64 KB smaller. The four Unicode
accessors that profiled hot (combining class, UTS #46 mapping, canonical
decomposition,Bidi_Class) no longer binary-search: each is a two-stage
trie, two loads and no branches, O(1) for every code point rather than only
for ASCII. The previous release made ASCII free but left every non-ASCII code
point paying 11-14 branch-mispredicting probes --- and the worst case was not
an exotic character but a common one the table does not list, since every CJK
ideograph walked the whole combining-class table only to conclude 0. Table
lookups fell from 33% of self time to 17% on an all-non-ASCII corpus. Storing
identical blocks once, and keying the UTS #46 trie on distinct
(status, mapping) values rather than on ranges, is what makes the structure
smaller than the range tables it replaced. Every array, element type and
block size is derived indata-raw/generate_unicode_tables.R, which now also
verifies each trie against its source ranges for all 1,114,112 code points
before emitting it. Output is unchanged on every input in the UTS #46
conformance corpus under all supported flag combinations. -
host_normalize()is substantially faster again --- 1.75x on all-ASCII
hosts, 1.36x on a mixed corpus at 20% non-ASCII, and 1.12x even when every
host is non-ASCII. Lookups into the vendored Unicode tables were 56% of
process time: seven near-identical binary searches, ~14 branch-mispredicting
probes per code point for the 9,185-range UTS #46 table alone. They now share
one search, and each answers ASCII --- the dominant input --- without
searching at all, via a 128-entry direct index for the two tables that cover
ASCII and a bounds test for the rest. Every boundary is derived in
data-raw/generate_unicode_tables.Rfrom the UCD data itself, so it cannot
drift from the table it guards and a Unicode version bump moves it
automatically. Output is unchanged on every input in the UTS #46 conformance
corpus under all supported flag combinations. -
host_normalize()is roughly 25-30% faster. Label validation no longer
re-runs Unicode NFC on labels taken straight from the label split: NFC is
applied to the whole host before splitting, and U+002E is a safe break point
(it appears in no canonical decomposition and no composition pair), so those
labels are already in NFC by construction. Punycode-decoded A-label payloads,
which never go through that pass, are still checked. Output is unchanged on
every input in the UTS #46 conformance corpus, under all supported flag
combinations.
Internal
-
The documentation site is published at
https://bart-turczynski.gitlab.io/punycoder/, the GitLab Pages namespace
path every package in the family uses.DESCRIPTION'sURL:,_pkgdown.yml
and.bestpractices.jsonname it; the project's unique-domain Pages address
no longer resolves (PUNY-rsxtbbln, SEOR-hcmtspmv). -
The agent instructions no longer import fp's generated
FP_CLAUDE.md, and
point at the houseagent-workflowandfpskills for the git workflow.
The tracker snapshot is refreshed before a copy leaves the machine, not on
every issue closure (SEOR-ipwcbcov, PUNY-lezxwoov). -
CI folds the formerly-separate
lint,readme, andnews-version
jobs into onegatesjob. Each was cheap on its own -- well under a
minute of real checking combined -- but every GitLab job pays a roughly
constant ~2 minute tax for runner pickup and setup regardless of how
little script it runs.scripts/gates.Rruns all three checks
unconditionally, accumulates a PASS/FAIL for each, and prints one summary
before exiting nonzero if any failed, so folding them costs no
diagnostic signal.citation-versionwas a candidate but stayed its own
job: it needspython3, which thelint/readme/news-versionjobs'
sharedrocker/r-verimage does not have (SEOR-pgammbgo). -
full-checkandsanitizerscan now run on a weekly schedule instead
of only on a release tag or by hand.osv-auditandsecurity-audit,
which already ran on any pipeline schedule, now additionally require a
SCHEDULE_KINDselector so a second schedule (for the release-shaped
checks) cannot silently also fire the dependency audits. Adding the
actual pipeline schedules is a separate, manual step (SEOR-ihmntqzm). -
The
readmecheck, now inside thegatesjob, ignores blank-line-only
differences inREADME.md. pandoc versions disagree about the blank line
after the badges marker, so a README rendered with a newer local pandoc
passed the pre-push gate and then failed CI, as it did in seor
(SEOR-kaqtnovh). -
The pkgdown site no longer publishes the repository's agent instruction
files. pkgdown renders every top-level.md, soAGENTS.htmland
CLAUDE.htmlwere being served next to the function reference; thepages
job now strips them with a glob beforebuild_site(SEOR-pibdjanz). -
CI now creates exactly one pipeline per merge, on
main, instead of
three. Theworkflow:block used to allow both merge-request and branch
pipelines (suppressing the branch one only when an MR was already open).
CI runs on a self-hosted Docker runner on one Mac, not on GitLab.com's
shared runners, and its few job slots are shared by six of the fleet's
repositories. The branch and MR pipelines test the same tree as the
eventualmainpipeline and get created first, so they took those slots
while the pipeline that actually gates the work queued behind them ---
measured once holding the runner for 36+ minutes on an already-merged MR. Both are now suppressed outright; only a
push tomain, a tag, or a pipeline started by hand creates one.
Feature-branch pushes get no CI at all, which is the intent, not a
regression:mainis a protected branch so nothing merges without going
through it, and no project in the fleet has ever gated a merge on pipeline
success. Starting a pipeline by hand from Build > Pipelines > Run pipeline
still works against any ref and runs the full gate there ---full-check
andsanitizersincluded, one click away --- so a branch can still be
verified before it merges; onlypagesis pinned tomain(SEOR-bmgkzhvy). -
CI installs the pandoc
.debfor the architecture the runner reports
rather than a hardcodedamd64one. The.pandoc_scriptanchor, spliced
by four jobs, asked forpandoc-3.10-1-amd64.deb; on the project's own
runner --- a local runner on Apple Silicon, where Docker resolves
rocker/r-verto arm64 ---dpkg -irefuses that package, socheckand
readmefailed the first time the pipeline ever ran on a real executor. The
suffix is now$(dpkg --print-architecture), command substitution rather
than a CI variable so that it is evaluated inside the container it describes.
The|| apt-get install -f -yfallback is gone with it: it swallowed the
dpkg exit status, which is why the trace read as a missing binary two lines
later instead of an architecture mismatch at the install (PUNY-llvlqvrr). -
The OSS Index dependency audit in
tests/testthat/test-security.Rscopes to
hard dependencies (Depends+Imports) instead of theSuggeststree.
oysteR::expect_secure()auditsSuggeststoo, which pulled in oysteR's own
recursive dependencies ---curlamong them --- and failed the pre-push gate
on a vulnerability in the auditor rather than in anything punycoder ships.
Scoped to hard dependencies the audit covers 3 packages and is clean; the old
scope covered 78 (PUNY-vymqxjnf). -
CI, community-health templates and the documentation host followed the move
to GitLab. The eight GitHub Actions workflows in.github/could not run at
all --- the account that executed them is suspended --- so.github/is gone
and a single.gitlab-ci.ymlreplaces it. The merge gate keeps its shape and
its job names (lint,readme,news-version,check,coverage), so
CONTRIBUTING.md's doc-only-gate rule still names real jobs.pkgdown.yaml
became apagesjob publishing to GitLab Pages;osv-auditand
security-auditbecame a weekly pipeline schedule; the issue and
pull-request templates became.gitlab/issue_templates/and
.gitlab/merge_request_templates/.Three things changed rather than moved, and are worth knowing about:
- Cross-platform checking. R-hub v2 is GitHub-Actions-native, so
rhub.yamlhad no port. But R-hub publishes its check environments as
ordinary container images, so the ASAN/UBSAN and valgrind runs that
actually mattered survive as a manualsanitizersjob pulling
ghcr.io/r-hub/containers/{clang-asan,valgrind}directly. What genuinely
did not survive is the macOS and Windows legs offull-check.yml;
full-checkis now an R-version matrix (devel / release / oldrel-1) on
Linux, and pre-release cross-platform coverage comes from R's own
forge-independent services --- win-builder and the macOS builder --- which
the CRAN release checklist now names explicitly. - Coverage reporting. The Codecov project was bound to the GitHub
repository and cannot follow. Coverage now goes to GitLab's built-in
reporting (pipeline badge, merge-request coverage diff, per-file Cobertura
annotations) --- no external account, no token. - Dependabot. Removed rather than replaced. Its only ecosystem was
github-actions, and with the workflows gone there is nothing left for it
to bump: GitLab CI pins images by floating tag on purpose, and the one
remaining pinned external ref lives in.pre-commit-config.yaml, which
pre-commit autoupdatehandles.
SECURITY.mdwas rewritten for the same reason: GitHub private vulnerability
reporting is no longer a channel for this project, so the confidential routes
are now maintainer email and a confidential GitLab issue.
.bestpractices.json--- the OpenSSF Best Practices submission --- had about
forty URLs pointing at the suspended account and at the dead pkgdown site;
all of them were repointed. Note that the file is only half of that fix: the
published submission at bestpractices.dev must be updated from it separately,
or the badge keeps citing URLs that no longer resolve.The pkgdown site was republished on GitLab Pages afterwards; see the
documentation-site bullet above.Historical release notes below were left as written. They cite
bart-turczynski.github.io/punycoder/and GitHub Actions because that is
what was true when those versions shipped; silently rewriting a published
changelog would be worse than a dead link in it. - Cross-platform checking. R-hub v2 is GitHub-Actions-native, so
-
The package's public identity moved from GitHub to GitLab. The GitHub
account that hostedpunycoderis suspended, so every URL naming it now 404s
--- including the twoDESCRIPTIONfields CRAN reads,URL:and
BugReports:, and the pkgdown site they pointed at.URL:is now
https://gitlab.com/bart-turczynski/punycoder plus the CRAN page, and
BugReports:is the GitLab tracker. The same repoint was applied to
CITATION.cff,codemeta.json,_pkgdown.yml, the README and the
introduction vignette; in-repo document links became repository-relative so
they survive the next move.Three URLs were dropped rather than replaced, because no live equivalent
exists: thebart-turczynski.github.io/punycoder/pkgdown site (no publisher
--- the workflow that built it cannot run, and GitLab Pages for this project
has never deployed), the GitHub Actions and Codecov badges, and the
r-universe entry. r-universe still serves a build of 1.2.1.9000, but it
tracks the suspended GitHub repository as its source and so can never update;
restoring it means re-registering the universe against GitLab._pkgdown.yml
carries nourl:key until a documentation site is published somewhere
reachable, andDESCRIPTIONmust name the same site when one is. -
The UTS #46 conformance suite now runs once per shipped Unicode version,
against the corpus Unicode published with that version. There was a single
inst/testdata/IdnaTestV2.txtof 16.0.0 vintage and one hardcoded expectation
set, so the 17.0.0 table set added alongside 16.0.0 was only ever checked
against 16.0.0's expectations --- a corpus that predates it and cannot
exercise anything 17.0.0 changed. Each version now has its own vendored corpus
(inst/testdata/IdnaTestV2-16.0.0.txt, dated 2024-07-03;
inst/testdata/IdnaTestV2-17.0.0.txt, dated 2025-05-01), named with the
dotted version exactly asunicode_versions()reports it so tests build the
path with no tag translation. A newdata-raw/fetch_idna_fixtures.Racquires
them the way the UCD table generator does: network access at generation time
only, a per-version cache under a git-ignoreddata-raw/.idna-cache/, and a
shape check so a truncated download or an HTML error page cannot be committed
and quietly weaken every conformance assertion. The pinned A4_2 root-dot
deviation count is a property of the fixture rather than of the engine, so it
is per-version too (57 at 16.0.0, 59 at 17.0.0, both entirely A4_2 with zero
false rejections), and a version with no listed count fails loudly instead of
skipping its check. Added with it is the invariant the multi-version work
actually rests on, which no fixed delta count can express: a newer table set
may newly accept a host, but must never reject one an older set accepted,
nor return a different value for one both accept. No package code changed and
no result moved. -
The OSS Index audit in
tests/testthat/test-security.Rnow gates on
dispositions rather than on silence. An allow-list in
tests/testthat/helper-security.R(empty today: the audit reports no
advisories) must account for every reported advisory, and every row in it
must still be reported, so the list can neither hide a new finding nor
outlive its reason; a row past its review date or seen at an older version
only warns. The audit also fails on an empty result, and under
OSSINDEX_AUDIT_REQUIRED=truea missingoysteRor missing credentials fail
instead of skipping, so a dedicated audit job cannot pass having audited
nothing. Thesecurity-auditCI job sets that flag (see the next entry)
(SEOR-fftbjnpl). -
The
security-auditCI job now fails instead of passing when it cannot
audit. It setsOSSINDEX_AUDIT_REQUIRED=true, so missing OSS Index
credentials or a missingoysteRturn the job red with a message naming
what is absent; before, it skipped and reported success having audited
nothing.osv-auditandsecurity-auditnow run only from the
dependency-auditpipeline schedule or by hand, and no longer also run on
mainwheneverDESCRIPTION, their test file or.gitlab-ci.ymlchanges
(SEOR-fftbjnpl). -
A new pre-push and CI check,
scripts/check-bugreports.py, keeps the two
tracker addresses apart.DESCRIPTION'sBugReports:(and the man page
generated from it) must stay on the/-/issuesform CRAN's incoming check
accepts, whilecodemeta.json,SECURITY.md,.bestpractices.jsonand the
intro vignette must link/-/work_items, and the README must not carry a
/-/issueslink. It runs as its own pre-push hook next to the citation
check, and in thecitation-versionCI job (SEOR-ocbtrrnl). -
scripts/bestpractices-url.pyis vendored from seor, with a pre-push
self-test hook. bestpractices.dev never imports.bestpractices.jsonfrom a
GitLab repository, so the script turns the file into edit links the
maintainer saves on the site, and--checkcompares the site with the file.
.bestpractices.jsonnow names GitLab as the home of the project and GitHub
only as a read-only mirror, and describes today's CI: pipelines run on pushes
tomain, the pre-push hook gates branches, and thesanitizersjob has not
yet run, so the dynamic-analysis answers are Unmet (SEOR-grrcptww).