Merge pull request #24 from IO-Design-Team/feature/support-freezed

Support freezed

hive/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.6.0
+
+- Adds `TargetKind.parameter` to `HiveField` to support `freezed`
+
 ## 2.5.0+2
 
 - Adds documentation for adding new fields (@vizakenjack)

hive/example/lib/freezed.dart

@@ -0,0 +1,15 @@
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:hive_ce/hive.dart';
+
+part 'freezed.freezed.dart';
+part 'freezed.g.dart';
+
+@freezed
+@HiveType(typeId: 100)
+class FreezedPerson with _$FreezedPerson {
+  const factory FreezedPerson({
+    @HiveField(0) required String firstName,
+    @HiveField(1) required String lastName,
+    @HiveField(2) required int age,
+  }) = _FreezedPerson;
+}

hive/example/lib/freezed.freezed.dart

@@ -0,0 +1,198 @@
+// coverage:ignore-file
+// GENERATED CODE - DO NOT MODIFY BY HAND
+// ignore_for_file: type=lint
+// ignore_for_file: unused_element, deprecated_member_use, deprecated_member_use_from_same_package, use_function_type_syntax_for_parameters, unnecessary_const, avoid_init_to_null, invalid_override_different_default_values_named, prefer_expression_function_bodies, annotate_overrides, invalid_annotation_target, unnecessary_question_mark
+
+part of 'freezed.dart';
+
+// **************************************************************************
+// FreezedGenerator
+// **************************************************************************
+
+T _$identity<T>(T value) => value;
+
+final _privateConstructorUsedError = UnsupportedError(
+    'It seems like you constructed your class using `MyClass._()`. This constructor is only meant to be used by freezed and you are not supposed to need it nor use it.\nPlease check the documentation here for more information: https://github.com/rrousselGit/freezed#adding-getters-and-methods-to-our-models');
+
+/// @nodoc
+mixin _$FreezedPerson {
+  @HiveField(0)
+  String get firstName => throw _privateConstructorUsedError;
+  @HiveField(1)
+  String get lastName => throw _privateConstructorUsedError;
+  @HiveField(2)
+  int get age => throw _privateConstructorUsedError;
+
+  /// Create a copy of FreezedPerson
+  /// with the given fields replaced by the non-null parameter values.
+  @JsonKey(includeFromJson: false, includeToJson: false)
+  $FreezedPersonCopyWith<FreezedPerson> get copyWith =>
+      throw _privateConstructorUsedError;
+}
+
+/// @nodoc
+abstract class $FreezedPersonCopyWith<$Res> {
+  factory $FreezedPersonCopyWith(
+          FreezedPerson value, $Res Function(FreezedPerson) then) =
+      _$FreezedPersonCopyWithImpl<$Res, FreezedPerson>;
+  @useResult
+  $Res call(
+      {@HiveField(0) String firstName,
+      @HiveField(1) String lastName,
+      @HiveField(2) int age});
+}
+
+/// @nodoc
+class _$FreezedPersonCopyWithImpl<$Res, $Val extends FreezedPerson>
+    implements $FreezedPersonCopyWith<$Res> {
+  _$FreezedPersonCopyWithImpl(this._value, this._then);
+
+  // ignore: unused_field
+  final $Val _value;
+  // ignore: unused_field
+  final $Res Function($Val) _then;
+
+  /// Create a copy of FreezedPerson
+  /// with the given fields replaced by the non-null parameter values.
+  @pragma('vm:prefer-inline')
+  @override
+  $Res call({
+    Object? firstName = null,
+    Object? lastName = null,
+    Object? age = null,
+  }) {
+    return _then(_value.copyWith(
+      firstName: null == firstName
+          ? _value.firstName
+          : firstName // ignore: cast_nullable_to_non_nullable
+              as String,
+      lastName: null == lastName
+          ? _value.lastName
+          : lastName // ignore: cast_nullable_to_non_nullable
+              as String,
+      age: null == age
+          ? _value.age
+          : age // ignore: cast_nullable_to_non_nullable
+              as int,
+    ) as $Val);
+  }
+}
+
+/// @nodoc
+abstract class _$$FreezedPersonImplCopyWith<$Res>
+    implements $FreezedPersonCopyWith<$Res> {
+  factory _$$FreezedPersonImplCopyWith(
+          _$FreezedPersonImpl value, $Res Function(_$FreezedPersonImpl) then) =
+      __$$FreezedPersonImplCopyWithImpl<$Res>;
+  @override
+  @useResult
+  $Res call(
+      {@HiveField(0) String firstName,
+      @HiveField(1) String lastName,
+      @HiveField(2) int age});
+}
+
+/// @nodoc
+class __$$FreezedPersonImplCopyWithImpl<$Res>
+    extends _$FreezedPersonCopyWithImpl<$Res, _$FreezedPersonImpl>
+    implements _$$FreezedPersonImplCopyWith<$Res> {
+  __$$FreezedPersonImplCopyWithImpl(
+      _$FreezedPersonImpl _value, $Res Function(_$FreezedPersonImpl) _then)
+      : super(_value, _then);
+
+  /// Create a copy of FreezedPerson
+  /// with the given fields replaced by the non-null parameter values.
+  @pragma('vm:prefer-inline')
+  @override
+  $Res call({
+    Object? firstName = null,
+    Object? lastName = null,
+    Object? age = null,
+  }) {
+    return _then(_$FreezedPersonImpl(
+      firstName: null == firstName
+          ? _value.firstName
+          : firstName // ignore: cast_nullable_to_non_nullable
+              as String,
+      lastName: null == lastName
+          ? _value.lastName
+          : lastName // ignore: cast_nullable_to_non_nullable
+              as String,
+      age: null == age
+          ? _value.age
+          : age // ignore: cast_nullable_to_non_nullable
+              as int,
+    ));
+  }
+}
+
+/// @nodoc
+
+class _$FreezedPersonImpl implements _FreezedPerson {
+  const _$FreezedPersonImpl(
+      {@HiveField(0) required this.firstName,
+      @HiveField(1) required this.lastName,
+      @HiveField(2) required this.age});
+
+  @override
+  @HiveField(0)
+  final String firstName;
+  @override
+  @HiveField(1)
+  final String lastName;
+  @override
+  @HiveField(2)
+  final int age;
+
+  @override
+  String toString() {
+    return 'FreezedPerson(firstName: $firstName, lastName: $lastName, age: $age)';
+  }
+
+  @override
+  bool operator ==(Object other) {
+    return identical(this, other) ||
+        (other.runtimeType == runtimeType &&
+            other is _$FreezedPersonImpl &&
+            (identical(other.firstName, firstName) ||
+                other.firstName == firstName) &&
+            (identical(other.lastName, lastName) ||
+                other.lastName == lastName) &&
+            (identical(other.age, age) || other.age == age));
+  }
+
+  @override
+  int get hashCode => Object.hash(runtimeType, firstName, lastName, age);
+
+  /// Create a copy of FreezedPerson
+  /// with the given fields replaced by the non-null parameter values.
+  @JsonKey(includeFromJson: false, includeToJson: false)
+  @override
+  @pragma('vm:prefer-inline')
+  _$$FreezedPersonImplCopyWith<_$FreezedPersonImpl> get copyWith =>
+      __$$FreezedPersonImplCopyWithImpl<_$FreezedPersonImpl>(this, _$identity);
+}
+
+abstract class _FreezedPerson implements FreezedPerson {
+  const factory _FreezedPerson(
+      {@HiveField(0) required final String firstName,
+      @HiveField(1) required final String lastName,
+      @HiveField(2) required final int age}) = _$FreezedPersonImpl;
+
+  @override
+  @HiveField(0)
+  String get firstName;
+  @override
+  @HiveField(1)
+  String get lastName;
+  @override
+  @HiveField(2)
+  int get age;
+
+  /// Create a copy of FreezedPerson
+  /// with the given fields replaced by the non-null parameter values.
+  @override
+  @JsonKey(includeFromJson: false, includeToJson: false)
+  _$$FreezedPersonImplCopyWith<_$FreezedPersonImpl> get copyWith =>
+      throw _privateConstructorUsedError;
+}

