Merge branch 'adamghill:main' into main

Author: ntuckovic

.all-contributorsrc

@@ -240,6 +240,25 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "jacksund",
+      "name": "Jack Sundberg",
+      "avatar_url": "https://avatars.githubusercontent.com/u/47992949?v=4",
+      "profile": "http://jacksund.github.io",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "siliconcow",
+      "name": "siliconcow",
+      "avatar_url": "https://avatars.githubusercontent.com/u/908362?v=4",
+      "profile": "https://github.com/siliconcow",
+      "contributions": [
+        "code",
+        "test"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/js.yml

@@ -6,12 +6,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2.3.4
+      - uses: actions/checkout@v4.1.1
         with:
           fetch-depth: 1
 
       - name: Set up node
-        uses: actions/setup-node@v2.1.2
+        uses: actions/setup-node@v4.0.2
 
       - name: Install node packages
         run: npm install

.github/workflows/python.yml

@@ -30,9 +30,6 @@ jobs:
       - name: Install dependencies
         run: poetry install
 
-      - name: black check
-        run: poetry run black . --check
-
       - name: ruff check
         run: poetry run ruff .
 

README.md

@@ -222,6 +222,8 @@ Thanks to the following wonderful people ([emoji key](https://allcontributors.or
       <td align="center" valign="top" width="14.28%"><a href="https://digitalpinup.art"><img src="https://avatars.githubusercontent.com/u/1392097?v=4?s=100" width="100px;" alt="Pierre"/><br /><sub><b>Pierre</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=bloodywing" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://roman.pt"><img src="https://avatars.githubusercontent.com/u/75075?v=4?s=100" width="100px;" alt="Roman Imankulov"/><br /><sub><b>Roman Imankulov</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=imankulov" title="Tests">⚠️</a> <a href="https://github.com/adamghill/django-unicorn/commits?author=imankulov" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/rhymiz"><img src="https://avatars.githubusercontent.com/u/7029352?v=4?s=100" width="100px;" alt="Lemi Boyce"/><br /><sub><b>Lemi Boyce</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=rhymiz" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://jacksund.github.io"><img src="https://avatars.githubusercontent.com/u/47992949?v=4?s=100" width="100px;" alt="Jack Sundberg"/><br /><sub><b>Jack Sundberg</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=jacksund" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/siliconcow"><img src="https://avatars.githubusercontent.com/u/908362?v=4?s=100" width="100px;" alt="siliconcow"/><br /><sub><b>siliconcow</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=siliconcow" title="Code">💻</a> <a href="https://github.com/adamghill/django-unicorn/commits?author=siliconcow" title="Tests">⚠️</a></td>
     </tr>
   </tbody>
 </table>

django_unicorn/components/unicorn_template_response.py

@@ -62,6 +62,10 @@ def is_html_well_formed(html: str) -> bool:
 
 
 def assert_has_single_wrapper_element(root_element: Tag, component_name: str) -> None:
+    """Assert that there is at least one child in the root element. And that there is only
+    one root element.
+    """
+
     # Check that the root element has at least one child
     try:
         next(root_element.descendants)
@@ -70,8 +74,13 @@ def assert_has_single_wrapper_element(root_element: Tag, component_name: str) ->
             f"The '{component_name}' component does not appear to have one root element."
         ) from None
 
+    if "unicorn:view" in root_element.attrs or "u:view" in root_element.attrs:
+        # If the root element is a direct view, skip the check
+        return
+
     # Check that there is not more than one root element
     parent_element = root_element.parent
+
     tag_count = len([c for c in parent_element.children if isinstance(c, Tag)])
 
     if tag_count > 1:
@@ -80,6 +89,37 @@ def assert_has_single_wrapper_element(root_element: Tag, component_name: str) ->
         ) from None
 
 
+def _get_direct_view(tag: Tag):
+    return tag.find_next(attrs={"unicorn:view": True}) or tag.find_next(attrs={"u:view": True})
+
+
+def get_root_element(soup: BeautifulSoup) -> Tag:
+    """Gets the first tag element for the component or the first element with a `unicorn:view` attribute for a direct
+    view.
+
+    Returns:
+        BeautifulSoup tag element.
+
+        Raises `Exception` if an element cannot be found.
+    """
+
+    for element in soup.contents:
+        if isinstance(element, Tag) and element.name:
+            if element.name == "html":
+                view_element = _get_direct_view(element)
+
+                if not view_element:
+                    raise MissingComponentViewElementError(
+                        "An element with an `unicorn:view` attribute is required for a direct view"
+                    )
+
+                return view_element
+
+            return element
+
+    raise MissingComponentElementError("No root element for the component was found")
+
+
 class UnsortedAttributes(HTMLFormatter):
     """
     Prevent beautifulsoup from re-ordering attributes.
@@ -230,32 +270,3 @@ def render(self):
     def _desoupify(soup):
         soup.smooth()
         return soup.encode(formatter=UnsortedAttributes()).decode("utf-8")
-
-
-def get_root_element(soup: BeautifulSoup) -> Tag:
-    """
-    Gets the first tag element for the component or the first element with a `unicorn:view` attribute for a direct view.
-
-    Returns:
-        BeautifulSoup tag element.
-
-        Raises `Exception` if an element cannot be found.
-    """
-
-    for element in soup.contents:
-        if isinstance(element, Tag) and element.name:
-            if element.name == "html":
-                view_element = element.find_next(attrs={"unicorn:view": True}) or element.find_next(
-                    attrs={"u:view": True}
-                )
-
-                if not view_element:
-                    raise MissingComponentViewElementError(
-                        "An element with an `unicorn:view` attribute is required for a direct view"
-                    )
-
-                return view_element
-
-            return element
-
-    raise MissingComponentElementError("No root element for the component was found")

django_unicorn/components/unicorn_view.py

@@ -7,8 +7,7 @@
 from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Type
 
 import shortuuid
-from django.apps import AppConfig
-from django.conf import settings
+from django.apps import apps as django_apps_module
 from django.core.exceptions import ImproperlyConfigured
 from django.db.models import Model
 from django.forms.widgets import CheckboxInput, Select
@@ -106,30 +105,17 @@ def get_locations(component_name: str) -> List[Tuple[str, str]]:
     class_name = f"{class_name}View"
     module_name = convert_to_snake_case(component_name)
 
-    unicorn_apps = get_setting("APPS", settings.INSTALLED_APPS)
+    # note - app_config.name gives the python path
+    all_django_apps = [app_config.name for app_config in django_apps_module.get_app_configs()]
+    unicorn_apps = get_setting("APPS", all_django_apps)
 
     if not is_non_string_sequence(unicorn_apps):
         raise AssertionError("APPS is expected to be a list, tuple or set")
 
-    for app in unicorn_apps:
-        # Handle an installed app that actually points to an app config
-        if ".apps." in app:
-            is_app_config = True  # default to True for backwards compatibility
-            app_config_idx = app.rindex(".apps.")
+    locations += [(f"{app}.components.{module_name}", class_name) for app in unicorn_apps]
 
-            try:
-                app_config_module_name = app[: app_config_idx + 5]
-                app_config_class_name = app[app_config_idx + 6 :]
-                app_config_module = importlib.import_module(app_config_module_name)
-                is_app_config = type(getattr(app_config_module, app_config_class_name)) == type(AppConfig)
-            except ModuleNotFoundError:
-                pass
-
-            if is_app_config:
-                app = app[:app_config_idx]  # noqa: PLW2901
-
-        app_module_name = f"{app}.components.{module_name}"
-        locations.append((app_module_name, class_name))
+    # Add default directory to the end of the list as a fallback
+    locations.append((f"components.{module_name}", class_name))
 
     return locations
 
@@ -393,8 +379,6 @@ def dispatch(self, request, *args, **kwargs):  # noqa: ARG002
         self.mount()
         self.hydrate()
 
-        self._cache_component(**kwargs)
-
         return self.render_to_response(
             context=self.get_context_data(),
             component=self,