Skip to content

Create renderers for more model classes and update some tests #2078

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

Merged
merged 4 commits into from
Nov 21, 2019
Merged
Show file tree
Hide file tree
Changes from all 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
15 changes: 5 additions & 10 deletions lib/src/model/enum.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
// TODO(jcollins-g): Consider Enum as subclass of Container?
import 'package:analyzer/dart/element/element.dart';
import 'package:dartdoc/src/model/model.dart';
import 'package:dartdoc/src/render/enum_field_renderer.dart';

class Enum extends Class {
Enum(ClassElement element, Library library, PackageGraph packageGraph)
Expand Down Expand Up @@ -32,24 +33,18 @@ class Enum extends Class {
/// Enum's fields are virtual, so we do a little work to create
/// usable values for the docs.
class EnumField extends Field {
int _index;
int index;

EnumField(FieldElement element, Library library, PackageGraph packageGraph,
Accessor getter, Accessor setter)
: super(element, library, packageGraph, getter, setter);

EnumField.forConstant(this._index, FieldElement element, Library library,
EnumField.forConstant(this.index, FieldElement element, Library library,
PackageGraph packageGraph, Accessor getter)
: super(element, library, packageGraph, getter, null);

@override
String get constantValueBase {
if (name == 'values') {
return 'const List&lt;<wbr><span class="type-parameter">${field.enclosingElement.name}</span>&gt;';
} else {
return 'const ${field.enclosingElement.name}($_index)';
}
}
String get constantValueBase => EnumFieldRendererHtml().renderValue(this);

@override
List<ModelElement> get documentationFrom {
Expand Down Expand Up @@ -87,7 +82,7 @@ class EnumField extends Field {
if (name == 'index') return false;
// If this is something inherited from Object, e.g. hashCode, let the
// normal rules apply.
if (_index == null) {
if (index == null) {
return super.isCanonical;
}
// TODO(jcollins-g): We don't actually document this as a separate entity;
Expand Down
74 changes: 7 additions & 67 deletions lib/src/model/model_element.dart
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import 'package:dartdoc/src/markdown_processor.dart' show Documentation;
import 'package:dartdoc/src/model/model.dart';
import 'package:dartdoc/src/model_utils.dart' as utils;
import 'package:dartdoc/src/render/parameter_renderer.dart';
import 'package:dartdoc/src/render/model_element_renderer.dart';
import 'package:dartdoc/src/source_linker.dart';
import 'package:dartdoc/src/tuple.dart';
import 'package:dartdoc/src/utils.dart';
Expand Down Expand Up @@ -1144,8 +1145,7 @@ abstract class ModelElement extends Canonicalization
return htmlEscape.convert(name);
}

var classContent = isDeprecated ? ' class="deprecated"' : '';
return '<a${classContent} href="${href}">$name</a>';
return ModelElementRendererHtml().renderLinkedName(this);
}

/// Replace &#123;@example ...&#125; in API comments with the content of named file.
Expand Down Expand Up @@ -1370,37 +1370,14 @@ abstract class ModelElement extends Canonicalization
warn(PackageWarning.invalidParameter,
message: 'A @youtube directive has an invalid URL: '
'"${positionalArgs[2]}". Supported YouTube URLs have the '
'follwing format: https://www.youtube.com/watch?v=oHg5SJYRHA0.');
'following format: https://www.youtube.com/watch?v=oHg5SJYRHA0.');
return '';
}
final String youTubeId = url.group(url.groupCount);
final String aspectRatio = (height / width * 100).toStringAsFixed(2);

// Blank lines before and after, and no indenting at the beginning and end
// is needed so that Markdown doesn't confuse this with code, so be
// careful of whitespace here.
return '''

<p style="position: relative;
padding-top: $aspectRatio%;">
<iframe src="https://www.youtube.com/embed/$youTubeId?rel=0"
frameborder="0"
allow="accelerometer;
autoplay;
encrypted-media;
gyroscope;
picture-in-picture"
allowfullscreen
style="position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;">
</iframe>
</p>

'''; // String must end at beginning of line, or following inline text will be
// indented.
return ModelElementRendererHtml()
.renderYoutubeUrl(youTubeId, aspectRatio);
});
}

