Added coverage & some tests for catch raise exceptions

Author: paqstd-dev

.DS_Store

@@ -1,4 +1,4 @@
-name: Check code
+name: Testing code & Coverage
 
 on:
   push:
@@ -11,7 +11,7 @@ on:
       - '**.py'
 
 jobs:
-  code-checks:
+  tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -31,4 +31,28 @@ jobs:
 
       - name: Run tests
         run: |
-          python run.py test
+          python manage.py test
+
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.10
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+          pip install coverage
+
+      - name: Run tests with coverage
+        run: |
+          python -m coverage run --source='.' manage.py test   
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/tests.yml

@@ -158,7 +158,3 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
-
-# hide other django apps
-config/
-manage.py

.gitignore

@@ -1,3 +1,6 @@
 include LICENSE
 include README.md
 recursive-include simple_components/templates *
+
+exclude manage.py
+recursive-exclude tests *

MANIFEST.in

@@ -4,20 +4,41 @@ Django Simple Components is a small package to easily create components inside y
 
 ## Quick start
 
-0. Install package from pypi:
+### 0. Install package from pypi:
 ```bash
 pip install django-simple-components
 ```
 
-1. Add `simple_components` to your INSTALLED_APPS setting like this:
+### 1. Add `simple_components` to your INSTALLED_APPS setting like this:
 ```python
 INSTALLED_APPS = [
     ...,
     "simple_components",
 ]
 ```
 
-2. Add `simple_components` to your template like this:
+Optionally, you can specify `simple_components` as builtins and this will be available in any of your templates without additionally specifying `{% load simple_components %}`:
+```python
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [BASE_DIR / "templates"],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+            "builtins": ["simple_components.templatetags.simple_components"],
+        },
+    },
+]
+```
+If you choose not use it as a built-in, you will need to add `{% load simple_components %}` to the top of your template whenever you want to use simple components.
+
+### 2. Create component inside your template:
 ```html
 {% load simple_components %}
 
@@ -41,7 +62,7 @@ INSTALLED_APPS = [
 </div>
 ```
 
-3. Hooray! Everything is ready to use it.
+### 3. Hooray! Everything is ready to use it.
 
 ## Contributing
 If you would like to suggest a new feature, you can create an issue on the GitHub repository for this project. 

README.md

@@ -4,8 +4,6 @@ requires = [
     "setuptools-scm>=8.0"]
 build-backend = "setuptools.build_meta"
 
-[tool.setuptools_scm]
-
 [project]
 name = "django-simple-components"
 dynamic = ["version"]
@@ -35,3 +33,13 @@ classifiers = [
 [project.urls]
 "Homepage" = "https://github.com/paqstd-dev/django-simple-components"
 "Bug Tracker" = "https://github.com/paqstd-dev/django-simple-components/issues"
+
+
+[tool.setuptools_scm]
+
+[tool.coverage.run]
+omit = [
+    "manage.py",
+    "setup.py",
+    "tests/*"
+]

run.py renamed to manage.py

@@ -1,3 +1,3 @@
 from setuptools import setup
 
-setup()
+setup()

pyproject.toml

@@ -0,0 +1,17 @@
+from django import template
+
+
+class SetComponentNameError(template.TemplateSyntaxError):
+    pass
+
+
+class ComponentNameError(template.TemplateSyntaxError):
+    pass
+
+
+class ComponentArgsError(template.TemplateSyntaxError):
+    pass
+
+
+class ComponentNotDefined(template.TemplateSyntaxError):
+    pass

setup.py

@@ -1,6 +1,8 @@
 import re
 from django import template
 
+from ..exceptions import SetComponentNameError, ComponentNameError, ComponentArgsError, ComponentNotDefined
+
 # allow line breaks inside tags
 template.base.tag_re = re.compile(template.base.tag_re.pattern, re.DOTALL)
 
@@ -14,7 +16,7 @@ def set_component(parser, token):
 
     bits = token.split_contents()
     if len(bits) < 2:
-        raise template.TemplateSyntaxError(
+        raise SetComponentNameError(
             '\'%s\' takes at least one argument (name of component)' % bits[0]
         )
 
@@ -39,9 +41,10 @@ def render(self, context):
 @register.tag
 def component(parser, token):
     bits = token.split_contents()
-    if len(bits) < 2:
-        raise template.TemplateSyntaxError(
-            '\'%s\' takes at least one argument (name of component)' % bits[0]
+    if len(bits) < 2 or '=' in bits[1]:
+        example = '{% component \"name\" ' + ' '.join(bits[1:]) + ' %}'
+        raise ComponentNameError(
+            'Component takes at least one required argument (name of component):\n%s' % example
         )
 
     component_name = str(parser.compile_filter(bits[1]))
@@ -55,36 +58,29 @@ def component(parser, token):
         if name:
             kwargs[name] = parser.compile_filter(value)
         else:
-            raise template.TemplateSyntaxError(
-                '\'%s\' must be takes as kwargs' % bit
+            example = '{% component "' + component_name + '" param1=%s' % bit + ' ... %}'
+            raise ComponentArgsError(
+                'Argument %s must be takes as kwargs:\n%s' % (bit, example)
             )
 
     return ComponentNode(component_name, kwargs)
 
 
 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.'
-            )
-
+    def __init__(self, component_name, kwargs=None):
         self.component_name = component_name
-
-        if kwargs is None:
-            kwargs = {}
-
         self.kwargs = kwargs
 
     def render(self, context):
         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.'
+            raise ComponentNotDefined(
+                '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)
+        if self.kwargs is not None:
+            for key, value in self.kwargs.items():
+                context[key] = value.resolve(context)
         return nodelist.render(context)