Merge pull request #225 from ioet/refactor-large-files

closes #224 - Refactor projects and time entries classes

Author: enriquezrene

tests/conftest.py

@@ -11,7 +11,7 @@
 from time_tracker_api import create_app
 from time_tracker_api.database import init_sql
 from time_tracker_api.security import get_or_generate_dev_secret_key
-from time_tracker_api.time_entries.time_entries_model import (
+from time_tracker_api.time_entries.time_entries_repository import (
     TimeEntryCosmosDBRepository,
 )
 

tests/time_tracker_api/time_entries/time_entries_model_test.py

@@ -3,10 +3,9 @@
 
 from commons.data_access_layer.database import EventContext
 from time_tracker_api.time_entries.time_entries_model import (
-    TimeEntryCosmosDBRepository,
     TimeEntryCosmosDBModel,
 )
-
+from time_tracker_api.time_entries.time_entries_repository import TimeEntryCosmosDBRepository
 
 def create_time_entry(
     start_date: str,

time_tracker_api/projects/projects_dao.py

@@ -0,0 +1,68 @@
+from azure.cosmos import PartitionKey
+from commons.data_access_layer.cosmos_db import (
+    CosmosDBDao,
+    CosmosDBRepository,
+)
+from time_tracker_api.database import CRUDDao, APICosmosDBDao
+from time_tracker_api.customers.customers_model import (
+    create_dao as customers_create_dao,
+)
+from time_tracker_api.projects.projects_model import ProjectCosmosDBModel
+
+from utils.extend_model import add_customer_name_to_projects
+
+
+class ProjectDao(CRUDDao):
+    pass
+
+
+container_definition = {
+    'id': 'project',
+    'partition_key': PartitionKey(path='/tenant_id'),
+    'unique_key_policy': {
+        'uniqueKeys': [{'paths': ['/name', '/customer_id', '/deleted']},]
+    },
+}
+
+
+class ProjectCosmosDBRepository(CosmosDBRepository):
+    def __init__(self):
+        CosmosDBRepository.__init__(
+            self,
+            container_id=container_definition['id'],
+            partition_key_attribute='tenant_id',
+            mapper=ProjectCosmosDBModel,
+        )
+
+
+class ProjectCosmosDBDao(APICosmosDBDao, ProjectDao):
+    def __init__(self, repository):
+        CosmosDBDao.__init__(self, repository)
+
+    def get_all(self, conditions: dict = None, **kwargs) -> list:
+        event_ctx = self.create_event_context("read-many")
+        customer_dao = customers_create_dao()
+        customers = customer_dao.get_all(
+            max_count=kwargs.get('max_count', None)
+        )
+
+        customers_id = [customer.id for customer in customers]
+        conditions = conditions if conditions else {}
+        custom_condition = "c.customer_id IN {}".format(
+            str(tuple(customers_id))
+        )
+        # TODO this must be refactored to be used from the utils module ↑
+        if "custom_sql_conditions" in kwargs:
+            kwargs["custom_sql_conditions"].append(custom_condition)
+        else:
+            kwargs["custom_sql_conditions"] = [custom_condition]
+        projects = self.repository.find_all(event_ctx, conditions, **kwargs)
+
+        add_customer_name_to_projects(projects, customers)
+        return projects
+
+
+def create_dao() -> ProjectDao:
+    repository = ProjectCosmosDBRepository()
+
+    return ProjectCosmosDBDao(repository)

time_tracker_api/projects/projects_model.py

@@ -1,31 +1,9 @@
 from dataclasses import dataclass
-from azure.cosmos import PartitionKey
 from commons.data_access_layer.cosmos_db import (
     CosmosDBModel,
-    CosmosDBDao,
-    CosmosDBRepository,
-)
-from time_tracker_api.database import CRUDDao, APICosmosDBDao
-from time_tracker_api.customers.customers_model import (
-    create_dao as customers_create_dao,
 )
 from time_tracker_api.customers.customers_model import CustomerCosmosDBModel
 
-from utils.extend_model import add_customer_name_to_projects
-
-
-class ProjectDao(CRUDDao):
-    pass
-
-
-container_definition = {
-    'id': 'project',
-    'partition_key': PartitionKey(path='/tenant_id'),
-    'unique_key_policy': {
-        'uniqueKeys': [{'paths': ['/name', '/customer_id', '/deleted']},]
-    },
-}
-
 
 @dataclass()
 class ProjectCosmosDBModel(CosmosDBModel):
@@ -52,52 +30,3 @@ def __repr__(self):
 
     def __str___(self):
         return "the project \"%s\"" % self.name  # pragma: no cover
-
-
-class ProjectCosmosDBRepository(CosmosDBRepository):
-    def __init__(self):
-        CosmosDBRepository.__init__(
-            self,
-            container_id=container_definition['id'],
-            partition_key_attribute='tenant_id',
-            mapper=ProjectCosmosDBModel,
-        )
-
-
-class ProjectCosmosDBDao(APICosmosDBDao, ProjectDao):
-    def __init__(self, repository):
-        CosmosDBDao.__init__(self, repository)
-
-    def get_all(self, conditions: dict = None, **kwargs) -> list:
-        """
-        Get all the projects an active client has
-        :param (dict) conditions: Conditions for querying the database
-        :param (dict) kwargs: Pass arguments
-        :return (list): ProjectCosmosDBModel object list
-        """
-        event_ctx = self.create_event_context("read-many")
-        customer_dao = customers_create_dao()
-        customers = customer_dao.get_all(
-            max_count=kwargs.get('max_count', None)
-        )
-
-        customers_id = [customer.id for customer in customers]
-        conditions = conditions if conditions else {}
-        custom_condition = "c.customer_id IN {}".format(
-            str(tuple(customers_id))
-        )
-        # TODO this must be refactored to be used from the utils module ↑
-        if "custom_sql_conditions" in kwargs:
-            kwargs["custom_sql_conditions"].append(custom_condition)
-        else:
-            kwargs["custom_sql_conditions"] = [custom_condition]
-        projects = self.repository.find_all(event_ctx, conditions, **kwargs)
-
-        add_customer_name_to_projects(projects, customers)
-        return projects
-
-
-def create_dao() -> ProjectDao:
-    repository = ProjectCosmosDBRepository()
-
-    return ProjectCosmosDBDao(repository)

time_tracker_api/projects/projects_namespace.py

@@ -4,7 +4,7 @@
 
 from time_tracker_api.api import common_fields, create_attributes_filter, UUID, api, remove_required_constraint, \
     NullableString
-from time_tracker_api.projects.projects_model import create_dao
+from time_tracker_api.projects.projects_dao import create_dao
 
 faker = Faker()