hive/example/lib/hive_registrar.g.dart

@@ -1,8 +1,10 @@
 import 'package:hive_ce/hive.dart';
+import 'package:example/freezed.dart';
 import 'package:example/main.dart';
 
 extension HiveRegistrar on HiveInterface {
   void registerAdapters() {
+    registerAdapter(FreezedPersonAdapter());
     registerAdapter(PersonAdapter());
   }
 }

hive/example/pubspec.yaml

@@ -2,11 +2,13 @@ name: example
 
 dependencies:
   hive_ce: any
+  freezed_annotation: ^2.4.4
 
 dev_dependencies:
   rexios_lints: ^8.2.0
   hive_ce_generator: any
   build_runner: any
+  freezed: ^2.5.7
 
 environment:
   sdk: ^3.0.0

hive/lib/src/annotations/hive_field.dart

@@ -6,6 +6,7 @@ part of '../../hive.dart';
   TargetKind.getter,
   TargetKind.setter,
   TargetKind.enumValue,
+  TargetKind.parameter,
 })
 class HiveField {
   /// The index of this field.

hive/pubspec.yaml

@@ -1,6 +1,6 @@
 name: hive_ce
 description: Hive Community Edition - A spiritual continuation of Hive v2
-version: 2.5.0+2
+version: 2.6.0
 homepage: https://github.com/IO-Design-Team/hive_ce/tree/main/hive
 documentation: https://docs.hivedb.dev/
 

hive_generator/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 1.6.0
 
+- Adds `.freezed.dart` to `required_inputs` to support `freezed`
 - Sorts adapters and uris in `HiveRegistrar`
 
 ## 1.5.0

hive_generator/build.yaml

@@ -6,6 +6,8 @@ builders:
     auto_apply: dependents
     build_to: cache
     applies_builders: ["source_gen|combining_builder"]
+    required_inputs:
+      - .freezed.dart
   hive_registrar_intermediate_generator:
     import: "package:hive_ce_generator/hive_generator.dart"
     builder_factories: ["getRegistrarIntermediateBuilder"]