Merge branch 'master' into asgi

Author: Thembahank

.all-contributorsrc

@@ -41,6 +41,25 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "sbidy",
+      "name": "Stephan Traub",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1077364?v=4",
+      "profile": "https://github.com/sbidy",
+      "contributions": [
+        "test"
+      ]
+    },
+    {
+      "login": "frbor",
+      "name": "Fredrik Borg",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2320183?v=4",
+      "profile": "https://github.com/frbor",
+      "contributions": [
+        "code",
+        "test"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.dj-config.toml

@@ -18,7 +18,7 @@ long_running = true
 
 [[commands]]
 name = "t"
-execute = "poetry run pytest tests && npm run-script test"
+execute = "poetry run pytest -m 'not slow' && poetry run pytest -m 'slow' && npm run-script test"
 
 [[commands]]
 name = "is"

.flake8

@@ -1,4 +1,5 @@
 [flake8]
-max-line-length = 80
+max-line-length = 88
 select = C,E,F,W,B,B950
-ignore = E501,W503
+ignore = E501,W503,E231
+extend-ignore = E203,W503

.github/workflows/python.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7]
+        python-version: [3.6, 3.7, 3.8, 3.9]
 
     steps:
       - uses: actions/[email protected]
@@ -45,5 +45,5 @@ jobs:
       - name: isort check
         run: poetry run isort --settings pyproject.toml --check .
 
-      - name: Test with pytest
-        run: poetry run pytest tests
+      - name: Run all tests
+        run: poetry run nox

.gitignore

@@ -83,7 +83,7 @@ celerybeat-schedule
 
 # Environments
 .env
-.venv
+.venv*
 env/
 venv/
 ENV/

DEVELOPING.md

@@ -0,0 +1,32 @@
+# Developing
+
+1. `git clone [email protected]:adamghill/django-unicorn.git`
+1. `poetry install`
+1. `poetry run python example/manage.py migrate`
+1. `poetry run python example/manage.py runserver localhost:8000`
+1. Go to `localhost:8000` in your browser
+1. To install in another project `pip install -e ../django-unicorn`
+
+## Run unittests
+
+1. `poetry run pytest`
+1. `npm run test`
+
+## Minify Javascript
+
+1. `npm install`
+1. `npm run build`
+
+## Bump version
+
+1. `dj t`
+1. `npm run build`
+1. `poetry version major|minor|patch`
+1. Commit/tag/push version bump
+1. `poetry publish --build -r test`
+1. Make sure test package can be installed as expected (https://test.pypi.org/project/django-unicorn/)
+1. `poetry publish`
+1. Make sure live package can be installed as expected (https://pypi.org/project/django-unicorn/)
+1. [Create GitHub release](https://github.com/adamghill/django-unicorn/releases/new) and add changelog there
+1. Update django-unicorn.com's changelog.md
+1. Update django-unicorn.com's version of `django-unicorn`

README.md

@@ -1,66 +1,32 @@
-# django-unicorn
+<p align="center">
+  <a href="https://www.django-unicorn.com/"><img src="https://www.django-unicorn.com/static/img/unicorn.svg" alt="django-unicorn logo" height="80"/></a>
+</p>
+<h1 align="center">Unicorn</h1>
+<p align="center">The magical full-stack framework for Django ✨</p>
 
 ![PyPI](https://img.shields.io/pypi/v/django-unicorn?color=blue&style=flat-square)
 
-![GitHub Release Date](https://img.shields.io/github/release-date/adamghill/django-unicorn?style=flat-square)
-
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-
-[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
-
+[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-The magical fullstack framework for Django. ✨
-
-`Unicorn` is a reactive component framework that progressively enhances a normal Django view, makes AJAX calls in the background, and dynamically updates the DOM. It seamlessly extends Django past its server-side framework roots without giving up all of its niceties or re-building your website.
-
-## Why?
-
-Building server-side sites in Django with the ORM and template engine is so pleasant, but once you need more interactivity on the frontend, there is a lot more ambiguity. Should you build out an entire API in Django REST framework? Should you use React or Vue.js (or some) other frontend framework?
-
-It seems like there should be an easier way to create interactive experiences.
-
-## A note
-
-`django-unicorn` is still beta and the API will likely change on the way to version 1.0.0. All efforts will be made to include an easy upgrade path. 1.0.0 will signify that the public API won't change until the next major release.
-
-# Detailed documentation
-
-https://www.django-unicorn.com
-
-# Developing
-
-1. `git clone [email protected]:adamghill/django-unicorn.git`
-1. `poetry install`
-1. `poetry run python example/manage.py migrate`
-1. `poetry run python example/manage.py runserver localhost:8000`
-1. Go to `localhost:8000` in your browser
-1. To install in another project `pip install -e ../django-unicorn`
-
-## Run unittests
-
-1. `poetry run pytest`
-1. `npm run test`
+[Unicorn](https://www.django-unicorn.com) is a reactive component framework that progressively enhances a normal Django view, makes AJAX calls in the background, and dynamically updates the DOM. It seamlessly extends Django past its server-side framework roots without giving up all of its niceties or re-building your website.
 
-## Minify Javascript
+## :zap: How to use
 
-1. `npm install`
-1. `npm run build`
+1. [Install](https://www.django-unicorn.com/docs/installation/) `Unicorn`
+1. [Create](https://www.django-unicorn.com/docs/components/) a component
+1. Load the `Unicorn` templatetag with `{% load unicorn %}` and add the component to your template with `{% unicorn 'component-name' %}`
+1. :tada:
 
-## Bump version
+## :book: More details
 
-1. `npm run build`
-1. `poetry version major|minor|patch`
-1. Commit/tag/push version bump
-1. `poetry publish --build -r test`
-1. Make sure test package can be installed as expected (https://test.pypi.org/project/django-unicorn/)
-1. `poetry publish`
-1. Make sure live package can be installed as expected (https://pypi.org/project/django-unicorn/)
-1. Update django-unicorn.com's changelog.md
-1. Update django-unicorn.com's version of `django-unicorn`
-1. [Create GitHub release](https://github.com/adamghill/django-unicorn/releases/new) and add changelog there
+- [Changelog](https://www.django-unicorn.com/docs/changelog/)
+- [Docs](https://www.django-unicorn.com/docs/)
+- [Screencasts](https://www.django-unicorn.com/screencasts/installation)
+- [Examples](https://www.django-unicorn.com/examples/todo)
 
-## Contributors ✨
+## :clap: Contributors
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
@@ -69,14 +35,16 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://adamghill.com"><img src="https://avatars0.githubusercontent.com/u/317045?v=4" width="100px;" alt=""/><br /><sub><b>Adam Hill</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=adamghill" title="Code">💻</a> <a href="https://github.com/adamghill/django-unicorn/commits?author=adamghill" title="Tests">⚠️</a></td>
-    <td align="center"><a href="https://python3.ninja"><img src="https://avatars1.githubusercontent.com/u/44167?v=4" width="100px;" alt=""/><br /><sub><b>Andres Vargas</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=zodman" title="Code">💻</a></td>
-    <td align="center"><a href="http://iskra.ml"><img src="https://avatars3.githubusercontent.com/u/6555851?v=4" width="100px;" alt=""/><br /><sub><b>Eddy Ernesto del Valle Pino</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=edelvalle" title="Code">💻</a></td>
-    <td align="center"><a href="https://www.linkedin.com/in/yaser-al-najjar-429b9096/"><img src="https://avatars3.githubusercontent.com/u/10493809?v=4" width="100px;" alt=""/><br /><sub><b>Yaser Al-Najjar</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=yaseralnajjar" title="Code">💻</a></td>
+    <td align="center"><a href="https://adamghill.com"><img src="https://avatars0.githubusercontent.com/u/317045?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Adam Hill</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=adamghill" title="Code">💻</a> <a href="https://github.com/adamghill/django-unicorn/commits?author=adamghill" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://python3.ninja"><img src="https://avatars1.githubusercontent.com/u/44167?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Andres Vargas</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=zodman" title="Code">💻</a></td>
+    <td align="center"><a href="http://iskra.ml"><img src="https://avatars3.githubusercontent.com/u/6555851?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Eddy Ernesto del Valle Pino</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=edelvalle" title="Code">💻</a></td>
+    <td align="center"><a href="https://www.linkedin.com/in/yaser-al-najjar-429b9096/"><img src="https://avatars3.githubusercontent.com/u/10493809?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yaser Al-Najjar</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=yaseralnajjar" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/sbidy"><img src="https://avatars.githubusercontent.com/u/1077364?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stephan Traub</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=sbidy" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/frbor"><img src="https://avatars.githubusercontent.com/u/2320183?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fredrik Borg</b></sub></a><br /><a href="https://github.com/adamghill/django-unicorn/commits?author=frbor" title="Code">💻</a> <a href="https://github.com/adamghill/django-unicorn/commits?author=frbor" title="Tests">⚠️</a></td>
   </tr>
 </table>
 
-<!-- markdownlint-enable -->
+<!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->

conftest.py

@@ -1,5 +1,7 @@
 from django.conf import settings
 
+import pytest
+
 
 def pytest_configure():
     templates = [
@@ -11,13 +13,56 @@ def pytest_configure():
     databases = {"default": {"ENGINE": "django.db.backends.sqlite3",}}
 
     installed_apps = [
-        "example.coffee",
+        "example.coffee.apps.Config",
+        "example.books.apps.Config",
     ]
 
+    unicorn_settings = {
+        "SERIAL": {"ENABLED": True, "TIMEOUT": 5},
+        "CACHE_ALIAS": "default",
+        "APPS": ("unicorn",),
+    }
+
+    caches = {
+        "default": {
+            "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
+            "LOCATION": "unique-snowflake",
+        }
+    }
+
     settings.configure(
         TEMPLATES=templates,
         ROOT_URLCONF="django_unicorn.urls",
         DATABASES=databases,
         INSTALLED_APPS=installed_apps,
         UNIT_TEST=True,
+        UNICORN=unicorn_settings,
+        CACHES=caches,
     )
+
+
+@pytest.fixture(autouse=True)
+def reset_settings(settings):
+    """
+    This takes the original `UNICORN` settings before the test is run, runs the test, and then resets them afterwards.
+    This is required because mutating nested dictionaries does not reset them as expected by `pytest-django`.
+    More details in https://github.com/pytest-dev/pytest-django/issues/601#issuecomment-440676001.
+    """
+
+    # Get original settings
+    cache_settings = {**settings.CACHES}
+    unicorn_settings = {**settings.UNICORN}
+    django_unicorn_settings = {}
+
+    if hasattr(settings, "DJANGO_UNICORN"):
+        django_unicorn_settings = {**settings.DJANGO_UNICORN}
+
+    # Run test
+    yield
+
+    # Re-set original settings
+    settings.CACHES = cache_settings
+    settings.UNICORN = unicorn_settings
+
+    if django_unicorn_settings:
+        settings.DJANGO_UNICORN = django_unicorn_settings