Files
giza-kmp/docs/scripts/m3-title-case.py
T
Kgothatso NgakoandClaude Opus 5 3bc8be535a refactor: rebrand mantra to curated, and the five names that stay
`press.mantra.{compose,android,desktop}` becomes `com.it.curated.{compose,android,desktop}`
across 680 file moves, and the app is Curated everywhere a user can see it. The work
that mattered was not the rename; it was deciding which of the 6355 occurrences of
"mantra" were the brand and which were something else wearing it.

**"Mantra" was two words in one tree, and only one of them is a brand.** 1369 of the
tokens belong to a domain model -- `MantraArtifact`, `MantraChapter`, `MantraChunk`,
`MantraDialect`, the seven `MantraTranslation*` types, their 15 DAOs and
`MantraRepository` -- and those 12 entity classes declare no `tableName`, so Room takes
the class name as the SQLite table name. A blanket `s/Mantra/Curated/` renames 12 live
tables, which is not a rename but a v20 with 12 `@RenameTable` specs and a regenerated
schema. Asked, the decision was brand surface only, so the domain keeps its name and the
database keeps every one of its tables. The count is the check: the same 1369 tokens are
present before and after, and Room found all 19 existing schemas at the moved directory
and generated no stray -- which is what proves no table moved.

**Renamed instead is the set of names that only ever meant "this app".** `CuratedApp`,
`CuratedApplication`, `CuratedGlobal`, `CuratedNavHost`, `CuratedNavigationSuite`,
`CuratedShapes`, `CuratedConverters`, `defaultCuratedDir`, and `CuratedDatabase` with its
constructor and test. `CuratedDatabase` is safe to rename precisely because the entity
classes were not: the `@Database` class name picks the schema *directory*
(`composeApp/schemas/com.it.curated.compose.database.CuratedDatabase/`), never a table,
so the 19 schema files move unmodified and the AutoMigration chain from 1 is untouched.

**`com.it.curated` is the applicationId; the namespace is `com.it.curated.android`.**
These were one value before, and splitting them is what lets the identifier land verbatim
as the app's store identity while `BuildConfig` and the manifest's relative
`android:name=".CuratedApplication"` keep resolving against the android source package.
The debug build is `com.it.curated.debug` via the existing suffix.

**The generated resources package moved because `rootProject.name` did.** Compose
Resources derives it from the root project, so `Mantra` -> `Curated` silently turns
`mantra.composeapp.generated.resources` into `curated.composeapp.generated.resources` and
breaks all 501 imports at once. They are rewritten, along with the two string keys that
carried the brand -- `mantra` -> `curated` and `sign_in_is_not_yet_available_while_mantra_is`
-- and their three call sites. The seven `docs/scripts/` tools and `m3-audit.sh` hardcode
the UI source path, so they moved too; the audit passing is the evidence they still see
the whole tree rather than an empty one.

**Two hash inputs and a hostname keep the old name, and now say why.**
`SharedKeyDerivation.TWEAK_TAG` and `ChillDkgRitualManager.HOST_KEY_DERIVATION_TAG` are
`"mantra/..."` strings that are fed to SHA256. Renaming them derives different keys from
the same seed: every room already created is orphaned, every completed ChillDKG becomes
unrecoverable, and a Curated client and a Mantra client sharing a group derive different
keys from one threshold key, so their partial signatures aggregate to something that
verifies against nothing. That is a protocol fork and belongs in a `v2` tag, not in a
rebrand. `Relays.ephemeral` stays on `wss://ephemeral.mantra.press` for the duller reason
that it is a relay that is running and is in the bootstrap, publish, finder and DM sets;
pointing it at a name nobody has stood up takes the app off the network. All three sites,
and `docs/shared-key-derivation.md`, now carry the reasoning, because the failure mode of
each is silent and the next reader will otherwise finish the job.

**iOS had never been moved off the brand before this one.** `Config.xcconfig` still read
`PRODUCT_NAME=Torch` with a bundle id of `ac.aux.compose.Aux` -- two brands ago -- so a
Curated repo built a Torch.app. It is now `Curated` / `com.it.curated`, with the pbxproj's
three product references renamed to match. This is wider than Mantra -> Curated and is
called out for that reason; it is also unverified here, because the build gates the ios
targets behind `isMacOsX` and this was built on linux. In the same spirit the last stale
`press.auxiliary.compose` file -- a KMP template test asserting `1 + 2 == 3` -- was
relocated rather than deleted, so the source tree has one root package instead of an
orphan under the vacated one.

