Skip to content
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
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
7 changes: 2 additions & 5 deletions lib/src/model/container_member.dart
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,8 @@ mixin ContainerMember on ModelElement implements EnclosedElement {
as Container?;
}
// TODO(jcollins-g): move Extension specific code to [Extendable]
if (enclosingElement.isDocumented) {
return packageGraph.findCanonicalModelElementFor(enclosingElement.element)
as Container?;
}
return null;
return packageGraph.findCanonicalModelElementFor(enclosingElement.element)
as Container?;
}

@override
Expand Down
4 changes: 0 additions & 4 deletions lib/src/model/inheritable.dart
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,6 @@ mixin Inheritable on ContainerMember {
if (canonicalEnclosingContainer == null) {
return null;
}
// TODO(jcollins-g): factor out extension logic into [Extendable]
if (canonicalEnclosingContainer is Extension) {
return this;
}
return canonicalEnclosingContainer.allCanonicalModelElements
.firstWhereOrNull((m) =>
m.name == name &&
Expand Down
68 changes: 68 additions & 0 deletions test/dartdoc_test_base.dart
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ import 'package:meta/meta.dart';
import 'src/test_descriptor_utils.dart' as d;
import 'src/utils.dart';

/// Exception thrown for invalid use of [DartdocTestBase]'s api/
Copy link
Member

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed.

class DartdocTestBaseFailure implements Exception {
final String message;

DartdocTestBaseFailure(this.message);

@override
String toString() => message;
}

abstract class DartdocTestBase {
late final PackageMetaProvider packageMetaProvider;
late final MemoryResourceProvider resourceProvider;
Expand Down Expand Up @@ -65,6 +75,64 @@ analyzer:
d.file('lib.dart', '''
library $libraryName;

$libraryContent
'''),
]).createInMemory(resourceProvider, packagePath);

var packageGraph = await bootBasicPackage(
packagePath,
packageMetaProvider,
packageConfigProvider,
);
return packageGraph.libraries.named(libraryName);
}

/// Similar to [bootPackageWithLibrary], but allows for more complex
/// cases to test the edges of canonicalization.
///
/// - Puts [reexportedContent] in a library named [libraryName]_src in
/// `lib/src` (if [reexportPrivate] is true), or 'lib/subdir'.
/// - Creates a reexporting library named [libraryName]_lib in `lib` that
/// reexports [libraryName]_src.
/// - Creates [libraryName] containing [libraryContent] that can optionally
/// import 'lib.dart' to import the reexporting library.
///
/// Optionally, specify [show] or [hide] to change whether the reexport
/// gives access to the full namespace.
Future<Library> bootPackageWithReexportedLibrary(
String reexportedContent, String libraryContent,
{bool reexportPrivate = false,
List<String> show = const [],
List<String> hide = const []}) async {
final subdir = reexportPrivate ? 'src' : 'subdir';
await d.dir('lib', [
d.dir(subdir, [
d.file('lib.dart', '''
library ${libraryName}_src;

$reexportedContent
'''),
])
]).createInMemory(resourceProvider, packagePath);

if (show.isNotEmpty && hide.isNotEmpty) {
throw DartdocTestBaseFailure('Can not specify show and hide');
}

final showHideString = '${show.isNotEmpty ? 'show ${show.join(', ')}' : ''}'
'${hide.isNotEmpty ? 'hide ${hide.join(', ')}' : ''}';
await d.dir('lib', [
d.file('lib.dart', '''
library ${libraryName}_lib;

export '$subdir/lib.dart' $showHideString;
'''),
]).createInMemory(resourceProvider, packagePath);

await d.dir('lib', [
d.file('importing_lib.dart', '''
library $libraryName;

$libraryContent
'''),
]).createInMemory(resourceProvider, packagePath);
Expand Down
115 changes: 115 additions & 0 deletions test/extension_methods_test.dart
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');
}
}