refactor: remove automated de/serialization

fulleni · fulleni · commit 223f78cab5b2 · 2025-05-21T21:14:49.000+01:00
diff --git a/lib/src/models/feed/ad.dart b/lib/src/models/feed/ad.dart
@@ -1,4 +1,3 @@
-import 'package:equatable/equatable.dart';
 import 'package:ht_shared/src/models/feed/ad_placement.dart';
 import 'package:ht_shared/src/models/feed/feed_item.dart';
 import 'package:ht_shared/src/models/feed/feed_item_action.dart';
@@ -70,7 +69,7 @@ class Ad extends FeedItem {
   /// Converts this [Ad] instance to a JSON map.
   @override
   Map<String, dynamic> toJson() {
-    final Map<String, dynamic> json = {
+    final json = <String, dynamic>{
       'id': id,
       'imageUrl': imageUrl,
       'targetUrl': targetUrl,
diff --git a/lib/src/models/feed/engagement_content.dart b/lib/src/models/feed/engagement_content.dart
@@ -1,4 +1,3 @@
-import 'package:equatable/equatable.dart';
 import 'package:ht_shared/src/models/feed/engagement_content_type.dart';
 import 'package:ht_shared/src/models/feed/feed_item.dart';
 import 'package:ht_shared/src/models/feed/feed_item_action.dart';
@@ -23,7 +22,9 @@ class EngagementContent extends FeedItem {
     this.callToActionUrl,
     String? id,
   })  : id = id ?? const Uuid().v4(),
-        super(type: 'engagement_content'); // Removed action from super constructor
+        super(
+            type:
+                'engagement_content',); // Removed action from super constructor
 
   /// Factory method to create an [EngagementContent] instance from a JSON map.
   factory EngagementContent.fromJson(Map<String, dynamic> json) {
@@ -61,7 +62,7 @@ class EngagementContent extends FeedItem {
   /// Converts this [EngagementContent] instance to a JSON map.
   @override
   Map<String, dynamic> toJson() {
-    final Map<String, dynamic> json = {
+    final json = <String, dynamic>{
       'id': id,
       'title': title,
       'description': description,
diff --git a/lib/src/models/feed/suggested_content.dart b/lib/src/models/feed/suggested_content.dart
@@ -1,4 +1,3 @@
-import 'package:equatable/equatable.dart';
 import 'package:ht_shared/ht_shared.dart'
     show Category, Country, Headline, Source;
 import 'package:ht_shared/src/models/feed/feed_item.dart';
@@ -25,7 +24,8 @@ class SuggestedContent extends FeedItem {
     this.description,
     String? id,
   })  : id = id ?? const Uuid().v4(),
-        super(type: 'suggested_content'); // Removed action from super constructor
+        super(
+            type: 'suggested_content',); // Removed action from super constructor
 
   /// Factory method to create a [SuggestedContent] instance from a JSON map.
   factory SuggestedContent.fromJson(Map<String, dynamic> json) {
@@ -36,24 +36,22 @@ class SuggestedContent extends FeedItem {
       displayType: suggestedContentDisplayTypeFromJson(
         json['displayType'] as String,
       ),
-      items: (json['items'] as List<dynamic>)
-          .map((e) {
-            final itemMap = e as Map<String, dynamic>;
-            final itemType = itemMap['type'] as String;
-            switch (itemType) {
-              case 'headline':
-                return Headline.fromJson(itemMap);
-              case 'category':
-                return Category.fromJson(itemMap);
-              case 'source':
-                return Source.fromJson(itemMap);
-              case 'country':
-                return Country.fromJson(itemMap);
-              default:
-                throw FormatException('Unknown item type: $itemType');
-            }
-          })
-          .toList(),
+      items: (json['items'] as List<dynamic>).map((e) {
+        final itemMap = e as Map<String, dynamic>;
+        final itemType = itemMap['type'] as String;
+        switch (itemType) {
+          case 'headline':
+            return Headline.fromJson(itemMap);
+          case 'category':
+            return Category.fromJson(itemMap);
+          case 'source':
+            return Source.fromJson(itemMap);
+          case 'country':
+            return Country.fromJson(itemMap);
+          default:
+            throw FormatException('Unknown item type: $itemType');
+        }
+      }).toList(),
       action: FeedItemAction.fromJson(json['action'] as Map<String, dynamic>),
     );
   }
@@ -77,7 +75,7 @@ class SuggestedContent extends FeedItem {
   /// Converts this [SuggestedContent] instance to a JSON map.
   @override
   Map<String, dynamic> toJson() {
-    final Map<String, dynamic> json = {
+    final json = <String, dynamic>{
       'id': id,
       'title': title,
       'description': description,
@@ -92,7 +90,8 @@ class SuggestedContent extends FeedItem {
         } else if (e is Country) {
           return e.toJson();
         }
-        throw FormatException('Unknown item type for serialization: ${e.runtimeType}');
+        throw FormatException(
+            'Unknown item type for serialization: ${e.runtimeType}',);
       }).toList(),
       'action': action.toJson(),
       'type': type, // Inherited from FeedItem
diff --git a/lib/src/models/models.dart b/lib/src/models/models.dart
@@ -1,3 +1,4 @@
+export '../utils/json_converters.dart';
 export 'feed/feed.dart';
 export 'news/news.dart';
 export 'permission.dart';
@@ -7,4 +8,3 @@ export 'user-preferences/user_preferences.dart';
 export 'user-settings/user_settings.dart';
 export 'user.dart';
 export 'user_role.dart';
-export '../utils/json_converters.dart';
diff --git a/lib/src/models/news/category.dart b/lib/src/models/news/category.dart
@@ -1,4 +1,3 @@
-import 'package:equatable/equatable.dart';
 import 'package:ht_shared/src/models/feed/feed_item.dart';
 import 'package:ht_shared/src/models/feed/feed_item_action.dart';
 import 'package:meta/meta.dart';
diff --git a/lib/src/models/news/country.dart b/lib/src/models/news/country.dart
@@ -1,4 +1,3 @@
-import 'package:equatable/equatable.dart';
 import 'package:ht_shared/src/models/feed/feed_item.dart';
 import 'package:ht_shared/src/models/feed/feed_item_action.dart';
 import 'package:uuid/uuid.dart';
@@ -43,7 +42,6 @@ class Country extends FeedItem {
   /// The URL pointing to an image of the country's flag.
   final String flagUrl;
 
-
   /// Converts this Country instance into a JSON map.
   @override
   Map<String, dynamic> toJson() {
diff --git a/lib/src/models/news/headline.dart b/lib/src/models/news/headline.dart
@@ -1,4 +1,3 @@
-import 'package:equatable/equatable.dart';
 import 'package:ht_shared/src/models/feed/feed_item.dart';
 import 'package:ht_shared/src/models/feed/feed_item_action.dart';
 import 'package:ht_shared/src/models/news/category.dart';
@@ -83,7 +82,7 @@ class Headline extends FeedItem {
   /// Converts this [Headline] instance to a JSON map.
   @override
   Map<String, dynamic> toJson() {
-    final Map<String, dynamic> json = {
+    final json = <String, dynamic>{
       'id': id,
       'title': title,
       'description': description,
diff --git a/lib/src/models/news/source.dart b/lib/src/models/news/source.dart
@@ -1,4 +1,3 @@
-import 'package:equatable/equatable.dart';
 import 'package:ht_shared/src/models/feed/feed_item.dart';
 import 'package:ht_shared/src/models/feed/feed_item_action.dart';
 import 'package:ht_shared/src/models/feed/source_type.dart';
@@ -74,7 +73,7 @@ class Source extends FeedItem {
   /// Converts this [Source] instance to a JSON map.
   @override
   Map<String, dynamic> toJson() {
-    final Map<String, dynamic> json = {
+    final json = <String, dynamic>{
       'id': id,
       'name': name,
       'description': description,
diff --git a/lib/src/models/remote-config/ad_config.dart b/lib/src/models/remote-config/ad_config.dart
@@ -1,4 +1,8 @@
 import 'package:equatable/equatable.dart';
+import 'package:ht_shared/ht_shared.dart' show AppConfig;
+import 'package:ht_shared/src/models/models.dart' show AppConfig;
+import 'package:ht_shared/src/models/remote-config/app_config.dart' show AppConfig;
+import 'package:ht_shared/src/models/remote-config/remote_config.dart' show AppConfig;
 
 /// {@template ad_config}
 /// Defines configuration settings related to ad injection and display,
diff --git a/lib/src/models/remote-config/user_preference_limits.dart b/lib/src/models/remote-config/user_preference_limits.dart
@@ -1,4 +1,6 @@
 import 'package:equatable/equatable.dart';
+import 'package:ht_shared/ht_shared.dart' show AppConfig, UserContentPreferences;
+import 'package:ht_shared/src/models/models.dart' show AppConfig, UserContentPreferences;
 import 'package:meta/meta.dart';
 
 /// {@template user_preference_limits}
diff --git a/lib/src/models/responses/paginated_reponse.dart b/lib/src/models/responses/paginated_reponse.dart
@@ -23,9 +23,7 @@ class PaginatedResponse<T> extends Equatable {
     T Function(Object? json) fromJsonT,
   ) {
     return PaginatedResponse(
-      items: (json['items'] as List<dynamic>)
-          .map((e) => fromJsonT(e))
-          .toList(),
+      items: (json['items'] as List<dynamic>).map((e) => fromJsonT(e)).toList(),
       cursor: json['cursor'] as String?,
       hasMore: json['hasMore'] as bool,
     );
diff --git a/lib/src/models/user-preferences/user_content_preferences.dart b/lib/src/models/user-preferences/user_content_preferences.dart
@@ -75,11 +75,9 @@ class UserContentPreferences extends Equatable {
   Map<String, dynamic> toJson() {
     return <String, dynamic>{
       'id': id,
-      'followedCountries':
-          followedCountries.map((e) => e.toJson()).toList(),
+      'followedCountries': followedCountries.map((e) => e.toJson()).toList(),
       'followedSources': followedSources.map((e) => e.toJson()).toList(),
-      'followedCategories':
-          followedCategories.map((e) => e.toJson()).toList(),
+      'followedCategories': followedCategories.map((e) => e.toJson()).toList(),
       'savedHeadlines': savedHeadlines.map((e) => e.toJson()).toList(),
     };
   }
diff --git a/lib/src/utils/json_converters.dart b/lib/src/utils/json_converters.dart
@@ -1,12 +1,5 @@
 import 'package:ht_shared/ht_shared.dart';
 import 'package:ht_shared/src/models/content_type.dart';
-import 'package:ht_shared/src/models/feed/ad_placement.dart';
-import 'package:ht_shared/src/models/feed/engagement_content_type.dart';
-import 'package:ht_shared/src/models/feed/suggested_content_display_type.dart';
-import 'package:ht_shared/src/models/user-settings/app_accent_theme.dart';
-import 'package:ht_shared/src/models/user-settings/app_base_theme.dart';
-import 'package:ht_shared/src/models/user-settings/app_font_weight.dart';
-import 'package:ht_shared/src/models/user-settings/app_text_scale_factor.dart';
 
 /// Converts a snake_case string to a [ContentType] enum value.
 ///
diff --git a/pubspec.lock b/pubspec.lock
@@ -258,21 +258,13 @@ packages:
     source: hosted
     version: "0.7.2"
   json_annotation:
-    dependency: "direct main"
+    dependency: transitive
     description:
       name: json_annotation
       sha256: "1ce844379ca14835a50d2f019a3099f419082cfdd231cd86a142af94dd5c6bb1"
       url: "https://pub.dev"
     source: hosted
     version: "4.9.0"
-  json_serializable:
-    dependency: "direct dev"
-    description:
-      name: json_serializable
-      sha256: c50ef5fc083d5b5e12eef489503ba3bf5ccc899e487d691584699b4bdefeea8c
-      url: "https://pub.dev"
-    source: hosted
-    version: "6.9.5"
   logging:
     dependency: transitive
     description:
@@ -393,22 +385,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "3.0.0"
-  source_gen:
-    dependency: transitive
-    description:
-      name: source_gen
-      sha256: "35c8150ece9e8c8d263337a265153c3329667640850b9304861faea59fc98f6b"
-      url: "https://pub.dev"
-    source: hosted
-    version: "2.0.0"
-  source_helper:
-    dependency: transitive
-    description:
-      name: source_helper
-      sha256: "86d247119aedce8e63f4751bd9626fc9613255935558447569ad42f9f5b48b3c"
-      url: "https://pub.dev"
-    source: hosted
-    version: "1.3.5"
   source_map_stack_trace:
     dependency: transitive
     description:
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -8,13 +8,11 @@ environment:
 
 dependencies:
   equatable: ^2.0.7
-  json_annotation: ^4.9.0
   meta: ^1.17.0
   uuid: ^4.5.1
 
 dev_dependencies:
   build_runner: ^2.4.15
-  json_serializable: ^6.9.5
   mocktail: ^1.0.4
   test: ^1.26.1
   very_good_analysis: ^7.0.0
diff --git a/test/src/models/feed/feed_item_action_test.dart b/test/src/models/feed/feed_item_action_test.dart
@@ -186,8 +186,10 @@ void main() {
         };
         final action = feedItemActionFromJson(json);
         expect(action, isA<ShowInterstitialThenOpenInternalContent>());
-        expect((action as ShowInterstitialThenOpenInternalContent).contentId,
-            'id2',);
+        expect(
+          (action as ShowInterstitialThenOpenInternalContent).contentId,
+          'id2',
+        );
         expect(action.contentType, ContentType.category);
       });
 
@@ -205,23 +207,27 @@ void main() {
         final json = <String, dynamic>{'contentId': 'id1'};
         expect(
           () => feedItemActionFromJson(json),
-          throwsA(isA<FormatException>().having(
-            (e) => e.message,
-            'message',
-            'Missing "type" field in FeedItemAction JSON.',
-          ),),
+          throwsA(
+            isA<FormatException>().having(
+              (e) => e.message,
+              'message',
+              'Missing "type" field in FeedItemAction JSON.',
+            ),
+          ),
         );
       });
 
       test('throws FormatException if type is unknown', () {
         final json = <String, dynamic>{'type': 'unknown_type'};
         expect(
           () => feedItemActionFromJson(json),
-          throwsA(isA<FormatException>().having(
-            (e) => e.message,
-            'message',
-            'Unknown FeedItemAction type: unknown_type',
-          ),),
+          throwsA(
+            isA<FormatException>().having(
+              (e) => e.message,
+              'message',
+              'Unknown FeedItemAction type: unknown_type',
+            ),
+          ),
         );
       });
     });
diff --git a/test/src/models/feed/feed_item_test.dart b/test/src/models/feed/feed_item_test.dart
@@ -108,23 +108,27 @@ void main() {
         final json = <String, dynamic>{'id': 'some-id'};
         expect(
           () => FeedItem.fromJson(json),
-          throwsA(isA<FormatException>().having(
-            (e) => e.message,
-            'message',
-            'Missing "type" field in FeedItem JSON.',
-          ),),
+          throwsA(
+            isA<FormatException>().having(
+              (e) => e.message,
+              'message',
+              'Missing "type" field in FeedItem JSON.',
+            ),
+          ),
         );
       });
 
       test('throws FormatException if type is unknown', () {
         final json = <String, dynamic>{'type': 'unknown_type'};
         expect(
           () => FeedItem.fromJson(json),
-          throwsA(isA<FormatException>().having(
-            (e) => e.message,
-            'message',
-            'Unknown FeedItem type: unknown_type',
-          ),),
+          throwsA(
+            isA<FormatException>().having(
+              (e) => e.message,
+              'message',
+              'Unknown FeedItem type: unknown_type',
+            ),
+          ),
         );
       });
     });
diff --git a/test/src/models/feed/source_type_test.dart b/test/src/models/feed/source_type_test.dart
@@ -8,7 +8,9 @@ void main() {
       expect(SourceType.localNewsOutlet.name, 'localNewsOutlet');
       expect(SourceType.nationalNewsOutlet.name, 'nationalNewsOutlet');
       expect(
-          SourceType.internationalNewsOutlet.name, 'internationalNewsOutlet',);
+        SourceType.internationalNewsOutlet.name,
+        'internationalNewsOutlet',
+      );
       expect(SourceType.specializedPublisher.name, 'specializedPublisher');
       expect(SourceType.blog.name, 'blog');
       expect(SourceType.governmentSource.name, 'governmentSource');
diff --git a/test/src/models/news/source_test.dart b/test/src/models/news/source_test.dart
@@ -165,7 +165,9 @@ void main() {
         expect(json['url'], testUrl);
         expect(json['type'], 'source');
         expect(
-            json['sourceType'], 'specialized-publisher',); // Use direct string
+          json['sourceType'],
+          'specialized-publisher',
+        ); // Use direct string
         expect(json['language'], testLanguage);
         expect(json['headquarters'], testHeadquartersJson);
         expect(json['action'], defaultAction.toJson());
diff --git a/test/src/models/remote-config/ad_config_test.dart b/test/src/models/remote-config/ad_config_test.dart
diff --git a/test/src/models/user-settings/app_accent_theme_test.dart b/test/src/models/user-settings/app_accent_theme_test.dart
diff --git a/test/src/models/user-settings/app_text_scale_factor_test.dart b/test/src/models/user-settings/app_text_scale_factor_test.dart

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import 'package:equatable/equatable.dart';`
`2`	`1`	`import 'package:ht_shared/src/models/feed/feed_item.dart';`
`3`	`2`	`import 'package:ht_shared/src/models/feed/feed_item_action.dart';`
`4`	`3`	`import 'package:meta/meta.dart';`