switch to decorator collection method

Author: rmorshea

src/django_idom/__init__.py

@@ -1,5 +1,6 @@
-from .app_paths import idom_web_modules_path, idom_websocket_path
+from .components import register_component
+from .paths import idom_web_modules_path, idom_websocket_path
 
 
 __version__ = "0.0.1"
-__all__ = ["idom_websocket_path", "idom_web_modules_path"]
+__all__ = ["idom_websocket_path", "idom_web_modules_path", "register_component"]

src/django_idom/app_components.py

@@ -0,0 +1,48 @@
+import inspect
+from typing import Any, Optional
+
+from idom.core.component import component as component_deco
+
+from .config import IDOM_REGISTERED_COMPONENTS
+
+
+def register_component(
+    component: Optional[Any] = None,
+    is_render_function: bool = True,
+    module_name: Optional[str] = None,
+) -> Any:
+    module_name = module_name or _get_outer_frame_module_name()
+    if module_name is None:
+        raise ValueError("Could not infer module name - provide it explicitely")
+
+    def setup(component: Any) -> Any:
+        if is_render_function:
+            component = component_deco(component)
+
+        try:
+            component_name = component.__name__
+        except AttributeError:
+            raise AttributeError("Component constructor must have a __name__ attribute")
+
+        IDOM_REGISTERED_COMPONENTS[f"{module_name}.{component_name}"] = component
+
+        return component
+
+    if component is not None:
+        return setup(component)
+    else:
+        return setup
+
+
+def _get_outer_frame_module_name() -> Optional[str]:
+    frame = inspect.currentframe()
+
+    if frame is None:
+        return None
+
+    for i in range(2):
+        frame = frame.f_back
+        if frame is None:
+            return None
+
+    return frame.f_globals.get("__name__")

src/django_idom/components.py

@@ -1,7 +1,10 @@
+from typing import Dict
+
 from django.conf import settings
+from idom.core.proto import ComponentConstructor
 
 
-IDOM_IGNORE_INSTALLED_APPS = set(getattr(settings, "IDOM_IGNORE_INSTALLED_APPS", []))
+IDOM_REGISTERED_COMPONENTS: Dict[str, ComponentConstructor] = {}
 
 IDOM_BASE_URL = getattr(settings, "IDOM_BASE_URL", "_idom/")
 IDOM_WEBSOCKET_URL = IDOM_BASE_URL + "websocket/"

src/django_idom/app_settings.py renamed to src/django_idom/config.py

@@ -1,7 +1,7 @@
 from django.urls import path
 
 from . import views
-from .app_settings import IDOM_WEB_MODULES_URL, IDOM_WEBSOCKET_URL
+from .config import IDOM_WEB_MODULES_URL, IDOM_WEBSOCKET_URL
 from .websocket_consumer import IdomAsyncWebSocketConsumer
 
 

src/django_idom/app_paths.py renamed to src/django_idom/paths.py

@@ -4,17 +4,20 @@
 
 from django import template
 
-from django_idom.app_settings import IDOM_WEB_MODULES_URL, IDOM_WEBSOCKET_URL
-
-from ..app_components import has_component
+from django_idom.config import (
+    IDOM_REGISTERED_COMPONENTS,
+    IDOM_WEB_MODULES_URL,
+    IDOM_WEBSOCKET_URL,
+)
 
 
 register = template.Library()
 
 
 @register.inclusion_tag("idom/view.html")
 def idom_view(_component_id_, **kwargs):
-    if not has_component(_component_id_):
+    if _component_id_ not in IDOM_REGISTERED_COMPONENTS:
+        print(list(IDOM_REGISTERED_COMPONENTS))
         raise ValueError(f"No component {_component_id_!r} exists")
 
     json_kwargs = json.dumps(kwargs, separators=(",", ":"))

src/django_idom/templatetags/idom.py

@@ -1,7 +1,7 @@
-from django.http import HttpResponse
+from django.http import HttpRequest, HttpResponse
 from idom.config import IDOM_WED_MODULES_DIR
 
 
-def web_modules_file(request, file: str) -> HttpResponse:
+def web_modules_file(request: HttpRequest, file: str) -> HttpResponse:
     file_path = IDOM_WED_MODULES_DIR.current.joinpath(*file.split("/"))
     return HttpResponse(file_path.read_text(), content_type="text/javascript")

src/django_idom/views.py

@@ -9,7 +9,7 @@
 from idom.core.dispatcher import dispatch_single_view
 from idom.core.layout import Layout, LayoutEvent
 
-from .app_components import get_component, has_component
+from .config import IDOM_REGISTERED_COMPONENTS
 
 
 _logger = logging.getLogger(__name__)
@@ -38,12 +38,12 @@ async def receive_json(self, content: Any, **kwargs: Any) -> None:
     async def _run_dispatch_loop(self):
         view_id = self.scope["url_route"]["kwargs"]["view_id"]
 
-        if not has_component(view_id):
+        try:
+            component_constructor = IDOM_REGISTERED_COMPONENTS[view_id]
+        except KeyError:
             _logger.warning(f"Uknown IDOM view ID {view_id!r}")
             return
 
-        component_constructor = get_component(view_id)
-
         query_dict = dict(parse_qsl(self.scope["query_string"].decode()))
         component_kwargs = json.loads(query_dict.get("kwargs", "{}"))
 

src/django_idom/websocket_consumer.py

@@ -1,12 +1,14 @@
 import idom
 
+from django_idom import register_component
 
-@idom.component
+
+@register_component
 def HelloWorld():
     return idom.html.h1({"id": "hello-world"}, "Hello World!")
 
 
-@idom.component
+@register_component
 def Button():
     count, set_count = idom.hooks.use_state(0)
     return idom.html.div(
@@ -21,16 +23,16 @@ def Button():
     )
 
 
-@idom.component
+@register_component
 def ParametrizedComponent(x, y):
     total = x + y
     return idom.html.h1({"id": "parametrized-component", "data-value": total}, total)
 
 
-victory = idom.web.module_from_template("react", "victory", fallback="...")
+victory = idom.web.module_from_template("react", "victory-line", fallback="...")
 VictoryBar = idom.web.export(victory, "VictoryBar")
 
 
-@idom.component
+@register_component
 def SimpleBarChart():
     return VictoryBar()

tests/test_app/components.py

@@ -15,9 +15,11 @@
 
   <body>
     <h1>IDOM Test Page</h1>
-    <div>{% idom_view "test_app.HelloWorld" %}</div>
-    <div>{% idom_view "test_app.Button" %}</div>
-    <div>{% idom_view "test_app.ParametrizedComponent" x=123 y=456 %}</div>
-    <div>{% idom_view "test_app.SimpleBarChart" %}</div>
+    <div>{% idom_view "test_app.views.HelloWorld" %}</div>
+    <div>{% idom_view "test_app.views.Button" %}</div>
+    <div>
+      {% idom_view "test_app.views.ParametrizedComponent" x=123 y=456 %}
+    </div>
+    <div>{% idom_view "test_app.views.SimpleBarChart" %}</div>
   </body>
 </html>

tests/test_app/idom.py

@@ -1,6 +1,8 @@
 from django.http import HttpResponse
 from django.template import loader
 
+import test_app.components
+
 
 def base_template(request):
     context = {}