Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Hook iOS FlutterSpellCheckPlugin to Framework #35742

Merged
auto-submit merged 8 commits into from
Sep 14, 2022
Merged

Hook iOS FlutterSpellCheckPlugin to Framework #35742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
754b3a3
Add nativeSpellCheckServiceDefined:
camsim99 Aug 24, 2022
4b81280
Make corrections
camsim99 Aug 25, 2022
b51ad98
Formatting
camsim99 Aug 26, 2022
7f58d19
Revert changes to FlutterEngine
camsim99 Aug 26, 2022
0d92b62
Add comment
camsim99 Sep 1, 2022
293ad93
Formatting
camsim99 Sep 2, 2022
d25457f
Add back tests
camsim99 Sep 2, 2022
9005973
Merge remote-tracking branch 'upstream/main' into ios_sc
camsim99 Sep 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion shell/platform/android/io/flutter/plugin/editing/SpellCheckPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ public void initiateSpellCheck(

/** Calls on the Android spell check API to spell check specified text. */
public void performSpellCheck(@NonNull String locale, @NonNull String text) {
String[] localeCodes = locale.split("-");
Locale localeFromString = LocalizationPlugin.localeFromString(locale);

if (mSpellCheckerSession == null) {
Expand Down
6 changes: 5 additions & 1 deletion shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPlugin.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
// Returns an empty array if no spell check suggestions.
- (NSArray<NSDictionary<NSString*, id>*>*)findAllSpellCheckSuggestionsForText:(NSString*)text
inLanguage:(NSString*)language {
// Transform Dart Locale format to iOS language format.
language = [language stringByReplacingOccurrencesOfString:@"-" withString:@"_"];
if (![UITextChecker.availableLanguages containsObject:language]) {
return nil;
}
Expand Down Expand Up @@ -145,7 +147,9 @@ - (instancetype)initWithMisspelledRange:(NSRange)range
- (NSDictionary<NSString*, NSObject*>*)toDictionary {
NSMutableDictionary* result = [[[NSMutableDictionary alloc] initWithCapacity:3] autorelease];
result[@"startIndex"] = @(_misspelledRange.location);
result[@"endIndex"] = @(_misspelledRange.location + _misspelledRange.length - 1);
// The end index represents the next index after the last character of a misspelled word to match
// the behavior of Dart's TextRange: https://api.flutter.dev/flutter/dart-ui/TextRange/end.html
result[@"endIndex"] = @(_misspelledRange.location + _misspelledRange.length);
result[@"suggestions"] = _suggestions;
return result;
}
Expand Down
33 changes: 28 additions & 5 deletions shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPluginTest.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,11 +161,11 @@ - (void)testFindAllSpellCheckSuggestionsForText {
XCTAssertTrue(capturedResult.count == 2);
NSDictionary* suggestionsJSON1 = capturedResult.firstObject;
XCTAssertEqualObjects(suggestionsJSON1[@"startIndex"], @0);
XCTAssertEqualObjects(suggestionsJSON1[@"endIndex"], @4);
XCTAssertEqualObjects(suggestionsJSON1[@"endIndex"], @5);
Copy link
Member

@jmagman jmagman Aug 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this right?

This isss misspelled
xxxxx^^^^xx
01234567890

Start index is 5, length is 4, end index is 8, not 9.

Copy link
Contributor Author

@camsim99 camsim99 Aug 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the end is exclusive: https://github.com/flutter/flutter/blob/f57fcac717092e9d55d25a63d79505b455719609/packages/flutter/lib/src/services/spell_check.dart#L19

Copy link
Member

@jmagman jmagman Aug 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://api.flutter.dev/flutter/dart-ui/TextRange-class.html

The next index after the characters in this range.

Well that's confusing, as you experienced from the off by one error... Can you add a comment about that in toDictionary? In Objective-C this is usually expressed with a tuple range of start index + length, that the endIndex is after the range is not intuitive.

Copy link
Member

@jmagman jmagman Sep 2, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

Test Case '-[FlutterSpellCheckPluginTest testFindAllSpellCheckSuggestionsForText]' started.
/../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPluginTest.mm:164: error: -[FlutterSpellCheckPluginTest testFindAllSpellCheckSuggestionsForText] : ((suggestionsJSON1[@"endIndex"]) equal to (@4)) failed: ("5") is not equal to ("4")
/../../flutter/shell/platform/darwin/ios/framework/Source/FlutterSpellCheckPluginTest.mm:168: error: -[FlutterSpellCheckPluginTest testFindAllSpellCheckSuggestionsForText] : ((suggestionsJSON2[@"endIndex"]) equal to (@9)) failed: ("10") is not equal to ("9")
Test Case '-[FlutterSpellCheckPluginTest testFindAllSpellCheckSuggestionsForText]' failed (0.061 seconds).

XCTAssertEqualObjects(suggestionsJSON1[@"suggestions"], suggestions1);
NSDictionary* suggestionsJSON2 = capturedResult[1];
XCTAssertEqualObjects(suggestionsJSON2[@"startIndex"], @5);
XCTAssertEqualObjects(suggestionsJSON2[@"endIndex"], @9);
XCTAssertEqualObjects(suggestionsJSON2[@"endIndex"], @10);
XCTAssertEqualObjects(suggestionsJSON2[@"suggestions"], suggestions2);
[self.mockTextChecker reset];
[textCheckerClassMock stopMocking];
Expand Down Expand Up @@ -198,11 +198,11 @@ - (void)testStopFindingMoreWhenTheLastWordIsMisspelled {
XCTAssertTrue(capturedResult.count == 2);
NSDictionary* suggestionsJSON1 = capturedResult.firstObject;
XCTAssertEqualObjects(suggestionsJSON1[@"startIndex"], @0);
XCTAssertEqualObjects(suggestionsJSON1[@"endIndex"], @4);
XCTAssertEqualObjects(suggestionsJSON1[@"endIndex"], @5);
XCTAssertEqualObjects(suggestionsJSON1[@"suggestions"], suggestions1);
NSDictionary* suggestionsJSON2 = capturedResult[1];
XCTAssertEqualObjects(suggestionsJSON2[@"startIndex"], @6);
XCTAssertEqualObjects(suggestionsJSON2[@"endIndex"], @9);
XCTAssertEqualObjects(suggestionsJSON2[@"endIndex"], @10);
XCTAssertEqualObjects(suggestionsJSON2[@"suggestions"], suggestions2);
[self.mockTextChecker reset];
[textCheckerClassMock stopMocking];
Expand All @@ -228,7 +228,7 @@ - (void)testStopFindingMoreWhenTheWholeStringIsAMisspelledWord {
XCTAssertTrue(capturedResult.count == 1);
NSDictionary* suggestionsJSON1 = capturedResult.firstObject;
XCTAssertEqualObjects(suggestionsJSON1[@"startIndex"], @0);
XCTAssertEqualObjects(suggestionsJSON1[@"endIndex"], @4);
XCTAssertEqualObjects(suggestionsJSON1[@"endIndex"], @5);
XCTAssertEqualObjects(suggestionsJSON1[@"suggestions"], suggestions1);
[self.mockTextChecker reset];
[textCheckerClassMock stopMocking];
Expand Down Expand Up @@ -270,6 +270,29 @@ - (void)testUnsupportedLanguageShouldReturnNil {
[textCheckerClassMock stopMocking];
}

- (void)testSupportSubLanguage {
self.partialMockPlugin = OCMPartialMock(self.plugin);
OCMStub([self.partialMockPlugin textChecker]).andReturn(self.mockTextChecker);
id textCheckerClassMock = OCMClassMock([UITextChecker class]);
[[[textCheckerClassMock stub] andReturn:@[ @"en_us" ]] availableLanguages];
NSArray* suggestions1 = @[ @"suggestion 1", @"suggestion 2" ];

[self mockUITextCheckerWithExpectedMisspelledWordRange:NSMakeRange(0, 5)
startingIndex:0
suggestions:suggestions1];
__block NSArray* capturedResult;
[self.mockMethodChannel invokeMethod:@"SpellCheck.initiateSpellCheck"
arguments:@[ @"en-us", @"hejjo" ]
result:^(id _Nullable result) {
capturedResult = result;
}];
NSDictionary* suggestionsJSON1 = capturedResult.firstObject;
XCTAssertEqualObjects(suggestionsJSON1[@"startIndex"], @0);
XCTAssertEqualObjects(suggestionsJSON1[@"endIndex"], @5);
XCTAssertEqualObjects(suggestionsJSON1[@"suggestions"], suggestions1);
[textCheckerClassMock stopMocking];
}

- (void)testEmptyStringShouldReturnEmptyResults {
self.partialMockPlugin = OCMPartialMock(self.plugin);
OCMStub([self.partialMockPlugin textChecker]).andReturn(self.mockTextChecker);
Expand Down
3 changes: 2 additions & 1 deletion shell/platform/darwin/ios/framework/Source/FlutterViewController.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1654,7 +1654,8 @@ - (void)onUserSettingsChanged:(NSNotification*)notification {
@"textScaleFactor" : @([self textScaleFactor]),
@"alwaysUse24HourFormat" : @([self isAlwaysUse24HourFormat]),
@"platformBrightness" : [self brightnessMode],
@"platformContrast" : [self contrastMode]
@"platformContrast" : [self contrastMode],
@"nativeSpellCheckServiceDefined" : @true
}];
}

Expand Down