task(department-name): Adiciona nome dos departamentos ao banco de dados

api/api/admin.py

@@ -6,9 +6,9 @@
 
 @admin.register(Department)
 class DepartmentAdmin(admin.ModelAdmin):
-    list_display = ['code', 'year', 'period']
-    search_fields = ['code']
-    ordering = ['year', 'period']
+    list_display = ['name', 'code', 'year', 'period']
+    search_fields = ['code', 'name']
+    ordering = ['year', 'period', 'name']
 
 
 @admin.register(Discipline)

api/api/management/commands/updatedb.py

@@ -60,18 +60,20 @@ def handle(self, *args: Any, **options: Any):
                     target=self.delete_period, args=(year, period,))
                 threads.append(thread)
                 thread.start()
-            
+
             for thread in threads:
                 thread.join()
             threads.clear()
 
             return
 
-        departments_ids = get_list_of_departments()
-
-        if departments_ids is None:
-            self.display_error_message("department_ids")
+        departments_data = get_list_of_departments()
+        if departments_data is None:
+            self.display_error_message("get_list_of_departments")
             return
+        departments_ids, departments_names = departments_data
+        if departments_ids is None or departments_names is None:
+            self.display_error_message("get_list_of_departments")
 
         print("Atualizando o banco de dados...")
 
@@ -81,7 +83,7 @@ def start_update_year_period(year: str, period: str):
                 print(f"Começando atualização de {year}/{period}")
                 with transaction.atomic():
                     self.update_departments(
-                        departments_ids, year, period, options)
+                        departments_ids=departments_ids, departments_names=departments_names, year=year, period=period, options=options)
 
                 self.display_success_update_message(
                     operation=f"{year}/{period}", start_time=start_time)
@@ -105,9 +107,9 @@ def start_update_year_period(year: str, period: str):
 
         print(f"\nTempo total de execução: {(time() - start_tot_time):.1f}s")
 
-    def update_departments(self, departments_ids: list, year: str, period: str, options: Any) -> None:
+    def update_departments(self, departments_ids: list, departments_names: list, year: str, period: str, options: Any) -> None:
         """Atualiza os departamentos do banco de dados e suas respectivas disciplinas."""
-        def execute_update(department_id):
+        def execute_update(department_id, department_name) -> None:
             scraper = DisciplineWebScraper(department_id, year, period)
             fingerprint = scraper.create_page_fingerprint()
 
@@ -124,7 +126,7 @@ def execute_update(department_id):
 
             disciplines_list = scraper.get_disciplines()
             department = dbh.get_or_create_department(
-                code=department_id, year=year, period=period)
+                code=department_id, name=department_name, year=year, period=period)
 
             if options['descriptive']:
                 print(f"Departamento ({department_id}) desatualizado, operação necessária")
@@ -146,14 +148,14 @@ def execute_update(department_id):
                                      days=class_info["days"], _class=class_info["class_code"], discipline=discipline, special_dates=class_info["special_dates"])
 
             cache.set(cache_key, fingerprint, timeout=THIRTY_DAYS_IN_SECS)
-            
+
             if options['descriptive']:
                 print(f'Operação de atualização finalizada para o departamento ({department_id})')
-            
+
         threads = deque()
-        for department_id in departments_ids:
+        for department_id, department_name in zip(departments_ids, departments_names):
             thread = threading.Thread(
-                target=execute_update, args=(department_id,))
+                target=execute_update, args=(department_id, department_name))
             threads.append(thread)
             thread.start()
 

api/api/migrations/0009_department_name.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.10 on 2024-02-22 01:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0008_schedule_created_at'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='department',
+            name='name',
+            field=models.CharField(default='', max_length=128),
+        ),
+    ]

api/api/models.py

@@ -16,7 +16,7 @@ def delete(self, *args, **kwargs):
         try:
             cache.delete(kwargs['cache_key'])
             kwargs.pop('cache_key')
-        except: # pragma: no cover
+        except:  # pragma: no cover
             raise ValueError(cache_error_msg)
         else:
             super(CustomModel, self).delete()
