feat!: migrate to the new element model and remove SerializableLibrary

SerializableLibrary has been removed to simplify the dogs_generator and make it easier to keep it up to date with the upstream analyzer. Porting this to the new directive-based annotation discovery would have been hell since I would have to rewrite portions of lyell for this to properly work. Additionally, the feature was finicky to use and prone to errors anyway.

Refs: #19

Author: helightdev

benchmarks/pubspec.lock

@@ -76,30 +76,6 @@ class Serializable {
   const Serializable({this.serialName});
 }
 
-/// Marks a library import as dogs serializable.
-///
-/// All types defined inside or exported by the library will be considered
-/// serializable. The [include] and [exclude] parameters can be used to
-/// further restrict the set of serializable types.
-///
-/// Types that semantically match a structure conformity or compatibility check must also be
-/// correct, invalid items will not be skipped but throw an exception. You must explicitly exclude
-/// types that are not serializable using the [exclude] parameter, or only include types that are
-/// serializable using the [include] parameter.
-///
-/// For built_value types, the not serializable builder will automatically be excluded, but will be
-/// used for the generation of the actual type converter.
-class SerializableLibrary {
-  /// A list of regex patterns that match the type identifiers to include in the serialization.
-  final List<String>? include;
-
-  /// A list of regex patterns that match the type identifiers to exclude from the serialization.
-  final List<String>? exclude;
-
-  /// see @[SerializableLibrary].
-  const SerializableLibrary({this.include, this.exclude});
-}
-
 /// Marks a class or enum as serializable.
 const serializable = Structure(serializable: true);
 

packages/dogs_core/lib/src/converter.dart

@@ -13,14 +13,14 @@ builders:
   dogs_bindings:
     import: "package:dogs_generator/integrations.dart"
     builder_factories: [ "dogsBindings" ]
-    build_extensions: { ".dart": [ ".conv.dogs", ".slib.dogs" ] }
+    build_extensions: { ".dart": [ ".conv.dogs" ] }
     runs_before: [ "dogs_generator:dogs_reactor" ]
     auto_apply: root_package
     build_to: cache
   dogs_descriptors:
     import: "package:dogs_generator/integrations.dart"
     builder_factories: [ "dogsConverters" ]
-    build_extensions: { ".dart": [ ".conv.g.dart", "slib.g.dart" ] }
+    build_extensions: { ".dart": [ ".conv.g.dart"] }
     auto_apply: root_package
     build_to: source
   dogs_reactor:

packages/dogs_generator/build.yaml

