Merge branch 'fix/nested-relations' of https://github.com/MasoniteFramework/orm into fix/nested-relations

Author: josephmancuso

cc.py

@@ -53,16 +53,14 @@ def articles(self):
 
 
 class Company(Model):
-    __connection__ = "sqlite"
-
-
+    __connection__ = "t"
 # /Users/personal/programming/masonite/packages/orm/src/masoniteorm/query/QueryBuilder.py
 
 # user = User.create({"name": "phill", "email": "phill"})
 # print(inspect.isclass(User))
 user = User.with_("articles.logos.user").first()
 # user.update({"verified_at": None, "updated_at": None})
-# print(user.articles)
+print(user.articles)
 
 print(user.serialize())
 # print(User.first())

src/masoniteorm/__init__.py

@@ -1,2 +1,2 @@
-from .models import Model
 from .factories.Factory import Factory
+from .models import Model

src/masoniteorm/collection/Collection.py

@@ -1,6 +1,6 @@
 import json
-import random
 import operator
+import random
 from functools import reduce
 
 
@@ -310,7 +310,9 @@ def random(self, count=None):
         if collection_count == 0:
             return None
         elif count and count > collection_count:
-            raise ValueError("count argument must be inferior to collection length.")
+            raise ValueError(
+                "count argument must be inferior to collection length."
+            )
         elif count:
             self._items = random.sample(self._items, k=count)
             return self
@@ -330,15 +332,38 @@ def reverse(self):
         self._items = self[::-1]
 
     def serialize(self, *args, **kwargs):
+        """Serialize the collection into a list of dictionaries.
+
+        Returns:
+            list: Returns a list of dictionaries.
+        """
+
         def _serialize(item):
-            if self.__appends__:
-                item.set_appends(self.__appends__)
+            if not hasattr(item, "serialize"):
+                return item
+
+            # Check if this item has already been serialized
+            if not hasattr(self, "_serialized_objects"):
+                self._serialized_objects = set()
+
+            if id(item) in self._serialized_objects:
+                # Return just the primary key if it's a circular reference
+                return (
+                    item.get_primary_key_value()
+                    if hasattr(item, "get_primary_key_value")
+                    else None
+                )
+
+            # Add this item to the set of serialized objects
+            self._serialized_objects.add(id(item))
+
+            # Serialize the item
+            result = item.serialize(*args, **kwargs)
+
+            # Remove this item from the set of serialized objects
+            self._serialized_objects.remove(id(item))
 
-            if hasattr(item, "serialize"):
-                return item.serialize(*args, **kwargs)
-            elif hasattr(item, "to_dict"):
-                return item.to_dict()
-            return item
+            return result
 
         return list(map(_serialize, self))
 
@@ -424,17 +449,17 @@ def where(self, key, *args):
             if isinstance(item, dict):
                 comparison = item.get(key)
             else:
-                comparison = getattr(item, key) if hasattr(item, key) else False
+                comparison = (
+                    getattr(item, key) if hasattr(item, key) else False
+                )
             if self._make_comparison(comparison, value, op):
                 attributes.append(item)
         return self.__class__(attributes)
 
     def where_in(self, key, args: list) -> "Collection":
         # Compatibility patch - allow numeric strings to match integers
         # (if all args are numeric strings)
-        if all(
-                [isinstance(arg, str) and arg.isnumeric() for arg in args]
-        ):
+        if all([isinstance(arg, str) and arg.isnumeric() for arg in args]):
             return self.where_in(key, [int(arg) for arg in args])
 
         attributes = []
@@ -457,9 +482,7 @@ def where_in(self, key, args: list) -> "Collection":
     def where_not_in(self, key, args: list) -> "Collection":
         # Compatibility patch - allow numeric strings to match integers
         # (if all args are numeric strings)
-        if all(
-                [isinstance(arg, str) and arg.isnumeric() for arg in args]
-        ):
+        if all([isinstance(arg, str) and arg.isnumeric() for arg in args]):
             return self.where_not_in(key, [int(arg) for arg in args])
 
         attributes = []
@@ -482,7 +505,9 @@ def where_not_in(self, key, args: list) -> "Collection":
     def zip(self, items):
         items = self.__get_items(items)
         if not isinstance(items, list):
-            raise ValueError("The 'items' parameter must be a list or a Collection")
+            raise ValueError(
+                "The 'items' parameter must be a list or a Collection"
+            )
 
         _items = []
         for x, y in zip(self, items):

src/masoniteorm/commands/Entry.py

