Skip to content

Commit 8ac453b

Browse files
fullenifulleni
authored
Merge pull request #9 from flutter-news-app-full-source-code/feat/keys-update
Feat/keys update
2 parents 35f1c63 + 3bc84d4 commit 8ac453b

File tree

8 files changed

+211
-177
lines changed

8 files changed

+211
-177
lines changed

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 1.1.0 - 2025-12-04
2+
3+
- **feat**: add `positiveInteractionCountKey` to track user engagement for in-app reviews.
4+
- **feat**: add `fcmToken` and `oneSignalPlayerId` key to persist the Firebase Cloud Messaging and onesignal token.
5+
- **chore**: update package dependencies.
6+
17
## 1.0.1 - 2025-10-24
28

39
- **chore**: add changelog.

‎analysis_options.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
include: package:very_good_analysis/analysis_options.6.0.0.yaml
2+
analyzer:
3+
errors:
4+
lines_longer_than_80_chars: ignore

‎lib/kv_storage_service.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/// Defines an abstract interface for key-value storage services.
22
library kv_storage_service;
33

4+
export 'src/exceptions.dart';
45
export 'src/kv_storage_service.dart';
56
export 'src/storage_keys.dart';

‎lib/src/exceptions.dart‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
// ignore_for_file: lines_longer_than_80_chars
2+
3+
/// {@template storage_exception}
4+
/// Base class for all key-value storage related exceptions.
5+
/// {@endtemplate}
6+
abstract class StorageException implements Exception {
7+
/// {@macro storage_exception}
8+
const StorageException({this.message, this.cause});
9+
10+
/// Optional original exception that caused this storage exception.
11+
final Object? cause;
12+
13+
/// Optional message describing the error.
14+
final String? message;
15+
16+
@override
17+
String toString() {
18+
var result = runtimeType.toString();
19+
if (message != null) {
20+
result += ': $message';
21+
}
22+
if (cause != null) {
23+
result += '\nCaused by: $cause';
24+
}
25+
return result;
26+
}
27+
}
28+
29+
/// {@template storage_initialization_exception}
30+
/// Exception thrown when a storage operation fails during initialization.
31+
/// {@endtemplate}
32+
class StorageInitializationException extends StorageException {
33+
/// {@macro storage_initialization_exception}
34+
const StorageInitializationException({super.message, super.cause});
35+
}
36+
37+
/// {@template storage_write_exception}
38+
/// Exception thrown when a write operation fails.
39+
/// {@endtemplate}
40+
class StorageWriteException extends StorageException {
41+
/// {@macro storage_write_exception}
42+
const StorageWriteException(
43+
this.key,
44+
this.value, {
45+
super.message = 'Failed to write value for key.',
46+
super.cause,
47+
});
48+
49+
/// The key associated with the failed write operation.
50+
final String key;
51+
52+
/// The value that failed to be written.
53+
final dynamic value;
54+
55+
@override
56+
String toString() {
57+
var result = 'StorageWriteException: $message Key: "$key"';
58+
if (cause != null) {
59+
result += '\nCaused by: $cause';
60+
}
61+
return result;
62+
}
63+
}
64+
65+
/// {@template storage_read_exception}
66+
/// Exception thrown when a read operation fails for reasons other than
67+
/// key not found or type mismatch.
68+
/// {@endtemplate}
69+
class StorageReadException extends StorageException {
70+
/// {@macro storage_read_exception}
71+
const StorageReadException(
72+
this.key, {
73+
super.message = 'Failed to read value for key.',
74+
super.cause,
75+
});
76+
77+
/// The key associated with the failed read operation.
78+
final String key;
79+
80+
@override
81+
String toString() {
82+
var result = 'StorageReadException: $message Key: "$key"';
83+
if (cause != null) {
84+
result += '\nCaused by: $cause';
85+
}
86+
return result;
87+
}
88+
}
89+
90+
/// {@template storage_delete_exception}
91+
/// Exception thrown when a delete operation fails.
92+
/// {@endtemplate}
93+
class StorageDeleteException extends StorageException {
94+
/// {@macro storage_delete_exception}
95+
const StorageDeleteException(
96+
this.key, {
97+
super.message = 'Failed to delete value for key.',
98+
super.cause,
99+
});
100+
101+
/// The key associated with the failed delete operation.
102+
final String key;
103+
104+
@override
105+
String toString() {
106+
var result = 'StorageDeleteException: $message Key: "$key"';
107+
if (cause != null) {
108+
result += '\nCaused by: $cause';
109+
}
110+
return result;
111+
}
112+
}
113+
114+
/// {@template storage_clear_exception}
115+
/// Exception thrown when the clear operation fails.
116+
/// {@endtemplate}
117+
class StorageClearException extends StorageException {
118+
/// {@macro storage_clear_exception}
119+
const StorageClearException({
120+
super.message = 'Failed to clear storage.',
121+
super.cause,
122+
});
123+
}
124+
125+
/// {@template storage_key_not_found_exception}
126+
/// Exception thrown when attempting to read or delete a key that does not exist.
127+
///
128+
/// Note: `read*` methods might return null instead of throwing this,
129+
/// depending on the implementation contract.
130+
/// {@endtemplate}
131+
class StorageKeyNotFoundException extends StorageException {
132+
/// {@macro storage_key_not_found_exception}
133+
const StorageKeyNotFoundException(
134+
this.key, {
135+
super.message = 'Key not found in storage.',
136+
}) : super(cause: null);
137+
138+
/// The key that was not found.
139+
final String key; // Typically not caused by another exception
140+
141+
@override
142+
String toString() {
143+
return 'StorageKeyNotFoundException: $message Key: "$key"';
144+
}
145+
}
146+
147+
/// {@template storage_type_mismatch_exception}
148+
/// Exception thrown when the data retrieved from storage does not match
149+
/// the expected type.
150+
/// {@endtemplate}
151+
class StorageTypeMismatchException extends StorageException {
152+
/// {@macro storage_type_mismatch_exception}
153+
const StorageTypeMismatchException(
154+
this.key,
155+
this.expectedType,
156+
this.actualType, {
157+
super.message = 'Type mismatch for key.',
158+
}) : super(cause: null);
159+
160+
/// The key associated with the type mismatch.
161+
final String key;
162+
163+
/// The type that was expected.
164+
final Type expectedType;
165+
166+
/// The actual type found in storage.
167+
final Type actualType; // Typically not caused by another exception
168+
169+
@override
170+
String toString() {
171+
return 'StorageTypeMismatchException: $message Key: "$key", Expected: $expectedType, Found: $actualType';
172+
}
173+
}

