-
-
Notifications
You must be signed in to change notification settings - Fork 50
Block assigning one shortcut to multiple keybindings #465
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
Merged
Changes from all commits
Commits
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
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
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
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
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
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,82 @@ | ||
| import XCTest | ||
| @testable import Cotabby | ||
|
|
||
| /// Locks down the duplicate-shortcut guard that keeps the three keybindings unambiguous. | ||
| /// | ||
| /// The original bug: the global-toggle hotkey was excluded from any conflict check, so a user could | ||
| /// bind it to a key already used by an accept binding (the default full-accept key is backtick). The | ||
| /// head-inserted accept tap then consumed the shared key before the toggle tap saw it, so Toggle | ||
| /// Tabby silently did nothing. `conflictingShortcutName` is the single source of truth the recorder | ||
| /// consults to refuse such a binding up front. | ||
| @MainActor | ||
| final class ShortcutConflictTests: XCTestCase { | ||
|
|
||
| /// A combo already owned by another action is reported, keyed by that action's display name. | ||
| func test_conflict_reportsActionOwningTheCombo() { | ||
| let model = makeModel() | ||
| // Default full-accept is backtick (keyCode 50). Binding the toggle to the same key must | ||
| // be flagged as a conflict with "Accept Entire Suggestion". | ||
| let conflict = model.conflictingShortcutName( | ||
| keyCode: 50, | ||
| modifiers: [], | ||
| excluding: .toggleTabby | ||
| ) | ||
| XCTAssertEqual(conflict, "Accept Entire Suggestion") | ||
| } | ||
|
|
||
| /// An action never conflicts with itself, so re-recording the same key for the same binding is | ||
| /// allowed (e.g. confirming the current value). | ||
| func test_conflict_excludesTheActionBeingEdited() { | ||
| let model = makeModel() | ||
| let conflict = model.conflictingShortcutName( | ||
| keyCode: model.acceptanceKeyCode, | ||
| modifiers: model.acceptanceKeyModifiers, | ||
| excluding: .acceptWord | ||
| ) | ||
| XCTAssertNil(conflict) | ||
| } | ||
|
|
||
| /// A free combo (default Accept Word is Tab; some other key is unused) reports no conflict. | ||
| func test_conflict_allowsUnusedCombo() { | ||
| let model = makeModel() | ||
| // keyCode 49 is Space, unused by any default binding. | ||
| let conflict = model.conflictingShortcutName( | ||
| keyCode: 49, | ||
| modifiers: [], | ||
| excluding: .toggleTabby | ||
| ) | ||
| XCTAssertNil(conflict) | ||
| } | ||
|
|
||
| /// The disabled sentinel never conflicts: multiple actions may be left unbound at once. | ||
| func test_conflict_ignoresDisabledSentinel() { | ||
| let model = makeModel() | ||
| let conflict = model.conflictingShortcutName( | ||
| keyCode: SuggestionSettingsModel.disabledKeyCode, | ||
| modifiers: [], | ||
| excluding: .toggleTabby | ||
| ) | ||
| XCTAssertNil(conflict) | ||
| } | ||
|
|
||
| /// Same key but different modifiers is a distinct binding and must not be flagged. | ||
| func test_conflict_treatsModifierSetsAsDistinct() { | ||
| let model = makeModel() | ||
| // Full-accept default is bare backtick; backtick + shift is a different binding. | ||
| let conflict = model.conflictingShortcutName( | ||
| keyCode: 50, | ||
| modifiers: [.shift], | ||
| excluding: .toggleTabby | ||
| ) | ||
| XCTAssertNil(conflict) | ||
| } | ||
|
|
||
| // MARK: - Helpers | ||
|
|
||
| private func makeModel() -> SuggestionSettingsModel { | ||
| let suiteName = "cotabby.test.shortcutConflict.\(UUID().uuidString)" | ||
| let defaults = UserDefaults(suiteName: suiteName)! | ||
| defaults.removePersistentDomain(forName: suiteName) | ||
| return SuggestionSettingsModel(configuration: .standard, userDefaults: defaults) | ||
| } | ||
| } | ||
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.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!