Merge pull request #6 from elasticsales/feature-lower-fields

LowerStringField and LowerEmailField

Author: rozza

.gitignore

@@ -1 +1,2 @@
 *.pyc
+venv/

fields/fields.py

@@ -1,5 +1,6 @@
 from datetime import timedelta
 from mongoengine.base import BaseField
+from mongoengine.fields import StringField, EmailField
 
 import os
 import datetime
@@ -18,7 +19,7 @@ class TimedeltaField(BaseField):
 
     Looks to the outside world like a datatime.timedelta, but stores
     in the database as an integer (or float) number of seconds.
-    
+
     """
     def validate(self, value):
         if not isinstance(value, (timedelta, int, float)):
@@ -53,11 +54,11 @@ def total_seconds(value):
 
 
 class LocalStorageFileField(BaseField):
-    
+
     proxy_class = FieldFile
 
     def __init__(self,
-                 db_alias=DEFAULT_CONNECTION_NAME, 
+                 db_alias=DEFAULT_CONNECTION_NAME,
                  name=None,
                  upload_to='',
                  storage=None,
@@ -93,7 +94,7 @@ def __get__(self, instance, owner):
             file.instance = instance
             file.field = self
             file.storage = self.storage
- 
+
         return instance._data[self.name]
 
 
@@ -122,11 +123,33 @@ def to_mongo(self, value):
             value.save(value.name, value)
             return value.path
 
-        return value.name    
+        return value.name
 
 
     def to_python(self, value):
         eu = self
         return eu.proxy_class(eu.owner_document, eu, value)
 
 
+class LowerStringField(StringField):
+    def __set__(self, instance, value):
+        value = self.to_python(value)
+        return super(LowerStringField, self).__set__(instance, value)
+
+    def to_python(self, value):
+        if value:
+            value = value.lower()
+        return value
+
+    def prepare_query_value(self, op, value):
+        value = value.lower() if value else value
+        return super(LowerStringField, self).prepare_query_value(op, value)
+
+
+class LowerEmailField(LowerStringField):
+
+    def validate(self, value):
+        if not EmailField.EMAIL_REGEX.match(value):
+            self.error('Invalid Mail-address: %s' % value)
+        super(LowerEmailField, self).validate(value)
+

fields/test_fields.py

@@ -1,6 +1,16 @@
 import unittest2 as unittest
 from datetime import timedelta
-from fields import TimedeltaField
+from mongoengine import Document, NotUniqueError, ValidationError, connect
+from mongoengine.connection import get_db
+
+from django.conf import settings
+settings.configure(
+    USE_TZ=True,
+    INSTALLED_APPS=[]
+)
+
+from fields import TimedeltaField, LowerStringField, LowerEmailField
+
 
 class OldStyleTimedelta(timedelta):
     "Used for backwards compatibility testing"
@@ -22,5 +32,43 @@ def test_total_seconds_26(self):
         value = OldStyleTimedelta(minutes=1, seconds=10)
         self.assertEqual(self.field.total_seconds(value), 70)
 
+class LowerStringFieldTestCase(unittest.TestCase):
+
+    def setUp(self):
+        connect(db='extrasmongoenginetest')
+        self.db = get_db()
+
+    def tearDown(self):
+        for collection in self.db.collection_names():
+            if 'system.' in collection:
+                continue
+            self.db.drop_collection(collection)
+
+    def test_case_insensitive_querying(self):
+        class BlogPost(Document):
+            slug = LowerStringField()
+
+        BlogPost.objects.create(slug='whatever')
+        self.assertEqual(BlogPost.objects.get(slug='WHATEVER').slug, 'whatever')
+
+    def test_case_insensitive_uniqueness(self):
+        class User(Document):
+            username = LowerStringField(unique=True)
+
+        User.objects.create(username='whatever')
+        dupe = User(username='WHATEVER')
+        self.assertRaises(NotUniqueError, dupe.save)
+
+    def test_lower_email_validation(self):
+        class User(Document):
+            email = LowerEmailField()
+
+        u = User.objects.create(email='[email protected]')
+        self.assertEqual(User.objects.get(email='[email protected]'), u)
+
+        u2 = User(email='whatever')
+        self.assertRaises(ValidationError, u2.save)
+
+
 if __name__ == '__main__':
     unittest.main()

requirements.txt

@@ -0,0 +1,3 @@
+unittest2
+django
+mongoengine