refactor: rearrange files for a more consistent layout and extract annotations from converter.dart

Author: helightdev

benchmarks/pubspec.lock

@@ -77,10 +77,10 @@ packages:
     dependency: transitive
     description:
       name: build
-      sha256: "6439a9c71a4e6eca8d9490c1b380a25b02675aa688137dfbe66d2062884a23ac"
+      sha256: ce76b1d48875e3233fde17717c23d1f60a91cc631597e49a400c89b475395b1d
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.2"
+    version: "3.1.0"
   build_config:
     dependency: transitive
     description:
@@ -101,42 +101,42 @@ packages:
     dependency: transitive
     description:
       name: build_modules
-      sha256: "78f00844db79736785b1f00aa416bf8187936a4033246104f299e60c8ba73531"
+      sha256: "5d599f7213e465cbc5193f73d7b323a9e6d7d300734b63a63eb99500cba259ac"
       url: "https://pub.dev"
     source: hosted
-    version: "5.0.16"
+    version: "5.0.17"
   build_resolvers:
     dependency: transitive
     description:
       name: build_resolvers
-      sha256: "2b21a125d66a86b9511cc3fb6c668c42e9a1185083922bf60e46d483a81a9712"
+      sha256: d1d57f7807debd7349b4726a19fd32ec8bc177c71ad0febf91a20f84cd2d4b46
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.2"
+    version: "3.0.3"
   build_runner:
     dependency: "direct dev"
     description:
       name: build_runner
-      sha256: fd3c09f4bbff7fa6e8d8ef688a0b2e8a6384e6483a25af0dac75fef362bcfe6f
+      sha256: b24597fceb695969d47025c958f3837f9f0122e237c6a22cb082a5ac66c3ca30
       url: "https://pub.dev"
     source: hosted
-    version: "2.7.0"
+    version: "2.7.1"
   build_runner_core:
     dependency: transitive
     description:
       name: build_runner_core
-      sha256: ab27e46c8aa233e610cf6084ee6d8a22c6f873a0a9929241d8855b7a72978ae7
+      sha256: "066dda7f73d8eb48ba630a55acb50c4a84a2e6b453b1cb4567f581729e794f7b"
       url: "https://pub.dev"
     source: hosted
-    version: "9.3.0"
+    version: "9.3.1"
   build_web_compilers:
     dependency: "direct dev"
     description:
       name: build_web_compilers
-      sha256: "7a6bb81907c3cdcc538af003db497cb9af37c94991bc960f9f25affd7a15df15"
+      sha256: f730cf4decb4e3906cd93a8777500aa8daf55dac64f46cf5ec33b83d2cf635c5
       url: "https://pub.dev"
     source: hosted
-    version: "4.2.2"
+    version: "4.2.3"
   built_collection:
     dependency: "direct main"
     description:
@@ -149,18 +149,18 @@ packages:
     dependency: "direct main"
     description:
       name: built_value
-      sha256: ba95c961bafcd8686d1cf63be864eb59447e795e124d98d6a27d91fcd13602fb
+      sha256: a30f0a0e38671e89a492c44d005b5545b830a961575bbd8336d42869ff71066d
       url: "https://pub.dev"
     source: hosted
-    version: "8.11.1"
+    version: "8.12.0"
   built_value_generator:
     dependency: "direct dev"
     description:
       name: built_value_generator
-      sha256: "82281895e5347dd70ffd3aab2756f39d52b55c945fa0efa635ad6d643dae5833"
+      sha256: "65f5823a2c4158384ebc845218e19286fdf5dd04f8ac2cf607b01a502be40b1b"
       url: "https://pub.dev"
     source: hosted
-    version: "8.11.1"
+    version: "8.12.0"
   cbor:
     dependency: transitive
     description:
@@ -255,35 +255,35 @@ packages:
       path: "../formats/dogs_cbor"
       relative: true
     source: path
