Merge pull request #35 from IO-Design-Team/feature/generate-adapters

Add generator support for `GenerateAdapters` annotation

hive/example/pubspec.yaml

@@ -17,9 +17,4 @@ dependency_overrides:
   hive_ce:
     path: ../
   hive_ce_generator:
-    # TODO: Revert
-    # path: ../../hive_generator
-    git:
-      url: https://github.com/IO-Design-Team/hive_ce
-      ref: 4f06756e5eee0b027f2e9d623e8136620309afcb
-      path: hive_generator
+    path: ../../hive_generator

hive_generator/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.8.0
+
+- Adds support for the `GenerateAdapters` annotation. See the [hive_ce documentation](https://pub.dev/packages/hive_ce) for more information.
+
 ## 1.7.0
 
 - Supports named imports

hive_generator/build.yaml

@@ -21,3 +21,17 @@ builders:
     build_extensions: { "$lib$": ["hive_registrar.g.dart"] }
     auto_apply: dependents
     build_to: source
+  hive_adapters_generator:
+    import: "package:hive_ce_generator/hive_generator.dart"
+    builder_factories: ["getAdaptersBuilder"]
+    build_extensions: { ".dart": ["hive_adapters_generator.g.part"] }
+    auto_apply: dependents
+    build_to: cache
+    applies_builders: ["source_gen|combining_builder"]
+  hive_schema_migrator:
+    import: "package:hive_ce_generator/hive_generator.dart"
+    builder_factories: ["getSchemaMigratorBuilder"]
+    build_extensions:
+      { "$lib$": ["hive/hive_adapters.yaml", "hive/hive_adapters.g.yaml"] }
+    auto_apply: none
+    build_to: source

hive_generator/example/lib/hive/hive_adapters.dart

@@ -0,0 +1,36 @@
+import 'package:hive_ce/hive.dart';
+
+part 'hive_adapters.g.dart';
+
+@GenerateAdapters(
+  [
+    AdapterSpec<ClassSpec1>(),
+    AdapterSpec<ClassSpec2>(),
+    AdapterSpec<EnumSpec>(),
+  ],
+  firstTypeId: 50,
+)
+// This is for code generation
+// ignore: unused_element
+void _() {}
+
+class ClassSpec1 {
+  final int value;
+  final int value2;
+
+  ClassSpec1(this.value, this.value2);
+}
+
+class ClassSpec2 {
+  final String value;
+  final String value2;
+
+  ClassSpec2(this.value, this.value2);
+}
+
+enum EnumSpec {
+  value1,
+  value2;
+
+  EnumSpec get getter => EnumSpec.value2;
+}

hive_generator/example/lib/hive/hive_adapters.g.yaml

@@ -0,0 +1,29 @@
+# Generated by Hive CE
+# Manual modifications may be necessary for certain migrations
+# Check in to version control
+nextTypeId: 53
+types:
+  ClassSpec1:
+    typeId: 50
+    nextIndex: 2
+    fields:
+      value:
+        index: 0
+      value2:
+        index: 1
+  ClassSpec2:
+    typeId: 51
+    nextIndex: 2
+    fields:
+      value:
+        index: 0
+      value2:
+        index: 1
+  EnumSpec:
+    typeId: 52
+    nextIndex: 2
+    fields:
+      value1:
+        index: 0
+      value2:
+        index: 1

hive_generator/example/lib/hive_registrar.g.dart → hive_generator/example/lib/hive/hive_registrar.g.dart

@@ -5,18 +5,20 @@
 // ignore_for_file: unnecessary_const, require_trailing_commas, document_ignores
 
 import 'package:hive_ce/hive.dart';
-import 'package:example/named_import.dart';
+import 'package:example/hive/hive_adapters.dart';
 import 'package:example/types.dart';
 
 extension HiveRegistrar on HiveInterface {
   void registerAdapters() {
     registerAdapter(Class1Adapter());
     registerAdapter(Class2Adapter());
+    registerAdapter(ClassSpec1Adapter());
+    registerAdapter(ClassSpec2Adapter());
     registerAdapter(ConstructorDefaultsAdapter());
     registerAdapter(EmptyClassAdapter());
     registerAdapter(Enum1Adapter());
+    registerAdapter(EnumSpecAdapter());
     registerAdapter(IterableClassAdapter());
-    registerAdapter(NamedImportTypeAdapter());
     registerAdapter(NamedImportsAdapter());
     registerAdapter(NullableTypesAdapter());
   }

hive_generator/example/lib/named_import.dart

@@ -1,6 +1 @@
-import 'package:hive_ce/hive.dart';
-
-part 'named_import.g.dart';
-
-@HiveType(typeId: 100)
 class NamedImportType {}

hive_generator/lib/hive_generator.dart

@@ -1,7 +1,9 @@
 import 'package:build/build.dart';
-import 'package:hive_ce_generator/src/registrar_builder.dart';
-import 'package:hive_ce_generator/src/registrar_intermediate_builder.dart';
-import 'package:hive_ce_generator/src/type_adapter_generator.dart';
+import 'package:hive_ce_generator/src/builder/schema_migrator_builder.dart';
+import 'package:hive_ce_generator/src/generator/adapters_generator.dart';
+import 'package:hive_ce_generator/src/builder/registrar_builder.dart';
+import 'package:hive_ce_generator/src/builder/registrar_intermediate_builder.dart';
+import 'package:hive_ce_generator/src/generator/type_adapter_generator.dart';
 import 'package:source_gen/source_gen.dart';
 
 /// Builds Hive TypeAdapters
@@ -14,3 +16,11 @@ Builder getRegistrarIntermediateBuilder(BuilderOptions options) =>
 
 /// Builds the HiveRegistrar extension
 Builder getRegistrarBuilder(BuilderOptions options) => RegistrarBuilder();
+
+/// Builds Hive TypeAdapters from the GenerateAdapters annotation
+Builder getAdaptersBuilder(BuilderOptions options) =>
+    SharedPartBuilder([AdaptersGenerator()], 'hive_adapters_generator');
+
+/// Builds a Hive schema from existing HiveType annotations
+Builder getSchemaMigratorBuilder(BuilderOptions options) =>
+    SchemaMigratorBuilder();

hive_generator/lib/src/builder.dart → hive_generator/lib/src/adapter_builder/adapter_builder.dart

@@ -4,6 +4,9 @@ import 'package:analyzer/dart/element/type.dart';
 
 /// Metadata about a field in a class adapter
 class AdapterField {
+  /// The corresponding element for this field
+  final PropertyAccessorElement element;
+
   /// The index of the field
   ///
   /// Determines the order fields are read and written
@@ -23,6 +26,7 @@ class AdapterField {
 
   /// Constructor
   AdapterField(
+    this.element,
     this.index,
     this.name,
     this.type,
@@ -32,7 +36,7 @@ class AdapterField {
 }
 
 /// TODO: Document this!
-abstract class Builder {
+abstract class AdapterBuilder {
   /// TODO: Document this!
   final InterfaceElement cls;
 
@@ -43,7 +47,11 @@ abstract class Builder {
   final List<AdapterField> setters;
 
   /// TODO: Document this!
-  Builder(this.cls, this.getters, [this.setters = const <AdapterField>[]]);
+  AdapterBuilder(
+    this.cls,
+    this.getters, [
+    this.setters = const <AdapterField>[],
+  ]);
 
   /// TODO: Document this!
   String buildRead();

hive_generator/lib/src/class_builder.dart → hive_generator/lib/src/adapter_builder/class_adapter_builder.dart

@@ -5,16 +5,16 @@ import 'package:analyzer/dart/element/nullability_suffix.dart';
 import 'package:analyzer/dart/element/type.dart';
 import 'package:collection/collection.dart';
 import 'package:hive_ce/hive.dart';
-import 'package:hive_ce_generator/src/builder.dart';
+import 'package:hive_ce_generator/src/adapter_builder/adapter_builder.dart';
 import 'package:hive_ce_generator/src/helper/helper.dart';
 import 'package:source_gen/source_gen.dart';
 
 import 'package:hive_ce_generator/src/helper/type_helper.dart';
 
 /// TODO: Document this!
-class ClassBuilder extends Builder {
+class ClassAdapterBuilder extends AdapterBuilder {
   /// TODO: Document this!
-  ClassBuilder(
+  ClassAdapterBuilder(
     super.cls,
     super.getters,
     super.setters,

hive_generator/lib/src/enum_builder.dart → hive_generator/lib/src/adapter_builder/enum_adapter_builder.dart

@@ -1,9 +1,9 @@
-import 'package:hive_ce_generator/src/builder.dart';
+import 'package:hive_ce_generator/src/adapter_builder/adapter_builder.dart';
 
 /// TODO: Document this!
-class EnumBuilder extends Builder {
+class EnumAdapterBuilder extends AdapterBuilder {
   /// TODO: Document this!
-  EnumBuilder(super.cls, super.getters);
+  EnumAdapterBuilder(super.cls, super.getters);
 
   @override
   String buildRead() {