From cfd87beff06c99264761e298b624375e3b3c80f3 Mon Sep 17 00:00:00 2001 From: RuiAlonso Date: Wed, 23 Mar 2022 11:52:34 +0100 Subject: [PATCH] refactor: changed name of LeaderboardEntry at LeaderboardRepository to LeaderboardEntryData --- lib/leaderboard/bloc/leaderboard_event.dart | 8 +++--- lib/leaderboard/bloc/leaderboard_state.dart | 4 +-- .../lib/src/leaderboard_repository.dart | 12 +++++---- .../lib/src/models/leaderboard_entry.g.dart | 8 +++--- ...entry.dart => leaderboard_entry_data.dart} | 26 +++++++++---------- .../lib/src/models/leaderboard_ranking.dart | 8 +++--- .../lib/src/models/models.dart | 2 +- .../test/src/leaderboard_repository_test.dart | 4 +-- ....dart => leaderboard_entry_data_test.dart} | 10 +++---- .../bloc/leaderboard_bloc_test.dart | 4 +-- .../bloc/leaderboard_event_test.dart | 2 +- .../bloc/leaderboard_state_test.dart | 2 +- 12 files changed, 46 insertions(+), 44 deletions(-) rename packages/leaderboard_repository/lib/src/models/{leaderboard_entry.dart => leaderboard_entry_data.dart} (66%) rename packages/leaderboard_repository/test/src/models/{leaderboard_entry_test.dart => leaderboard_entry_data_test.dart} (72%) diff --git a/lib/leaderboard/bloc/leaderboard_event.dart b/lib/leaderboard/bloc/leaderboard_event.dart index 34152163..b9e6955a 100644 --- a/lib/leaderboard/bloc/leaderboard_event.dart +++ b/lib/leaderboard/bloc/leaderboard_event.dart @@ -9,7 +9,7 @@ abstract class LeaderboardEvent extends Equatable { } /// {@template top_10_fetched} -/// Request the top 10 [LeaderboardEntry]s. +/// Request the top 10 [LeaderboardEntryData]s. /// {endtemplate} class Top10Fetched extends LeaderboardEvent { /// {@macro top_10_fetched} @@ -20,7 +20,7 @@ class Top10Fetched extends LeaderboardEvent { } /// {@template leaderboard_entry_added} -/// Writes a new [LeaderboardEntry]. +/// Writes a new [LeaderboardEntryData]. /// /// Should be added when a player finishes a game. /// {endtemplate} @@ -28,8 +28,8 @@ class LeaderboardEntryAdded extends LeaderboardEvent { /// {@macro leaderboard_entry_added} const LeaderboardEntryAdded({required this.entry}); - /// [LeaderboardEntry] to be written to the remote storage. - final LeaderboardEntry entry; + /// [LeaderboardEntryData] to be written to the remote storage. + final LeaderboardEntryData entry; @override List get props => [entry]; diff --git a/lib/leaderboard/bloc/leaderboard_state.dart b/lib/leaderboard/bloc/leaderboard_state.dart index 20d68f0d..fe6ef92c 100644 --- a/lib/leaderboard/bloc/leaderboard_state.dart +++ b/lib/leaderboard/bloc/leaderboard_state.dart @@ -40,7 +40,7 @@ class LeaderboardState extends Equatable { final LeaderboardRanking ranking; /// List of top-ranked players. - final List leaderboard; + final List leaderboard; @override List get props => [status, ranking, leaderboard]; @@ -48,7 +48,7 @@ class LeaderboardState extends Equatable { LeaderboardState copyWith({ LeaderboardStatus? status, LeaderboardRanking? ranking, - List? leaderboard, + List? leaderboard, }) { return LeaderboardState( status: status ?? this.status, diff --git a/packages/leaderboard_repository/lib/src/leaderboard_repository.dart b/packages/leaderboard_repository/lib/src/leaderboard_repository.dart index 5a5fa42c..d75a88b3 100644 --- a/packages/leaderboard_repository/lib/src/leaderboard_repository.dart +++ b/packages/leaderboard_repository/lib/src/leaderboard_repository.dart @@ -83,9 +83,9 @@ class LeaderboardRepository { final FirebaseFirestore _firebaseFirestore; - /// Acquires top 10 [LeaderboardEntry]s. - Future> fetchTop10Leaderboard() async { - final leaderboardEntries = []; + /// Acquires top 10 [LeaderboardEntryData]s. + Future> fetchTop10Leaderboard() async { + final leaderboardEntries = []; late List documents; try { @@ -103,7 +103,7 @@ class LeaderboardRepository { final data = document.data() as Map?; if (data != null) { try { - leaderboardEntries.add(LeaderboardEntry.fromJson(data)); + leaderboardEntries.add(LeaderboardEntryData.fromJson(data)); } catch (error, stackTrace) { throw LeaderboardDeserializationException(error, stackTrace); } @@ -115,7 +115,9 @@ class LeaderboardRepository { /// Adds player's score entry to the leaderboard and gets their /// [LeaderboardRanking]. - Future addLeaderboardEntry(LeaderboardEntry entry) async { + Future addLeaderboardEntry( + LeaderboardEntryData entry, + ) async { late DocumentReference entryReference; try { entryReference = await _firebaseFirestore diff --git a/packages/leaderboard_repository/lib/src/models/leaderboard_entry.g.dart b/packages/leaderboard_repository/lib/src/models/leaderboard_entry.g.dart index fc685220..e57e43b8 100644 --- a/packages/leaderboard_repository/lib/src/models/leaderboard_entry.g.dart +++ b/packages/leaderboard_repository/lib/src/models/leaderboard_entry.g.dart @@ -1,19 +1,19 @@ // GENERATED CODE - DO NOT MODIFY BY HAND -part of 'leaderboard_entry.dart'; +part of 'leaderboard_entry_data.dart'; // ************************************************************************** // JsonSerializableGenerator // ************************************************************************** -LeaderboardEntry _$LeaderboardEntryFromJson(Map json) => - LeaderboardEntry( +LeaderboardEntryData _$LeaderboardEntryFromJson(Map json) => + LeaderboardEntryData( playerInitials: json['playerInitials'] as String, score: json['score'] as int, character: $enumDecode(_$CharacterTypeEnumMap, json['character']), ); -Map _$LeaderboardEntryToJson(LeaderboardEntry instance) => +Map _$LeaderboardEntryToJson(LeaderboardEntryData instance) => { 'playerInitials': instance.playerInitials, 'score': instance.score, diff --git a/packages/leaderboard_repository/lib/src/models/leaderboard_entry.dart b/packages/leaderboard_repository/lib/src/models/leaderboard_entry_data.dart similarity index 66% rename from packages/leaderboard_repository/lib/src/models/leaderboard_entry.dart rename to packages/leaderboard_repository/lib/src/models/leaderboard_entry_data.dart index 86cb2464..1372502c 100644 --- a/packages/leaderboard_repository/lib/src/models/leaderboard_entry.dart +++ b/packages/leaderboard_repository/lib/src/models/leaderboard_entry_data.dart @@ -3,7 +3,7 @@ import 'package:json_annotation/json_annotation.dart'; part 'leaderboard_entry.g.dart'; -/// Google character type associated with a [LeaderboardEntry]. +/// Google character type associated with a [LeaderboardEntryData]. enum CharacterType { /// Dash character. dash, @@ -18,7 +18,7 @@ enum CharacterType { dino, } -/// {@template leaderboard_entry} +/// {@template leaderboard_entry_data} /// A model representing a leaderboard entry containing the player's initials, /// score, and chosen character. /// @@ -34,42 +34,42 @@ enum CharacterType { /// ``` /// {@endtemplate} @JsonSerializable() -class LeaderboardEntry extends Equatable { - /// {@macro leaderboard_entry} - const LeaderboardEntry({ +class LeaderboardEntryData extends Equatable { + /// {@macro leaderboard_entry_data} + const LeaderboardEntryData({ required this.playerInitials, required this.score, required this.character, }); - /// Factory which converts a [Map] into a [LeaderboardEntry]. - factory LeaderboardEntry.fromJson(Map json) { + /// Factory which converts a [Map] into a [LeaderboardEntryData]. + factory LeaderboardEntryData.fromJson(Map json) { return _$LeaderboardEntryFromJson(json); } - /// Converts the [LeaderboardEntry] to [Map]. + /// Converts the [LeaderboardEntryData] to [Map]. Map toJson() => _$LeaderboardEntryToJson(this); - /// Player's chosen initials for [LeaderboardEntry]. + /// Player's chosen initials for [LeaderboardEntryData]. /// /// Example: 'ABC'. @JsonKey(name: 'playerInitials') final String playerInitials; - /// Score for [LeaderboardEntry]. + /// Score for [LeaderboardEntryData]. /// /// Example: 1500. @JsonKey(name: 'score') final int score; - /// [CharacterType] for [LeaderboardEntry]. + /// [CharacterType] for [LeaderboardEntryData]. /// /// Example: [CharacterType.dash]. @JsonKey(name: 'character') final CharacterType character; - /// An empty [LeaderboardEntry] object. - static const empty = LeaderboardEntry( + /// An empty [LeaderboardEntryData] object. + static const empty = LeaderboardEntryData( playerInitials: '', score: 0, character: CharacterType.dash, diff --git a/packages/leaderboard_repository/lib/src/models/leaderboard_ranking.dart b/packages/leaderboard_repository/lib/src/models/leaderboard_ranking.dart index 7ec90ef4..4a322e00 100644 --- a/packages/leaderboard_repository/lib/src/models/leaderboard_ranking.dart +++ b/packages/leaderboard_repository/lib/src/models/leaderboard_ranking.dart @@ -2,17 +2,17 @@ import 'package:equatable/equatable.dart'; import 'package:leaderboard_repository/leaderboard_repository.dart'; /// {@template leaderboard_ranking} -/// Contains [ranking] for a single [LeaderboardEntry] and the number of players -/// the [ranking] is [outOf]. +/// Contains [ranking] for a single [LeaderboardEntryData] and the number of +/// players the [ranking] is [outOf]. /// {@endtemplate} class LeaderboardRanking extends Equatable { /// {@macro leaderboard_ranking} const LeaderboardRanking({required this.ranking, required this.outOf}); - /// Place ranking by score for a [LeaderboardEntry]. + /// Place ranking by score for a [LeaderboardEntryData]. final int ranking; - /// Number of [LeaderboardEntry]s at the time of score entry. + /// Number of [LeaderboardEntryData]s at the time of score entry. final int outOf; @override diff --git a/packages/leaderboard_repository/lib/src/models/models.dart b/packages/leaderboard_repository/lib/src/models/models.dart index 3dabe2bf..e10a743b 100644 --- a/packages/leaderboard_repository/lib/src/models/models.dart +++ b/packages/leaderboard_repository/lib/src/models/models.dart @@ -1,2 +1,2 @@ -export 'leaderboard_entry.dart'; +export 'leaderboard_entry_data.dart'; export 'leaderboard_ranking.dart'; diff --git a/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart b/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart index cd632638..592425ec 100644 --- a/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart +++ b/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart @@ -57,7 +57,7 @@ void main() { final top10Leaderboard = top10Scores .map( - (score) => LeaderboardEntry( + (score) => LeaderboardEntryData( playerInitials: 'user$score', score: score, character: CharacterType.dash, @@ -144,7 +144,7 @@ void main() { entryScore, 1000, ]; - final leaderboardEntry = LeaderboardEntry( + final leaderboardEntry = LeaderboardEntryData( playerInitials: 'ABC', score: entryScore, character: CharacterType.dash, diff --git a/packages/leaderboard_repository/test/src/models/leaderboard_entry_test.dart b/packages/leaderboard_repository/test/src/models/leaderboard_entry_data_test.dart similarity index 72% rename from packages/leaderboard_repository/test/src/models/leaderboard_entry_test.dart rename to packages/leaderboard_repository/test/src/models/leaderboard_entry_data_test.dart index 21056529..f6e27e8a 100644 --- a/packages/leaderboard_repository/test/src/models/leaderboard_entry_test.dart +++ b/packages/leaderboard_repository/test/src/models/leaderboard_entry_data_test.dart @@ -9,21 +9,21 @@ void main() { 'character': 'dash', }; - const leaderboardEntry = LeaderboardEntry( + const leaderboardEntry = LeaderboardEntryData( playerInitials: 'ABC', score: 1500, character: CharacterType.dash, ); test('can be instantiated', () { - const leaderboardEntry = LeaderboardEntry.empty; + const leaderboardEntry = LeaderboardEntryData.empty; expect(leaderboardEntry, isNotNull); }); test('supports value equality.', () { - const leaderboardEntry = LeaderboardEntry.empty; - const leaderboardEntry2 = LeaderboardEntry.empty; + const leaderboardEntry = LeaderboardEntryData.empty; + const leaderboardEntry2 = LeaderboardEntryData.empty; expect(leaderboardEntry, equals(leaderboardEntry2)); }); @@ -33,7 +33,7 @@ void main() { }); test('can be obtained from json', () { - final leaderboardEntryFrom = LeaderboardEntry.fromJson(data); + final leaderboardEntryFrom = LeaderboardEntryData.fromJson(data); expect(leaderboardEntry, equals(leaderboardEntryFrom)); }); diff --git a/test/leaderboard/bloc/leaderboard_bloc_test.dart b/test/leaderboard/bloc/leaderboard_bloc_test.dart index c44f7d3a..72db27e4 100644 --- a/test/leaderboard/bloc/leaderboard_bloc_test.dart +++ b/test/leaderboard/bloc/leaderboard_bloc_test.dart @@ -42,7 +42,7 @@ void main() { final top10Leaderboard = top10Scores .map( - (score) => LeaderboardEntry( + (score) => LeaderboardEntryData( playerInitials: 'user$score', score: score, character: CharacterType.dash, @@ -101,7 +101,7 @@ void main() { }); group('LeaderboardEntryAdded', () { - final leaderboardEntry = LeaderboardEntry( + final leaderboardEntry = LeaderboardEntryData( playerInitials: 'ABC', score: 1500, character: CharacterType.dash, diff --git a/test/leaderboard/bloc/leaderboard_event_test.dart b/test/leaderboard/bloc/leaderboard_event_test.dart index f74296af..33199ca1 100644 --- a/test/leaderboard/bloc/leaderboard_event_test.dart +++ b/test/leaderboard/bloc/leaderboard_event_test.dart @@ -20,7 +20,7 @@ void main() { }); group('LeaderboardEntryAdded', () { - const leaderboardEntry = LeaderboardEntry( + const leaderboardEntry = LeaderboardEntryData( playerInitials: 'ABC', score: 1500, character: CharacterType.dash, diff --git a/test/leaderboard/bloc/leaderboard_state_test.dart b/test/leaderboard/bloc/leaderboard_state_test.dart index 6ff5df13..da8410b5 100644 --- a/test/leaderboard/bloc/leaderboard_state_test.dart +++ b/test/leaderboard/bloc/leaderboard_state_test.dart @@ -25,7 +25,7 @@ void main() { }); group('copyWith', () { - const leaderboardEntry = LeaderboardEntry( + const leaderboardEntry = LeaderboardEntryData( playerInitials: 'ABC', score: 1500, character: CharacterType.dash,