|
| 1 | +// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file |
| 2 | +// for details. All rights reserved. Use of this source code is governed by a |
| 3 | +// BSD-style license that can be found in the LICENSE file. |
| 4 | + |
| 5 | +import 'package:dartdoc/src/model/model.dart'; |
| 6 | +import 'package:dartdoc/src/render/parameter_renderer.dart'; |
| 7 | +import 'package:test/test.dart'; |
| 8 | +import 'package:test_reflective_loader/test_reflective_loader.dart'; |
| 9 | + |
| 10 | +import 'dartdoc_test_base.dart'; |
| 11 | +import 'src/utils.dart'; |
| 12 | + |
| 13 | +void main() { |
| 14 | + defineReflectiveSuite(() { |
| 15 | + defineReflectiveTests(TypesTest); |
| 16 | + }); |
| 17 | +} |
| 18 | + |
| 19 | +@reflectiveTest |
| 20 | +class TypesTest extends DartdocTestBase { |
| 21 | + @override |
| 22 | + String get libraryName => 'types'; |
| 23 | + |
| 24 | + void test_setter_functionTypedParameter() async { |
| 25 | + var library = await bootPackageWithLibrary(''' |
| 26 | +class C { |
| 27 | + set f(p(int a, List<int> b)) {} |
| 28 | +} |
| 29 | +'''); |
| 30 | + var f = library.field('C', 'f'); |
| 31 | + expect(f.modelType.linkedName, matchesCompressed(''' |
| 32 | + dynamic Function |
| 33 | + <span class="signature">\\( |
| 34 | + <span class="parameter" id="p-param-a"> |
| 35 | + <span class="type-annotation"> |
| 36 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 37 | + </span> |
| 38 | + <span class="parameter-name">a</span>, |
| 39 | + </span> |
| 40 | + <span class="parameter" id="p-param-b"> |
| 41 | + <span class="type-annotation"> |
| 42 | + <a href="$dartCoreUrlPrefix/List-class.html">List</a> |
| 43 | + <span class="signature"><<wbr> |
| 44 | + <span class="type-parameter"> |
| 45 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 46 | + </span>> |
| 47 | + </span> |
| 48 | + </span> |
| 49 | + <span class="parameter-name">b</span> |
| 50 | + </span>\\) |
| 51 | + </span> |
| 52 | + ''')); |
| 53 | + } |
| 54 | + |
| 55 | + void test_field_substitutedTypes() async { |
| 56 | + var library = await bootPackageWithLibrary(''' |
| 57 | +class C<T> { |
| 58 | + List<T>? f; |
| 59 | +} |
| 60 | +class D extends C<int> {} |
| 61 | +'''); |
| 62 | + var f = library.field('D', 'f'); |
| 63 | + expect(f.modelType.linkedName, matchesCompressed(''' |
| 64 | + <a href="$dartCoreUrlPrefix/List-class.html">List</a> |
| 65 | + <span class="signature"><<wbr> |
| 66 | + <span class="type-parameter"> |
| 67 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 68 | + </span>> |
| 69 | + </span> |
| 70 | + ''')); |
| 71 | + } |
| 72 | + |
| 73 | + void test_getter_substitutedTypes() async { |
| 74 | + var library = await bootPackageWithLibrary(''' |
| 75 | +class C<T> { |
| 76 | + List<T> get f => []; |
| 77 | +} |
| 78 | +class D extends C<int> {} |
| 79 | +'''); |
| 80 | + var f = library.field('D', 'f').getter!; |
| 81 | + expect(f.modelType.returnType.linkedName, matchesCompressed(''' |
| 82 | + <a href="$dartCoreUrlPrefix/List-class.html">List</a> |
| 83 | + <span class="signature"><<wbr> |
| 84 | + <span class="type-parameter"> |
| 85 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 86 | + </span>> |
| 87 | + </span> |
| 88 | + ''')); |
| 89 | + } |
| 90 | + |
| 91 | + void test_setterParameter_substitutedTypes() async { |
| 92 | + var library = await bootPackageWithLibrary(''' |
| 93 | +class C<T> { |
| 94 | + set f(List<T> p) {} |
| 95 | +} |
| 96 | +class D extends C<int> {} |
| 97 | +'''); |
| 98 | + var f = library.field('D', 'f').setter!; |
| 99 | + expect(f.parameters.first.modelType.linkedName, matchesCompressed(''' |
| 100 | + <a href="$dartCoreUrlPrefix/List-class.html">List</a> |
| 101 | + <span class="signature"><<wbr> |
| 102 | + <span class="type-parameter"> |
| 103 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 104 | + </span>> |
| 105 | + </span> |
| 106 | + ''')); |
| 107 | + } |
| 108 | + |
| 109 | + void test_methodReturnType() async { |
| 110 | + var library = await bootPackageWithLibrary(''' |
| 111 | +abstract class C { |
| 112 | + List<int> m(); |
| 113 | +} |
| 114 | +'''); |
| 115 | + var m = library.method('C', 'm'); |
| 116 | + expect(m.modelType.returnType.linkedName, matchesCompressed(''' |
| 117 | + <a href="$dartCoreUrlPrefix/List-class.html">List</a> |
| 118 | + <span class="signature"><<wbr> |
| 119 | + <span class="type-parameter"> |
| 120 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 121 | + </span>> |
| 122 | + </span> |
| 123 | + ''')); |
| 124 | + } |
| 125 | + |
| 126 | + void test_methodReturnType_substitutedTypes() async { |
| 127 | + var library = await bootPackageWithLibrary(''' |
| 128 | +abstract class C<T> { |
| 129 | + List<T> m(); |
| 130 | +} |
| 131 | +class D extends C<int> {} |
| 132 | +'''); |
| 133 | + var m = library.method('D', 'm'); |
| 134 | + expect(m.modelType.returnType.linkedName, matchesCompressed(''' |
| 135 | + <a href="$dartCoreUrlPrefix/List-class.html">List</a> |
| 136 | + <span class="signature"><<wbr> |
| 137 | + <span class="type-parameter"> |
| 138 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 139 | + </span>> |
| 140 | + </span> |
| 141 | + ''')); |
| 142 | + } |
| 143 | + |
| 144 | + void test_methodReturnType_parameterizedTypedef() async { |
| 145 | + var library = await bootPackageWithLibrary(''' |
| 146 | +typedef String TD<T>(T p); |
| 147 | +abstract class C { |
| 148 | + TD<int> m(); |
| 149 | +} |
| 150 | +'''); |
| 151 | + var m = library.method('C', 'm'); |
| 152 | + expect(m.modelType.returnType.linkedName, matchesCompressed(''' |
| 153 | + <a href="${htmlBasePlaceholder}types/TD.html">TD</a> |
| 154 | + <span class="signature"><<wbr> |
| 155 | + <span class="type-parameter"> |
| 156 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 157 | + </span>> |
| 158 | + </span> |
| 159 | + ''')); |
| 160 | + } |
| 161 | + |
| 162 | + void test_methodReturnType_substitutedTypes_parameterizedTypedef() async { |
| 163 | + var library = await bootPackageWithLibrary(''' |
| 164 | +typedef String TD<T>(T p); |
| 165 | +abstract class C<T> { |
| 166 | + TD<T> m(); |
| 167 | +} |
| 168 | +class D extends C<int> {} |
| 169 | +'''); |
| 170 | + var m = library.method('D', 'm'); |
| 171 | + expect(m.modelType.returnType.linkedName, matchesCompressed(''' |
| 172 | + <a href="${htmlBasePlaceholder}types/TD.html">TD</a> |
| 173 | + <span class="signature"><<wbr> |
| 174 | + <span class="type-parameter"> |
| 175 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 176 | + </span>> |
| 177 | + </span> |
| 178 | + ''')); |
| 179 | + } |
| 180 | + |
| 181 | + void test_operatorTypes_substitutedTypes() async { |
| 182 | + var library = await bootPackageWithLibrary(''' |
| 183 | +abstract class C<T> { |
| 184 | + List<T> operator +(List<T> p); |
| 185 | +} |
| 186 | +class D extends C<int> {} |
| 187 | +'''); |
| 188 | + var plus = library.operator('D', 'operator +'); |
| 189 | + expect(plus.modelType.returnType.linkedName, matchesCompressed(''' |
| 190 | + <a href="$dartCoreUrlPrefix/List-class.html">List</a> |
| 191 | + <span class="signature"><<wbr> |
| 192 | + <span class="type-parameter"> |
| 193 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 194 | + </span>> |
| 195 | + </span> |
| 196 | + ''')); |
| 197 | + var renderedParameter = |
| 198 | + ParameterRendererHtml().renderLinkedParams(plus.parameters); |
| 199 | + expect(renderedParameter, matchesCompressed(''' |
| 200 | + <a href="$dartCoreUrlPrefix/List-class.html">List</a> |
| 201 | + <span class="signature"><<wbr> |
| 202 | + <span class="type-parameter"> |
| 203 | + <a href="$dartCoreUrlPrefix/int-class.html">int</a> |
| 204 | + </span>> |
| 205 | + </span> |
| 206 | + ''')); |
| 207 | + } |
| 208 | +} |
| 209 | + |
| 210 | +extension on Library { |
| 211 | + Field field(String className, String methodName) => classes |
| 212 | + .firstWhere((c) => c.name == className) |
| 213 | + .instanceFields |
| 214 | + .firstWhere((field) => field.name == methodName); |
| 215 | + |
| 216 | + Method method(String className, String methodName) => classes |
| 217 | + .firstWhere((clas) => clas.name == className) |
| 218 | + .instanceMethods |
| 219 | + .firstWhere((method) => method.name == methodName); |
| 220 | + |
| 221 | + Operator operator(String className, String methodName) => classes |
| 222 | + .firstWhere((clas) => clas.name == className) |
| 223 | + .instanceOperators |
| 224 | + .firstWhere((method) => method.name == methodName); |
| 225 | +} |
0 commit comments