-    version: "2.3.5-dev.4"
+    version: "2.3.5-dev.6"
   dogs_core:
     dependency: "direct main"
     description:
       path: "../packages/dogs_core"
       relative: true
     source: path
-    version: "10.0.0-dev.4"
+    version: "10.0.0-dev.6"
   dogs_generator:
     dependency: "direct dev"
     description:
       path: "../packages/dogs_generator"
       relative: true
     source: path
-    version: "7.0.0-dev.4"
+    version: "7.0.0-dev.6"
   dogs_toml:
     dependency: "direct main"
     description:
       path: "../formats/dogs_toml"
       relative: true
     source: path
-    version: "2.3.5-dev.4"
+    version: "2.3.5-dev.6"
   dogs_yaml:
     dependency: "direct main"
     description:
       path: "../formats/dogs_yaml"
       relative: true
     source: path
-    version: "2.3.5-dev.4"
+    version: "2.3.5-dev.6"
   duffer:
     dependency: transitive
     description:
@@ -432,10 +432,10 @@ packages:
     dependency: "direct dev"
     description:
       name: json_serializable
-      sha256: "3f2913b7c2430afe8ac5afe6fb15c1de4a60af4f630625e6e238f80ba4b80cbd"
+      sha256: "33a040668b31b320aafa4822b7b1e177e163fc3c1e835c6750319d4ab23aa6fe"
       url: "https://pub.dev"
     source: hosted
-    version: "6.11.0"
+    version: "6.11.1"
   lints:
     dependency: "direct dev"
     description:
@@ -456,18 +456,18 @@ packages:
     dependency: transitive
     description:
       name: lyell
-      sha256: "552cbf1ae9ba85040c0da34e1bbb2bcec769de4ee9a97ffb3496e60fbd8e03de"
+      sha256: "0cad511dc437e83acc9c4e1a30dcbe984c95e91fa0ad48623e3d2c61e358f3b4"
       url: "https://pub.dev"
     source: hosted
-    version: "1.4.5"
+    version: "1.4.6"
   lyell_gen:
     dependency: transitive
     description:
       name: lyell_gen
-      sha256: ce9d006796e2f8286c68e988f7ed7aa1e98e993838ed4e5120d7a526caef0cee
+      sha256: "90eafd2e98c7f8d67c1c10ab4f36f447bd7a533e767005089e3b1981a3718a4d"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.9"
+    version: "3.0.12"
   matcher:
     dependency: transitive
     description:
@@ -608,10 +608,10 @@ packages:
     dependency: transitive
     description:
       name: scratch_space
-      sha256: "816989dd0a1f92cd5f0db012ed330035571034956dc3593fba66aaa6ee6a7e43"
+      sha256: efe807ddf27b148b500465957ceee4255deb4a8558575530b6398840436300ce
       url: "https://pub.dev"
     source: hosted
-    version: "1.1.0"
+    version: "1.1.1"
   shelf:
     dependency: transitive
     description:
@@ -656,10 +656,10 @@ packages:
     dependency: transitive
     description:
       name: source_helper
-      sha256: a447acb083d3a5ef17f983dd36201aeea33fedadb3228fa831f2f0c92f0f3aca
+      sha256: "6a3c6cc82073a8797f8c4dc4572146114a39652851c157db37e964d9c7038723"
       url: "https://pub.dev"
     source: hosted
-    version: "1.3.7"
+    version: "1.3.8"
   source_map_stack_trace:
     dependency: transitive
     description:

packages/dogs_core/lib/dogs_core.dart

@@ -21,6 +21,7 @@ library;
 // Include lyell
 export "package:lyell/lyell.dart";
 
+export "src/annotations.dart";
 export "src/codec.dart";
 export "src/converter.dart";
 export "src/converters/common.dart";

packages/dogs_core/lib/dogs_validation.dart

@@ -16,11 +16,11 @@
 
 library;
 
