rename StateDispatcher to ViewDispatcher

Author: rmorshea

docs/source/core-concepts.rst

@@ -127,7 +127,7 @@ callback that's called by the dispatcher to events it should execute.
 
     import asyncio
 
-    from idom.core import SingleStateDispatcher, EventHandler
+    from idom.core import SingleViewDispatcher, EventHandler
     from idom.core.layout import LayoutEvent
 
 
@@ -152,7 +152,7 @@ callback that's called by the dispatcher to events it should execute.
         return event
 
 
-    async with SingleStateDispatcher(idom.Layout(ClickCount())) as dispatcher:
+    async with SingleViewDispatcher(idom.Layout(ClickCount())) as dispatcher:
         context = None  # see note below
         await dispatcher.run(send, recv, context)
 
@@ -163,8 +163,8 @@ callback that's called by the dispatcher to events it should execute.
 
     ``context`` is information that's specific to the
     :class:`~idom.core.dispatcher.AbstractDispatcher` implementation. In the case of
-    the :class:`~idom.core.dispatcher.SingleStateDispatcher` it doesn't require any
-    context. On the other hand the :class:`~idom.core.dispatcher.SharedStateDispatcher`
+    the :class:`~idom.core.dispatcher.SingleViewDispatcher` it doesn't require any
+    context. On the other hand the :class:`~idom.core.dispatcher.SharedViewDispatcher`
     requires a client ID as its piece of contextual information.
 
 

idom/core/__init__.py

@@ -1,7 +1,7 @@
 from .element import element, Element, AbstractElement, ElementConstructor
 from .events import event, Events, EventHandler
 from .layout import Layout, Layout
-from .dispatcher import AbstractDispatcher, SharedStateDispatcher, SingleStateDispatcher
+from .dispatcher import AbstractDispatcher, SharedViewDispatcher, SingleViewDispatcher
 from .vdom import vdom
 
 __all__ = [
@@ -17,6 +17,6 @@
     "hooks",
     "Layout",
     "vdom",
-    "SharedStateDispatcher",
-    "SingleStateDispatcher",
+    "SharedViewDispatcher",
+    "SingleViewDispatcher",
 ]

idom/core/dispatcher.py

@@ -63,11 +63,11 @@ async def _incoming(self, layout: Layout, context: Any, message: Any) -> None:
         ...
 
 
-class SingleStateDispatcher(AbstractDispatcher):
+class SingleViewDispatcher(AbstractDispatcher):
     """Each client of the dispatcher will get its own model.
 
     ..note::
-        The ``context`` parameter of :meth:`SingleStateDispatcher.run` should just
+        The ``context`` parameter of :meth:`SingleViewDispatcher.run` should just
         be ``None`` since it's not used.
     """
 
@@ -85,11 +85,11 @@ async def _incoming(self, layout: Layout, context: Any, event: LayoutEvent) -> N
         return None
 
 
-class SharedStateDispatcher(SingleStateDispatcher):
+class SharedViewDispatcher(SingleViewDispatcher):
     """Each client of the dispatcher shares the same model.
 
     The client's ID is indicated by the ``context`` argument of
-    :meth:`SharedStateDispatcher.run`
+    :meth:`SharedViewDispatcher.run`
     """
 
     __slots__ = "_update_queues", "_model_state"

idom/server/sanic.py

@@ -10,8 +10,8 @@
 from websockets import WebSocketCommonProtocol
 
 from idom.core.dispatcher import (
-    SingleStateDispatcher,
-    SharedStateDispatcher,
+    SingleViewDispatcher,
+    SharedViewDispatcher,
     SendCoroutine,
     RecvCoroutine,
 )
@@ -139,7 +139,7 @@ def _run_application(
 class PerClientStateServer(SanicRenderServer):
     """Each client view will have its own state."""
 
-    _dispatcher_type = SingleStateDispatcher
+    _dispatcher_type = SingleViewDispatcher
 
     async def _run_dispatcher(
         self,
@@ -155,8 +155,8 @@ async def _run_dispatcher(
 class SharedClientStateServer(SanicRenderServer):
     """All connected client views will have shared state."""
 
-    _dispatcher_type = SharedStateDispatcher
-    _dispatcher: SharedStateDispatcher
+    _dispatcher_type = SharedViewDispatcher
+    _dispatcher: SharedViewDispatcher
 
     def _setup_application(self, app: Sanic, config: Config) -> None:
         app.listener("before_server_start")(self._activate_dispatcher)
@@ -166,7 +166,7 @@ def _setup_application(self, app: Sanic, config: Config) -> None:
     async def _activate_dispatcher(
         self, app: Sanic, loop: asyncio.AbstractEventLoop
     ) -> None:
-        self._dispatcher = cast(SharedStateDispatcher, self._make_dispatcher({}, loop))
+        self._dispatcher = cast(SharedViewDispatcher, self._make_dispatcher({}, loop))
         await self._dispatcher.__aenter__()
 
     async def _deactivate_dispatcher(

tests/test_core/test_dispatcher.py

@@ -6,7 +6,7 @@
 
 import idom
 from idom.core.layout import Layout, LayoutEvent
-from idom.core.dispatcher import SharedStateDispatcher, AbstractDispatcher
+from idom.core.dispatcher import SharedViewDispatcher, AbstractDispatcher
 
 
 async def test_shared_state_dispatcher():
@@ -45,7 +45,7 @@ async def an_event():
 
         return idom.html.div({"anEvent": an_event, "count": count})
 
-    async with SharedStateDispatcher(Layout(Clickable())) as dispatcher:
+    async with SharedViewDispatcher(Layout(Clickable())) as dispatcher:
         await dispatcher.run(send_1, recv_1, "1")
         await dispatcher.run(send_2, recv_2, "2")