Django 2.0 compat

Author: nicholasserra

Diff for: .gitignore

@@ -1,3 +1,5 @@
 *.pyc
 .coverage
 htmlcov/
+venv
+.python-version

Diff for: requirements.txt

@@ -1,2 +1 @@
-Django>=1.4
 coverage

Diff for: runtests.py

@@ -1,20 +1,26 @@
 #!/usr/bin/env python
+import logging
 import sys
 
 import django
 
 from django.conf import settings
 from django.core.management import execute_from_command_line
 
+from tos.compat import get_middleware_settings_key
+
+
+middleware_settings_key = get_middleware_settings_key()
+
 
 if not settings.configured:
-    settings.configure(
-        DATABASES={
+    django_settings = {
+        'DATABASES': {
             'default': {
                 'ENGINE': 'django.db.backends.sqlite3',
             }
         },
-        INSTALLED_APPS=[
+        'INSTALLED_APPS': [
             'django.contrib.auth',
             'django.contrib.contenttypes',
             'django.contrib.sessions',
@@ -23,14 +29,7 @@
             'tos',
             'tos.tests'
         ],
-        MIDDLEWARE_CLASSES=[
-            'django.middleware.common.CommonMiddleware',
-            'django.contrib.sessions.middleware.SessionMiddleware',
-            'django.middleware.csrf.CsrfViewMiddleware',
-            'django.contrib.auth.middleware.AuthenticationMiddleware',
-            'django.contrib.messages.middleware.MessageMiddleware',
-        ],
-        TEMPLATES=[
+        'TEMPLATES': [
             {
                 'BACKEND': 'django.template.backends.django.DjangoTemplates',
                 'DIRS': [],
@@ -45,22 +44,45 @@
                 },
             },
         ],
-        ROOT_URLCONF='tos.tests.test_urls',
-        LOGIN_URL='/login/',
-        SITE_ID='1',
-        CACHES = {
+        'ROOT_URLCONF': 'tos.tests.test_urls',
+        'LOGIN_URL': '/login/',
+        'SITE_ID': '1',
+        'CACHES': {
             'default': {
                 'BACKEND': 'django.core.cache.backends.dummy.DummyCache',
             },
             'tos': {
                 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
             }
         },
-        TOS_CACHE_NAME = 'tos' 
-    )
+        'TOS_CACHE_NAME': 'tos' 
+    }
+
+    if django.VERSION >= (1, 10, 0):
+        django_settings[middleware_settings_key] = [
+            'django.middleware.security.SecurityMiddleware',
+            'django.contrib.sessions.middleware.SessionMiddleware',
+            'django.middleware.common.CommonMiddleware',
+            'django.middleware.csrf.CsrfViewMiddleware',
+            'django.contrib.auth.middleware.AuthenticationMiddleware',
+            'django.contrib.messages.middleware.MessageMiddleware',
+            'django.middleware.clickjacking.XFrameOptionsMiddleware',
+        ]
+    else:
+        django_settings[middleware_settings_key] = [
+            'django.middleware.security.SecurityMiddleware',
+            'django.contrib.sessions.middleware.SessionMiddleware',
+            'django.middleware.common.CommonMiddleware',
+            'django.middleware.csrf.CsrfViewMiddleware',
+            'django.contrib.auth.middleware.AuthenticationMiddleware',
+            'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+            'django.contrib.messages.middleware.MessageMiddleware',
+            'django.middleware.clickjacking.XFrameOptionsMiddleware',
+        ]
+
+    settings.configure(**django_settings)
 
 
-import logging
 logging.basicConfig(
     level = logging.DEBUG,
     format = '%(asctime)s %(levelname)s %(message)s',

Diff for: tos/apps.py

@@ -4,7 +4,11 @@
 
 from .signal_handlers import invalidate_cached_agreements
 
-MIDDLEWARES = getattr(settings, 'MIDDLEWARE_CLASSES', [])
+from .compat import get_middleware_settings_key
+
+
+middleware_settings_key = get_middleware_settings_key()
+MIDDLEWARES = getattr(settings, middleware_settings_key, [])
 
 
 class TOSConfig(AppConfig):

Diff for: tos/compat.py

@@ -1,5 +1,6 @@
 import django
 from django.conf import settings
+from django.utils import deprecation
 
 
 def patterns(mod, *urls):
@@ -50,7 +51,26 @@ def get_cache(cache_name):
         return get_cache(cache_name)
 
 
+def get_middleware_mixin():
+    if django.VERSION >= (1, 10, 0):
+        return deprecation.MiddlewareMixin
+    else:
+        return object
+
+
+def get_middleware_settings_key():
+    if django.VERSION >= (1, 10, 0):
+        return 'MIDDLEWARE'
+    else:
+        return 'MIDDLEWARE_CLASSES'
+
+
 if django.VERSION < (1, 5):
     from django.templatetags.future import url
 else:
     from django.template.defaulttags import url
+
+if django.VERSION >= (1, 10, 0):
+    from django.urls import reverse
+else:
+    from django.core.urlresolvers import reverse

Diff for: tos/middleware.py

@@ -1,25 +1,18 @@
-from django import VERSION as DJANGO_VERSION
 from django.conf import settings
 from django.contrib.auth import SESSION_KEY as session_key
 from django.contrib.auth import REDIRECT_FIELD_NAME
 from django.http import HttpResponseRedirect
-from django.utils import deprecation
 from django.utils.cache import add_never_cache_headers
 
-from .compat import get_cache
+from .compat import get_cache, get_middleware_mixin, reverse
 from .models import UserAgreement
 
-if DJANGO_VERSION >= (1, 10, 0):
-    from django.urls import reverse
-else:
-    from django.core.urlresolvers import reverse
-
 
 cache = get_cache(getattr(settings, 'TOS_CACHE_NAME', 'default'))
 tos_check_url = reverse('tos_check_tos')
+middleware_mixin = get_middleware_mixin()
 
-
-class UserAgreementMiddleware(deprecation.MiddlewareMixin if DJANGO_VERSION >= (1, 10, 0) else object):
+class UserAgreementMiddleware(middleware_mixin):
     """
     Some middleware to check if users have agreed to the latest TOS
     """

Diff for: tos/tests/test_middleware.py

@@ -1,24 +1,21 @@
-from django import VERSION as DJANGO_VERSION
 from django.conf import settings
 from django.contrib.auth import REDIRECT_FIELD_NAME
 from django.test import TestCase
-from django.test.utils import override_settings
+from django.test.utils import modify_settings
 
-from tos.compat import get_cache, get_runtime_user_model
+from tos.compat import get_cache, get_runtime_user_model, reverse
 from tos.middleware import UserAgreementMiddleware
 from tos.models import TermsOfService, UserAgreement
 from tos.signal_handlers import invalidate_cached_agreements
 
-if DJANGO_VERSION >= (1, 10, 0):
-    from django.urls import reverse
-else:
-    from django.core.urlresolvers import reverse
 
-
-@override_settings(
-    MIDDLEWARE_CLASSES=settings.MIDDLEWARE_CLASSES + [
-        'tos.middleware.UserAgreementMiddleware',
-    ]
+@modify_settings(
+    MIDDLEWARE_CLASSES={
+        'append': 'tos.middleware.UserAgreementMiddleware',
+    },
+    MIDDLEWARE={
+        'append': 'tos.middleware.UserAgreementMiddleware',
+    },
 )
 class TestMiddleware(TestCase):
 
@@ -91,10 +88,13 @@ def test_accept_after_middleware_redirects_properly(self):
         self.assertEqual(response.url.replace('http://testserver', ''), str(reverse('index')))
 
 
-@override_settings(
-    MIDDLEWARE_CLASSES=settings.MIDDLEWARE_CLASSES + [
-        'tos.middleware.UserAgreementMiddleware',
-    ]
+@modify_settings(
+    MIDDLEWARE_CLASSES={
+        'append': 'tos.middleware.UserAgreementMiddleware',
+    },
+    MIDDLEWARE={
+        'append': 'tos.middleware.UserAgreementMiddleware',
+    },
 )
 class BumpCoverage(TestCase):
 

Diff for: tos/tests/test_views.py

@@ -1,15 +1,9 @@
-from django import VERSION as DJANGO_VERSION
 from django.conf import settings
 from django.test import TestCase
 
-from tos.compat import get_runtime_user_model
+from tos.compat import get_runtime_user_model, reverse
 from tos.models import TermsOfService, UserAgreement, has_user_agreed_latest_tos
 
-if DJANGO_VERSION >= (1, 10, 0):
-    from django.urls import reverse
-else:
-    from django.core.urlresolvers import reverse
-
 
 class TestViews(TestCase):