Resolve strftime type compatibility issue with jdatetime version 5 (#80)

* Resolve strftime type compatibility issue with jdatetime version 5

* Add tests app

* Add test runner file

* Add tests for template tags

* Add "Review" workflow

* Remove pip caching from "Review" workflow to resolve workflow run issue

* Add quotations to matrix versions in "Review" workflow

* Remove Python 3.12 version from "Review" workflow matrix due to "distutils" package issue

* Refactor "to_jalali" template tag tests

Author: aminvsf

.github/workflows/Review.yml

@@ -0,0 +1,45 @@
+name: Review
+on:
+  pull_request:
+    branches:
+      - master
+      - main
+  push:
+    branches:
+      - master
+      - main
+jobs:
+  unit-test:
+    strategy:
+      matrix:
+        python-version: [ "3.8", "3.9", "3.10", "3.11" ]
+        django-version: [ "2.2.*", "3.2.*", "4.2.*", "5.0.*" ]
+        jdatetime-version: [ "3.8.*", "4.1.*", "5.0.*" ]
+        exclude:
+          # Django 5 does not support Python 3.8 and 3.9.
+          - django-version: "5.0.*"
+            python-version: "3.8"
+          - django-version: "5.0.*"
+            python-version: "3.9"
+          # Django 3 does not support Python 3.11.
+          - django-version: "3.2.*"
+            python-version: "3.11"
+          # Django 2 does not support Python 3.10 and 3.11.
+          - django-version: "2.2.*"
+            python-version: "3.10"
+          - django-version: "2.2.*"
+            python-version: "3.11"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Django ${{ matrix.django-version }}
+        run: pip install django==${{ matrix.django-version }}
+      - name: Install Jdatetime ${{ matrix.jdatetime-version }}
+        run: pip install jdatetime==${{ matrix.jdatetime-version }}
+      - name: Run unit tests
+        run: python runtests.py

jalali_date/templatetags/jalali_tags.py

@@ -27,15 +27,25 @@ def contents(self):
 		return self.value
 
 
+def normalize_strftime(strftime):
+	"""
+	Normalize strftime values to make sure their usable for datetime libraries.
+	"""
+	if not isinstance(strftime, str):
+		# Convert non-str values to str to support stuff like "lazy_translations".
+		strftime = str(strftime)
+	return strftime
+
+
 @register.filter
 def to_jalali(g_date, strftime=None):
 	if g_date is None:
 		return '-'
 	elif isinstance(g_date, datetime):
-		strftime = strftime if strftime else DEFAULTS['Strftime']['datetime']
+		strftime = normalize_strftime(strftime if strftime else DEFAULTS['Strftime']['datetime'])
 		return datetime2jalali(g_date).strftime(strftime)
 	elif isinstance(g_date, date):
-		strftime = strftime if strftime else DEFAULTS['Strftime']['date']
+		strftime = normalize_strftime(strftime if strftime else DEFAULTS['Strftime']['date'])
 		return date2jalali(g_date).strftime(strftime)
 	return '-'
 
@@ -55,10 +65,10 @@ def jalali_admin_safe_readonly(readonly_field, strftime=None):
 
 	field = getattr(instance, field_name)
 	if isinstance(field, datetime):
-		strftime = strftime if strftime else DEFAULTS['Strftime']['datetime']
+		strftime = normalize_strftime(strftime if strftime else DEFAULTS['Strftime']['datetime'])
 		return ObjectContents(datetime2jalali(field).strftime(strftime))
 	elif isinstance(field, date):
-		strftime = strftime if strftime else DEFAULTS['Strftime']['date']
+		strftime = normalize_strftime(strftime if strftime else DEFAULTS['Strftime']['date'])
 		return ObjectContents(date2jalali(field).strftime(strftime))
 	elif field is None:
 		return ObjectContents('-')
@@ -68,5 +78,5 @@ def jalali_admin_safe_readonly(readonly_field, strftime=None):
 
 @register.simple_tag
 def jalali_now(strftime=None):
-	strftime = strftime if strftime else DEFAULTS['Strftime']['datetime']
+	strftime = normalize_strftime(strftime if strftime else DEFAULTS['Strftime']['datetime'])
 	return datetime2jalali(datetime.now()).strftime(strftime)

runtests.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+import os
+import sys
+
+import django
+from django.conf import settings
+from django.test.utils import get_runner
+
+if __name__ == "__main__":
+	os.environ["DJANGO_SETTINGS_MODULE"] = "tests.test_settings"
+	django.setup()
+	TestRunner = get_runner(settings)
+	test_runner = TestRunner()
+	failures = test_runner.run_tests(["tests"])
+	sys.exit(bool(failures))

tests/__init__.py

@@ -0,0 +1,5 @@
+SECRET_KEY = "fake-secret-key"
+
+INSTALLED_APPS = [
+	"tests",
+]

tests/test_settings.py

@@ -0,0 +1,88 @@
+from datetime import datetime, date
+from unittest.mock import Mock
+
+from django.conf import settings
+from django.test import SimpleTestCase
+from django.utils.translation import gettext_lazy
+
+from jalali_date.templatetags.jalali_tags import jalali_admin_safe_readonly
+
+
+class TestJalaliAdminSafeReadonlyTemplateTag(SimpleTestCase):
+	"""
+	Tests for `jalali_admin_safe_readonly` template tag
+	"""
+
+	FAKE_DATETIME = datetime(year=2012, month=4, day=17, hour=10, minute=51, second=36)
+	FAKE_DATETIME_JALALI = datetime(year=1391, month=1, day=29, hour=10, minute=51, second=36)
+
+	FAKE_DATE = date(year=2012, month=4, day=17)
+	FAKE_DATE_JALALI = date(year=1391, month=1, day=29)
+
+	@property
+	def default_date_format(self):
+		return settings.JALALI_DATE_DEFAULTS["Strftime"]["date"]
+
+	@property
+	def default_datetime_format(self):
+		return settings.JALALI_DATE_DEFAULTS["Strftime"]["datetime"]
+
+	@staticmethod
+	def create_readonly_field(field_value=None):
+		"""
+		A helper method which creates a mock readonly field.
+		"""
+		instance = Mock()
+		instance.some_field = field_value
+		form = Mock()
+		form.instance = instance
+		readonly_field = Mock()
+		readonly_field.form = form
+		readonly_field.field = {"field": "some_field"}
+		return readonly_field
+
+	def test_instance_missing_field(self):
+		readonly_field = self.create_readonly_field()
+		readonly_field.field = {"field": "missing_field"}
+		self.assertEqual(jalali_admin_safe_readonly(readonly_field), readonly_field)
+
+	def test_with_datetime(self):
+		readonly_field = self.create_readonly_field(self.FAKE_DATETIME)
+		self.assertEqual(
+			jalali_admin_safe_readonly(readonly_field).value,
+			self.FAKE_DATETIME_JALALI.strftime(self.default_datetime_format),
+		)
+
+	def test_with_custom_strftime_datetime(self):
+		readonly_field = self.create_readonly_field(self.FAKE_DATETIME)
+		custom_strftime = "%H.%M.%S | %Y-%m-%d"
+		self.assertEqual(
+			jalali_admin_safe_readonly(readonly_field=readonly_field, strftime=custom_strftime).value,
+			self.FAKE_DATETIME_JALALI.strftime(custom_strftime),
+		)
+
+	def test_with_date(self):
+		readonly_field = self.create_readonly_field(self.FAKE_DATE)
+		self.assertEqual(
+			jalali_admin_safe_readonly(readonly_field).value,
+			self.FAKE_DATE_JALALI.strftime(self.default_date_format),
+		)
+
+	def test_with_custom_strftime_date(self):
+		readonly_field = self.create_readonly_field(self.FAKE_DATE)
+		custom_strftime = "%Y-%m-%d"
+		self.assertEqual(
+			jalali_admin_safe_readonly(readonly_field=readonly_field, strftime=custom_strftime).value,
+			self.FAKE_DATE_JALALI.strftime(custom_strftime),
+		)
+
+	def test_error_prevention_with_lazy_translatable_strftime(self):
+		"""
+		Ensure that using lazy translatable strings as strftime will not raise an error. (#78)
+		"""
+		readonly_field = self.create_readonly_field(self.FAKE_DATETIME)
+		custom_strftime = gettext_lazy("%H.%M.%S | %Y-%m-%d")
+		self.assertEqual(
+			jalali_admin_safe_readonly(readonly_field=readonly_field, strftime=custom_strftime).value,
+			self.FAKE_DATETIME_JALALI.strftime(str(custom_strftime)),
+		)

tests/tests/__init__.py

@@ -0,0 +1,50 @@
+from datetime import datetime
+from unittest.mock import patch, Mock
+
+from django.conf import settings
+from django.test import SimpleTestCase
+from django.utils.translation import gettext_lazy
+
+from jalali_date.templatetags.jalali_tags import jalali_now
+
+
+class TestJalaliNowTemplateTag(SimpleTestCase):
+	"""
+	Tests for `jalali_now` template tag
+	"""
+
+	FAKE_NOW_DATETIME = datetime(year=2012, month=4, day=17, hour=10, minute=51, second=36)
+	FAKE_NOW_DATETIME_JALALI = datetime(year=1391, month=1, day=29, hour=10, minute=51, second=36)
+
+	@property
+	def default_datetime_format(self):
+		return settings.JALALI_DATE_DEFAULTS["Strftime"]["datetime"]
+
+	@patch("jalali_date.templatetags.jalali_tags.datetime")
+	def test_default_strftime(self, patched_datetime: Mock):
+		patched_datetime.now.return_value = self.FAKE_NOW_DATETIME
+		self.assertEqual(
+			jalali_now(),
+			self.FAKE_NOW_DATETIME_JALALI.strftime(self.default_datetime_format),
+		)
+
+	@patch("jalali_date.templatetags.jalali_tags.datetime")
+	def test_custom_strftime(self, patched_datetime: Mock):
+		patched_datetime.now.return_value = self.FAKE_NOW_DATETIME
+		custom_strftime = "%H.%M.%S | %Y-%m-%d"
+		self.assertEqual(
+			jalali_now(strftime=custom_strftime),
+			self.FAKE_NOW_DATETIME_JALALI.strftime(custom_strftime),
+		)
+
+	@patch("jalali_date.templatetags.jalali_tags.datetime")
+	def test_error_prevention_with_lazy_translatable_strftime(self, patched_datetime: Mock):
+		"""
+		Ensure that using lazy translatable strings as strftime will not raise an error. (#78)
+		"""
+		patched_datetime.now.return_value = self.FAKE_NOW_DATETIME
+		custom_strftime = gettext_lazy("%Y-%m-%d")
+		self.assertEqual(
+			jalali_now(strftime=custom_strftime),
+			self.FAKE_NOW_DATETIME_JALALI.strftime(str(custom_strftime)),
+		)

tests/tests/templatetags/__init__.py

@@ -0,0 +1,70 @@
+from datetime import datetime, date
+
+from django.conf import settings
+from django.test import SimpleTestCase
+from django.utils.translation import gettext_lazy
+
+from jalali_date.templatetags.jalali_tags import to_jalali
+
+
+class TestToJalaliTemplateTag(SimpleTestCase):
+	"""
+	Tests for `to_jalali` template tag
+	"""
+
+	FAKE_DATE = date(year=2012, month=4, day=17)
+	FAKE_DATE_JALALI = date(year=1391, month=1, day=29)
+
+	FAKE_DATETIME = datetime(year=2012, month=4, day=17, hour=10, minute=51, second=36)
+	FAKE_DATETIME_JALALI = datetime(year=1391, month=1, day=29, hour=10, minute=51, second=36)
+
+	@property
+	def default_date_format(self):
+		return settings.JALALI_DATE_DEFAULTS["Strftime"]["date"]
+
+	@property
+	def default_datetime_format(self):
+		return settings.JALALI_DATE_DEFAULTS["Strftime"]["datetime"]
+
+	def test_none_g_date(self):
+		self.assertEqual(to_jalali(g_date=None), "-")
+
+	def test_invalid_type_g_date(self):
+		self.assertEqual(to_jalali(g_date=123), "-")
+		self.assertEqual(to_jalali(g_date="test-str"), "-")
+
+	def test_date_conversion(self):
+		self.assertEqual(
+			to_jalali(self.FAKE_DATE),
+			self.FAKE_DATE_JALALI.strftime(self.default_date_format),
+		)
+
+	def test_date_conversion_with_custom_strftime(self):
+		custom_strftime = "%Y-%m-%d"
+		self.assertEqual(
+			to_jalali(g_date=self.FAKE_DATE, strftime=custom_strftime),
+			self.FAKE_DATE_JALALI.strftime(custom_strftime),
+		)
+
+	def test_datetime_conversion(self):
+		self.assertEqual(
+			to_jalali(self.FAKE_DATETIME),
+			self.FAKE_DATETIME_JALALI.strftime(self.default_datetime_format),
+		)
+
+	def test_datetime_conversion_with_custom_strftime(self):
+		custom_strftime = "%H.%M.%S | %Y-%m-%d"
+		self.assertEqual(
+			to_jalali(g_date=self.FAKE_DATETIME, strftime=custom_strftime),
+			self.FAKE_DATETIME_JALALI.strftime(custom_strftime),
+		)
+
+	def test_error_prevention_with_lazy_translatable_strftime(self):
+		"""
+		Ensure that using lazy translatable strings as strftime will not raise an error. (#78)
+		"""
+		custom_strftime = gettext_lazy("%Y-%m-%d")
+		self.assertEqual(
+			to_jalali(g_date=self.FAKE_DATE, strftime=custom_strftime),
+			self.FAKE_DATE_JALALI.strftime(str(custom_strftime)),
+		)