-
Notifications
You must be signed in to change notification settings - Fork 118
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
Fix a reexport case for comment reference linking to extension methods #3393
Merged
jcollins-g
merged 6 commits into
dart-lang:master
from
jcollins-g:canonicalization-problem-reset
Apr 24, 2023
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c91a388
recommit
jcollins-g 865610d
this works. but did it break anything else
jcollins-g 8d991db
fix up test
jcollins-g 17ca6e8
cleanup
jcollins-g d38356e
Merge branch 'master' into canonicalization-problem-reset
jcollins-g daa8454
period instead of slash
jcollins-g 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 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 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 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 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,115 @@ | ||
// Copyright (c) 2023, the Dart project authors. Please see the AUTHORS file | ||
// for details. All rights reserved. Use of this source code is governed by a | ||
// BSD-style license that can be found in the LICENSE file. | ||
|
||
import 'package:dartdoc/src/markdown_processor.dart'; | ||
import 'package:dartdoc/src/model/extension.dart'; | ||
import 'package:dartdoc/src/model/method.dart'; | ||
import 'package:dartdoc/src/model/model_element.dart'; | ||
import 'package:test/test.dart'; | ||
import 'package:test_reflective_loader/test_reflective_loader.dart'; | ||
|
||
import 'dartdoc_test_base.dart'; | ||
import 'src/utils.dart'; | ||
|
||
void main() { | ||
defineReflectiveSuite(() { | ||
if (classModifiersAllowed) { | ||
defineReflectiveTests(ExtensionMethodsTest); | ||
} | ||
}); | ||
} | ||
|
||
@reflectiveTest | ||
class ExtensionMethodsTest extends DartdocTestBase { | ||
@override | ||
String get libraryName => 'extension_methods'; | ||
|
||
static const String reexportedContent = ''' | ||
class AClassNotNeedingExtending {} | ||
|
||
class AClassNeedingExtending {} | ||
|
||
extension AnExtension on AClassNeedingExtending { | ||
void aMethod() {} | ||
} | ||
'''; | ||
|
||
static const String libraryContent = ''' | ||
/// This is an amazing public function. | ||
var aPublicFunction() {} | ||
'''; | ||
|
||
void expectReferenceValid( | ||
ModelElement reference, ModelElement expected, String href) { | ||
expect(identical(reference.canonicalModelElement, expected), isTrue); | ||
expect(expected.isCanonical, isTrue); | ||
expect(expected.href, endsWith(href)); | ||
} | ||
|
||
void test_reexportWithShow() async { | ||
var library = await bootPackageWithReexportedLibrary( | ||
reexportedContent, libraryContent, | ||
reexportPrivate: true, show: ['AClassNeedingExtending', 'AnExtension']); | ||
var aPublicFunction = library.functions.named('aPublicFunction'); | ||
var anExtension = library.package.publicLibraries | ||
.named('${libraryName}_lib') | ||
.extensions | ||
.named('AnExtension'); | ||
var anExtensionMethod = anExtension.instanceMethods.named('aMethod'); | ||
var anExtensionReference = | ||
getMatchingLinkElement('AnExtension', aPublicFunction).commentReferable | ||
as Extension; | ||
expectReferenceValid(anExtensionReference, anExtension, | ||
'%extension_methods_lib/AnExtension.html'); | ||
var anExtensionMethodReference = | ||
getMatchingLinkElement('AnExtension.aMethod', aPublicFunction) | ||
.commentReferable as Method; | ||
expectReferenceValid(anExtensionMethodReference, anExtensionMethod, | ||
'%extension_methods_lib/AnExtension/aMethod.html'); | ||
} | ||
|
||
void test_reexportWithHide() async { | ||
var library = await bootPackageWithReexportedLibrary( | ||
reexportedContent, libraryContent, | ||
reexportPrivate: true, hide: ['AClassNotNeedingExtending']); | ||
var aPublicFunction = library.functions.named('aPublicFunction'); | ||
var anExtension = library.package.publicLibraries | ||
.named('${libraryName}_lib') | ||
.extensions | ||
.named('AnExtension'); | ||
var anExtensionMethod = anExtension.instanceMethods.named('aMethod'); | ||
var anExtensionReference = | ||
getMatchingLinkElement('AnExtension', aPublicFunction).commentReferable | ||
as Extension; | ||
expectReferenceValid(anExtensionReference, anExtension, | ||
'%extension_methods_lib/AnExtension.html'); | ||
var anExtensionMethodReference = | ||
getMatchingLinkElement('AnExtension.aMethod', aPublicFunction) | ||
.commentReferable as Method; | ||
expectReferenceValid(anExtensionMethodReference, anExtensionMethod, | ||
'%extension_methods_lib/AnExtension/aMethod.html'); | ||
} | ||
|
||
void test_reexportFull() async { | ||
var library = await bootPackageWithReexportedLibrary( | ||
reexportedContent, libraryContent, | ||
reexportPrivate: true); | ||
var aPublicFunction = library.functions.named('aPublicFunction'); | ||
var anExtension = library.package.publicLibraries | ||
.named('${libraryName}_lib') | ||
.extensions | ||
.named('AnExtension'); | ||
var anExtensionMethod = anExtension.instanceMethods.named('aMethod'); | ||
var anExtensionReference = | ||
getMatchingLinkElement('AnExtension', aPublicFunction).commentReferable | ||
as Extension; | ||
expectReferenceValid(anExtensionReference, anExtension, | ||
'%extension_methods_lib/AnExtension.html'); | ||
var anExtensionMethodReference = | ||
getMatchingLinkElement('AnExtension.aMethod', aPublicFunction) | ||
.commentReferable as Method; | ||
expectReferenceValid(anExtensionMethodReference, anExtensionMethod, | ||
'%extension_methods_lib/AnExtension/aMethod.html'); | ||
} | ||
} |
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.
Should that end with a period?
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.
fixed.