Major refactor from djorm-ext-pgjson

Author: Andrey Antukh

CHANGES.txt

@@ -1,17 +1 @@
-Changelog
-=========
 
-Version 0.3
------------
-
-- Minor fixes.
-
-Version 0.2
------------
-
-- Fix wrong handling the default value.
-
-Version 0.1
------------
-
-- Initial version

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Andrey Antukh <niwi@niwi.be>
+Copyright (c) 2014 Andrey Antukh <niwi@niwi.be>
 
 All rights reserved.
 

README.md

@@ -0,0 +1,3 @@
+# djorm-ext-pgjson
+
+PostgreSQL json support for Django.

README.rst

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+
+import json
+import re
+import django
+
+from django.db.backends.postgresql_psycopg2.version import get_version
+from django.core.serializers.json import DjangoJSONEncoder
+from django.db import models
+from django import forms
+from django.utils import six
+
+import psycopg2
+import psycopg2.extensions
+import psycopg2.extras
+
+
+class JsonAdapter(psycopg2.extras.Json):
+    def dumps(self, obj):
+        return json.dumps(obj, cls=DjangoJSONEncoder)
+
+
+psycopg2.extensions.register_adapter(dict, JsonAdapter)
+psycopg2.extras.register_default_json(loads=json.loads)
+
+
+class JsonField(six.with_metaclass(models.SubfieldBase, models.Field)):
+    def db_type(self, connection):
+        if get_version(connection) < 90200:
+            raise RuntimeError("django_pgjson does not supports postgresql version < 9.2")
+        return "json"
+
+    def value_to_string(self, obj):
+        value = self._get_val_from_obj(obj)
+        return json.dumps(self.get_prep_value(value), cls=DjangoJSONEncoder)
+
+    def formfield(self, **kwargs):
+        defaults = {'form_class': JsonFormField}
+        defaults.update(kwargs)
+        return super(JsonField, self).formfield(**defaults)
+
+    # if django.get_version() >= '1.7':
+    #     def get_transform(self, name):
+    #         from .lookups import KeyTransformFactory
+    #         transform = super(JsonField, self).get_transform(name)
+    #         if transform:
+    #             return transform
+    #         if not re.match("field_\w+", name):
+    #             return None
+    #         _, key = name.rsplit("_", 1)
+    #         return KeyTransformFactory(key, self)
+
+
+class JsonFormField(forms.CharField):
+    widget = forms.Textarea
+
+    def prepare_value(self, value):
+        if isinstance(value, six.string_types):
+            return value
+        return json.dumps(value, cls=DjangoJSONEncoder)
+
+
+# South compatibility
+try:
+    from south.modelsinspector import add_introspection_rules
+    add_introspection_rules([(
+        (JSONField,),
+        [],
+        {
+            'blank': ['blank', { 'default': True }],
+            'null': ['null', { 'default': True }],
+        },
+    )], (r'^django_pgjson\.fields\.JsonField',))
+except ImportError:
+    pass

djorm_pgjson/__init__.py django_pgjson/__init__.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+from django.utils.functional import cached_property
+from django.db.models import Transform
+
+
+class KeyTransform(Transform):
+    def __init__(self, key, base_field, *args, **kwargs):
+        super(KeyTransform, self).__init__(*args, **kwargs)
+        self.key = key
+        self.base_field = base_field
+
+    def as_sql(self, qn, connection):
+        lhs, params = qn.compile(self.lhs)
+        import pdb; pdb.set_trace()
+
+        return "%s->>'%s'" % (lhs, self.key), params
+
+    @cached_property
+    def output_type(self):
+        return self.base_field
+
+
+class KeyTransformFactory(object):
+    def __init__(self, key, base_field):
+        self.key = key
+        self.base_field = base_field
+
+    def __call__(self, *args, **kwargs):
+        return KeyTransform(self.key, self.base_field, *args, **kwargs)
+

django_pgjson/fields.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+
+import os, sys
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
+sys.path.insert(0, 'tests')
+
+if __name__ == "__main__":
+    from django.core.management import execute_from_command_line
+    args = sys.argv
+    args.insert(1, "test")
+
+    execute_from_command_line(args)

django_pgjson/lookups.py