-export "validation/blank.dart";
-export "validation/description.dart";
-export "validation/length.dart";
-export "validation/must_match.dart" hide MustMatchCacheEntry;
-export "validation/range.dart";
-export "validation/regex.dart" hide RegexCacheEntry;
-export "validation/size.dart";
-export "validation/validated.dart" hide ValidatedCacheEntry;
+export "src/validation/validators/blank.dart";
+export "src/schema/annotations/description.dart";
+export "src/validation/validators/length.dart";
+export "src/validation/validators/must_match.dart" hide MustMatchCacheEntry;
+export "src/validation/validators/range.dart";
+export "src/validation/validators/regex.dart" hide RegexCacheEntry;
+export "src/validation/validators/size.dart";
+export "src/validation/validators/validated.dart" hide ValidatedCacheEntry;

packages/dogs_core/lib/src/annotations.dart

@@ -0,0 +1,98 @@
+// TODO: Future replacement for @serializable
+import "package:dogs_core/dogs_core.dart";
+import "package:meta/meta.dart";
+
+/// Configures the dogs structuration of a class or enum.
+class Structure extends Serializable implements StructureMetadata {
+  /// If the type is serializable.
+  final bool serializable;
+
+  /// Configures the dogs structuration of a class or enum.
+  const Structure({this.serializable = false, super.serialName});
+}
+
+/// See @[serializable].
+class Serializable {
+  /// The name of the type used for serialization.
+  final String? serialName;
+
+  /// See @[serializable].
+  const Serializable({this.serialName});
+}
+
+/// Marks a class or enum as serializable.
+const serializable = Structure(serializable: true);
+
+@internal
+class DogLinked {
+  const DogLinked();
+}
+
+/// Manually marks a custom dog converter implementation for linking.
+/// The dogs_generator will then include an instance of this converter.
+const linkSerializer = DogLinked();
+
+/// Automatically links a [DogLinkable] object when running the generated
+/// dogs plugin.
+const dogsLinked = DogLinked();
+
+/// Supplier function for default values.
+typedef DefaultValueSupplier = dynamic Function();
+
+class _BeanIgnore {
+  const _BeanIgnore();
+}
+
+/// Marks a property as ignored when using the bean conformity.
+const beanIgnore = _BeanIgnore();
+
+/// Marks a property as polymorphic, meaning its values type can vary.
+class _Polymorphic extends StructureMetadata {
+  const _Polymorphic();
+}
+
+/// Marks a property as polymorphic, meaning its value's type can vary.
+const polymorphic = _Polymorphic();
+
+@internal
+
+/// Checks if a field is marked as polymorphic.
+bool isPolymorphicField(DogStructureField field) {
+  return field.annotationsOf<_Polymorphic>().isNotEmpty;
+}
+
+/// Overrides the name that will be used by the [GeneratedDogConverter] for this
+/// specific property. By default, the field name will be used.
+class PropertyName {
+  /// The name of the property used as a map key in serialization.
+  final String name;
+
+  /// Instantiates a new [PropertyName] with the given [name].
+  const PropertyName(this.name);
+}
+
+/// Overrides the serializer that will be used by the [GeneratedDogConverter]
+/// for this specific property. By default, the field will be serialized using
+/// the convert associated with its type.
+class PropertySerializer {
+  /// The type of the serializer.
+  final Type type;
+
+  /// Instantiates a new [PropertySerializer] with the given [type].
+  const PropertySerializer(this.type);
+}
+
+/// Configures how the [GeneratedEnumDogConverter] will serialize this individual
+/// enum value. The name can be overridden by specifying a [name]. This enum
+/// value can also be marked as the fallback value.
+class EnumProperty {
+  /// The name of the enum value used as a map key in serialization.
+  final String? name;
+
+  /// If this enum value should be used as a fallback value when an invalid
+  /// value is encountered during deserialization.
+  final bool fallback;
+
+  /// Instantiates a new [EnumProperty] with the given [name] and [fallback].
+  const EnumProperty({this.name, this.fallback = false});
+}