Merge pull request #6 from girardinsamuel/feat/add-share-custom

Author: zodman

.github/workflows/inertia-ci.yml

@@ -1,35 +1,33 @@
 name: Python package
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [3.6, 3.7, 3.8]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flake8 bake-cli
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Executing Test
-      run: bake t
-    - 
-      uses: AndreMiras/coveralls-python-action@develop
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 bake-cli
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Executing Test
+        run: bake t
+      - uses: AndreMiras/coveralls-python-action@develop
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

inertia/middleware.py

@@ -1,6 +1,6 @@
 from django.http import HttpResponse, HttpResponseRedirect
 from .share import share
-from .version import asset_version
+from .version import get_version
 
 
 class InertiaMiddleware:
@@ -13,8 +13,8 @@ def __call__(self, request):
         if is_ajax:
             isInertia = request.headers.get("X-Inertia", False)
             assert isInertia, "The client not send X-Inertia Header"
-            inertia_version = asset_version.get_version()
-            inertia_version_header = str(request.headers.get("X-Inertia-Version", "")) 
+            inertia_version = get_version()
+            inertia_version_header = str(request.headers.get("X-Inertia-Version", ""))
             if inertia_version_header != "" and \
                     inertia_version_header != str(inertia_version):
                 response = HttpResponse(status=409)

inertia/share.py

@@ -6,8 +6,8 @@ def share(request, key, value):
     request.session.setdefault("share",{})
     request.session["share"][key]=value
 
-# used in pingcrm ... 
-def share_flash(request, success=False, error=False, errors=False):  
+# used in pingcrm ...
+def share_flash(request, success=False, error=False, errors=False):
     if success:
         request.session["success"]=success
     if error:
@@ -20,3 +20,19 @@ def share_flash(request, success=False, error=False, errors=False):
     share(request, "flash",{'success':success,'error':error})
     if errors:
         share(request, "errors",errors)
+
+
+def share_auth(request):
+    """Default function for globally sharing authentication data. It can be
+    overriden with a custom function defined in SHARE_INERTIA."""
+    auth = {}
+    if request.user.is_authenticated:
+        auth = {
+            "id": request.user.id,
+            "username": request.user.username,
+            "first_name": request.user.first_name,
+            "last_name": request.user.last_name,
+            "email": request.user.email,
+        }
+
+    share(request, "auth", auth)

inertia/version.py

@@ -1,18 +1,12 @@
-# pragma pylint: disable=unused-variable
-# pragma pylint: disable=not-callable
 from django.conf import settings
 
-class Version:
 
-    def set_version(self, version):
-        self.asset_version = version
-
-    def get_version(self):
-        if callable(self.asset_version):
-            return self.asset_version()
-        else:
-            return self.asset_version
-
-
-asset_version = Version()
-asset_version.set_version(getattr(settings,"VERSION",1))
+def get_version():
+    try:
+        asset_version = settings.VERSION
+    except AttributeError:
+        asset_version = 1
+    if callable(asset_version):
+        return asset_version()
+    else:
+        return asset_version

inertia/views.py

@@ -7,8 +7,9 @@
 from django.shortcuts import render
 from django.http import JsonResponse
 from django.middleware import csrf
+from django.urls import get_callable
 from .share import share
-from .version import asset_version
+from .version import get_version
 
 from django.views.generic import View
 from django.conf import settings
@@ -48,6 +49,12 @@ def render_inertia(request, component_name, props=None, template_name=None):
             "in settings.py or pass template parameter."
         )
 
+    # share custom data or default authenticated user
+    share_method_path = getattr(settings, "INERTIA_SHARE", "inertia.share.share_auth")
+    if share_method_path:
+        share_method = get_callable(share_method_path)
+        share_method(request)
+
     if props is None:
         props = {}
     shared = {}
@@ -62,23 +69,22 @@ def render_inertia(request, component_name, props=None, template_name=None):
             del request.session[key]
 
     # subsequent renders
-    inertia_version = asset_version.get_version()
+    inertia_version = get_version()
     is_version_correct = 'X-Inertia-Version' in request.headers and \
                          request.headers["X-Inertia-Version"] == str(inertia_version)
     if 'X-Inertia' in request.headers:
         response = JsonResponse({
             "component": component_name,
             "props": props,
-            "version": asset_version.get_version(),
+            "version": inertia_version,
             "url": request.get_full_path()
         })
         response['X-Inertia'] = True
         response['Vary'] = 'Accept'
         return response
     context = _build_context(component_name, props,
-                             asset_version.get_version(),
+                             inertia_version,
                              url=request.get_full_path())
-
     return render(request, inertia_template, context)
 
 class InertiaMixin:
@@ -95,4 +101,3 @@ def render_to_response(self, context, **kwargs):
             self.props = {}
         self.props.update(self.get_data(context))
         return render_inertia(self.request, self.component_name, self.props, self.template_name)
-

test.py

@@ -7,24 +7,33 @@
 from django.http import HttpResponse, HttpResponseRedirect
 import os
 
+from inertia.share import share
+
+
 settings.configure(
     VERSION=1, DEBUG=True,
     TEMPLATES= [{
          'BACKEND': 'django.template.backends.django.DjangoTemplates',
          'APP_DIRS': True,
          'DIRS': [ os.path.join('testutils'), ],
-    }]
+    }],
+    INERTIA_SHARE = "test.share_custom_func"
 )
 django.setup()
-from inertia.version import asset_version
+from inertia.version import get_version
 from inertia.views import render_inertia
 from inertia.middleware import InertiaMiddleware
 
 
+def share_custom_func(request):
+    share(request, "custom_data", "custom_value")
+
+
 class TestInertia(TestCase):
     def test_views(self):
         requestfactory = RequestFactory()
         request = requestfactory.get("/")
+        self.set_session(request)
         response = render_inertia(request, "Index")
         self.assertTrue(b'id="page"' in response.content)
 
@@ -46,7 +55,7 @@ def test_middlware_missing_header(self):
         defaults = {
             'X-Inertia': 'true',
             'X-Requested-With': 'XMLHttpRequest',
-            'X-Inertia-Version': str(asset_version.get_version()+1),
+            'X-Inertia-Version': str(get_version()+1),
         }
         request = RequestFactory().get("/")
         request.headers = defaults
@@ -58,7 +67,7 @@ def test_middleware(self):
         view = lambda request: HttpResponse()
         defaults = {
             'x-Inertia': 'true',
-            'X-Inertia-Version': asset_version.get_version(),
+            'X-Inertia-Version': get_version(),
             'x-Requested-With': 'XMLHttpRequest'
         }
         request = RequestFactory().get("/", **defaults)
@@ -67,6 +76,14 @@ def test_middleware(self):
         response = InertiaMiddleware(view)(request)
         self.assertTrue(response.status_code == 200, response.status_code)
 
+    def test_share_custom_data(self):
+        requestfactory = RequestFactory()
+        request = requestfactory.get("/")
+        self.set_session(request)
+        response = render_inertia(request, "Index")
+        self.assertDictEqual({"custom_data": "custom_value"}, request.session["share"])
+        # self.assertTrue(b'share_custom_value"' in response.content)
+
     def test_redirect_303_for_put_patch_delete_requests(self):
         request = RequestFactory().put("/users/1")
         self.set_session(request)