‎lib/src/kv_storage_service.dart‎

Lines changed: 1 addition & 175 deletions
Original file line numberDiff line numberDiff line change
@@ -1,178 +1,4 @@
1-
// ignore_for_file: lines_longer_than_80_chars
2-
3-
/// {@template storage_exception}
4-
/// Base class for all key-value storage related exceptions.
5-
/// {@endtemplate}
6-
abstract class StorageException implements Exception {
7-
/// {@macro storage_exception}
8-
const StorageException({this.message, this.cause});
9-
10-
/// Optional original exception that caused this storage exception.
11-
final Object? cause;
12-
13-
/// Optional message describing the error.
14-
final String? message;
15-
16-
@override
17-
String toString() {
18-
var result = runtimeType.toString();
19-
if (message != null) {
20-
result += ': $message';
21-
}
22-
if (cause != null) {
23-
result += '\nCaused by: $cause';
24-
}
25-
return result;
26-
}
27-
}
28-
29-
/// {@template storage_initialization_exception}
30-
/// Exception thrown when a storage operation fails during initialization.
31-
/// {@endtemplate}
32-
class StorageInitializationException extends StorageException {
33-
/// {@macro storage_initialization_exception}
34-
const StorageInitializationException({super.message, super.cause});
35-
}
36-
37-
/// {@template storage_write_exception}
38-
/// Exception thrown when a write operation fails.
39-
/// {@endtemplate}
40-
class StorageWriteException extends StorageException {
41-
/// {@macro storage_write_exception}
42-
const StorageWriteException(
43-
this.key,
44-
this.value, {
45-
super.message = 'Failed to write value for key.',
46-
super.cause,
47-
});
48-
49-
/// The key associated with the failed write operation.
50-
final String key;
51-
52-
/// The value that failed to be written.
53-
final dynamic value;
54-
55-
@override
56-
String toString() {
57-
var result = 'StorageWriteException: $message Key: "$key"';
58-
if (cause != null) {
59-
result += '\nCaused by: $cause';
60-
}
61-
return result;
62-
}
63-
}
64-
65-
/// {@template storage_read_exception}
66-
/// Exception thrown when a read operation fails for reasons other than
67-
/// key not found or type mismatch.
68-
/// {@endtemplate}
69-
class StorageReadException extends StorageException {
70-
/// {@macro storage_read_exception}
71-
const StorageReadException(
72-
this.key, {
73-
super.message = 'Failed to read value for key.',
74-
super.cause,
75-
});
76-
77-
/// The key associated with the failed read operation.
78-
final String key;
79-
80-
@override
81-
String toString() {
82-
var result = 'StorageReadException: $message Key: "$key"';
83-
if (cause != null) {
84-
result += '\nCaused by: $cause';
85-
}
86-
return result;
87-
}
88-
}
89-
90-
/// {@template storage_delete_exception}
91-
/// Exception thrown when a delete operation fails.
92-
/// {@endtemplate}
93-
class StorageDeleteException extends StorageException {
94-
/// {@macro storage_delete_exception}
95-
const StorageDeleteException(
96-
this.key, {
97-
super.message = 'Failed to delete value for key.',
98-
super.cause,
99-
});
100-
101-
/// The key associated with the failed delete operation.
102-
final String key;
103-
104-
@override
105-
String toString() {
106-
var result = 'StorageDeleteException: $message Key: "$key"';
107-
if (cause != null) {
108-
result += '\nCaused by: $cause';
109-
}
110-
return result;
111-
}
112-
}
113-
114-
/// {@template storage_clear_exception}
115-
/// Exception thrown when the clear operation fails.
116-
/// {@endtemplate}
117-
class StorageClearException extends StorageException {
118-
/// {@macro storage_clear_exception}
119-
const StorageClearException({
120-
super.message = 'Failed to clear storage.',
121-
super.cause,
122-
});
123-
}
124-
125-
/// {@template storage_key_not_found_exception}
126-
/// Exception thrown when attempting to read or delete a key that does not exist.
127-
///
128-
/// Note: `read*` methods might return null instead of throwing this,
129-
/// depending on the implementation contract.
130-
/// {@endtemplate}
131-
class StorageKeyNotFoundException extends StorageException {
132-
/// {@macro storage_key_not_found_exception}
133-
const StorageKeyNotFoundException(
134-
this.key, {
135-
super.message = 'Key not found in storage.',
136-
}) : super(cause: null);
137-
138-
/// The key that was not found.
139-
final String key; // Typically not caused by another exception
140-
141-
@override
142-
String toString() {
143-
return 'StorageKeyNotFoundException: $message Key: "$key"';
144-
}
145-
}
146-
147-
/// {@template storage_type_mismatch_exception}
148-
/// Exception thrown when the data retrieved from storage does not match
149-
/// the expected type.
150-
/// {@endtemplate}
151-
class StorageTypeMismatchException extends StorageException {
152-
/// {@macro storage_type_mismatch_exception}
153-
const StorageTypeMismatchException(
154-
this.key,
155-
this.expectedType,
156-
this.actualType, {
157-
super.message = 'Type mismatch for key.',
158-
}) : super(cause: null);
159-
160-
/// The key associated with the type mismatch.
161-
final String key;
162-
163-
/// The type that was expected.
164-
final Type expectedType;
165-
166-
/// The actual type found in storage.
167-
final Type actualType; // Typically not caused by another exception
168-
169-
@override
170-
String toString() {
171-
return 'StorageTypeMismatchException: $message Key: "$key", Expected: $expectedType, Found: $actualType';
172-
}
173-
}
174-
175-
// endregion
1+
import 'package:kv_storage_service/src/exceptions.dart';
1762

1773
/// {@template key_value_storage_service}
1784
/// Defines the contract for a generic key-value storage service.

0 commit comments

Comments
 (0)