0 5 3 sam (#81)

LegoStormtroopr · liutuo368 · web-flow · commit 70f00f381a74 · 2025-02-25T14:52:18.000+11:00
* Added support for django 4.2

* more upgrades

* update github python

* linting

* fix customfield for 4.2 changes

* add extra html fallback test

* lint

* fix deps versions

* Remove trace debug code

---------

Co-authored-by: Tuo Liu &lt;tuo.liu@aristotlemetadata.com&gt;
diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
@@ -9,5 +9,5 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
       - uses: psf/black@stable
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -43,7 +43,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.12
 
       - name: Install test tools
         run: pip install tox coverage
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,3 +2,5 @@
 
 ## 0.5.1
   - Added support for django 4.1
+## 0.5.3
+  - Added support for django 4.2
diff --git a/dev/Dockerfile b/dev/Dockerfile
@@ -1,4 +1,4 @@
-FROM python:3.8-buster
+FROM python:3.12
 
 # Install python package management tools
 RUN pip install --upgrade setuptools pip poetry tox
diff --git a/dev/README.md b/dev/README.md
@@ -28,3 +28,7 @@
 * Reformat the file using black command:
 
     Run `black .` at the root directory of the project
+
+* Testing against a specific database:
+
+    DATABASE_URL=postgres://postgres:changeme@postgres_db/postgres tox -e dj-51
diff --git a/dev/pg/Dockerfile b/dev/pg/Dockerfile
@@ -1,2 +1,2 @@
-FROM postgres:10
+FROM postgres:13
 COPY install-extensions.sql /docker-entrypoint-initdb.d
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-garnett"
-version = "0.5.2"
+version = "0.5.3"
 description = "Simple translatable Django fields"
 authors = ["Aristotle Metadata Enterprises"]
 license = "BSD-3-Clause"
@@ -10,8 +10,8 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.7"
-django = ">3.1, <4.2"
+python = "^3.12"
+django = ">=4.1"
 langcodes = "~3.3.0"
 language-data = "~1.0.1"
 
@@ -21,10 +21,10 @@ coverage = "~5.3.1"
 dj-database-url = "~0.5.0"
 psycopg2 = "~2.8.6"
 mock = "~4.0.3"
-djangorestframework = "~3.12.4"
-drf_yasg = "~1.20.0"
-django-reversion = ">=4.0.1"
-django-reversion-compare = ">=0.14.1"
+djangorestframework = "~3.15"
+drf_yasg = ">=1.20.0"
+django-reversion = ">=5.1.0"
+django-reversion-compare = ">=0.18.1"
 django-filter = ">=21.1"
 
 [build-system]
diff --git a/runtime.txt b/runtime.txt
@@ -1 +1 @@
-python-3.8.10
+python-3.10.12
diff --git a/tests/library_app/models.py b/tests/library_app/models.py
@@ -13,36 +13,36 @@
 
 
 class CustomTestingField(models.TextField):
-    def get_db_prep_save(self, value, connection):
+    def get_db_prep_value(self, value, connection, prepared=False):
         """
         Note: If there is data migration when migrating to TranslatedField, the manually added
          step_1_safe_encode_content() function in the migration file will base64 encode the value in the field
-         before get_db_prep_save is called.
+         before get_db_prep_value is called.
 
          For example:
             old value = "this is a book"
             new value = '{"en": "dGhpcyBpcyBhIGJvb2s="}'
 
-        The new value is then parse to the get_db_prep_save() function.
-        If custom get_db_prep_save() function is used you will need to make sure that the custom get_db_prep_save() function is
+        The new value is then parse to the get_db_prep_value() function.
+        If custom get_db_prep_value() function is used you will need to make sure that the custom get_db_prep_value() function is
         not modifying the input value.
 
         Some examples,
-            1. if the custom get_db_prep_save() function append a fix str to all input value:
+            1. if the custom get_db_prep_value() function append a fix str to all input value:
                     input value = '{"en": "dGhpcyBpcyBhIGJvb2s="}'
                     return value = '{"en": "dGhpcyBpcyBhIGJvb2s="}1234567'
                this would raise "django.db.utils.DataError: invalid input syntax for type json" because the return value
-               from the custom get_db_prep_save() function is not valid json
+               from the custom get_db_prep_value() function is not valid json
 
-            2. if the custom get_db_prep_save() function bleach certain substring (e.g dGhpcy) on the input value:
+            2. if the custom get_db_prep_value() function bleach certain substring (e.g dGhpcy) on the input value:
                     input value = '{"en": "dGhpcyBpcyBhIGJvb2s="}'
                     return value = '{"en": "BpcyBhIGJvb2s="}'
                this would modify the base64 value and decoding the modfied base64 value would return unexpected result
         """
         if value is None:
-            return super().get_db_prep_save(value, connection)
+            return super().get_db_prep_value(value, connection, prepared)
         bleached_value = value.replace(BLEACH_STR, RANDOM_STR)
-        return super().get_db_prep_save(bleached_value, connection)
+        return super().get_db_prep_value(bleached_value, connection, prepared)
 
 
 def validate_length(value):
diff --git a/tests/library_app/urls.py b/tests/library_app/urls.py
@@ -13,6 +13,7 @@
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+
 from django.contrib import admin
 from django.urls import path, include
 from library_app import views
diff --git a/tests/tests/test_html.py b/tests/tests/test_html.py
@@ -0,0 +1,45 @@
+from django.db import models
+from django.test import TestCase
+
+from garnett.expressions import L, LangF
+from garnett.context import set_field_language
+from garnett.fields import TranslatedField
+from library_app.models import Book, RANDOM_STR, BLEACH_STR
+
+book_data = dict(
+    title={
+        "en": "A good book",
+        "de": "Eine gut buch",
+    },
+    author="I. M. Nice",
+    description={
+        "en": "A book on how to be good, and stuff",
+        "fr": "Un livre sur la façon d'être bon, et tout",
+    },
+    category={"dewey": 222},
+    number_of_pages=100,
+)
+
+
+class TestHTMLRender(TestCase):
+    def setUp(self):
+        with set_field_language("en"):
+            self.book = Book(**book_data)
+            self.book.save()
+
+        # Need this to prevent data persisting across tests
+        self.book = Book.objects.get(pk=self.book.pk)
+
+    def test_field_html_render(self):
+        with set_field_language("en"):
+            self.assertTrue("[en]" not in self.book.title.__html__())
+            self.assertEqual(self.book.title.__html__(), self.book.title)
+
+        with set_field_language("de"):
+            self.assertTrue("[de]" not in self.book.title.__html__())
+            self.assertEqual(self.book.title.__html__(), self.book.title)
+
+        with set_field_language("fr"):
+            tag = self.book.title.fallback_language.to_tag()
+            self.assertTrue(f"[{tag}]" in self.book.title.__html__())
+            self.assertTrue(self.book.title_tsall[tag] in self.book.title.__html__())
diff --git a/tox.ini b/tox.ini
@@ -2,25 +2,26 @@
 toxworkdir=/tmp/tox
 skipsdist = True
 envlist =
-    dj-{31,32,40,41} #-db-{pg,sqlite,maria}
+    dj-{42,50,51} #-db-{pg,sqlite,maria}
 
 [testenv]
 passenv =
     DATABASE_URL
 
 setenv =
     DJANGO_SETTINGS_MODULE = library_app.settings
-    dj-31: DJANGO_VERSION="~=3.1.0"
-    dj-31: DJANGO_REVERSION_VERSION="~=4.0.1"
-    dj-31: DJANGO_REVERSION_COMPARE_VERSION="~=0.14.1"
 
-    dj-32: DJANGO_VERSION="~=3.2.0"
-    dj-32: DJANGO_REVERSION_VERSION=">4.0.1"
-    dj-32: DJANGO_REVERSION_COMPARE_VERSION=">0.14.1"
+    dj-42: DJANGO_VERSION="==4.2.0"
+    dj-42: DJANGO_REVERSION_VERSION=">=5.1"
+    dj-42: DJANGO_REVERSION_COMPARE_VERSION=">=0.18.1"
 
-    dj-40: DJANGO_VERSION="~=4.0.0"
-    dj-40: DJANGO_REVERSION_VERSION=">4.0.1"
-    dj-40: DJANGO_REVERSION_COMPARE_VERSION=">0.14.1"
+    dj-50: DJANGO_VERSION="~=5.0.0"
+    dj-50: DJANGO_REVERSION_VERSION=">=5.1"
+    dj-50: DJANGO_REVERSION_COMPARE_VERSION=">=0.18.1"
+
+    dj-51: DJANGO_VERSION="~=5.1.0"
+    dj-51: DJANGO_REVERSION_VERSION=">=5.1"
+    dj-51: DJANGO_REVERSION_COMPARE_VERSION=">=0.18.1"
 
 deps =
     -e .
@@ -31,8 +32,8 @@ deps =
 
     # From poetry
     dj-database-url~=0.5.0
-    djangorestframework~=3.12.4
-    drf_yasg~=1.20.0
+    djangorestframework~=3.15
+    drf_yasg>=1.20.0
     django-filter>=21.1
     mock~=4.0.3
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM python:3.8-buster`
	`1`	`+FROM python:3.12`
`2`	`2`
`3`	`3`	`# Install python package management tools`
`4`	`4`	`RUN pip install --upgrade setuptools pip poetry tox`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-FROM postgres:10`
	`1`	`+FROM postgres:13`
`2`	`2`	`COPY install-extensions.sql /docker-entrypoint-initdb.d`