put all modules under web_modules + more test coverage

Author: rmorshea

.pre-commit-config.yaml

@@ -1,15 +1,20 @@
 repos:
--   repo: https://github.com/ambv/black
+  - repo: https://github.com/ambv/black
     rev: stable
     hooks:
-    - id: black
-      language_version: python3.6
--   repo: https://github.com/PyCQA/flake8
+      - id: black
+        language_version: python3.6
+  - repo: https://github.com/PyCQA/flake8
     rev: 3.7.9
     hooks:
-    - id: flake8
--   repo: https://github.com/pre-commit/mirrors-mypy
+      - id: flake8
+  - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v0.761
     hooks:
-    -   id: mypy
+      - id: mypy
         additional_dependencies: [pyalect]
+  - repo: https://github.com/kynan/nbstripout
+    rev: master
+    hooks:
+      - id: nbstripout
+        files: ".ipynb"

docs/source/extras.rst

@@ -105,7 +105,7 @@ While ``your_module.py`` should contain the following:
 
     # dialect=html
     from idom import html
-    assert html("<div/>") == {"tagName": "div"}
+    assert html(f"<div/>") == {"tagName": "div"}
 
 And that's it!
 

examples/chart.js

@@ -1,11 +1,6 @@
-import React from "../web_modules/react.js";
-import {
-  VictoryBar,
-  VictoryChart,
-  VictoryTheme,
-  Bar,
-} from "../web_modules/victory.js";
-import htm from "../web_modules/htm.js";
+import React from "./react.js";
+import { VictoryBar, VictoryChart, VictoryTheme, Bar } from "./victory.js";
+import htm from "./htm.js";
 
 const html = htm.bind(React.createElement);
 

idom/__init__.py

@@ -15,11 +15,12 @@
 
 from .tools import Var, html_to_vdom
 
+# try to automatically setup the dialect's import hook
 try:
     import pyalect
     import tagged
     import htm
-except ImportError:
+except ImportError:  # pragma: no cover
     pass
 else:
     from . import dialect

idom/client/.gitignore

@@ -1,3 +1,2 @@
 node_modules
 web_modules
-user_modules

idom/client/__init__.py

@@ -12,32 +12,31 @@
 CORE_MODULES = CLIENT_DIR / "core_modules"
 NODE_MODULES = CLIENT_DIR / "node_modules"
 WEB_MODULES = CLIENT_DIR / "web_modules"
-USER_MODULES = CLIENT_DIR / "user_modules"
 
 
-def import_path(prefix: str, name: str) -> str:
-    path = f"../{prefix}/{name}.js"
-    if not module_exists(prefix, name):
+def import_path(name: str) -> str:
+    path = f"../{WEB_MODULES.name}/{name}.js"
+    if not module_exists(name):
         raise ValueError(f"Module '{path}' does not exist.")
     return path
 
 
 def define_module(name: str, source: str) -> str:
-    path = _create_module_os_path(USER_MODULES, name)
+    path = _create_web_module_os_path(name)
     with path.open("w+") as f:
         f.write(source)
-    return import_path("user_modules", name)
+    return import_path(name)
 
 
-def delete_module(prefix: str, name: str) -> None:
-    path = _find_module_os_path(prefix, name)
+def delete_module(name: str) -> None:
+    path = _find_web_module_os_path(name)
     if path is None:
-        raise ValueError(f"Module '{import_path(prefix, name)}' does not exist.")
+        raise ValueError(f"Module '{name}' does not exist.")
     _delete_os_paths(path)
 
 
-def module_exists(prefix: Union[str, Path], name: str) -> bool:
-    return _find_module_os_path(prefix, name) is not None
+def module_exists(name: str) -> bool:
+    return _find_web_module_os_path(name) is not None
 
 
 def install(dependencies: Dict[str, str]) -> None:
@@ -65,7 +64,7 @@ def install(dependencies: Dict[str, str]) -> None:
 
 
 def restore() -> None:
-    _delete_os_paths(WEB_MODULES, NODE_MODULES, USER_MODULES)
+    _delete_os_paths(WEB_MODULES, NODE_MODULES)
     _run_subprocess(["npm", "install"], CLIENT_DIR)
     _run_subprocess(["npm", "run", "snowpack"], CLIENT_DIR)
 
@@ -99,11 +98,8 @@ def _run_subprocess(args: List[str], cwd: Union[str, Path]):
         raise
 
 
-def _find_module_os_path(prefix: Union[str, Path], name: str) -> Optional[Path]:
-    if isinstance(prefix, str):
-        path = CLIENT_DIR / prefix
-    else:
-        path = prefix
+def _find_web_module_os_path(name: str) -> Optional[Path]:
+    path = WEB_MODULES
     for name_part in name.split("/"):
         if not path.is_dir():
             return None
@@ -114,11 +110,8 @@ def _find_module_os_path(prefix: Union[str, Path], name: str) -> Optional[Path]:
     return full_path
 
 
-def _create_module_os_path(prefix: Union[str, Path], name: str) -> Path:
-    if isinstance(prefix, str):
-        path = CLIENT_DIR / prefix
-    else:
-        path = prefix
+def _create_web_module_os_path(name: str) -> Path:
+    path = WEB_MODULES
     for n in name.split("/"):
         if not path.exists():
             path.mkdir()

idom/core/element.py

@@ -17,7 +17,7 @@
 )
 
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from .layout import AbstractLayout
     from .vdom import VdomDict  # noqa
 

idom/server/__init__.py

@@ -13,7 +13,7 @@
 for name in ["sanic"]:
     try:
         import_module(name)
