Skip to content

Commit a962a5d

Browse files
committed
Fix some tests and dartfmt
1 parent 4e6f3c0 commit a962a5d

File tree

7 files changed

+39
-35
lines changed

7 files changed

+39
-35
lines changed

lib/src/model/model_element.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1375,8 +1375,8 @@ abstract class ModelElement extends Canonicalization
13751375
final String youTubeId = url.group(url.groupCount);
13761376
final String aspectRatio = (height / width * 100).toStringAsFixed(2);
13771377

1378-
return ModelElementRendererHtml().renderYoutubeUrl(
1379-
youTubeId, aspectRatio);
1378+
return ModelElementRendererHtml()
1379+
.renderYoutubeUrl(youTubeId, aspectRatio);
13801380
});
13811381
}
13821382

@@ -1507,8 +1507,8 @@ abstract class ModelElement extends Canonicalization
15071507
'parameter)');
15081508
}
15091509

1510-
return ModelElementRendererHtml().renderAnimation(
1511-
uniqueId, width, height, movieUrl, overlayId);
1510+
return ModelElementRendererHtml()
1511+
.renderAnimation(uniqueId, width, height, movieUrl, overlayId);
15121512
});
15131513
}
15141514

lib/src/model/type_parameter.dart

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,11 @@ abstract class TypeParameters implements ModelElement {
7777
bool get hasGenericParameters => typeParameters.isNotEmpty;
7878

7979
String get genericParameters {
80-
if (typeParameters.isEmpty) return '';
81-
return TypeParametersRendererHtml().renderGenericParameters(typeParameters);
80+
return TypeParametersRendererHtml().renderGenericParameters(this);
8281
}
8382

8483
String get linkedGenericParameters {
85-
if (typeParameters.isEmpty) return '';
86-
return TypeParametersRendererHtml()
87-
.renderLinkedGenericParameters(typeParameters);
84+
return TypeParametersRendererHtml().renderLinkedGenericParameters(this);
8885
}
8986

9087
@override

lib/src/model/typedef.dart

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,14 @@ class Typedef extends ModelElement
2121
String get nameWithGenerics => '$name${super.genericParameters}';
2222

2323
@override
24-
String get genericParameters {
24+
String get genericParameters =>
25+
TypedefRendererHtml().renderGenericParameters(this);
26+
27+
List<TypeParameterElement> get genericTypeParameters {
2528
if (element is GenericTypeAliasElement) {
26-
List<TypeParameterElement> genericTypeParameters =
27-
(element as GenericTypeAliasElement).function.typeParameters;
28-
if (genericTypeParameters.isNotEmpty) {
29-
return TypedefRendererHtml().renderGenericParameters(
30-
genericTypeParameters);
31-
}
32-
} // else, all types are resolved.
33-
return '';
29+
return (element as GenericTypeAliasElement).function.typeParameters;
30+
}
31+
return Iterable.empty();
3432
}
3533

3634
@override

lib/src/render/type_parameters_renderer.dart

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,28 @@
55
import 'package:dartdoc/src/model/type_parameter.dart';
66

77
abstract class TypeParametersRenderer {
8-
String renderGenericParameters(List<TypeParameter> typeParameters);
9-
String renderLinkedGenericParameters(List<TypeParameter> typeParameters);
8+
String renderGenericParameters(TypeParameters typeParameters);
9+
String renderLinkedGenericParameters(TypeParameters typeParameters);
1010
}
1111

1212
class TypeParametersRendererHtml extends TypeParametersRenderer {
1313
@override
14-
String renderGenericParameters(List<TypeParameter> typeParameters) {
15-
var joined = typeParameters
14+
String renderGenericParameters(TypeParameters typeParameters) {
15+
if (typeParameters.typeParameters.isEmpty) {
16+
return '';
17+
}
18+
var joined = typeParameters.typeParameters
1619
.map((t) => t.name)
1720
.join('</span>, <span class="type-parameter">');
1821
return '&lt;<wbr><span class="type-parameter">${joined}</span>&gt;';
1922
}
2023

2124
@override
22-
String renderLinkedGenericParameters(List<TypeParameter> typeParameters) {
23-
var joined = typeParameters
25+
String renderLinkedGenericParameters(TypeParameters typeParameters) {
26+
if (typeParameters.typeParameters.isEmpty) {
27+
return '';
28+
}
29+
var joined = typeParameters.typeParameters
2430
.map((t) => t.linkedName)
2531
.join('</span>, <span class="type-parameter">');
2632
return '<span class="signature">&lt;<wbr><span class="type-parameter">${joined}</span>&gt;</span>';

lib/src/render/typedef_renderer.dart

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,19 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
import 'package:analyzer/dart/element/element.dart';
5+
import 'package:dartdoc/src/model/typedef.dart';
66

77
abstract class TypedefRenderer {
8-
String renderGenericParameters(List<TypeParameterElement> typeParameters);
8+
String renderGenericParameters(Typedef typedef);
99
}
1010

1111
class TypedefRendererHtml extends TypedefRenderer {
1212
@override
13-
String renderGenericParameters(List<TypeParameterElement> typeParameters) {
14-
var joined = typeParameters
13+
String renderGenericParameters(Typedef typedef) {
14+
if (typedef.genericTypeParameters.isEmpty) {
15+
return '';
16+
}
17+
var joined = typedef.genericTypeParameters
1518
.map((t) => t.name)
1619
.join('</span>, <span class="type-parameter">');
1720
return '&lt;<wbr><span class="type-parameter">${joined}</span>&gt;';

test/model_special_cases_test.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ void main() {
459459
PackageWarning.invalidParameter,
460460
'A @youtube directive has an invalid URL: '
461461
'"http://host/path/to/video.mp4". Supported YouTube URLs have '
462-
'the follwing format: '
462+
'the following format: '
463463
'https://www.youtube.com/watch?v=oHg5SJYRHA0.'),
464464
isTrue);
465465
});
@@ -470,7 +470,7 @@ void main() {
470470
PackageWarning.invalidParameter,
471471
'A @youtube directive has an invalid URL: '
472472
'"https://www.youtube.com/watch?v=yI-8QHpGIP4&list=PLjxrf2q8roU23XGwz3Km7sQZFTdB996iG&index=5". '
473-
'Supported YouTube URLs have the follwing format: '
473+
'Supported YouTube URLs have the following format: '
474474
'https://www.youtube.com/watch?v=oHg5SJYRHA0.'),
475475
isTrue);
476476
});

test/model_test.dart

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import 'package:dartdoc/src/model/model.dart';
1111
import 'package:dartdoc/src/model_utils.dart';
1212
import 'package:dartdoc/src/render/category_renderer.dart';
1313
import 'package:dartdoc/src/render/enum_field_renderer.dart';
14+
import 'package:dartdoc/src/render/typedef_renderer.dart';
1415
import 'package:dartdoc/src/warnings.dart';
1516
import 'package:test/test.dart';
1617

@@ -1987,8 +1988,7 @@ void main() {
19871988
test("has a (synthetic) values constant", () {
19881989
var valuesField = animal.constants.firstWhere((f) => f.name == 'values');
19891990
expect(valuesField, isNotNull);
1990-
expect(
1991-
valuesField.constantValue,
1991+
expect(valuesField.constantValue,
19921992
equals(EnumFieldRendererHtml().renderValue(valuesField)));
19931993
expect(valuesField.documentation, startsWith('A constant List'));
19941994
});
@@ -3408,9 +3408,9 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
34083408
// TODO(jdkoren): Not easy to call TypedefRenderer directly because Typedef
34093409
// inspects its element member. Find a better way when we start to isolate
34103410
// renderer tests.
3411-
test("render generic parameters HTML", () {
3412-
expect(t.genericParameters, equals(''));
3413-
expect(generic.genericParameters,
3411+
test("TypedefRendererHtml renders genericParameters", () {
3412+
expect(TypedefRendererHtml().renderGenericParameters(t), equals(''));
3413+
expect(TypedefRendererHtml().renderGenericParameters(generic),
34143414
equals('&lt;<wbr><span class="type-parameter">S</span>&gt;'));
34153415
});
34163416
});

0 commit comments

Comments
 (0)