Merge branch 'release/6.0.0'

Author: marteinn

.coveragerc

@@ -0,0 +1,17 @@
+[run]
+branch = true
+omit =
+    */tests/*
+    */migrations/*
+    */urls.py
+    */settings/*
+    */wsgi.py
+    example_django_react_templatetags/*
+    venv/*
+    manage.py
+    runtests.py
+    setup.py
+source = .
+
+[report]
+show_missing = true

.gitignore

@@ -50,3 +50,6 @@ example_django_react_templatetags/django_react_templatetags
 
 # DB
 *.sqlite3
+
+# Pyenv
+.python-version

.travis.yml

@@ -1,27 +1,22 @@
 language: python
 
 env:
- - DJANGO_VERSION=1.11.8
- - DJANGO_VERSION=2.0
+ - DJANGO_VERSION=2.2.11
+ - DJANGO_VERSION=3.0.4
 
 python:
-  - "2.7"
   - "3.5"
   - "3.6"
-  - "3.7-dev"
-  - "pypy"
+  - "3.7"
+  - "3.8"
 
 matrix:
   exclude:
-  - python: "2.7"
-    env: DJANGO_VERSION=2.0
-  - python: "pypy"
-    env: DJANGO_VERSION=2.0
-  - python: "3.7-dev"
-    env: DJANGO_VERSION=1.11.8
+  - python: "3.5"
+    env: DJANGO_VERSION=3.0.4
 
 install:
- - pip install -q Django==$DJANGO_VERSION requests responses mock
+ - pip install -q Django==$DJANGO_VERSION requests mock hypernova
 
 script:
  - python runtests.py

README.md

@@ -13,7 +13,7 @@ This django library allows you to add React (16+) components into your django te
 - Include react components using django templatetags
 - Unlimited amount of components in one view
 - Support custom models (that is from the beginning not json-serializable)
-- Server side rendering
+- Server side rendering with [Hypernova](https://github.com/airbnb/hypernova) or [Hastur](https://github.com/frojd/Hastur)
 
 
 ## Installation
@@ -29,9 +29,10 @@ $ pip install django_react_templatetags
 
 You should first read [Getting started](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/getting-started.md), then go through these topics:
 - [Settings](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/settings.md)
-- [Adding a single component](https://github.com/Frojd/django-react-templatetags/blob/develop/<Paste>docs/example-single-component.md)
+- [How to use the templatetags included in this library](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/templatetags-params.md)
+- [Adding a single component](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/example-single-component.md)
 - [Adding multiple components](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/example-multiple-components.md)
-- [Example application](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/example-application.md)
+- [Examples](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/examples.md)
 - [Working with models](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/working-with-models.md)
 - [Server side rendering](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/server-side-rendering.md)
 - [FAQ](https://github.com/Frojd/django-react-templatetags/blob/develop/docs/faq.md)
@@ -44,6 +45,11 @@ This library include tests, just run `python runtests.py`
 You can also run separate test cases: `python runtests.py tests.test_filters.ReactIncludeComponentTest`
 
 
+## Coverage
+
+Make sure you have Coverage.py installed, then run `coverage run runtests.py` to measure coverage. We are currently at 95%.
+
+
 ## Contributing
 
 Want to contribute? Awesome. Just send a pull request.

django_react_templatetags/__init__.py

@@ -8,8 +8,8 @@
 """
 
 __title__ = "django_react_templatetags"
-__version__ = "5.4.0"
-__build__ = 540
+__version__ = "6.0.0"
+__build__ = 541
 __author__ = "Martin Sandström"
 __license__ = "MIT"
-__copyright__ = "Copyright 2015-2019 Fröjd Interactive"
+__copyright__ = "Copyright 2015-2020 Fröjd Interactive"

django_react_templatetags/context_processors.py

@@ -1,9 +1,14 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+import warnings
+
 
 def react_context_processor(request):
     """Expose a global list of react components to be processed"""
+    warnings.warn(
+        "react_context_processor is no longer required.", DeprecationWarning
+    )
 
     return {
         'REACT_COMPONENTS': [],

django_react_templatetags/encoders.py

@@ -20,10 +20,6 @@ class ReactRepresentationJSONEncoder(DjangoJSONEncoder):
 
     def default(self, o):
         if isinstance(o, RepresentationMixin):
-            # Allow backwards compability with react_representation prop
-            if not hasattr(o, 'to_react_representation'):
-                return o.react_representation
-
             args = [self.context if hasattr(self, 'context') else None]
             args = [x for x in args if x is not None]
 

django_react_templatetags/ssr/__init__.py

@@ -33,7 +33,10 @@ def load_or_empty(self, component, headers={}, ssr_context=None):
             )
             logger.exception(msg)
 
-        return inner_html
+        return {
+            "html": inner_html,
+            "params": {},
+        }
 
 
     def load(self, request_json, headers):

django_react_templatetags/ssr.py renamed to django_react_templatetags/ssr/default.py

@@ -0,0 +1,57 @@
+import logging
+import json
+import re
+
+from django.conf import settings
+import hypernova
+
+
+logger = logging.getLogger(__name__)
+hypernova_id_re = re.compile(r"data-hypernova-id=\"([\w\-]*)\"")
+hypernova_key_re = re.compile(r"data-hypernova-key=\"([\w\-]*)\"")
+
+
+class HypernovaService:
+    def load_or_empty(self, component, headers={}, ssr_context=None):
+        # from hypernova.plugins.dev_mode import DevModePlugin
+
+        renderer = hypernova.Renderer(
+            settings.REACT_RENDER_HOST,
+            # [DevModePlugin(logger)] if settings.DEBUG else [],
+            [],
+            timeout=get_request_timeout(),
+            headers=headers,
+        )
+
+        inner_html = ""
+        try:
+            props = json.loads(component["json"])
+            if ssr_context:
+                props["context"] = ssr_context
+            inner_html = renderer.render({component["name"]: props})
+        except Exception as e:
+            msg = "SSR request to '{}' failed: {}".format(
+                settings.REACT_RENDER_HOST, e.__class__.__name__
+            )
+            logger.exception(msg)
+
+        if not inner_html:
+            return {"html": "", "params": {}}
+
+        match = re.search(hypernova_id_re, inner_html)
+        hypernova_id = match.group(1) if match else None
+
+        match = re.search(hypernova_key_re, inner_html)
+        hypernova_key = match.group(1) if match else None
+
+        return {
+            "html": inner_html,
+            "params": {"hypernova_id": hypernova_id, "hypernova_key": hypernova_key,},
+        }
+
+
+def get_request_timeout():
+    if not hasattr(settings, "REACT_RENDER_TIMEOUT"):
+        return 20
+
+    return settings.REACT_RENDER_TIMEOUT