@@ -29,6 +29,7 @@ class Department(CustomModel):
     year:str -> Ano do departamento
     period:str -> Período do departamento
     """
+    name = models.CharField(max_length=128, default='')
     code = models.CharField(max_length=10)
     year = models.CharField(max_length=4, default='0000')
     period = models.CharField(max_length=1, default='1')

api/api/tests/test_generate_schedule_api.py

@@ -3,13 +3,14 @@
 from random import randint
 import json
 
+
 class TestGenerateScheduleAPI(APITestCase):
     def setUp(self):
         self.factory = APIRequestFactory()
         self.content_type = 'application/json'
         self.api_url = '/courses/schedules/generate/'
         self.department = get_or_create_department(
-            code='518', year='2023', period='2')
+            code='518', name='Departamento de Matemática e Estatística', year='2023', period='2')
         self.discipline = get_or_create_discipline(
             name='CÁLCULO 1', code='MAT518', department=self.department)
         self.class_1 = create_class(teachers=['RICARDO FRAGELLI'], classroom='S9', schedule='46M34', days=[
@@ -22,7 +23,7 @@ def setUp(self):
                                     'Segunda-Feira 10:00 às 11:50', 'Quarta-Feira 10:00 às 11:50'], _class="1", special_dates=[], discipline=self.discipline_2)
         self.class_4 = create_class(teachers=['Tatiana'], classroom='S1', schedule='7M1234', days=[
                                     'Sábado 08:00 às 11:50'], _class="2", special_dates=[], discipline=self.discipline_2)
-    
+
     def test_with_correct_parameters(self):
         """
         Testa a geração de horários com todos os parâmetros corretos
@@ -32,12 +33,13 @@ def test_with_correct_parameters(self):
             'preference': [3, 2, 1],
             'classes': [self.class_1.id, self.class_2.id, self.class_3.id, self.class_4.id]
         })
-
-        response = self.client.post(self.api_url, body, content_type=self.content_type)
-
+
+        response = self.client.post(
+            self.api_url, body, content_type=self.content_type)
+
         self.assertEqual(response.status_code, 200)
         self.assertTrue(len(response.data["schedules"]) > 0)
-    
+
     def test_with_conflicting_classes(self):
         """
         Testa a geração de horários com classes conflitantes
@@ -46,32 +48,35 @@ def test_with_conflicting_classes(self):
             'preference': [3, 2, 1],
             'classes': [self.class_1.id, self.class_3.id]
         })
-
-        response = self.client.post(self.api_url, body, content_type=self.content_type)
-
+
+        response = self.client.post(
+            self.api_url, body, content_type=self.content_type)
+
         self.assertEqual(response.status_code, 200)
         self.assertFalse(len(response.data["schedules"]))
-    
+
     def test_with_invalid_class(self):
         """
         Testa a geração de horários com uma classe inválida
         """
-
-        classes_ids = [self.class_1.id, self.class_2.id, self.class_3.id, self.class_4.id]
+
+        classes_ids = [self.class_1.id, self.class_2.id,
+                       self.class_3.id, self.class_4.id]
         random_id = randint(1, 10000)
-        
-        while(random_id in classes_ids): # pragma: no cover
+
+        while (random_id in classes_ids):  # pragma: no cover
             random_id = randint(1, 10000)
-        
+
         body = json.dumps({
             'preference': [3, 2, 1],
             'classes': classes_ids + [random_id]
         })
-
-        response = self.client.post(self.api_url, body, content_type=self.content_type)
-
+
+        response = self.client.post(
+            self.api_url, body, content_type=self.content_type)
+
         self.assertEqual(response.status_code, 400)
-    
+
     def test_with_invalid_preference(self):
         """
         Testa a geração de horários com uma preferência inválida
@@ -80,11 +85,12 @@ def test_with_invalid_preference(self):
             'preference': [3, 2, 1, 4],
             'classes': [self.class_1.id, self.class_2.id, self.class_3.id, self.class_4.id]
         })
-
-        response = self.client.post(self.api_url, body, content_type=self.content_type)
-
+
+        response = self.client.post(
+            self.api_url, body, content_type=self.content_type)
+
         self.assertEqual(response.status_code, 400)