@@ -6,18 +6,19 @@
 """
 
 from cleo import Application
+
 from . import (
-    MigrateCommand,
-    MigrateRollbackCommand,
-    MigrateRefreshCommand,
-    MigrateFreshCommand,
     MakeMigrationCommand,
     MakeModelCommand,
     MakeModelDocstringCommand,
     MakeObserverCommand,
-    MigrateStatusCommand,
-    MigrateResetCommand,
     MakeSeedCommand,
+    MigrateCommand,
+    MigrateFreshCommand,
+    MigrateRefreshCommand,
+    MigrateResetCommand,
+    MigrateRollbackCommand,
+    MigrateStatusCommand,
     SeedRunCommand,
     ShellCommand,
 )

src/masoniteorm/commands/MakeMigrationCommand.py

@@ -37,7 +37,8 @@ def handle(self):
 
         with open(
             os.path.join(
-                pathlib.Path(__file__).parent.absolute(), f"stubs/{stub_file}.stub"
+                pathlib.Path(__file__).parent.absolute(),
+                f"stubs/{stub_file}.stub",
             )
         ) as fp:
             output = fp.read()
@@ -46,7 +47,9 @@ def handle(self):
 
         file_name = f"{now.strftime('%Y_%m_%d_%H%M%S')}_{name}.py"
 
-        with open(os.path.join(os.getcwd(), migration_directory, file_name), "w") as fp:
+        with open(
+            os.path.join(os.getcwd(), migration_directory, file_name), "w"
+        ) as fp:
             fp.write(output)
 
         self.info(

src/masoniteorm/commands/MakeModelCommand.py

@@ -28,7 +28,9 @@ def handle(self):
         model_directory = self.option("directory")
 
         with open(
-            os.path.join(pathlib.Path(__file__).parent.absolute(), "stubs/model.stub")
+            os.path.join(
+                pathlib.Path(__file__).parent.absolute(), "stubs/model.stub"
+            )
         ) as fp:
             output = fp.read()
             output = output.replace("__CLASS__", camelize(name))
@@ -46,9 +48,13 @@ def handle(self):
             )
             return
 
-        os.makedirs(os.path.dirname(os.path.join(full_directory_path)), exist_ok=True)
+        os.makedirs(
+            os.path.dirname(os.path.join(full_directory_path)), exist_ok=True
+        )
 
-        with open(os.path.join(os.getcwd(), model_directory, file_name), "w+") as fp:
+        with open(
+            os.path.join(os.getcwd(), model_directory, file_name), "w+"
+        ) as fp:
             fp.write(output)
 
         self.info(f"Model created: {os.path.join(model_directory, file_name)}")
@@ -67,4 +73,6 @@ def handle(self):
 
         if self.option("seeder"):
             directory = self.option("seeders-directory")
-            self.call("seed", f"{self.argument('name')} --directory {directory}")
+            self.call(
+                "seed", f"{self.argument('name')} --directory {directory}"
+            )

src/masoniteorm/commands/MakeObserverCommand.py

@@ -46,7 +46,9 @@ def handle(self):
 
         os.makedirs(os.path.join(full_directory_path), exist_ok=True)
 
-        with open(os.path.join(os.getcwd(), observer_directory, file_name), "w+") as fp:
+        with open(
+            os.path.join(os.getcwd(), observer_directory, file_name), "w+"
+        ) as fp:
             fp.write(output)
 
         self.info(f"Observer created: {file_name}")

src/masoniteorm/commands/MakeSeedCommand.py

@@ -27,19 +27,26 @@ def handle(self):
 
         with open(
             os.path.join(
-                pathlib.Path(__file__).parent.absolute(), f"stubs/{stub_file}.stub"
+                pathlib.Path(__file__).parent.absolute(),
+                f"stubs/{stub_file}.stub",
             )
         ) as fp:
             output = fp.read()
             output = output.replace("__SEEDER_NAME__", camelize(name))
 
         file_name = f"{underscore(name)}.py"
-        full_path = pathlib.Path(os.path.join(os.getcwd(), seed_directory, file_name))
+        full_path = pathlib.Path(
+            os.path.join(os.getcwd(), seed_directory, file_name)
+        )
 
-        path_normalized = pathlib.Path(seed_directory) / pathlib.Path(file_name)
+        path_normalized = pathlib.Path(seed_directory) / pathlib.Path(
+            file_name
+        )
 
         if os.path.exists(full_path):
-            return self.line(f"<error>{path_normalized} already exists.</error>")
+            return self.line(
+                f"<error>{path_normalized} already exists.</error>"
+            )
 
         with open(full_path, "w") as fp:
             fp.write(output)

src/masoniteorm/commands/MigrateFreshCommand.py

@@ -1,5 +1,4 @@
 from ..migrations import Migration
-
 from .Command import Command
 
 

src/masoniteorm/commands/MigrateRefreshCommand.py

@@ -1,5 +1,4 @@
 from ..migrations import Migration
-
 from .Command import Command
 
 

src/masoniteorm/commands/MigrateRollbackCommand.py

@@ -21,4 +21,6 @@ def handle(self):
             migration_directory=self.option("directory"),
             config_path=self.option("config"),
             schema=self.option("schema"),
-        ).rollback(migration=self.option("migration"), output=self.option("show"))
+        ).rollback(
+            migration=self.option("migration"), output=self.option("show")
+        )

src/masoniteorm/commands/SeedRunCommand.py

@@ -28,9 +28,7 @@ def handle(self):
 
         else:
             table = self.argument("table")
-            seeder_file = (
-                f"{underscore(table)}_table_seeder.{camelize(table)}TableSeeder"
-            )
+            seeder_file = f"{underscore(table)}_table_seeder.{camelize(table)}TableSeeder"
             seeder.run_specific_seed(seeder_file)
             seeder_seeded = f"{camelize(table)}TableSeeder"
 

src/masoniteorm/commands/ShellCommand.py

@@ -1,11 +1,10 @@
-import subprocess
 import os
 import re
 import shlex
+import subprocess
 from collections import OrderedDict
 
 from ..config import load_config
-
 from .Command import Command
 
 
@@ -107,7 +106,9 @@ def get_mysql_args(self, config):
                 "--port": config.get("port"),
                 "--user": config.get("user"),
                 "--password": config.get("password"),
-                "--default-character-set": config.get("options", {}).get("charset"),
+                "--default-character-set": config.get("options", {}).get(
+                    "charset"
+                ),
             }
         )
         return args, options
@@ -136,7 +137,9 @@ def get_mssql_args(self, config):
         if config.get("port"):
             server += f",{config.get('port')}"
 
-        trusted_connection = config.get("options").get("trusted_connection") == "Yes"
+        trusted_connection = (
+            config.get("options").get("trusted_connection") == "Yes"
+        )
         options = OrderedDict(
             {
                 "-d": config.get("database"),
@@ -172,7 +175,9 @@ def remove_empty_options(self, options):
     def get_sensitive_options(self, config):
         driver = config.get("full_details").get("driver")
         try:
-            sensitive_options = getattr(self, f"get_{driver}_sensitive_options")()
+            sensitive_options = getattr(
+                self, f"get_{driver}_sensitive_options"
+            )()
         except AttributeError:
             sensitive_options = []
         return sensitive_options
@@ -194,5 +199,7 @@ def hide_sensitive_options(self, config, command):
             if option in command:
                 match = re.search(rf"{option} (\w+)", command)
                 if match.groups():
-                    cleaned_command = cleaned_command.replace(match.groups()[0], "***")
+                    cleaned_command = cleaned_command.replace(
+                        match.groups()[0], "***"
+                    )
         return cleaned_command

src/masoniteorm/commands/__init__.py

@@ -3,16 +3,16 @@
 
 sys.path.append(os.getcwd())
 
-from .MigrateCommand import MigrateCommand
-from .MigrateRollbackCommand import MigrateRollbackCommand
-from .MigrateRefreshCommand import MigrateRefreshCommand
-from .MigrateFreshCommand import MigrateFreshCommand
-from .MigrateResetCommand import MigrateResetCommand
+from .MakeMigrationCommand import MakeMigrationCommand
 from .MakeModelCommand import MakeModelCommand
 from .MakeModelDocstringCommand import MakeModelDocstringCommand
 from .MakeObserverCommand import MakeObserverCommand
-from .MigrateStatusCommand import MigrateStatusCommand
-from .MakeMigrationCommand import MakeMigrationCommand
 from .MakeSeedCommand import MakeSeedCommand
+from .MigrateCommand import MigrateCommand
+from .MigrateFreshCommand import MigrateFreshCommand
+from .MigrateRefreshCommand import MigrateRefreshCommand
+from .MigrateResetCommand import MigrateResetCommand
+from .MigrateRollbackCommand import MigrateRollbackCommand
+from .MigrateStatusCommand import MigrateStatusCommand
 from .SeedRunCommand import SeedRunCommand
 from .ShellCommand import ShellCommand

src/masoniteorm/config.py

@@ -2,8 +2,7 @@
 import pydoc
 import urllib.parse as urlparse
 
-from .exceptions import ConfigurationNotFound
-from .exceptions import InvalidUrlConfiguration
+from .exceptions import ConfigurationNotFound, InvalidUrlConfiguration
 
 
 def load_config(config_path=None):
@@ -98,7 +97,9 @@ def db_url(database_url=None, prefix="", options={}, log_queries=False):
         # lookup specified driver
         driver = DRIVERS_MAP[url.scheme]
         port = (
-            str(url.port) if url.port and driver in [DRIVERS_MAP["mssql"]] else url.port
+            str(url.port)
+            if url.port and driver in [DRIVERS_MAP["mssql"]]
+            else url.port
         )
 
     # build final configuration