Revert "experiment: generalize parameter makeGeneratedClassesFinal to classModifiers"

This reverts commit c071586.

Author: Yegair

packages/freezed/lib/src/models.dart

@@ -1041,15 +1041,8 @@ class Class {
     return '$escapedElementName$generics';
   }
 
-  String get classModifiers {
-    final modifiers = options.annotation.classModifiers;
-
-    if (modifiers.isEmpty) {
-      return '';
-    }
-
-    return '${modifiers.map((modifier) => modifier.lexeme).join(' ')} ';
-  }
+  bool get shouldBeFinal =>
+      options.annotation.makeGeneratedClassesFinal ?? false;
 }
 
 class PropertyList {
@@ -1087,7 +1080,6 @@ class ClassConfig {
     required this.asUnmodifiableCollections,
     required this.genericArgumentFactories,
     required this.annotation,
-    required this.modifiers,
   });
 
   static ClassConfig from(
@@ -1112,9 +1104,6 @@ class ClassConfig {
           resolvedAnnotation.makeCollectionsUnmodifiable!,
       genericArgumentFactories: resolvedAnnotation.genericArgumentFactories,
       annotation: resolvedAnnotation,
-      modifiers:
-          resolvedAnnotation.classModifiers.toNormalized()
-            ..throwIfInvalid(declaration.declaredElement),
     );
   }
 
@@ -1178,34 +1167,11 @@ class ClassConfig {
         },
         orElse: () => globalConfigs.unionValueCase,
       ),
-      classModifiers:
-          annotation
-              .decodeField(
-                'classModifiers',
-                decode: (obj) {
-                  final dartValues = obj.toListValue();
-
-                  if (dartValues == null) {
-                    return const <FreezedClassModifier>[];
-                  }
-
-                  final modifiers = <FreezedClassModifier>[];
-
-                  for (final value in dartValues) {
-                    final enumIndex = value.getField('index')?.toIntValue();
-
-                    if (enumIndex == null) {
-                      continue;
-                    }
-
-                    modifiers.add(FreezedClassModifier.values[enumIndex]);
-                  }
-
-                  return modifiers;
-                },
-                orElse: () => globalConfigs.classModifiers,
-              )
-              .toNormalized(),
+      makeGeneratedClassesFinal: annotation.decodeField(
+        'makeGeneratedClassesFinal',
+        decode: (obj) => obj.toBoolValue(),
+        orElse: () => globalConfigs.makeGeneratedClassesFinal,
+      ),
     );
   }
 
@@ -1216,7 +1182,6 @@ class ClassConfig {
   final bool asUnmodifiableCollections;
   final bool genericArgumentFactories;
   final Freezed annotation;
-  final List<FreezedClassModifier> modifiers;
 }
 
 extension on ConstructorDeclaration {
@@ -1290,43 +1255,3 @@ extension on DartObject {
     return decode(field);
   }
 }
-
-extension on FreezedClassModifier {
-  String get lexeme {
-    return switch (this) {
-      FreezedClassModifier.Final => 'final',
-      FreezedClassModifier.Base => 'base',
-      FreezedClassModifier.Mixin => 'mixin',
-    };
-  }
-}
-
-extension on List<FreezedClassModifier> {
-  List<FreezedClassModifier> toNormalized() {
-    return toSet().toList(growable: false)..sortByCompare(
-      (modifier) => switch (modifier) {
-        FreezedClassModifier.Final => 0,
-        FreezedClassModifier.Base => 0,
-        FreezedClassModifier.Mixin => 1,
-      },
-      (left, right) => left.compareTo(right),
-    );
-  }
-
-  void throwIfInvalid(Element? element) {
-    switch (this) {
-      case []:
-      case [FreezedClassModifier.Base]:
-      case [FreezedClassModifier.Base, FreezedClassModifier.Mixin]:
-      case [FreezedClassModifier.Mixin]:
-      case [FreezedClassModifier.Final]:
-        return;
-
-      default:
-        throw InvalidGenerationSourceError(
-          'invalid combination of class modifiers: ${map((modifier) => modifier.lexeme).join(' ')}',
-          element: element,
-        );
-    }
-  }
-}

