add robust lint/testing + upgrade idom

Author: rmorshea

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: Bug Report
+labels: bug
+assignees: rmorshea
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/doc_enhancement.md

@@ -0,0 +1,14 @@
+---
+name: Doc enhancement
+about: Documentation needs to be fixed or added
+title: Doc Enhancement
+labels: docs
+assignees: rmorshea
+
+---
+
+**Describe what documentation needs to be fixed or added**
+Is something missing, worded poorly, or flat out wrong? Tells us about it here.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: rmorshea
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/release.yaml

@@ -0,0 +1,30 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Release
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  publish-package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          python setup.py bdist_wheel
+          twine upload dist/*

.github/workflows/test.yaml

@@ -0,0 +1,33 @@
+name: Test
+
+on: [push]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Latest Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Install Python Dependencies
+        run: pip install -r requirements/nox-deps.txt
+      - name: Run Tests
+        run: nox -s test
+
+  environments:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Python Dependencies
+        run: pip install -r requirements/nox-deps.txt
+      - name: Run Tests
+        run: nox -s test -- --no-cov

idom_router/__init__.py

@@ -1,2 +1,12 @@
 # the version is statically loaded by setup.py
 __version__ = "0.0.1"
+
+from .router import Link, Route, Routes, configure, use_location
+
+__all__ = [
+    "configure",
+    "Link",
+    "Route",
+    "Routes",
+    "use_location",
+]

idom_router/router.py

@@ -1,64 +1,85 @@
 from __future__ import annotations
-from dataclasses import dataclass
 
+import re
+from dataclasses import dataclass
 from fnmatch import translate as fnmatch_translate
 from pathlib import Path
-import re
-from typing import Any, Iterator, Protocol, Callable, Sequence
+from typing import Any, Callable, Iterator, Sequence
 
-from idom import create_context, component, use_context, use_state
-from idom.web.module import export, module_from_file
-from idom.core.vdom import coalesce_attributes_and_children, VdomAttributesAndChildren
+from idom import component, create_context, use_context, use_state
+from idom.core.types import VdomAttributesAndChildren, VdomDict
+from idom.core.vdom import coalesce_attributes_and_children
 from idom.types import BackendImplementation, ComponentType, Context, Location
+from idom.web.module import export, module_from_file
 
+try:
+    from typing import Protocol
+except ImportError:
+    from typing_extensions import Protocol
 
-class Router(Protocol):
+
+class Routes(Protocol):
     def __call__(self, *routes: Route) -> ComponentType:
         ...
 
 
-def bind(backend: BackendImplementation) -> Router:
+def configure(
+    implementation: BackendImplementation[Any] | Callable[[], Location]
+) -> Routes:
+    if isinstance(implementation, BackendImplementation):
+        use_location = implementation.use_location
+    elif callable(implementation):
+        use_location = implementation
+    else:
+        raise TypeError(
+            "Expected a BackendImplementation or "
+            f"`use_location` hook, not {implementation}"
+        )
+
     @component
-    def Router(*routes: Route):
-        initial_location = backend.use_location()
+    def Router(*routes: Route) -> ComponentType | None:
+        initial_location = use_location()
         location, set_location = use_state(initial_location)
         for p, r in _compile_routes(routes):
-            if p.match(location.pathname):
+            match = p.match(location.pathname)
+            if match:
                 return _LocationStateContext(
                     r.element,
-                    value=(location, set_location),
-                    key=r.path,
+                    value=_LocationState(location, set_location, match),
+                    key=p.pattern,
                 )
         return None
 
     return Router
 
 
-def use_location() -> str:
-    return _use_location_state()[0]
+def use_location() -> Location:
+    return _use_location_state().location
+
+
+def use_match() -> re.Match[str]:
+    return _use_location_state().match
 
 
 @dataclass
 class Route:
-    path: str | re.Pattern
+    path: str | re.Pattern[str]
     element: Any
 
 
 @component
-def Link(*attributes_or_children: VdomAttributesAndChildren, to: str) -> None:
+def Link(*attributes_or_children: VdomAttributesAndChildren, to: str) -> VdomDict:
     attributes, children = coalesce_attributes_and_children(attributes_or_children)
-    set_location = _use_location_state()[1]
-    return _Link(
-        {
-            **attributes,
-            "to": to,
-            "onClick": lambda event: set_location(Location(**event)),
-        },
-        *children,
-    )
-
-
-def _compile_routes(routes: Sequence[Route]) -> Iterator[tuple[re.Pattern, Route]]:
+    set_location = _use_location_state().set_location
+    attrs = {
+        **attributes,
+        "to": to,
+        "onClick": lambda event: set_location(Location(**event)),
+    }
+    return _Link(attrs, *children)
+
+
+def _compile_routes(routes: Sequence[Route]) -> Iterator[tuple[re.Pattern[str], Route]]:
     for r in routes:
         if isinstance(r.path, re.Pattern):
             yield r.path, r
@@ -75,9 +96,14 @@ def _use_location_state() -> _LocationState:
     return location_state
 
 
-_LocationSetter = Callable[[str], None]
-_LocationState = tuple[Location, _LocationSetter]
-_LocationStateContext: type[Context[_LocationState | None]] = create_context(None)
+@dataclass
+class _LocationState:
+    location: Location
+    set_location: Callable[[Location], None]
+    match: re.Match[str]
+
+
+_LocationStateContext: Context[_LocationState | None] = create_context(None)
 
 _Link = export(
     module_from_file(

noxfile.py

@@ -0,0 +1,56 @@
+from pathlib import Path
+
+from nox import Session, session
+
+ROOT = Path(".")
+REQUIREMENTS_DIR = ROOT / "requirements"
+
+
+@session
+def format(session: Session) -> None:
+    install_requirements(session, "style")
+    session.run("black", ".")
+    session.run("isort", ".")
+
+
+@session
+def test(session: Session) -> None:
+    session.notify("test_style")
+    session.notify("test_types")
+    session.notify("test_suite")
+
+
+@session
+def test_style(session: Session) -> None:
+    install_requirements(session, "check-style")
+    session.run("black", "--check", ".")
+    session.run("isort", "--check", ".")
+    session.run("flake8", ".")
+
+
+@session
+def test_types(session: Session) -> None:
+    install_requirements(session, "check-types")
+    session.run("mypy", "--strict", "idom_router")
+
+
+@session
+def test_suite(session: Session) -> None:
+    install_requirements(session, "test-env")
+    session.run("playwright", "install", "chromium")
+
+    posargs = session.posargs[:]
+
+    if "--no-cov" in session.posargs:
+        posargs.remove("--no-cov")
+        session.log("Coverage won't be checked")
+        session.install(".")
+    else:
+        posargs += ["--cov=idom_router", "--cov-report=term"]
+        session.install("-e", ".")
+
+    session.run("pytest", "tests", *posargs)
+
+
+def install_requirements(session: Session, name: str) -> None:
+    session.install("-r", str(REQUIREMENTS_DIR / f"{name}.txt"))

pyproject.toml

@@ -6,3 +6,14 @@ build-backend = "setuptools.build_meta"
 [tool.pytest.ini_options]
 testpaths = "tests"
 asyncio_mode = "auto"
+
+
+[tool.isort]
+profile = "black"
+
+
+[tool.mypy]
+ignore_missing_imports = true
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true

requirements.txt

@@ -1,4 +1,5 @@
-twine
-pytest
-pytest-asyncio
-idom[testing,starlette]
+-r requirements/check-style.txt
+-r requirements/check-types.txt
+-r requirements/nox-deps.txt
+-r requirements/pkg-deps.txt
+-r requirements/test-env.txt

requirements/check-style.txt

@@ -0,0 +1,4 @@
+black
+flake8
+flake8_idom_hooks
+isort

requirements/check-types.txt

@@ -0,0 +1,2 @@
+mypy
+idom

requirements/nox-deps.txt

@@ -0,0 +1 @@
+nox

requirements/pkg-deps.txt

@@ -0,0 +1,2 @@
+idom >=0.40.2,<0.41
+typing_extensions

requirements/test-env.txt

@@ -0,0 +1,5 @@
+twine
+pytest
+pytest-asyncio
+pytest-cov
+idom[testing,starlette]

setup.cfg

@@ -1,2 +1,21 @@
 [bdist_wheel]
 universal=1
+
+[flake8]
+ignore = E203, E266, E501, W503, F811, N802
+max-line-length = 88
+extend-exclude =
+    .nox
+    venv
+    .venv
+    tests/cases/*
+
+[coverage:report]
+fail_under = 100
+show_missing = True
+skip_covered = True
+sort = Miss
+exclude_lines =
+    pragma: no cover
+    \.\.\.
+    raise NotImplementedError