refactor: replace Role model with UserRole enum

- Removed Role model
- Added UserRole enum
- Updated User model

Author: fulleni

analysis_options.yaml

@@ -3,3 +3,4 @@ analyzer:
   errors:
     lines_longer_than_80_chars: ignore
     no_runtimetype_tostring: ignore
+    unnecessary_null_checks: ignore

lib/ht_shared.dart

@@ -4,4 +4,3 @@ library;
 export 'src/exceptions/exceptions.dart';
 export 'src/models/models.dart';
 export 'src/models/permission.dart';
-export 'src/models/role.dart';

lib/src/models/role.dart

@@ -1,5 +1,5 @@
 import 'package:equatable/equatable.dart';
-import 'package:ht_shared/src/models/role.dart';
+import 'package:ht_shared/src/models/user_role.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'user.g.dart';
@@ -29,7 +29,7 @@ class User extends Equatable {
   final String? email;
 
   /// The role of the user.
-  final Role role;
+  final UserRole role;
 
   /// Converts this User instance to JSON data.
   Map<String, dynamic> toJson() => _$UserToJson(this);

lib/src/models/role.g.dart

@@ -0,0 +1,14 @@
+import 'package:json_annotation/json_annotation.dart';
+
+/// Defines the available user roles in the system.
+@JsonEnum(fieldRename: FieldRename.snake)
+enum UserRole {
+  /// Administrator role with full privileges.
+  admin,
+
+  /// Standard user role with regular privileges.
+  standardUser,
+
+  /// Guest user role with limited privileges.
+  guestUser,
+}

lib/src/models/user.dart

@@ -1,4 +1,5 @@
 import 'package:ht_shared/ht_shared.dart';
+import 'package:ht_shared/src/models/user_role.dart';
 import 'package:test/test.dart';
 
 void main() {
@@ -7,7 +8,7 @@ void main() {
     const testUser = User(
       id: 'user-123',
       email: 'test@example.com',
-      role: Role(name: 'standard_user'),
+      role: UserRole.standardUser,
     );
     const testToken = 'sample-jwt-token';
 
@@ -94,7 +95,7 @@ void main() {
         const updatedUser = User(
           id: 'user-456',
           email: 'updated@example.com',
-          role: Role(name: 'guest_user'), // Use Role object
+          role: UserRole.guestUser,
         );
         final copiedResponse = authSuccessResponse.copyWith(user: updatedUser);
 
@@ -115,7 +116,7 @@ void main() {
       });
 
       test('should create a copy with both user and token updated', () {
-        const updatedUser = User(id: 'user-789', role: Role(name: 'guest_user')); // Use Role object
+        const updatedUser = User(id: 'user-789', role: UserRole.guestUser);
         const updatedToken = 'another-token-xyz';
         final copiedResponse = authSuccessResponse.copyWith(
           user: updatedUser,
@@ -137,7 +138,7 @@ void main() {
       });
 
       test('should not equate instances with different users', () {
-        const differentUser = User(id: 'diff-user', role: Role(name: 'admin')); // Use Role object
+        const differentUser = User(id: 'diff-user', role: UserRole.admin);
         const response1 = AuthSuccessResponse(user: testUser, token: testToken);
         const response2 = AuthSuccessResponse(
           user: differentUser,

lib/src/models/user.g.dart

@@ -1,14 +1,14 @@
-import 'package:ht_shared/src/models/role.dart';
 import 'package:ht_shared/src/models/user.dart';
+import 'package:ht_shared/src/models/user_role.dart';
 import 'package:test/test.dart';
 
 void main() {
   group('User Model', () {
     const id = 'test-id';
     const email = 'test@example.com';
-    const standardRole = Role(name: 'standard_user');
-    const guestRole = Role(name: 'guest_user');
-    const adminRole = Role(name: 'admin');
+    const standardRole = UserRole.standardUser;
+    const guestRole = UserRole.guestUser;
+    const adminRole = UserRole.admin;
 
     test('supports value equality', () {
       expect(
@@ -18,20 +18,14 @@ void main() {
       expect(
         const User(id: id, email: email, role: standardRole),
         isNot(
-          equals(
-            const User(id: 'other-id', email: email, role: standardRole),
-          ),
+          equals(const User(id: 'other-id', email: email, role: standardRole)),
         ),
       );
       expect(
         const User(id: id, email: email, role: standardRole),
         isNot(
           equals(
-            const User(
-              id: id,
-              email: 'other@example.com',
-              role: standardRole,
-            ),
+            const User(id: id, email: 'other@example.com', role: standardRole),
           ),
         ),
       );
@@ -48,15 +42,15 @@ void main() {
     test('has correct toString', () {
       expect(
         const User(id: id, email: email, role: standardRole).toString(),
-        equals('User(id: $id, email: $email, role: ${standardRole.toString()})'),
+        equals('User(id: $id, email: $email, role: $standardRole)'),
       );
       expect(
         const User(id: id, role: guestRole).toString(),
-        equals('User(id: $id, email: null, role: ${guestRole.toString()})'),
+        equals('User(id: $id, email: null, role: $guestRole)'),
       );
       expect(
         const User(id: id, role: adminRole).toString(),
-        equals('User(id: $id, email: null, role: ${adminRole.toString()})'),
+        equals('User(id: $id, email: null, role: $adminRole)'),
       );
     });