Adds clubs models

lib/models.dart

@@ -37,7 +37,9 @@ export "src/models/data/reminders.dart";
 export "src/models/data/schedule.dart";
 export "src/models/data/sports.dart";
 export "src/models/data/user.dart";
-
+export "src/models/data/clubs/clubs.dart";
+export "src/models/data/clubs/club_captains.dart";
+export "src/models/data/clubs/club_admin.dart";
 // view models
 export "src/models/view/admin_schedules.dart";
 export "src/models/view/builders/day_builder.dart";

lib/src/data/clubs/club.dart

@@ -9,6 +9,12 @@ class Club {
 	/// The name of the club. 
 	final String name;
 
+	/// The random id assigned to the club to identify it.
+	final String id;
+
+	/// Approval status of the club.
+	bool? isApproved;
+
 	/// A short description of the club. 
 	final String shortDescription;
 
@@ -31,17 +37,19 @@ class Club {
 	final List<Message> messages;
 
 	/// A list of attendance for each member of the club.
-	final Map<String, int> attendance;
+	final Map<ContactInfo, int> attendance;
 
 	/// The captains of the club.
-	final List<ContactInfo> captains;
+	final List<ContactInfo?> captains;
 
 	/// The faculty advisor for this club.
-	final ContactInfo facultyAdvisor;
+	final List<ContactInfo?> facultyAdvisor;
 
 	/// Creates a new club.
 	Club({
 		required this.name,
+		required this.isApproved,
+		required this.id,
 		required this.shortDescription,
 		required this.description,
 		required this.phoneNumberRequested,

lib/src/data/contact_info.dart

@@ -15,7 +15,7 @@ class ContactInfo {
 	/// 
 	/// This is filled in voluntary by the user, and cannot be retrieved from the 
 	/// database. So this field will start off null, and be populated over time. 
-	final String? phoneNumber;
+	late final String? phoneNumber;
 
 	/// Bundles personal info about the user. 
 	ContactInfo({

lib/src/models/data/clubs/club_admin.dart

@@ -0,0 +1,30 @@
+import "package:ramaz/models.dart";
+import "package:ramaz/data.dart";
+import "package:ramaz/services.dart";
+import "package:ramaz/src/data/contact_info.dart";
+import "../model.dart";
+
+/// Handles all the actions a admin may need to do
+class ClubAdmins extends Model{
+  @override
+  Future<void> init() {
+    // TODO: implement init
+    throw UnimplementedError();
+  }
+
+  /// Allows clubs admin to approve a club to be shown to all the users
+  Future<void> approveClub(Club club) async{
+    club.isApproved=true;
+    Services.instance.database.clubs.save(club.id, club.toJson());
+  }
+
+  /// Allows a clubs admin to delete a club.
+  Future<void> deleteClub(Club club) async{
+    Services.instance.database.clubs.delete(club.toJson());
+  }
+
+  Future<void> addFacultyAdvisor(Club club, ContactInfo facultyAdvisor){
+    club.facultyAdvisor.add(facultyAdvisor);
+    Services.instance.database.clubs.update(club.toJson());
+  }
+}

lib/src/models/data/clubs/club_captains.dart

@@ -0,0 +1,65 @@
+import "package:ramaz/models.dart";
+import "package:ramaz/data.dart";
+import "package:ramaz/services.dart";
+import "package:ramaz/src/data/contact_info.dart";
+import "../model.dart";
+
+/// A model which handles all the actions which a captain may need.
+class ClubCaptains extends Model {
+
+  @override
+  Future<void> init() async{
+  }
+
+  /// Checks if a user is a captain.
+  bool isCaptain(Club club) =>
+      club.captains.contains(Models.instance.user.data.contactInfo);
+
+  /// Checks if a user is a faculty advisor.
+  bool? isFacultyAdvisor(Club club) =>
+      club.facultyAdvisor.contains(Models.instance.user.data.contactInfo);
+
+  /// Allows user to upload a club.
+  Future<void> uploadClub(Club newClub) async {
+    if((Models.instance.user.adminScopes ?? []).contains(AdminScope.clubs)){
+      newClub.isApproved = true;
+    }else{
+      newClub.isApproved = null;
+    }
+    Services.instance.database.clubs.admin.create(newClub.toJson());
+  }
+
+  /// Allows admin or club captain to remove a member from a club.
+  Future<void> removeMember(Club club, ContactInfo member) async {
+    Models.instance.user.data.registeredClubs.remove(club.id);
+    club.members.remove(member);
+    Services.instance.database.clubs.memberRemove(
+        club.id, member.toJson()
+    );
+    club.attendance.remove(Models.instance.user.data.contactInfo);
+  }
+
+  /// Allows captain to post message.
+  Future<void>? postMessage(Club club, Message message) async {
+    Services.instance.database.clubs.postMessage(club.id, message.toJson());
+  }
+
+  /// Allows captains to edit a club.
+  Future<void> editClub(Club club) async {
+    if((Models.instance.user.data.adminScopes ?? []).contains(
+        AdminScope.clubs)){
+      club.isApproved = true;
+    }else{
+      club.isApproved = null;
+    }
+    Services.instance.database.clubs.update(club.toJson());
+  }
+
+  /// Allows a captain to take attendance.
+  Future<void> takeAttendance(
+      ContactInfo member, Club club, bool attend) async{
+    attend ? club.attendance[member]= (club.attendance[member]!) + 1
+        :club.attendance[member] = club.attendance[member]!;
+    Services.instance.database.clubs.update(club.toJson());
+  }
+}

lib/src/models/data/clubs/clubs.dart

@@ -0,0 +1,46 @@
+import "package:ramaz/models.dart";
+import "package:ramaz/data.dart";
+import "package:ramaz/services.dart";
+import "../model.dart";
+
+/// A model which handles all the club actions for users.
+class Clubs extends Model{
+
+  /// List of all the clubs.
+  late List<Club> getAllClubs;
+
+  ///Returns a list of all the clubs that have been created.
+  @override
+  Future<void> init() async {
+    getAllClubs = [
+      for(final Map json in await Services.instance.database.clubs.getAll()){
+        Club.fromjson(json)
+      }
+    ];
+  }
+
+  /// Allows a user to register
+  Future<void> registerForClub(Club club) async {
+    Models.instance.user.data.registeredClubs.add(club.id);
+    club.members.add(Models.instance.user.data.contactInfo);
+    Services.instance.database.clubs.register(
+        club.id, Models.instance.user.data.contactInfo.toJson()
+    );
+    club.attendance[(Models.instance.user.data.contactInfo)]=0;
+  }
+
+  ///Allows User to unregister from a club
+  Future<void> unregisterFromClub(Club club) async {
+    Models.instance.user.data.registeredClubs.remove(club.id);
+    club.members.remove(Models.instance.user.data.contactInfo);
+    Services.instance.database.clubs.unregister(
+        club.id, Models.instance.user.data.contactInfo.toJson()
+    );
+    club.attendance.remove(Models.instance.user.data.contactInfo);
+  }
+
+  ///Adds the User's phone number to contactInfo.phoneNumber
+  Future<void> addPhoneNumber(String number) async {
+    Models.instance.user.data.contactInfo.phoneNumber=number;
+  }
+}