Add TimeZoneMixin

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Upcoming
+
+* Add `TimeZoneMixin` for custom `User` models.
+
 ## v14.0.0
 
 * Clarify error message when your old and new passwords match, you will need to update translations.

manage.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "user_management.tests.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

user_management/models/mixins.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.contrib.auth.models import BaseUserManager
 from django.contrib.auth.tokens import default_token_generator
 from django.contrib.sites.models import Site
@@ -55,6 +56,13 @@ class Meta:
         abstract = True
 
 
+class TimeZoneMixin(models.Model):
+    timezone = models.CharField(max_length=255, default=settings.TIME_ZONE)
+
+    class Meta:
+        abstract = True
+
+
 class EmailUserMixin(models.Model):
     email = models.EmailField(
         verbose_name=_('Email address'),

user_management/models/tests/models.py

@@ -11,20 +11,23 @@
     EmailVerifyUserMixin,
     IsStaffUserMixin,
     NameUserMethodsMixin,
+    TimeZoneMixin,
     VerifyEmailMixin,
 )
 
 
-class User(AvatarMixin, VerifyEmailMixin, PermissionsMixin, AbstractBaseUser):
-    pass
+class User(
+        AvatarMixin, TimeZoneMixin, VerifyEmailMixin, PermissionsMixin,
+        AbstractBaseUser):
+    """A User model using all the custom mixins."""
 
 
 class BasicUser(BasicUserFieldsMixin, AbstractBaseUser):
-    pass
+    """A User model using just the BasicUserFieldsMixin."""
 
 
 class VerifyEmailUser(VerifyEmailMixin, AbstractBaseUser):
-    pass
+    """A User model using just the VerifyEmailMixin."""
 
 
 class CustomVerifyEmailUser(VerifyEmailMixin, AbstractBaseUser):
@@ -35,6 +38,12 @@ class CustomVerifyEmailUser(VerifyEmailMixin, AbstractBaseUser):
 class CustomBasicUserFieldsMixin(
         NameUserMethodsMixin, EmailUserMixin, DateJoinedUserMixin,
         IsStaffUserMixin):
+    """
+    A replacement for BasicUserFieldsMixin with a custom name field.
+
+    Uses NameUserMethodsMixin instead of NameUserMixin.
+    """
+
     name = models.TextField()
 
     USERNAME_FIELD = 'email'
@@ -46,4 +55,4 @@ class Meta:
 class CustomNameUser(
         AvatarMixin, EmailVerifyUserMixin, CustomBasicUserFieldsMixin,
         AbstractBaseUser):
-    pass
+    """A User model using the CustomBasicUserFieldsMixin."""

user_management/models/tests/test_models.py

@@ -48,6 +48,7 @@ def test_fields(self):
             'last_login',
             'password',
             'avatar',
+            'timezone',
 
             # Incoming
             'groups',  # Django permission groups

user_management/tests/settings.py

@@ -0,0 +1,35 @@
+SECRET_KEY = 'not-for-production'
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+INSTALLED_APPS = (
+    # Put contenttypes before auth to work around test issue.
+    # See: https://code.djangoproject.com/ticket/10827#comment:12
+    'django.contrib.sites',
+    'django.contrib.contenttypes',
+    'django.contrib.auth',
+    'django.contrib.sessions',
+    'django.contrib.admin',
+
+    'rest_framework.authtoken',
+
+    # Added for templates
+    'user_management.api',
+    'user_management.models.tests',
+)
+
+AUTH_USER_MODEL = 'tests.User'
+
+MIDDLEWARE_CLASSES = ()
+
+LANGUAGE_CODE = 'en-us'
+TIME_ZONE = 'UTC'
+USE_I18N = True
+USE_L10N = True
+USE_TZ = True
+
+MIGRATION_MODULES = {
+    'api': 'user_management.tests.testmigrations.api',
+    'tests': 'user_management.tests.testmigrations.tests',
+}

user_management/tests/testmigrations/tests/0002_user_timezone.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tests', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='user',
+            name='timezone',
+            field=models.CharField(default='UTC', max_length=255),
+        ),
+    ]