@@ -95,23 +95,22 @@ Future<IRStructure> structurizeBuilt(SubjectCodeContext codeContext,
   var builderElement =
       builtInterfaceImpl.typeArguments[1].element! as ClassElement;
 
-  var getters = builderElement.accessors
-      .where((element) =>
-          element.isGetter && element.isPublic && !element.isStatic)
+  var getters = builderElement.getters
+      .where((element) => element.isPublic && !element.isStatic)
       .toList();
 
   var fields = <IRStructureField>[];
   for (var builderGetter in getters) {
-    var fieldGetter = element.getGetter(builderGetter.name)!;
-    var fieldName = fieldGetter.name;
+    var fieldGetter = element.getGetter(builderGetter.name!)!;
+    var fieldName = fieldGetter.name!;
     var fieldType = fieldGetter.returnType;
     var serialType = await getSerialType(fieldType, context);
     var iterableType = await getIterableType(fieldType, context);
 
     var optional = fieldType.nullabilitySuffix == NullabilitySuffix.question;
     if (fieldType is DynamicType) optional = true;
 
-    var builtValueFieldAnnotation = fieldGetter.metadata
+    var builtValueFieldAnnotation = fieldGetter.metadata.annotations
         .whereTypeChecker(builtValueFieldChecker)
         .firstOrNull
         ?.computeConstantValue();
@@ -140,7 +139,7 @@ Future<IRStructure> structurizeBuilt(SubjectCodeContext codeContext,
   return IRStructure(
     codeContext.className(element),
     StructureConformity.basic,
-    element.name,
+    element.name!,
     fields,
     getRetainedAnnotationSourceArray(element, counter),
   );
@@ -203,7 +202,7 @@ Future<void> writeBuiltInteropConverter(ClassElement element,
       ..static = true
       ..lambda = false
       ..body = Code(
-          "return (${typeRef}Builder()\n${builderElement.accessors.where((element) => element.isGetter && element.isPublic && !element.isStatic).mapIndexed((i, e) {
+          "return (${typeRef}Builder()\n${builderElement.getters.where((element) => element.isPublic && !element.isStatic).mapIndexed((i, e) {
         if (listBuilderChecker.isAssignableFromType(e.returnType)) {
           var innerType =
               e.returnType.asInstanceOf(listBuilderInterface)!.typeArguments[0];

packages/dogs_generator/lib/analyze/built_interop.dart

@@ -21,15 +21,16 @@ import 'package:dogs_generator/dogs_generator.dart';
 import 'package:lyell_gen/lyell_gen.dart';
 import 'package:source_gen/source_gen.dart';
 
-final _iterableChecker = TypeChecker.fromRuntime(Iterable);
-final _listChecker = TypeChecker.fromRuntime(List);
-final _setChecker = TypeChecker.fromRuntime(Set);
-final _stringChecker = TypeChecker.fromRuntime(String);
-final _intChecker = TypeChecker.fromRuntime(int);
-final _doubleChecker = TypeChecker.fromRuntime(double);
-final _boolChecker = TypeChecker.fromRuntime(bool);
+final _iterableChecker = TypeChecker.typeNamed(Iterable, inSdk: true);
+final _listChecker = TypeChecker.typeNamed(List, inSdk: true);
+final _setChecker = TypeChecker.typeNamed(Set, inSdk: true);
+final _stringChecker = TypeChecker.typeNamed(String, inSdk: true);
+final _intChecker = TypeChecker.typeNamed(int, inSdk: true);
+final _doubleChecker = TypeChecker.typeNamed(double, inSdk: true);
+final _boolChecker = TypeChecker.typeNamed(bool, inSdk: true);
 
 bool isDogPrimitiveType(DartType type) {
+  if (type is DynamicType || type is VoidType) return true;
   return _stringChecker.isExactlyType(type) ||
       _intChecker.isExactlyType(type) ||
       _doubleChecker.isExactlyType(type) ||
@@ -59,19 +60,19 @@ Future<IterableKind> getIterableType(
 }
 
 String getStructureMetadataSourceArray(Element element) {
-  var conditionChecker = TypeChecker.fromRuntime(StructureMetadata);
+  var conditionChecker = TypeChecker.typeNamed(StructureMetadata);
   var annotations = <String>[];
-  for (var value in element.metadata.whereTypeChecker(conditionChecker)) {
+  for (var value in element.metadata.annotations.whereTypeChecker(conditionChecker)) {
     annotations.add(value.toSource().substring(1));
   }
   return "[${annotations.join(", ")}]";
 }
 
 String getStructureMetadataSourceArrayAliased(
     Element element, List<AliasImport> imports, StructurizeCounter counter) {
-  var conditionChecker = TypeChecker.fromRuntime(StructureMetadata);
+  var conditionChecker = TypeChecker.typeNamed(StructureMetadata);
   var annotations = <String>[];
-  for (var value in element.metadata.whereTypeChecker(conditionChecker)) {
+  for (var value in element.metadata.annotations.whereTypeChecker(conditionChecker)) {
     var cszp = "$szPrefix${counter.getAndIncrement()}";
     var import = AliasImport.library(
         (value.element as ConstructorElement).library, cszp);

packages/dogs_generator/lib/analyze/introspect.dart

@@ -95,14 +95,14 @@ class StructurizeCounter {
 }
 
 String szPrefix = "sz";
-TypeChecker propertyNameChecker = TypeChecker.fromRuntime(PropertyName);
+TypeChecker propertyNameChecker = TypeChecker.typeNamed(PropertyName);
 TypeChecker propertySerializerChecker =
-    TypeChecker.fromRuntime(PropertySerializer);
-TypeChecker dataclassChecker = TypeChecker.fromRuntime(Dataclass);
-TypeChecker mapChecker = TypeChecker.fromRuntime(Map);
-TypeChecker beanIgnoreChecker = TypeChecker.fromRuntime(beanIgnore.runtimeType);
-TypeChecker serializableChecker = TypeChecker.fromRuntime(Serializable);
-TypeChecker enumPropertyChecker = TypeChecker.fromRuntime(EnumProperty);
+    TypeChecker.typeNamed(PropertySerializer);
+TypeChecker dataclassChecker = TypeChecker.typeNamed(Dataclass);
+TypeChecker mapChecker = TypeChecker.typeNamed(Map);
+TypeChecker beanIgnoreChecker = TypeChecker.typeNamed(beanIgnore.runtimeType);
+TypeChecker serializableChecker = TypeChecker.typeNamed(Serializable);
+TypeChecker enumPropertyChecker = TypeChecker.typeNamed(EnumProperty);
 
 Future<StructurizeResult> structurizeConstructor(
     DartType type,
@@ -113,7 +113,7 @@ Future<StructurizeResult> structurizeConstructor(
   List<AliasImport> imports = [];
   List<IRStructureField> fields = [];
   var element = type.element! as ClassElement;
-  var serialName = element.name;
+  var serialName = element.name!;
   serialName = settings.nameCase.recase(serialName);
 
   // Check for Serializable annotation and override serialName if applicable
@@ -132,7 +132,7 @@ Future<StructurizeResult> structurizeConstructor(
     constructorName = ".dog";
   }
 
-  for (var e in constructorElement.parameters) {
+  for (var e in constructorElement.formalParameters) {
     String? fieldName;
     DartType? fieldType;
     Element? fieldElement;
@@ -142,7 +142,7 @@ Future<StructurizeResult> structurizeConstructor(
       fieldType = e.type;
       fieldElement = e.field;
     } else if (e is SuperFormalParameterElement) {
-      FieldFormalParameterElement resolveUntilFieldFormal(ParameterElement e) {
+      FieldFormalParameterElement resolveUntilFieldFormal(FormalParameterElement e) {
         if (e is FieldFormalParameterElement) return e;
         if (e is SuperFormalParameterElement) {
           return resolveUntilFieldFormal(e.superConstructorParameter!);
@@ -156,9 +156,8 @@ Future<StructurizeResult> structurizeConstructor(
       fieldElement = field;
     } else {
       var parameterType = e.type;
-      var namedField = element.getField(e.name);
-      var namedGetter = element.augmented
-          .lookUpGetter(name: e.name, library: element.library);
+      var namedField = element.getField(e.name!);
+      var namedGetter = element.lookUpGetter(name: e.name!, library: element.library);
       if (namedField != null && namedGetter == null) {
         fieldName = e.name;
         fieldType = namedField.type;
@@ -220,7 +219,7 @@ Future<StructurizeResult> structurizeConstructor(
   // Create proxy arguments
   var getters = fields.map((e) => e.accessor).toList();
   var activator =
-      "return ${counter.get(element.thisType)}$constructorName(${constructorElement.parameters.mapIndexed((i, e) {
+      "return ${counter.get(element.thisType)}$constructorName(${constructorElement.formalParameters.mapIndexed((i, e) {
     if (e.isNamed) {
       return "${e.name}: list[$i]";
     } else {
@@ -246,7 +245,7 @@ Future<StructurizeResult> structurizeBean(
   List<AliasImport> imports = [];
   List<IRStructureField> fields = [];
   var element = type.element! as ClassElement;
-  var serialName = element.name;
+  var serialName = element.name!;
   serialName = settings.nameCase.recase(serialName);
 
   // Check for Serializable annotation and override serialName if applicable
@@ -259,12 +258,12 @@ Future<StructurizeResult> structurizeBean(
   }
 
   var beanFields = classElement.fields.where((element) {
-    var field = classElement.getField(element.name)!;
+    var field = classElement.getField(element.name!)!;
     if (beanIgnoreChecker.hasAnnotationOf(field)) return false;
     return field.getter != null && field.setter != null;
   }).toList();
   for (var field in beanFields) {
-    var fieldName = field.name;
+    var fieldName = field.name!;
     var fieldType = field.type;
     var serialType = await getSerialType(fieldType, context);
     var iterableType = await getIterableType(fieldType, context);

packages/dogs_generator/lib/analyze/structurize.dart

@@ -31,7 +31,7 @@ class ConverterBuilder extends DogsAdapter<Serializable> {
     var emitter = DartEmitter();
     var converterName = "${element.name}Converter";
 
-    String serialName = element.name;
+    String serialName = element.name!;
     serialName = settings.nameCase.recase(serialName);
 
     var serializableValue = serializableChecker.firstAnnotationOf(element);
@@ -44,7 +44,7 @@ class ConverterBuilder extends DogsAdapter<Serializable> {
     final fieldValueMap =
         Map.fromEntries(element.fields.where((e) => e.isEnumConstant).map((e) {
       final actual = e.name;
-      var serializedName = e.name;
+      var serializedName = e.name!;
       serializedName = settings.enumCase.recase(serializedName);
 
       final propertyName = propertyNameChecker.firstAnnotationOf(e);
@@ -133,7 +133,7 @@ class ConverterBuilder extends DogsAdapter<Serializable> {
       constructor = element.getNamedConstructor("dog");
     }
     StructurizeResult structurized;
-    if (constructor != null && constructor.parameters.isNotEmpty) {
+    if (constructor != null && constructor.formalParameters.isNotEmpty) {
       // Create constructor based serializable
       structurized = await structurizeConstructor(
           element.thisType, settings, constructor, genContext, codeContext.cachedCounter);
@@ -394,7 +394,7 @@ If you wish to use class-level generics, please implement a TreeBaseConverterFac
         builder.body = Code(bodyBuilder.toString());
       }));
 
-      var hasRebuildHook = TypeChecker.fromRuntime(PostRebuildHook)
+      var hasRebuildHook = TypeChecker.typeNamed(PostRebuildHook)
           .isAssignableFromType(element.thisType);
 
       builder.methods.add(Method((builder) => builder