Rewrite ReactPy-Router (#30)

### Changed

-   Bump GitHub workflows
-   Rename `use_query` to `use_search_params`.
-   Rename `simple.router` to `browser_router`.
-   Rename `SimpleResolver` to `StarletteResolver`.
-   Rename `CONVERSION_TYPES` to `CONVERTERS`.
-   Change "Match Any" syntax from a star `*` to `{name:any}`.
-   Rewrite `reactpy_router.link` to be a server-side component.
-   Simplified top-level exports within `reactpy_router`.

### Added

-   New error for ReactPy router elements being used outside router context.
-   Configurable/inheritable `Resolver` base class.
-   Add debug log message for when there are no router matches.
-   Add slug as a supported type.

### Fixed

-   Fix bug where changing routes could cause render failure due to key identity.
-   Fix bug where "Match Any" pattern wouldn't work when used in complex or nested paths.
-   Fix bug where `link` elements could not have `@component` type children.
-   Fix bug where the ReactPy would not detect the current URL after a reconnection.
-   Fixed flakey tests on GitHub CI by adding click delays.

Author: Archmonger

Diff for: .editorconfig

@@ -0,0 +1,32 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+end_of_line = lf
+
+[*.py]
+indent_size = 4
+max_line_length = 120
+
+[*.md]
+indent_size = 4
+
+[*.html]
+max_line_length = off
+
+[*.js]
+max_line_length = off
+
+[*.css]
+indent_size = 4
+max_line_length = off
+
+# Tests can violate line width restrictions in the interest of clarity.
+[**/test_*.py]
+max_line_length = off

Diff for: .github/workflows/codeql.yml

@@ -12,67 +12,51 @@
 name: "CodeQL"
 
 on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
-  schedule:
-    # Runs at 22:21 on Monday.
-    - cron: '21 22 * * 1'
+    push:
+        branches: ["main"]
+    pull_request:
+        # The branches below must be a subset of the branches above
+        branches: ["main"]
+    schedule:
+        # Runs at 22:21 on Monday.
+        - cron: "21 22 * * 1"
 
 jobs:
-  analyze:
-    name: Analyze
-    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
-    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript', 'python' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
-        # Use only 'java' to analyze code written in Java, Kotlin or both
-        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-
-        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
-
-
-    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-    #   If the Autobuild fails above, remove it and uncomment the following three lines.
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-    # - run: |
-    #     echo "Run, Build Application using script"
-    #     ./location_of_script_within_repo/buildscript.sh
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"
+    analyze:
+        name: Analyze
+        runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+        timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+        permissions:
+            actions: read
+            contents: read
+            security-events: write
+
+        strategy:
+            fail-fast: false
+            matrix:
+                language: ["javascript", "python"]
+                # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
+                # Use only 'java' to analyze code written in Java, Kotlin or both
+                # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+                # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            # Initializes the CodeQL tools for scanning.
+            - name: Initialize CodeQL
+              uses: github/codeql-action/init@v3
+              with:
+                  languages: ${{ matrix.language }}
+                  # If you wish to specify custom queries, you can do so here or in a config file.
+                  # By default, queries listed here will override any specified in a config file.
+                  # Prefix the list here with "+" to use these queries and those in the config file.
+
+                  # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+                  # queries: security-extended,security-and-quality
+
+            - name: Perform CodeQL Analysis
+              uses: github/codeql-action/analyze@v3
+              with:
+                  category: "/language:${{matrix.language}}"

Diff for: .github/workflows/publish-develop-docs.yml

@@ -7,10 +7,10 @@ jobs:
     deploy:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
               with:
                   fetch-depth: 0
-            - uses: actions/setup-python@v4
+            - uses: actions/setup-python@v5
               with:
                   python-version: 3.x
             - run: pip install -r requirements/build-docs.txt

Diff for: .github/workflows/publish-py.yaml

@@ -11,9 +11,9 @@ jobs:
     publish-package:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
             - name: Set up Python
-              uses: actions/setup-python@v4
+              uses: actions/setup-python@v5
               with:
                   python-version: "3.x"
             - name: Install dependencies

Diff for: .github/workflows/publish-release-docs.yml

@@ -8,10 +8,10 @@ jobs:
     deploy:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
               with:
                   fetch-depth: 0
-            - uses: actions/setup-python@v4
+            - uses: actions/setup-python@v5
               with:
                   python-version: 3.x
             - run: pip install -r requirements/build-docs.txt

Diff for: .github/workflows/test-docs.yml

@@ -1,37 +1,39 @@
 name: Test
 
 on:
-    push:
-        branches:
-            - main
-    pull_request:
-        branches:
-            - main
-    schedule:
-        - cron: "0 0 * * *"
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: "0 0 * * *"
 
 jobs:
-    docs:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v3
-              with:
-                  fetch-depth: 0
-            - uses: actions/setup-python@v4
-              with:
-                  python-version: 3.x
-            - name: Check docs build
-              run: |
-                  pip install -r requirements/build-docs.txt
-                  linkcheckMarkdown docs/ -v -r
-                  linkcheckMarkdown README.md -v -r
-                  linkcheckMarkdown CHANGELOG.md -v -r
-                  cd docs
-                  mkdocs build --strict
-            - name: Check docs examples
-              run: |
-                  pip install -r requirements/check-types.txt
-                  pip install -r requirements/check-style.txt
-                  mypy --show-error-codes docs/examples/python/
-                  black docs/examples/python/ --check
-                  ruff check docs/examples/python/
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Install Python Dependencies
+        run: |
+          pip install -r requirements/build-docs.txt
+          pip install -r requirements/check-types.txt
+          pip install -r requirements/check-style.txt
+          pip install -e .
+      - name: Check docs build
+        run: |
+          linkcheckMarkdown docs/ -v -r
+          linkcheckMarkdown README.md -v -r
+          linkcheckMarkdown CHANGELOG.md -v -r
+          cd docs
+          mkdocs build --strict
+      - name: Check docs examples
+        run: |
+          mypy --show-error-codes docs/examples/python/
+          ruff check docs/examples/python/

Diff for: .github/workflows/test-src.yaml

@@ -17,9 +17,9 @@ jobs:
             matrix:
                 python-version: ["3.9", "3.10", "3.11"]
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
             - name: Use Python ${{ matrix.python-version }}
-              uses: actions/setup-python@v4
+              uses: actions/setup-python@v5
               with:
                   python-version: ${{ matrix.python-version }}
             - name: Install Python Dependencies
@@ -29,9 +29,9 @@ jobs:
     coverage:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v2
+            - uses: actions/checkout@v4
             - name: Use Latest Python
-              uses: actions/setup-python@v2
+              uses: actions/setup-python@v5
               with:
                   python-version: "3.10"
             - name: Install Python Dependencies

Diff for: .gitignore

@@ -4,7 +4,7 @@ docs/site
 
 # --- JAVASCRIPT BUNDLES ---
 
-src/reactpy_router/bundle.js
+src/reactpy_router/static/bundle.js
 
 # --- PYTHON IGNORE FILES ----
 
@@ -108,7 +108,7 @@ celerybeat.pid
 
 # Environments
 .env
-.venv
+.venv*
 env/
 venv/
 ENV/

Diff for: .prettierrc

@@ -0,0 +1,4 @@
+{
+  "proseWrap": "never",
+  "trailingComma": "all"
+}

Diff for: CHANGELOG.md

@@ -34,7 +34,31 @@ Using the following categories, list your changes in this order:
 
 ## [Unreleased]
 
--   Nothing (yet)!
+### Changed
+
+-   Bump GitHub workflows
+-   Rename `use_query` to `use_search_params`.
+-   Rename `simple.router` to `browser_router`.
+-   Rename `SimpleResolver` to `StarletteResolver`.
+-   Rename `CONVERSION_TYPES` to `CONVERTERS`.
+-   Change "Match Any" syntax from a star `*` to `{name:any}`.
+-   Rewrite `reactpy_router.link` to be a server-side component.
+-   Simplified top-level exports within `reactpy_router`.
+
+### Added
+
+-   New error for ReactPy router elements being used outside router context.
+-   Configurable/inheritable `Resolver` base class.
+-   Add debug log message for when there are no router matches.
+-   Add slug as a supported type.
+
+### Fixed
+
+-   Fix bug where changing routes could cause render failure due to key identity.
+-   Fix bug where "Match Any" pattern wouldn't work when used in complex or nested paths.
+-   Fix bug where `link` elements could not have `@component` type children.
+-   Fix bug where the ReactPy would not detect the current URL after a reconnection.
+-   Fixed flakey tests on GitHub CI by adding click delays.
 
 ## [0.1.1] - 2023-12-13
 

Diff for: MANIFEST.in

@@ -1,2 +1,2 @@
-include src/reactpy_router/bundle.js
+recursive-include src/reactpy_router/static *
 include src/reactpy_router/py.typed

Diff for: docs/examples/python/basic-routing-more-routes.py

@@ -1,14 +1,13 @@
 from reactpy import component, html, run
-
-from reactpy_router import route, simple
+from reactpy_router import browser_router, route
 
 
 @component
 def root():
-    return simple.router(
+    return browser_router(
         route("/", html.h1("Home Page 🏠")),
         route("/messages", html.h1("Messages 💬")),
-        route("*", html.h1("Missing Link 🔗‍💥")),
+        route("{404:any}", html.h1("Missing Link 🔗‍💥")),
     )
 
 

Diff for: docs/examples/python/basic-routing.py

@@ -1,13 +1,12 @@
 from reactpy import component, html, run
-
-from reactpy_router import route, simple
+from reactpy_router import browser_router, route
 
 
 @component
 def root():
-    return simple.router(
+    return browser_router(
         route("/", html.h1("Home Page 🏠")),
-        route("*", html.h1("Missing Link 🔗‍💥")),
+        route("{404:any}", html.h1("Missing Link 🔗‍💥")),
     )