Migrate to Element2 APIs (kevmoo#87)

Author: davidmorgan

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.3.0-dev
+
+- Switch to analyzer element2 model and `build: ^3.0.0-dev`.
+
 ## 1.2.0
 
 - Require `build: ^2.5.0`.

example/example_generator.dart

@@ -1,4 +1,4 @@
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:build/build.dart';
 import 'package:source_gen/source_gen.dart';
 
@@ -11,41 +11,39 @@ class ExampleGenerator extends GeneratorForAnnotation<ExampleAnnotation> {
 
   @override
   Iterable<String> generateForAnnotatedElement(
-    // ignore: deprecated_member_use
-    Element element,
+    Element2 element,
     ConstantReader annotation,
     BuildStep buildStep,
   ) sync* {
     assert(!annotation.isNull, 'The source annotation should be set!');
 
-    if (element.name!.contains('Bad')) {
+    if (element.name3!.contains('Bad')) {
       log.info('This member might be not good.');
     }
 
-    // ignore: deprecated_member_use
-    if (element is! ClassElement) {
+    if (element is! ClassElement2) {
       throw InvalidGenerationSourceError(
         'Only supports annotated classes.',
         todo: 'Remove `TestAnnotation` from the associated element.',
         element: element,
       );
     }
 
-    if (requireTestClassPrefix && !element.name.startsWith('TestClass')) {
+    if (requireTestClassPrefix && !element.name3!.startsWith('TestClass')) {
       throw InvalidGenerationSourceError(
         'All classes must start with `TestClass`.',
         todo: 'Rename the type or remove the `TestAnnotation` from class.',
         element: element,
       );
     }
 
-    yield 'const ${element.name}NameLength = ${element.name.length};';
-    yield 'const ${element.name}NameLowerCase = '
-        "'${element.name.toLowerCase()}';";
+    yield 'const ${element.name3!}NameLength = ${element.name3!.length};';
+    yield 'const ${element.name3!}NameLowerCase = '
+        "'${element.name3!.toLowerCase()}';";
 
     if (annotation.read('includeUpperCase').literalValue as bool) {
-      yield 'const ${element.name}NameUpperCase = '
-          "'${element.name.toUpperCase()}';";
+      yield 'const ${element.name3!}NameUpperCase = '
+          "'${element.name3!.toUpperCase()}';";
     }
   }
 

lib/src/expectation_element.dart

@@ -1,5 +1,5 @@
 import 'package:analyzer/dart/constant/value.dart';
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:meta/meta.dart';
 import 'package:source_gen/source_gen.dart';
 
@@ -10,8 +10,8 @@ List<ExpectationElement> genAnnotatedElements(
   Set<String> configDefaults,
 ) {
   final allElements = libraryReader.allElements
-    .where((element) => element.name != null)
-    .toList(growable: false)..sort((a, b) => a.name!.compareTo(b.name!));
+    .where((element) => element.name3 != null)
+    .toList(growable: false)..sort((a, b) => a.name3!.compareTo(b.name3!));
 
   return allElements.expand((element) {
     final initialValues = _expectationElements(element).toList();
@@ -60,7 +60,7 @@ List<ExpectationElement> genAnnotatedElements(
       }
       assert(te.configurations!.isNotEmpty);
 
-      return ExpectationElement._(te, element.name!);
+      return ExpectationElement._(te, element.name3!);
     });
   }).toList();
 }
@@ -71,8 +71,7 @@ const _mappers = {
   TypeChecker.fromRuntime(ShouldThrow): _shouldThrow,
 };
 
-// ignore: deprecated_member_use
-Iterable<TestExpectation> _expectationElements(Element element) sync* {
+Iterable<TestExpectation> _expectationElements(Element2 element) sync* {
   for (var entry in _mappers.entries) {
     for (var annotation in entry.key.annotationsOf(element)) {
       yield entry.value(annotation);

lib/src/generate_for_element.dart

@@ -1,8 +1,8 @@
-// ignore_for_file: implementation_imports, deprecated_member_use
+// ignore_for_file: implementation_imports
 
 import 'dart:async';
 
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:build/build.dart';
 import 'package:dart_style/dart_style.dart' as dart_style;
@@ -20,7 +20,7 @@ Future<String> generateForElement<T>(
   String name,
 ) async {
   final elements =
-      libraryReader.allElements.where((e) => e.name == name).toList();
+      libraryReader.allElements.where((e) => e.name3 == name).toList();
 
   if (elements.isEmpty) {
     throw ArgumentError.value(
@@ -30,13 +30,13 @@ Future<String> generateForElement<T>(
     );
   }
 
-  Element element;
+  Element2 element;
 
   if (elements.length == 1) {
     element = elements[0];
   } else {
     final rootProperties =
-        elements.whereType<PropertyInducingElement>().toList();
+        elements.whereType<PropertyInducingElement2>().toList();
     if (rootProperties.length == 1) {
       element = rootProperties[0];
     } else {
@@ -48,18 +48,18 @@ Future<String> generateForElement<T>(
 
   if (annotation == null) {
     final annotationFromTestLib =
-        element.metadata
+        (element as Annotatable).metadata2.annotations
             .map((ea) => ea.computeConstantValue()!)
             .where((obj) {
               if (obj.type is InterfaceType) {
-                final uri = (obj.type as InterfaceType).element.source.uri;
+                final uri = (obj.type as InterfaceType).element3.library2.uri;
                 return uri.isScheme('package') &&
                     uri.pathSegments.first == testPackageName;
               }
 
               return false;
             })
-            .where((obj) => obj.type!.element!.name == T.toString())
+            .where((obj) => obj.type!.element3!.name3 == T.toString())
             .toList();
 
     String msg;
@@ -70,7 +70,7 @@ Future<String> generateForElement<T>(
   NOTE: Could not find an annotation that matched
       ${generator.typeChecker}.
     Using a annotation with the same name from the synthetic library instead
-      ${(annotation.type as InterfaceType).element.source.uri}#${annotation.type!.element!.name}''';
+      ${(annotation.type as InterfaceType).element3.library2.firstFragment.source.uri}#${annotation.type!.element3!.name3}''';
     } else {
       msg = '''
   NOTE: Could not find an annotation that matched

lib/src/init_library_reader.dart

@@ -1,7 +1,7 @@
 import 'dart:async';
 import 'dart:io';
 
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:build/build.dart';
 import 'package:build_test/build_test.dart';
 import 'package:path/path.dart' as p;
@@ -88,8 +88,7 @@ class PathAwareLibraryReader extends LibraryReader {
   PathAwareLibraryReader({
     required this.directory,
     required this.fileName,
-    // ignore: deprecated_member_use
-    required LibraryElement element,
+    required LibraryElement2 element,
   }) : super(element);
 
   String get path => p.join(directory, fileName);

lib/src/test_annotated_classes.dart

@@ -1,7 +1,7 @@
 import 'dart:async';
 import 'dart:io';
 
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:meta/meta.dart';
 import 'package:path/path.dart' as p;
 import 'package:source_gen/source_gen.dart';
@@ -355,9 +355,8 @@ class AnnotatedTest<T> {
         assert(exp.element is String);
         expectedElementName = exp.element as String;
       }
-      // ignore: deprecated_member_use
-      elementMatcher = const TypeMatcher<Element>().having(
-        (e) => e.name,
+      elementMatcher = const TypeMatcher<Element2>().having(
+        (e) => e.name3,
         'name',
         expectedElementName,
       );

pubspec.yaml

@@ -1,5 +1,5 @@
 name: source_gen_test
-version: 1.2.0
+version: 1.3.0-dev
 description: >-
   Test support for the source_gen package.
   Includes helpers to make it easy to validate both success and failure cases.
@@ -10,7 +10,7 @@ environment:
 
 dependencies:
   analyzer: ">=6.5.0 <8.0.0"
-  build: ^2.5.0
+  build: ^3.0.0-dev
   build_test: ^3.2.0
   dart_style: '>=2.3.7 <4.0.0'
   meta: ^1.15.0
@@ -21,3 +21,10 @@ dependencies:
 dev_dependencies:
   collection: ^1.19.0
   dart_flutter_team_lints: ^3.0.0
+
+dependency_overrides:
+  source_gen:
+    git:
+      url: https://github.com/dart-lang/source_gen
+      path: source_gen
+      ref: 6c9702e7152e61b16c8adec3f3011bda738b0e29

test/init_library_reader_test.dart

@@ -30,11 +30,6 @@ void main() {
           'int badTestFunc()',
           'int badTestField',
           'class TestClass2',
-          'import source /source_gen_test/lib/annotations.dart',
-          'import source /__test__/lib/test_annotation.dart',
-          'import source dart:core',
-          'part unit package:__test__/test_part.dart',
-          'part source /__test__/lib/goldens/test_library_file_part_of_current.dart',
         ]),
       );
     });

test/test_generator.dart

@@ -1,4 +1,4 @@
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/dart/element/element2.dart';
 import 'package:build/build.dart';
 import 'package:collection/collection.dart';
 import 'package:source_gen/source_gen.dart';
@@ -16,23 +16,21 @@ class TestGenerator extends GeneratorForAnnotation<TestAnnotation> {
 
   @override
   Iterable<String> generateForAnnotatedElement(
-    // ignore: deprecated_member_use
-    Element element,
+    Element2 element,
     ConstantReader annotation,
     BuildStep buildStep,
   ) sync* {
     if (alwaysThrowVagueError) {
       throw InvalidGenerationSourceError('Uh...');
     }
 
-    if (element.name!.contains('Bad')) {
+    if (element.name3!.contains('Bad')) {
       log.info('This member might be not good.');
     }
 
-    // ignore: deprecated_member_use
-    if (element is ClassElement) {
-      final unsupportedFunc = element.methods.firstWhereOrNull(
-        (me) => me.name.contains('unsupported'),
+    if (element is ClassElement2) {
+      final unsupportedFunc = element.methods2.firstWhereOrNull(
+        (me) => me.name3!.contains('unsupported'),
       );
 
       if (unsupportedFunc != null) {
@@ -50,17 +48,17 @@ class TestGenerator extends GeneratorForAnnotation<TestAnnotation> {
       );
     }
 
-    if (requireTestClassPrefix && !element.name.startsWith('TestClass')) {
+    if (requireTestClassPrefix && !element.name3!.startsWith('TestClass')) {
       throw InvalidGenerationSourceError(
         'All classes must start with `TestClass`.',
         todo: 'Rename the type or remove the `TestAnnotation` from class.',
         element: element,
       );
     }
 
-    yield 'const ${element.name}NameLength = ${element.name.length};';
-    yield 'const ${element.name}NameLowerCase = '
-        "'${element.name.toLowerCase()}';";
+    yield 'const ${element.name3!}NameLength = ${element.name3!.length};';
+    yield 'const ${element.name3!}NameLowerCase = '
+        "'${element.name3!.toLowerCase()}';";
   }
 
   @override