Expand Down Expand Up @@ -1531,45 +1508,8 @@ abstract class ModelElement extends Canonicalization
'parameter)');
}

// Blank lines before and after, and no indenting at the beginning and end
// is needed so that Markdown doesn't confuse this with code, so be
// careful of whitespace here.
return '''

<div style="position: relative;">
<div id="${overlayId}"
onclick="var $uniqueId = document.getElementById('$uniqueId');
if ($uniqueId.paused) {
$uniqueId.play();
this.style.display = 'none';
} else {
$uniqueId.pause();
this.style.display = 'block';
}"
style="position:absolute;
width:${width}px;
height:${height}px;
z-index:100000;
background-position: center;
background-repeat: no-repeat;
background-image: url(static-assets/play_button.svg);">
</div>
<video id="$uniqueId"
style="width:${width}px; height:${height}px;"
onclick="var $overlayId = document.getElementById('$overlayId');
if (this.paused) {
this.play();
$overlayId.style.display = 'none';
} else {
this.pause();
$overlayId.style.display = 'block';
}" loop>
<source src="$movieUrl" type="video/mp4"/>
</video>
</div>

'''; // String must end at beginning of line, or following inline text will be
// indented.
return ModelElementRendererHtml()
.renderAnimation(uniqueId, width, height, movieUrl, overlayId);
});
}

Expand Down
15 changes: 3 additions & 12 deletions lib/src/model/type_parameter.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import 'package:analyzer/dart/element/element.dart';
import 'package:dartdoc/src/element_type.dart';
import 'package:dartdoc/src/model/model.dart';
import 'package:dartdoc/src/render/type_parameters_renderer.dart';

class TypeParameter extends ModelElement {
TypeParameter(
Expand Down Expand Up @@ -76,21 +77,11 @@ abstract class TypeParameters implements ModelElement {
bool get hasGenericParameters => typeParameters.isNotEmpty;

String get genericParameters {
if (typeParameters.isEmpty) return '';

var joined = typeParameters
.map((t) => t.name)
.join('</span>, <span class="type-parameter">');
return '&lt;<wbr><span class="type-parameter">${joined}</span>&gt;';
return TypeParametersRendererHtml().renderGenericParameters(this);
}

String get linkedGenericParameters {
if (typeParameters.isEmpty) return '';

var joined = typeParameters
.map((t) => t.linkedName)
.join('</span>, <span class="type-parameter">');
return '<span class="signature">&lt;<wbr><span class="type-parameter">${joined}</span>&gt;</span>';
return TypeParametersRendererHtml().renderLinkedGenericParameters(this);
}

@override
Expand Down
19 changes: 8 additions & 11 deletions lib/src/model/typedef.dart
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import 'package:analyzer/dart/element/element.dart';
import 'package:dartdoc/src/element_type.dart';
import 'package:dartdoc/src/model/model.dart';
import 'package:dartdoc/src/render/typedef_renderer.dart';

class Typedef extends ModelElement
with SourceCodeMixin, TypeParameters, Categorization
Expand All @@ -20,18 +21,14 @@ class Typedef extends ModelElement
String get nameWithGenerics => '$name${super.genericParameters}';

@override
String get genericParameters {
String get genericParameters =>
TypedefRendererHtml().renderGenericParameters(this);

List<TypeParameterElement> get genericTypeParameters {
if (element is GenericTypeAliasElement) {
List<TypeParameterElement> genericTypeParameters =
(element as GenericTypeAliasElement).function.typeParameters;
if (genericTypeParameters.isNotEmpty) {
var joined = genericTypeParameters
.map((t) => t.name)
.join('</span>, <span class="type-parameter">');
return '&lt;<wbr><span class="type-parameter">${joined}</span>&gt;';
}
} // else, all types are resolved.
return '';
return (element as GenericTypeAliasElement).function.typeParameters;
}
return Iterable.empty();
}

@override
Expand Down
20 changes: 20 additions & 0 deletions lib/src/render/enum_field_renderer.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Copyright (c) 2019, 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/model/enum.dart';

abstract class EnumFieldRenderer {
String renderValue(EnumField field);
}

class EnumFieldRendererHtml extends EnumFieldRenderer {
@override
String renderValue(EnumField field) {
if (field.name == 'values') {
return 'const List&lt;<wbr><span class="type-parameter">${field.enclosingElement.name}</span>&gt;';
} else {
return 'const ${field.enclosingElement.name}(${field.index})';
}
}
}
90 changes: 90 additions & 0 deletions lib/src/render/model_element_renderer.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
// Copyright (c) 2019, 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/model/model_element.dart';

abstract class ModelElementRenderer {
String renderLinkedName(ModelElement modelElement);

String renderYoutubeUrl(String youTubeId, String aspectRatio);

String renderAnimation(
String uniqueId, int width, int height, Uri movieUrl, String overlayId);
}

class ModelElementRendererHtml extends ModelElementRenderer {
@override
String renderLinkedName(ModelElement modelElement) {
var cssClass = modelElement.isDeprecated ? ' class="deprecated"' : '';
return '<a${cssClass} href="${modelElement.href}">${modelElement.name}</a>';
}

@override
String renderYoutubeUrl(String youTubeId, String aspectRatio) {
// Blank lines before and after, and no indenting at the beginning and end
// is needed so that Markdown doesn't confuse this with code, so be
// careful of whitespace here.
return '''

<p style="position: relative;
padding-top: $aspectRatio%;">
<iframe src="https://www.youtube.com/embed/$youTubeId?rel=0"
frameborder="0"
allow="accelerometer;
autoplay;
encrypted-media;
gyroscope;
picture-in-picture"
allowfullscreen
style="position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;">
</iframe>
</p>

'''; // Must end at start of line, or following inline text will be indented.
}

@override
String renderAnimation(
String uniqueId, int width, int height, Uri movieUrl, String overlayId) {
return '''

<div style="position: relative;">
<div id="${overlayId}"
onclick="var $uniqueId = document.getElementById('$uniqueId');
if ($uniqueId.paused) {
$uniqueId.play();
this.style.display = 'none';
} else {
$uniqueId.pause();
this.style.display = 'block';
}"
style="position:absolute;
width:${width}px;
height:${height}px;
z-index:100000;
background-position: center;
background-repeat: no-repeat;
background-image: url(static-assets/play_button.svg);">
</div>
<video id="$uniqueId"
style="width:${width}px; height:${height}px;"
onclick="var $overlayId = document.getElementById('$overlayId');
if (this.paused) {
this.play();
$overlayId.style.display = 'none';
} else {
this.pause();
$overlayId.style.display = 'block';
}" loop>
<source src="$movieUrl" type="video/mp4"/>
</video>
</div>

'''; // Must end at start of line, or following inline text will be indented.
}
}
34 changes: 34 additions & 0 deletions lib/src/render/type_parameters_renderer.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright (c) 2019, 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/model/type_parameter.dart';

abstract class TypeParametersRenderer {
String renderGenericParameters(TypeParameters typeParameters);
String renderLinkedGenericParameters(TypeParameters typeParameters);
}

class TypeParametersRendererHtml extends TypeParametersRenderer {
@override
String renderGenericParameters(TypeParameters typeParameters) {
if (typeParameters.typeParameters.isEmpty) {
return '';
}
var joined = typeParameters.typeParameters
.map((t) => t.name)
.join('</span>, <span class="type-parameter">');
return '&lt;<wbr><span class="type-parameter">${joined}</span>&gt;';
}

@override
String renderLinkedGenericParameters(TypeParameters typeParameters) {
if (typeParameters.typeParameters.isEmpty) {
return '';
}
var joined = typeParameters.typeParameters
.map((t) => t.linkedName)
.join('</span>, <span class="type-parameter">');
return '<span class="signature">&lt;<wbr><span class="type-parameter">${joined}</span>&gt;</span>';
}
}
22 changes: 22 additions & 0 deletions lib/src/render/typedef_renderer.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// Copyright (c) 2019, 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/model/typedef.dart';

abstract class TypedefRenderer {
String renderGenericParameters(Typedef typedef);
}

class TypedefRendererHtml extends TypedefRenderer {
@override
String renderGenericParameters(Typedef typedef) {
if (typedef.genericTypeParameters.isEmpty) {
return '';
}
var joined = typedef.genericTypeParameters
.map((t) => t.name)
.join('</span>, <span class="type-parameter">');
return '&lt;<wbr><span class="type-parameter">${joined}</span>&gt;';
}
}
Loading