{{ book }}
15 | {% endfor %}
16 | ```
17 |
18 | ```python
19 | # views.py
20 | from django.shortcuts import render
21 |
22 | def index(request):
23 | return render(request, 'index.html', {})
24 | ```
25 |
--------------------------------------------------------------------------------
/tests/dj_angles/regex_replacer/test_get_attribute_replacements.py:
--------------------------------------------------------------------------------
1 | from collections import namedtuple
2 |
3 | import pytest
4 |
5 | from dj_angles.regex_replacer import get_attribute_replacements
6 |
7 | # Structure to store parameterize data
8 | Params = namedtuple(
9 | "Params",
10 | ("original", "replacement"),
11 | )
12 |
13 |
14 | @pytest.mark.parametrize(
15 | Params._fields,
16 | (
17 | Params(
18 | original="
",
19 | replacement="{% if True %}{% endif %}",
20 | ),
21 | ),
22 | )
23 | def test_if(original, replacement):
24 | actual = get_attribute_replacements(original)
25 |
26 | for tag_replacement in actual:
27 | assert tag_replacement.original == original
28 | assert tag_replacement.replacement == replacement
29 |
--------------------------------------------------------------------------------
/tests/dj_angles/templatetags/model/test_do_model.py:
--------------------------------------------------------------------------------
1 | from django.template.base import Token, TokenType
2 |
3 | from dj_angles.templatetags.model import do_model
4 |
5 |
6 | def test_model():
7 | token = Token(TokenType.BLOCK, contents="model Book.objects.filter(id=1).first() as books")
8 | actual = do_model(None, token)
9 |
10 | assert actual.parsed_function.portions[0].name == "__dj_angles_models"
11 | assert actual.parsed_function.portions[1].name == "Book"
12 | assert actual.parsed_function.portions[2].name == "objects"
13 | assert actual.parsed_function.portions[3].name == "filter"
14 | assert actual.parsed_function.portions[3].args == []
15 | assert actual.parsed_function.portions[3].kwargs == {"id": 1}
16 | assert actual.parsed_function.portions[4].name == "first"
17 | assert actual.context_variable_name == "books"
18 |
--------------------------------------------------------------------------------
/src/dj_angles/caseconverter/kebab.py:
--------------------------------------------------------------------------------
1 | from dj_angles.caseconverter.boundaries import OnDelimeterLowercaseNext, OnUpperPrecededByLowerAppendLower
2 | from dj_angles.caseconverter.caseconverter import CaseConverter
3 |
4 |
5 | class Kebab(CaseConverter):
6 | JOIN_CHAR = "-"
7 |
8 | def define_boundaries(self):
9 | self.add_boundary_handler(OnDelimeterLowercaseNext(self.delimiters(), self.JOIN_CHAR))
10 | self.add_boundary_handler(OnUpperPrecededByLowerAppendLower(self.JOIN_CHAR))
11 |
12 | def prepare_string(self, s):
13 | if s.isupper():
14 | return s.lower()
15 |
16 | return s
17 |
18 | def mutate(self, c):
19 | return c.lower()
20 |
21 |
22 | def kebabify(s, **kwargs):
23 | """Convert a string to kebab case
24 |
25 | Example
26 |
27 | Hello World => hello-world
28 |
29 | """
30 | return Kebab(s, **kwargs).convert()
31 |
--------------------------------------------------------------------------------
/.readthedocs.yml:
--------------------------------------------------------------------------------
1 | # .readthedocs.yaml
2 | # Read the Docs configuration file
3 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4 | version: 2
5 |
6 | sphinx:
7 | configuration: docs/source/conf.py
8 | fail_on_warning: true
9 | builder: dirhtml
10 |
11 | build:
12 | os: ubuntu-lts-latest
13 | tools:
14 | python: latest
15 | jobs:
16 | pre_create_environment:
17 | - asdf plugin add uv
18 | - asdf install uv latest
19 | - asdf global uv latest
20 | create_environment:
21 | - uv venv $READTHEDOCS_VIRTUALENV_PATH
22 | install:
23 | # Use a cache dir in the same mount to halve the install time
24 | - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv sync --cache-dir $READTHEDOCS_VIRTUALENV_PATH/../../uv_cache --group docs
25 | build:
26 | html:
27 | - uv run sphinx-build -T -b dirhtml docs/source $READTHEDOCS_OUTPUT/html
28 |
--------------------------------------------------------------------------------
/src/dj_angles/strings.py:
--------------------------------------------------------------------------------
1 | def dequotify(s: str) -> str:
2 | """Removes single or double quotes from a string.
3 |
4 | Args:
5 | param s: The string to remove quotes from.
6 |
7 | Returns:
8 | A new string without the quotes or the original if there were no quotes.
9 | """
10 |
11 | if (s.startswith("'") and s.endswith("'")) or (s.startswith('"') and s.endswith('"')):
12 | return s[1:-1]
13 |
14 | return s
15 |
16 |
17 | def replace_newlines(s: str, replacement: str = "") -> str:
18 | """Replaces newlines with the given replacement string.
19 |
20 | Args:
21 | param s: The string to replace newlines in.
22 | param replacement: The string to replace the newlines with.
23 |
24 | Returns:
25 | A new string with the newlines replaced.
26 | """
27 |
28 | return s.replace("\r\n", replacement).replace("\n", replacement).replace("\r", replacement)
29 |
--------------------------------------------------------------------------------
/docs/source/middlewares/request-method.md:
--------------------------------------------------------------------------------
1 | # RequestMethodMiddleware
2 |
3 | Adds the request's method as boolean properties to the `request` object.
4 |
5 | ```{note}
6 | Make sure to [install `dj_angles` middleware](../installation.md#middleware) to access this functionality.
7 | ```
8 |
9 | ## Example
10 |
11 | ```python
12 | # views.py
13 | from django.shortcuts import render
14 | from book.models import Book
15 |
16 | def book(request, book_id):
17 | book = Book.objects.filter(id=book_id).first()
18 |
19 | if request.is_post:
20 | book.name = request.POST.get('name')
21 | book.save()
22 |
23 | return redirect('book', id=book.id)
24 |
25 | return render(request, 'book.html', {'book': book})
26 | ```
27 |
28 | ## Properties
29 |
30 | - `request.is_post`
31 | - `request.is_get`
32 | - `request.is_patch`
33 | - `request.is_head`
34 | - `request.is_put`
35 | - `request.is_delete`
36 | - `request.is_trace`
--------------------------------------------------------------------------------
/docs/source/inline-expressions.md:
--------------------------------------------------------------------------------
1 | # Inline Expressions
2 |
3 | The `dj-angles` approach is shown first and then the equivalent Django Template Language is second.
4 |
5 | ## `or`
6 |
7 | Similar to the [`default` filter](https://docs.djangoproject.com/en/stable/ref/templates/builtins/#default), but feels a little more Pythonic.
8 |
9 | ```html
10 | {{ request.user.username or request.user.email }}
11 | ```
12 |
13 | ```html
14 | {% if request.user.username %}{{ request.user.username }}{% else %}{{ request.user.email }}{% endif %}
15 | ```
16 |
17 | ## `if`
18 |
19 | Python ternary operator where the first part is a conditional, the part after the " if " is the true value, and the part after the " else " is the false value.
20 |
21 | ```html
22 | {{ request.user.username if request.user.is_authenticated else 'Unknown' }}
23 | ```
24 |
25 | ```html
26 | {% if request.user.is_authenticated %}{{ request.user.username }}{% else %}Unknown{% endif %}
27 | ```
28 |
--------------------------------------------------------------------------------
/docs/source/middlewares/request-ajax.md:
--------------------------------------------------------------------------------
1 | # RequestAJAXMiddleware
2 |
3 | Adds whether the request is AJAX as a boolean property to the `request` object. Useful to check when rendering a view's HTML via AJAX, i.e. using the [`form` tag](../tag-elements.md#form) or [HTMX](https://htmx.org/).
4 |
5 | ```{note}
6 | Make sure to [install `dj_angles` middleware](../installation.md#middleware) to access this functionality.
7 | ```
8 |
9 | ## Example
10 |
11 | ```python
12 | # views.py
13 | from django.shortcuts import render
14 | from book.models import Book
15 |
16 | def book(request, book_id):
17 | book = Book.objects.filter(id=book_id).first()
18 |
19 | if request.is_post:
20 | book.title = request.POST.get('title')
21 | book.save()
22 |
23 | if not request.is_ajax:
24 | return redirect('book', id=book.id)
25 |
26 | return render(request, 'book.html', {'book': book})
27 | ```
28 |
29 | ## Properties
30 |
31 | - `request.is_ajax`
32 |
--------------------------------------------------------------------------------
/tests/dj_angles/test_template_loader.py:
--------------------------------------------------------------------------------
1 | from types import SimpleNamespace
2 |
3 | from django.template import Engine
4 |
5 | from dj_angles.template_loader import Loader
6 |
7 |
8 | def test_get_contents_returns_original_when_no_angles(tmp_path):
9 | html = "hello
\n"
10 | template_path = tmp_path / "plain.html"
11 | template_path.write_text(html, encoding="utf-8")
12 |
13 | engine = Engine()
14 | loader = Loader(engine=engine)
15 | origin = SimpleNamespace(name=str(template_path))
16 |
17 | actual = loader.get_contents(origin)
18 |
19 | assert actual == html
20 |
21 |
22 | def test_get_contents_converts_when_angles_present(tmp_path):
23 | expected = "{% debug %}"
24 |
25 | template_path = tmp_path / "has_angles.html"
26 | html = "...
9 | ```
10 |
11 | ```html
12 | {% if True %}...
{% endif %}
13 | ```
14 |
15 | ## [`elif`](https://docs.djangoproject.com/en/stable/ref/templates/builtins/#if)
16 |
17 | ```html
18 |
19 | if
20 |
21 |
22 | elif
23 |
24 | ```
25 |
26 | ```html
27 | {% if some_list.0 %}
28 |
29 | if
30 |
31 | {% elif some_list.1 %}
32 |
33 | elif
34 |
35 | {% endif %}
36 | ```
37 |
38 | ## [`else`](https://docs.djangoproject.com/en/stable/ref/templates/builtins/#if)
39 |
40 | ```html
41 |
42 | if
43 |
44 |
45 | elif
46 |
47 |
48 | else
49 |
50 | ```
51 |
52 | ```html
53 | {% if some_variable == 1 %}
54 |
55 | if
56 |
57 | {% elif some_variable == 2 %}
58 |
59 | elif
60 |
61 | {% else %}
62 |
63 | else
64 |
65 | {% endif %}
66 | ```
--------------------------------------------------------------------------------
/src/dj_angles/middleware.py:
--------------------------------------------------------------------------------
1 | class RequestMethodMiddleware:
2 | """Adds the request method as boolean properties to the request object."""
3 |
4 | def __init__(self, get_response):
5 | self.get_response = get_response
6 |
7 | def __call__(self, request):
8 | request.is_post = request.method == "POST"
9 | request.is_get = request.method == "GET"
10 | request.is_patch = request.method == "PATCH"
11 | request.is_head = request.method == "HEAD"
12 | request.is_put = request.method == "PUT"
13 | request.is_delete = request.method == "DELETE"
14 | request.is_connect = request.method == "CONNECT"
15 | request.is_trace = request.method == "TRACE"
16 |
17 | response = self.get_response(request)
18 |
19 | return response
20 |
21 |
22 | class RequestAJAXMiddleware:
23 | """Adds whether the request is AJAX as a boolean property to the request object."""
24 |
25 | def __init__(self, get_response):
26 | self.get_response = get_response
27 |
28 | def __call__(self, request):
29 | request.is_ajax = request.META.get("HTTP_X_REQUESTED_WITH") == "XMLHttpRequest"
30 |
31 | response = self.get_response(request)
32 |
33 | return response
34 |
--------------------------------------------------------------------------------
/tests/dj_angles/mappers/django/test_map_extends.py:
--------------------------------------------------------------------------------
1 | import pytest
2 |
3 | from dj_angles.exceptions import MissingAttributeError
4 | from dj_angles.mappers.django import map_extends
5 | from tests.dj_angles.tags import create_tag
6 |
7 |
8 | def test_string():
9 | expected = "{% extends 'base.html' %}"
10 |
11 | html = "16 | dj-angles </> 17 |
18 |19 | https://github.com/adamghill/dj-angles 20 |
21 | 29 |