-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
[Multiple-Profile]feat:profile name validation #20698
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mikehardy
merged 2 commits into
ankidroid:main
from
criticalAY:mp/profile-name-validation
Apr 19, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
AnkiDroid/src/main/java/com/ichi2/anki/multiprofile/ProfileName.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| * Copyright (c) 2026 Ashish Yadav <mailtoashish693@gmail.com> | ||
| * | ||
| * This program is free software; you can redistribute it and/or modify it under | ||
| * the terms of the GNU General Public License as published by the Free Software | ||
| * Foundation; either version 3 of the License, or (at your option) any later | ||
| * version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
| * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | ||
| * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more | ||
| * details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License along with | ||
| * this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package com.ichi2.anki.multiprofile | ||
|
|
||
| /** | ||
| * A validated, user-facing profile display name. | ||
| * | ||
| * Values can only be obtained through [validate] (for user input) or | ||
| * [fromTrustedSource] (for persisted / hard-coded values). This makes invalid | ||
| * profile names unrepresentable in the domain layer. | ||
| */ | ||
| @JvmInline | ||
| value class ProfileName private constructor( | ||
| val value: String, | ||
| ) { | ||
| override fun toString(): String = value | ||
|
|
||
| companion object { | ||
| const val MAX_LENGTH = 50 | ||
|
|
||
| /** | ||
| * Validates raw user input. Trims leading and trailing whitespace | ||
| * before checking the rules; interior whitespace (including multiple | ||
| * spaces between words) is preserved as-is. | ||
| * | ||
| * Any non-whitespace character is permitted — including punctuation, | ||
| * emoji, and symbols — matching the desktop Anki behavior. Only | ||
| * length and emptiness are enforced here; uniqueness is checked at | ||
| * the registry layer. | ||
| * | ||
| * Returns a [ValidationResult] — never throws. | ||
| */ | ||
| fun validate(raw: String): ValidationResult { | ||
| val cleaned = raw.trim() | ||
| return when { | ||
| cleaned.isEmpty() -> ValidationResult.Empty | ||
| cleaned.length > MAX_LENGTH -> | ||
| ValidationResult.TooLong(cleaned.length) | ||
| else -> ValidationResult.Valid(ProfileName(cleaned)) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Constructs a [ProfileName] from a value that has already been | ||
| * validated elsewhere (persisted metadata, hard-coded defaults). | ||
| * | ||
| * DO NOT use this for raw user input — use [validate] instead. | ||
| */ | ||
| internal fun fromTrustedSource(value: String): ProfileName = ProfileName(value) | ||
| } | ||
|
|
||
| /** Outcome of validating a candidate profile name. */ | ||
| sealed interface ValidationResult { | ||
| data class Valid( | ||
| val name: ProfileName, | ||
| ) : ValidationResult | ||
|
|
||
| data object Empty : ValidationResult | ||
|
|
||
| data class TooLong( | ||
| val actualLength: Int, | ||
| ) : ValidationResult | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Prefer .toString on the class