packages/freezed/lib/src/templates/concrete_template.dart

@@ -49,7 +49,7 @@ class Concrete {
 /// @nodoc
 $jsonSerializable
 ${constructor.decorators.join('\n')}
-${data.classModifiers}class ${constructor.redirectedName}${data.genericsDefinitionTemplate} $_concreteSuper {
+${data.shouldBeFinal ? 'final ' : ''}class ${constructor.redirectedName}${data.genericsDefinitionTemplate} $_concreteSuper {
   $_concreteConstructor
   $_concreteFromJsonConstructor
 

packages/freezed/test/integration/finalized.dart

@@ -2,34 +2,34 @@ import 'package:freezed_annotation/freezed_annotation.dart';
 
 part 'finalized.freezed.dart';
 
-@Freezed(classModifiers: [FreezedClassModifier.Final])
-abstract class SealedWithFinalFoo with _$SealedWithFinalFoo {
+@Freezed(makeGeneratedClassesFinal: true)
+sealed class SealedWithFinalFoo with _$SealedWithFinalFoo {
   factory SealedWithFinalFoo() = _SealedWithFinalFoo;
 }
 
-@Freezed(classModifiers: [FreezedClassModifier.Final])
+@Freezed(makeGeneratedClassesFinal: true)
 sealed class SealedWithFinalBar with _$SealedWithFinalBar {
   factory SealedWithFinalBar() = _SealedWithFinalBar;
 }
 
-@Freezed(classModifiers: [FreezedClassModifier.Final])
+@Freezed(makeGeneratedClassesFinal: true)
 sealed class SealedWithFinalAbc with _$SealedWithFinalAbc {
   factory SealedWithFinalAbc.a() = SealedWithFinalAbcA;
   factory SealedWithFinalAbc.b() = SealedWithFinalAbcB;
   factory SealedWithFinalAbc.c() = SealedWithFinalAbcC;
 }
 
-@Freezed(classModifiers: [FreezedClassModifier.Final])
+@Freezed(makeGeneratedClassesFinal: true)
 abstract class AbstractWithFinalFoo with _$AbstractWithFinalFoo {
   factory AbstractWithFinalFoo() = _AbstractWithFinalFoo;
 }
 
-@Freezed(classModifiers: [FreezedClassModifier.Final])
+@Freezed(makeGeneratedClassesFinal: true)
 abstract class AbstractWithFinalBar with _$AbstractWithFinalBar {
   factory AbstractWithFinalBar() = _AbstractWithFinalBar;
 }
 
-@Freezed(classModifiers: [FreezedClassModifier.Final])
+@Freezed(makeGeneratedClassesFinal: true)
 abstract class AbstractWithFinalAbc with _$AbstractWithFinalAbc {
   factory AbstractWithFinalAbc.a() = AbstractWithFinalAbcA;
   factory AbstractWithFinalAbc.b() = AbstractWithFinalAbcB;
@@ -42,15 +42,15 @@ sealed class SuperFoo {
 
 final class CustomFoo extends SuperFoo {}
 
-@Freezed(classModifiers: [FreezedClassModifier.Final])
+@Freezed(makeGeneratedClassesFinal: true)
 sealed class SealedWithFinalSuperFoo extends SuperFoo
     with _$SealedWithFinalSuperFoo {
   const SealedWithFinalSuperFoo._() : super();
 
   factory SealedWithFinalSuperFoo() = _SealedWithFinalSuperFoo;
 }
 
-@Freezed(classModifiers: [FreezedClassModifier.Final])
+@Freezed(makeGeneratedClassesFinal: true)
 abstract class AbstractWithFinalSuperFoo extends SuperFoo
     with _$AbstractWithFinalSuperFoo {
   const AbstractWithFinalSuperFoo._() : super();

packages/freezed_annotation/lib/freezed_annotation.dart

@@ -84,7 +84,7 @@ class Freezed {
     this.makeCollectionsUnmodifiable,
     this.addImplicitFinal = true,
     this.genericArgumentFactories = false,
-    this.classModifiers = const [],
+    this.makeGeneratedClassesFinal,
   });
 
   /// Decode the options from a build.yaml
@@ -341,24 +341,22 @@ class Freezed {
   /// ```
   final bool genericArgumentFactories;
 
-  /// Modifiers that are added the generated classes.
+  /// Whether to add `final` modifiers to the generated classes.
   ///
-  /// Defaults to an empty list.
-  ///
-  /// Can be used to make the generated classes `final`/'base'/'mixin'/'base mixin'/....
-  /// See https://dart.dev/language/class-modifiers for more information on class modifiers.
+  /// Defaults to false.
   ///
-  /// For example to make the compiler/analyzer warn about unnecessary clauses in switch statements,
-  /// one could add the 'final' modifier to generated classes:
+  /// This makes the generated classes `final` by default,
+  /// so when using them in a switch statement, the analzyer will warn you
+  /// if you try to match against a pattern that will never match the type.
   ///
   /// ```dart
-  /// @Freezed(classModifiers: ['final'])
+  /// @Freezed(makeGeneratedClassesFinal: true)
   /// sealed class Foo with _$Foo {
   ///   const Foo._();
   ///   const factory Foo() = _Foo;
   /// }
   ///
-  /// @Freezed(classModifiers: ['final'])
+  /// @Freezed(makeGeneratedClassesFinal: true)
   /// sealed class Bar with _$Bar {
   ///   const Bar._();
   ///   const factory Bar() = _Bar;
@@ -378,7 +376,7 @@ class Freezed {
   ///       break;
   ///   }
   /// ```
-  final List<FreezedClassModifier> classModifiers;
+  final bool? makeGeneratedClassesFinal;
 }
 
 /// Defines an immutable data-class.
@@ -571,10 +569,3 @@ enum FreezedUnionCase {
   /// Encodes a constructor named `screamingSnakeCase` with a JSON value `SCREAMING_SNAKE_CASE`.
   screamingSnake,
 }
-
-@JsonEnum(fieldRename: FieldRename.snake)
-enum FreezedClassModifier {
-  Final,
-  Base,
-  Mixin,
-}

packages/freezed_annotation/lib/freezed_annotation.g.dart

@@ -18,7 +18,7 @@ void main() {
         expect(defaultValue.makeCollectionsUnmodifiable, isTrue);
         expect(defaultValue.addImplicitFinal, isTrue);
         expect(defaultValue.genericArgumentFactories, isFalse);
-        expect(defaultValue.classModifiers, []);
+        expect(defaultValue.makeGeneratedClassesFinal, isNull);
       });
 
       test('explicit', () {
@@ -34,7 +34,7 @@ void main() {
           'make_collections_unmodifiable': false,
           'add_implicit_final': false,
           'generic_argument_factories': true,
-          'class_modifiers': ['base', 'mixin'],
+          'make_generated_classes_final': true,
         });
 
         expect(overrides.copyWith, isFalse);
@@ -48,22 +48,19 @@ void main() {
         expect(overrides.makeCollectionsUnmodifiable, isFalse);
         expect(overrides.addImplicitFinal, isFalse);
         expect(overrides.genericArgumentFactories, isTrue);
-        expect(overrides.classModifiers, [
-          FreezedClassModifier.Base,
-          FreezedClassModifier.Mixin,
-        ]);
+        expect(overrides.makeGeneratedClassesFinal, isTrue);
       });
     });
   });
 
   test('freezed', () {
-    expect(freezed.classModifiers, []);
+    expect(freezed.makeGeneratedClassesFinal, isNull);
   });
 
   test('unfreezed', () {
     expect(unfreezed.makeCollectionsUnmodifiable, false);
     expect(unfreezed.equal, false);
     expect(unfreezed.addImplicitFinal, false);
-    expect(unfreezed.classModifiers, []);
+    expect(unfreezed.makeGeneratedClassesFinal, isNull);
   });
 }