@@ -5,7 +5,7 @@
 """
 
 setup(
-    name = "djorm-ext-pgjson",
+    name = "django-pgjson",
     version = '0.3',
     url = 'https://github.com/niwibe/djorm-ext-pgjson',
     license = 'BSD',

djorm_pgjson/fields.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+
+from django.db import models
+from django_pgjson.fields import JsonField
+
+
+class TextModel(models.Model):
+    data = JsonField()

docs/Makefile

@@ -1,17 +1,17 @@
 # -*- coding: utf-8 -*-
 
+from __future__ import unicode_literals
+
 from django.contrib.admin import AdminSite, ModelAdmin
 
 from django.test import TestCase
 from django.core.serializers import serialize, deserialize
-
-from djorm_expressions.base import SqlExpression
-from djorm_pgjson.fields import JSONField
+from django_pgjson.fields import JsonField
 
 from .models import TextModel
 
 
-class JSONFieldTests(TestCase):
+class JsonFieldTests(TestCase):
     def setUp(self):
         TextModel.objects.all().delete()
 
@@ -21,38 +21,20 @@ def test_empty_create(self):
         self.assertEqual(instance.data, {})
 
     def test_unicode(self):
-        obj = TextModel.objects.create(data=[u"Fóö", u"Пример", u"test"])
-        obj = TextModel.objects.get(pk=obj.pk)
-
-        self.assertEqual(obj.data[1], u"Пример")
-
-    def test_correct_behavior_with_text(self):
-        obj = TextModel.objects.create(data="hello")
+        obj = TextModel.objects.create(data={"list": ["Fóö", "Пример", "test"]})
         obj = TextModel.objects.get(pk=obj.pk)
-        self.assertEqual(obj.data, "hello")
 
-    def test_correct_behavior_with_bool(self):
-        obj = TextModel.objects.create(data=True)
-        obj = TextModel.objects.get(pk=obj.pk)
-        self.assertEqual(obj.data, True)
+        self.assertEqual(obj.data["list"][1], "Пример")
 
-    def test_correct_behavior_with_int(self):
-        obj = TextModel.objects.create(data=1)
-        obj = TextModel.objects.get(pk=obj.pk)
-        self.assertEqual(obj.data, 1)
+    # def test_key_lookup(self):
+    #     obj1 = TextModel.objects.create(data={"name": "foo"})
+    #     obj2 = TextModel.objects.create(data={"name": "bar"})
 
-    def test_correct_behavior_with_float_01(self):
-        obj = TextModel.objects.create(data=1.4)
-        obj = TextModel.objects.get(pk=obj.pk)
-        self.assertEqual(obj.data, 1.4)
-
-    def test_correct_behavior_with_float_02(self):
-        obj = TextModel.objects.create(data=0.4)
-        obj = TextModel.objects.get(pk=obj.pk)
-        self.assertEqual(obj.data, 0.4)
+    #     qs = TextModel.objects.filter(data__field_name="foo")
+    #     self.assertEqual(qs.count(), 1)
 
     def test_value_to_string_serializes_correctly(self):
-        obj = TextModel.objects.create(data=[1,2,3])
+        obj = TextModel.objects.create(data={"a": 1})
 
         serialized_obj = serialize('json', TextModel.objects.filter(pk=obj.pk))
         obj.delete()
@@ -61,8 +43,9 @@ def test_value_to_string_serializes_correctly(self):
 
         obj = deserialized_obj.object
         obj.save()
+        obj = obj.__class__.objects.get(pk=obj.pk)
 
-        self.assertEqual(obj.data, [1,2,3])
+        self.assertEqual(obj.data, {"a": 1})
 
     def test_to_python_serializes_xml_correctly(self):
         obj = TextModel.objects.create(data={"a": 0.2})
@@ -74,11 +57,12 @@ def test_to_python_serializes_xml_correctly(self):
 
         obj = deserialized_obj.object
         obj.save()
+        obj = obj.__class__.objects.get(pk=obj.pk)
 
         self.assertEqual(obj.data, {"a": 0.2})
 
     def test_can_override_formfield(self):
-        model_field = JSONField()
+        model_field = JsonField()
         class FakeFieldClass(object):
             def __init__(self, *args, **kwargs):
                 pass

docs/conf.py

@@ -1,7 +1,6 @@
 import os, sys
 
 sys.path.insert(0, '..')
-sys.path.insert(0, '/home/niwi/devel/djorm-ext-expressions')
 
 PROJECT_ROOT = os.path.dirname(__file__)
 DEBUG = True