-    except ImportError:
+    except ImportError:  # pragma: no cover
         pass
     else:
         import_module(__name__ + "." + name)

idom/widgets/common.py

@@ -63,12 +63,12 @@ def __init__(
         install: Union[str, bool] = False,
     ) -> None:
         if install:
-            if not client.module_exists("web_modules", package):
+            if not client.module_exists(package):
                 if isinstance(install, str):
                     client.install({install: package})
                 else:
                     client.install({package: package})
-            new_import_path = client.import_path("web_modules", package)
+            new_import_path = client.import_path(package)
             if new_import_path is None:
                 raise ValueError(f"Unexpectedly failed to find install of {package}")
             package = new_import_path

setup.cfg

@@ -29,10 +29,11 @@ xfail_strict = True
 addopts = --cov=idom
 
 [coverage:report]
-fail_under = 86
+fail_under = 87
 show_missing = True
 skip_covered = True
 sort = Miss
 exclude_lines =
     pragma: no cover
     \.\.\.
+    raise NotImplementedError

tests/test_browser/conftest.py

@@ -6,6 +6,7 @@
 from selenium.webdriver.chrome.options import Options
 
 import idom
+from idom.server import imperative_server_mount
 from idom.server.sanic import PerClientState
 
 
@@ -48,17 +49,17 @@ def display(_display):
 
 @pytest.fixture(scope="session")
 def _display(driver):
-    _display, element = idom.hotswap()
-    server = ServerWithErrorCatch(element)
-    host, port = "127.0.0.1", 5555
-    server.daemon(host, port, debug=True)
+    host, port = "127.0.0.1", 5000
+    server, mount = imperative_server_mount(
+        ServerWithErrorCatch, host, port, run_options={"debug": True}
+    )
 
     def display(element):
-        _display(element)
+        mount(element)
         driver.get(f"http://{host}:{port}/client/index.html")
 
     time.sleep(1)  # wait for server start
-    return display
+    yield display
 
 
 @pytest.fixture(scope="session")

tests/test_browser/my_chart.js

@@ -1,14 +1,14 @@
-import React from '../web_modules/react.js';
-import { VictoryBar, VictoryChart, VictoryAxis } from '../web_modules/victory.js';
-import htm from "../web_modules/htm.js";
+import React from "../react.js";
+import { VictoryBar, VictoryChart, VictoryAxis } from "../victory.js";
+import htm from "../htm.js";
 
 const html = htm.bind(React.createElement);
 
 const data = [
   { quarter: 1, earnings: 13000 },
   { quarter: 2, earnings: 16500 },
   { quarter: 3, earnings: 14250 },
-  { quarter: 4, earnings: 19000 }
+  { quarter: 4, earnings: 19000 },
 ];
 
 function Chart() {
@@ -20,15 +20,15 @@ function Chart() {
         />
         <${VictoryAxis}
           dependentAxis
-          tickFormat=${(x) => (`$${x / 1000}k`)}
+          tickFormat=${(x) => `$${x / 1000}k`}
         />
         <${VictoryBar}
           data=${data}
           x="quarter"
           y="earnings"
         />
       </${VictoryChart}>
-    `
+    `;
 }
 
-export default { Chart: Chart }
+export default { Chart: Chart };

tests/test_browser/test_client.py

@@ -20,34 +20,32 @@ def test_install(driver, display, victory):
 
     driver.find_element_by_class_name("VictoryContainer")
 
-    assert client.module_exists("web_modules", "victory")
-    assert client.import_path("web_modules", "victory") == "../web_modules/victory.js"
+    assert client.module_exists("victory")
+    assert client.import_path("victory") == "../web_modules/victory.js"
 
 
 def test_raise_on_missing_import_path():
     with pytest.raises(ValueError, match="does not exist"):
-        client.import_path("web_modules", "module/that/does/not/exist")
+        client.import_path("module/that/does/not/exist")
 
 
 def test_custom_module(driver, display, victory):
-    my_chart = define_module("my_chart", HERE / "my_chart.js")
+    my_chart = define_module("my/chart", HERE / "my_chart.js")
+
+    assert client.module_exists("my/chart")
+    assert client.import_path("my/chart") == "../web_modules/my/chart.js"
 
     display(my_chart.Chart)
 
     driver.find_element_by_class_name("VictoryContainer")
 
-    assert client.module_exists("user_modules", "my_chart")
-    assert (
-        client.import_path("user_modules", "my_chart") == "../user_modules/my_chart.js"
-    )
-
 
 def test_delete_module(victory):
-    client.delete_module("web_modules", "victory")
-    assert not client.module_exists("web_modules", "victory")
+    client.delete_module("victory")
+    assert not client.module_exists("victory")
 
     with pytest.raises(ValueError, match="does not exist"):
-        client.delete_module("web_modules", "victory")
+        client.delete_module("victory")
 
 
 called_process_error = CalledProcessError(1, "failing-cmd")

tests/test_idom/test_tools.py

@@ -5,9 +5,13 @@
 
 
 def test_var_equivalence():
-    r1 = idom.Var([1, 2, 3])
-    r2 = idom.Var([1, 2, 3])
-    assert r1 == r2
+    assert idom.Var([1, 2, 3]) == idom.Var([1, 2, 3])
+    assert idom.Var([1, 2, 3]) != idom.Var([1, 2])
+    assert idom.Var([1, 2, 3]) != [1, 2, 3]
+
+
+def test_var_repr():
+    assert repr(idom.Var([1, 2, 3])) == "Var([1, 2, 3])"
 
 
 def test_var_set():