-    
+
     def test_with_invalid_preference_type(self):
         """
         Testa a geração de horários com uma preferência inválida (tipo)
@@ -93,32 +99,35 @@ def test_with_invalid_preference_type(self):
             'preference': [3, 2, '1'],
             'classes': [self.class_1.id, self.class_2.id, self.class_3.id, self.class_4.id]
         })
-
-        response = self.client.post(self.api_url, body, content_type=self.content_type)
-
+
+        response = self.client.post(
+            self.api_url, body, content_type=self.content_type)
+
         self.assertEqual(response.status_code, 400)
-    
+
     def test_with_no_classes(self):
         """
         Testa a geração de horários sem classes
         """
         body = json.dumps({
             'classes': []
         })
-
-        response = self.client.post(self.api_url, body, content_type=self.content_type)
-
+
+        response = self.client.post(
+            self.api_url, body, content_type=self.content_type)
+
         self.assertEqual(response.status_code, 400)
-    
+
     def test_with_no_preference(self):
         """
         Testa a geração de horários sem preferência
         """
         body = json.dumps({
             'classes': [self.class_1.id]
         })
-
-        response = self.client.post(self.api_url, body, content_type=self.content_type)
-
+
+        response = self.client.post(
+            self.api_url, body, content_type=self.content_type)
+
         self.assertEqual(response.status_code, 200)
-        self.assertTrue(len(response.data["schedules"]) > 0)
+        self.assertTrue(len(response.data["schedules"]) > 0)

api/api/tests/test_get_schedules_api.py

@@ -11,7 +11,8 @@
 
 class TestGetSchedules(APITestCase):
     def setUp(self):
-        self.department = dbh.get_or_create_department('518', '2023', '2')
+        self.department = dbh.get_or_create_department(
+            '518', 'Departamento de matematica', '2023', '2')
         self.discipline = dbh.get_or_create_discipline(
             'CÁLCULO 1', 'MAT0025', self.department)
         self._class = dbh.create_class(['EDSON ALVES DA COSTA JUNIOR'], 'FGA - I8', '35T23', [

api/api/tests/test_models.py

@@ -6,6 +6,7 @@
 class ModelsTest(TestCase):
     def create_data(self):
         self.department = Department.objects.create(
+            name='Instituto de Informática',
             code='INF',
             year="2023",
             period="2"
@@ -46,6 +47,7 @@ def test_create_class(self):
         self.assertEqual(self._class.discipline, self.discipline)
 
     def test_create_department(self):
+        self.assertEqual(self.department.name, 'Instituto de Informática')
         self.assertEqual(self.department.code, 'INF')
         self.assertEqual(self.department.year, '2023')
         self.assertEqual(self.department.period, '2')
@@ -85,4 +87,3 @@ def test_delete_class_with_cache_handle(self):
 
         self.assertTrue(empty_model)
         self.assertTrue(empty_cache)
-

api/api/tests/test_schedule_delete.py

@@ -11,7 +11,8 @@
 
 class TestDeleteSchedules(APITestCase):
     def setUp(self):
-        self.department = dbh.get_or_create_department('518', '2023', '2')
+        self.department = dbh.get_or_create_department(
+            '518', 'Departamento de Matemática e Estatística', '2023', '2')
         self.discipline = dbh.get_or_create_discipline(
             'CÁLCULO 1', 'MAT0025', self.department)
         self._class = dbh.create_class(['EDSON ALVES DA COSTA JUNIOR'], 'FGA - I8', '35T23', [

api/api/tests/test_schedule_save.py

@@ -21,8 +21,10 @@ class TestScheduleSaveAPI(APITestCase, ErrorRequestBodyScheduleSave):
 
     def setDepartmentInfos(self):
         self.department_infos = [
-            ('518', '2023', '2'), ('673', '2023', '2'),
-            ('518', '2024', '1'), ('673', '2024', '1')
+            ('518', 'Departamento de Matemática e Estatística',
+             '2023', '2'), ('673', 'Departamento de Matemática e Estatística', '2023', '2'),
+            ('518', 'Departamento de Matemática e Estatística', '2024',
+             '1'), ('673', 'Departamento de Matemática e Estatística', '2024', '1')
         ]
 
     def setDisciplineInfos(self):
@@ -98,9 +100,9 @@ def setUpDepartments(self):
         self.departments = {}
         self.setDepartmentInfos()
         for i, infos in enumerate(self.department_infos):
-            code, year, period = infos
+            code, name, year, period = infos
             new_department = dbh.get_or_create_department(
-                code=code, year=year, period=period
+                code=code, name=name, year=year, period=period
             )
             self.departments[f'department_{i}_{year}_{period}'] = new_department
 

api/api/tests/test_search_api.py

@@ -7,7 +7,7 @@
 class TestSearchAPI(APITestCase):
     def setUp(self) -> None:
         self.department = get_or_create_department(
-            code='518', year='2023', period='2')
+            code='518', name='Departamento de Computação', year='2023', period='2')
         self.discipline_1 = get_or_create_discipline(
             name='CÁLCULO 1', code='MAT518', department=self.department)
         self.discipline_2 = get_or_create_discipline(

api/utils/db_handler.py

@@ -15,9 +15,9 @@
 """Este módulo lida com as operações de banco de dados."""
 
 
-def get_or_create_department(code: str, year: str, period: str) -> Department:
+def get_or_create_department(code: str, name: str, year: str, period: str) -> Department:
     """Cria um departamento."""
-    return Department.objects.get_or_create(code=code, year=year, period=period)[0]
+    return Department.objects.get_or_create(code=code, name=name, year=year, period=period)[0]
 
 
 def get_or_create_discipline(name: str, code: str, department: Department) -> Discipline: