Skip to content
This repository has been archived by the owner on Feb 4, 2025. It is now read-only.

@JsonCodable() supports super toJson and fromJson. #89

Merged
merged 5 commits into from
Oct 10, 2024
Merged

@JsonCodable() supports super toJson and fromJson. #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9fbd365
@JsonCodable() supports super toJson and fromJson.
davidmorgan Oct 8, 2024
bb16d82
Address review comments.
davidmorgan Oct 8, 2024
10349da
Fix a typo.
davidmorgan Oct 8, 2024
30a29e3
Fix compile.
davidmorgan Oct 8, 2024
a25ecb5
Merge branch 'main' into json-superclasses
davidmorgan Oct 10, 2024
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
188 changes: 188 additions & 0 deletions goldens/foo/lib/foo.analyzer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,85 @@
"scopes": {
"Foo": {
"members": {
"construct": {
"properties": {
"isAbstract": false,
"isConstructor": true,
"isGetter": false,
"isField": false,
"isMethod": false,
"isStatic": false
},
"requiredPositionalParameters": [
{
"type": "NamedTypeDesc",
"value": {
"name": {
"uri": "dart:core",
"name": "int"
},
"instantiation": []
}
}
],
"optionalPositionalParameters": [],
"namedParameters": [
{
"type": "NamedTypeDesc",
"value": {
"name": {
"uri": "dart:core",
"name": "int"
},
"instantiation": []
}
}
]
},
"construct2": {
"properties": {
"isAbstract": false,
"isConstructor": true,
"isGetter": false,
"isField": false,
"isMethod": false,
"isStatic": false
},
"requiredPositionalParameters": [
{
"type": "NamedTypeDesc",
"value": {
"name": {
"uri": "dart:core",
"name": "int"
},
"instantiation": []
}
}
],
"optionalPositionalParameters": [
{
"type": "NullableTypeDesc",
"value": {
"inner": {
"type": "NamedTypeDesc",
"value": {
"name": {
"uri": "dart:core",
"name": "String"
},
"instantiation": []
}
}
}
}
],
"namedParameters": []
},
"bar": {
"properties": {
"isAbstract": false,
"isConstructor": false,
"isGetter": false,
"isField": true,
"isMethod": false,
Expand All @@ -22,14 +98,126 @@
"instantiation": []
}
}
},
"method": {
"properties": {
"isAbstract": false,
"isConstructor": false,
"isGetter": false,
"isField": false,
"isMethod": true,
"isStatic": false
},
"returnType": {
"type": "VoidTypeDesc"
},
"requiredPositionalParameters": [
{
"type": "NamedTypeDesc",
"value": {
"name": {
"uri": "dart:core",
"name": "int"
},
"instantiation": []
}
}
],
"optionalPositionalParameters": [],
"namedParameters": [
{
"type": "NullableTypeDesc",
"value": {
"inner": {
"type": "NamedTypeDesc",
"value": {
"name": {
"uri": "dart:core",
"name": "int"
},
"instantiation": []
}
}
}
}
]
},
"method2": {
"properties": {
"isAbstract": false,
"isConstructor": false,
"isGetter": false,
"isField": false,
"isMethod": true,
"isStatic": false
},
"returnType": {
"type": "NullableTypeDesc",
"value": {
"inner": {
"type": "NamedTypeDesc",
"value": {
"name": {
"uri": "package:foo/foo.dart",
"name": "Bar"
},
"instantiation": []
}
}
}
},
"requiredPositionalParameters": [
{
"type": "NamedTypeDesc",
"value": {
"name": {
"uri": "dart:core",
"name": "int"
},
"instantiation": []
}
}
],
"optionalPositionalParameters": [
{
"type": "NullableTypeDesc",
"value": {
"inner": {
"type": "NamedTypeDesc",
"value": {
"name": {
"uri": "dart:core",
"name": "String"
},
"instantiation": []
}
}
}
}
],
"namedParameters": []
}
}
},
"Bar": {
"members": {
"": {
"properties": {
"isAbstract": false,
"isConstructor": true,
"isGetter": false,
"isField": false,
"isMethod": false,
"isStatic": false
},
"requiredPositionalParameters": [],
"optionalPositionalParameters": [],
"namedParameters": []
},
"bar": {
"properties": {
"isAbstract": false,
"isConstructor": false,
"isGetter": false,
"isField": true,
"isMethod": false,
Expand Down
8 changes: 8 additions & 0 deletions goldens/foo/lib/foo.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ import 'package:_test_macros/query_class.dart';
@QueryClass()
class Foo {
final int bar = 3;

Foo.construct(int x, {required int y});
Foo.construct2(int x, [String? y]);

void method(int x, {int? y}) {}
Bar? method2(int x, [String? y]) {
return null;
}
}

@QueryClass()
Expand Down
17 changes: 17 additions & 0 deletions goldens/foo/lib/json_codable_test.analyzer.augmentations
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,23 @@ json[r'x'] = x;
return json;
}

}
augment class D {
// TODO(davidmorgan): see https://github.com/dart-lang/macros/issues/80.
// external D.fromJson(prefix0.Map<prefix0.String, prefix0.Object?> json);
// external prefix0.Map<prefix0.String, prefix0.Object?> toJson();

augment D.fromJson(prefix0.Map<prefix0.String, prefix0.Object?> json) :
y = json[r'y'] as prefix0.String,
super.fromJson(json);

augment prefix0.Map<prefix0.String, prefix0.Object?> toJson() {
final json = super.toJson();
json[r'y'] = y;

return json;
}

}
augment class E {
// TODO(davidmorgan): see https://github.com/dart-lang/macros/issues/80.
Expand Down
4 changes: 0 additions & 4 deletions goldens/foo/lib/json_codable_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ void main() {
expect(b.toJson(), isEmpty);
});

/* TODO(davidmorgan): make this test work.
test('class hierarchies', () {
var json = {
'x': 1,
Expand All @@ -118,7 +117,6 @@ void main() {

expect(d.toJson(), equals(json));
});
*/

test('collections of nullable objects', () {
var json = {
Expand Down Expand Up @@ -266,7 +264,6 @@ class C {
final int x;
}

/*
@JsonCodable()
class D extends C {
// TODO(davidmorgan): see https://github.com/dart-lang/macros/issues/80.
Expand All @@ -275,7 +272,6 @@ class D extends C {

final String y;
}
*/

@JsonCodable()
class E {
Expand Down
63 changes: 63 additions & 0 deletions pkgs/_analyzer_macros/lib/query_service.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,53 @@ class AnalyzerQueryService implements QueryService {
..addInterfaceElement(clazz);

final interface = Interface();
for (final constructor in clazz.constructors) {
interface.members[constructor.name] = Member(
requiredPositionalParameters: constructor
.requiredPositionalParameters(types.translator, types.context),
optionalPositionalParameters: constructor
.optionalPositionalParameters(types.translator, types.context),
namedParameters:
constructor.namedParameters(types.translator, types.context),
properties: Properties(
isAbstract: constructor.isAbstract,
isConstructor: true,
isGetter: false,
isField: false,
isMethod: false,
isStatic: false,
));
}
for (final field in clazz.fields) {
interface.members[field.name] = Member(
properties: Properties(
isAbstract: field.isAbstract,
isConstructor: false,
isGetter: false,
isField: true,
isMethod: false,
isStatic: field.isStatic,
),
returnType: types.addDartType(field.type));
}
for (final method in clazz.methods) {
interface.members[method.name] = Member(
requiredPositionalParameters: method.requiredPositionalParameters(
types.translator, types.context),
optionalPositionalParameters: method.optionalPositionalParameters(
types.translator, types.context),
namedParameters:
method.namedParameters(types.translator, types.context),
properties: Properties(
isAbstract: method.isAbstract,
isConstructor: false,
isGetter: false,
isField: false,
isMethod: true,
isStatic: method.isStatic,
),
returnType: types.addDartType(method.returnType));
}
return Model(types: types.typeHierarchy)
..uris[uri] = (Library()..scopes[clazz.name] = interface);
}
Expand Down Expand Up @@ -105,3 +141,30 @@ class AnalyzerTypeHierarchy {
);
}
}

extension ExecutableElementExtension on ExecutableElement {
List<StaticTypeDesc> requiredPositionalParameters(
AnalyzerTypesToMacros translator, TypeTranslationContext context) =>
[
for (final parameter in parameters)
if (parameter.isRequiredPositional)
parameter.type.acceptWithArgument(translator, context)
];

List<StaticTypeDesc> optionalPositionalParameters(
AnalyzerTypesToMacros translator, TypeTranslationContext context) =>
[
for (final parameter in parameters)
if (parameter.isOptionalPositional)
parameter.type.acceptWithArgument(translator, context)
];

List<NamedFunctionTypeParameter> namedParameters(
AnalyzerTypesToMacros translator, TypeTranslationContext context) =>
[
for (final parameter in parameters)
if (parameter.isNamed)
parameter.type.acceptWithArgument(translator, context)
as NamedFunctionTypeParameter
];
}
7 changes: 2 additions & 5 deletions pkgs/_macro_tool/lib/macro_tool.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,8 @@ abstract class MacroTool {
}

/// Returns [source] with lines added by [_addImportAugment] removed.
String _removeToolAddedLinesFromSource(String source) => source
.split('\n')
.where((l) => !l.endsWith(_addedMarker))
.map((l) => '$l\n')
.join();
String _removeToolAddedLinesFromSource(String source) =>
source.split('\n').where((l) => !l.endsWith(_addedMarker)).join('\n');
}

final String _addedMarker = '// added by macro_tool';
Expand Down
Loading