Added simple tests for code & tests workflow

Author: paqstd-dev

.github/workflows/release.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python 3.11
         uses: actions/setup-python@v4

.github/workflows/tests.yml

@@ -0,0 +1,30 @@
+name: Check code
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  code-checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+
+      - name: Run tests
+        run: |
+          python run.py test

MANIMEST.in renamed to MANIFEST.in

@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+import os
+import sys
+
+
+def main():
+    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tests.settings')
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

run.py

@@ -1,23 +1,21 @@
 import re
 from django import template
 
-
 # allow line breaks inside tags
 template.base.tag_re = re.compile(template.base.tag_re.pattern, re.DOTALL)
 
-
 register = template.Library()
 
 
 @register.tag
 def set_component(parser, token):
-    nodelist = parser.parse(("end_set_component",))
+    nodelist = parser.parse(('end_set_component',))
     parser.delete_first_token()
 
     bits = token.split_contents()
     if len(bits) < 2:
         raise template.TemplateSyntaxError(
-            "'%s' takes at least one argument (name of component)" % bits[0]
+            '\'%s\' takes at least one argument (name of component)' % bits[0]
         )
 
     component_name = str(parser.compile_filter(bits[1]))
@@ -68,7 +66,7 @@ class ComponentNode(template.Node):
     def __init__(self, component_name=None, kwargs=None):
         if component_name is None:
             raise template.TemplateSyntaxError(
-                "Component template nodes must be given a name to return."
+                'Component template nodes must be given a name to return.'
             )
 
         self.component_name = component_name
@@ -79,7 +77,13 @@ def __init__(self, component_name=None, kwargs=None):
         self.kwargs = kwargs
 
     def render(self, context):
-        nodelist = context['components'][self.component_name]
+        try:
+            nodelist = context['components'][self.component_name]
+        except KeyError:
+            raise template.TemplateSyntaxError(
+                'The component \'%s\' has not been previously defined.Check that the component is named correctly.'
+                % self.component_name
+            )
 
         for key, value in self.kwargs.items():
             context[key] = value.resolve(context)

simple_components/templatetags/simple_components.py

@@ -0,0 +1,35 @@
+from pathlib import Path
+
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+SECRET_KEY = 'secret_key'
+DEBUG = False
+
+ALLOWED_HOSTS = []
+
+INSTALLED_APPS = [
+    'tests',
+    'simple_components'
+]
+
+ROOT_URLCONF = 'tests.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.request',
+            ],
+        },
+    },
+]
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': ':memory:'
+    }
+}

tests/__init__.py

@@ -0,0 +1,9 @@
+{% load simple_components %}
+
+{% set_component "simple_v4" %}
+    <p>{{ c_list }}, {{ c_list.1 }}</p>
+    <p>{{ c_string }}, {{ c_string.4 }}</p>
+    <p>{{ c_dict }}, {{ c_dict.a.b.c }}</p>
+{% end_set_component %}
+
+{% component "simple_v4" c_list=list c_string=string c_dict=dict %}

tests/settings.py

@@ -0,0 +1,19 @@
+{% load simple_components %}
+
+{% set_component "simple_v3" %}
+    <div>
+        <h3>{{ title }}</h3>
+        <p>{{ description }}</p>
+
+        {{ other }}
+    </div>
+{% end_set_component %}
+
+{% component
+    "simple_v3"
+
+    title="Hello"
+    description="World"
+
+    other="..."
+%}

tests/templates/context.html

@@ -0,0 +1,5 @@
+{% load simple_components %}
+
+{% set_component "simple_v1" %}
+    simple text
+{% end_set_component %}