**Three things still say the old names on purpose and are not oversights.**
`UserAgent.APP_NAME` and `CLIENT_NAME` still read `"Torch"`, which a previous rename left
deliberately: it goes on the wire to relay operators and is a network identity rather
than a content one. `.gitea/workflows/material-design-conformance.yml` triggers on
`branches: [mantra]` because that is still the branch's real name. And
`docs/material-design-conformance.md:278` records that the top bar once read `"Torch"`
while the window title read `"Mantra"` -- a finding about a past defect, which rewriting
would falsify.

1136 tests pass -- 733 in `:composeApp:jvmTest`, 403 in `:composeApp:testDebugUnitTest` --
`:composeApp:compileDebugKotlinAndroid` is clean, and `m3Audit` meets every budget.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-10 00:53:05 +02:00

100 lines
4.4 KiB
Python
Executable File

#!/usr/bin/env python3
"""Find UI strings still written in title case.
M3's style guide: "All text, including titles, headings, labels, menu items, navigation
components, app bars, and buttons should use sentence-style capitalization." Product names
and branded terms keep their capitals.
Two things this gets right that the first, grep-based version did not:
- It allows lowercase articles inside a title-cased phrase, so "Invite a Friend" is
caught. Requiring every word after the first to be capitalised missed four strings.
- It scans the whole file rather than one line at a time, so a `Text(` whose literal is
on the next line is caught. That missed one more.
Sample data is excluded by name rather than by pattern, because "Steve Biko" and "To Kill
a Mockingbird" are title case for the correct reason: they are a person and a book.
Usage: m3-title-case.py [--list]
"""
import os, re, sys
UI = 'composeApp/src/commonMain/kotlin/com/it/curated/compose/ui'
CATALOGUE = 'composeApp/src/commonMain/composeResources/values/strings.xml'
SMALL = {'a', 'an', 'the', 'to', 'of', 'for', 'and', 'or', 'via',
'in', 'on', 'at', 'with', 'from', 'by'}
# People, book titles and other proper nouns used as preview and test fixtures.
SAMPLE = {
'Steve Biko', 'John Doe', 'Frank Talk', 'Alan Turing',
'To Kill a Mockingbird', 'Man With A Plan', 'Woman Of Few Words',
}
def offenders():
found = []
# The catalogue, first. When phase 4 moved 364 strings out of composables it moved
# them out of this checker's reach at the same time -- it scanned .kt files only, so
# it went on reporting zero while "%1$s Key Packages" and three surviving mentions of
# the old product name sat in strings.xml. Externalising narrows what a source scan
# can see; the check has to follow.
if os.path.exists(CATALOGUE):
for m in re.finditer(r'<string name="([^"]+)">([^<]*)</string>',
open(CATALOGUE, encoding='utf-8').read()):
phrase = m.group(2)
if phrase in SAMPLE:
continue
words = [w for w in re.sub(r'%\d+\$s', '', phrase).split() if w]
if len(words) < 2 or not words[0][:1].isupper():
continue
later = [w for w in words[1:] if w.lower() not in SMALL]
if not later:
continue
if all(w[:1].isupper() for w in later) and \
any(w[:1].isupper() and w[1:].islower() for w in later):
found.append((CATALOGUE, m.group(1), phrase))
for root, _, files in os.walk(UI):
for f in sorted(files):
if not f.endswith('.kt'):
continue
path = os.path.join(root, f)
text = open(path, encoding='utf-8').read()
for m in re.finditer(r'"([^"$\\]{4,90})"', text):
phrase = m.group(1)
if phrase in SAMPLE:
continue
line_start = text.rfind('\n', 0, m.start()) + 1
line = text[line_start:text.find('\n', m.start())]
if line.lstrip().startswith(('//', '*', '/*')):
continue
# A log line is not UI copy. `logger.d("Queried Sync")` is written for
# whoever is reading logcat, and sentence-casing it would be cargo cult.
if re.search(r'\blogger\s*\.\s*[dewiv]\s*\(', line):
continue
words = phrase.split()
if len(words) < 2 or not words[0][:1].isupper():
continue
later = [w for w in words[1:] if w.lower() not in SMALL]
if not later:
continue
# Title case: every significant word capitalised, and at least one of
# them an ordinary capitalised word rather than an acronym like NIP.
if all(w[:1].isupper() for w in later) and \
any(w[:1].isupper() and w[1:].islower() for w in later):
found.append((path, text[:m.start()].count('\n') + 1, phrase))
return found
def main():
found = offenders()
print(f' {"Title Case in UI strings":42s} {len(found):6d}')
if '--list' in sys.argv:
for path, line, phrase in found:
print(f' {path.replace(UI + "/", "")}:{line} {phrase!r}')
return 1 if found else 0
if __name__ == '__main__':
sys.exit(main())