Merge branch 'master' of git://github.com/melinath/philo
[philo.git] / models / fields.py
index 0c68858..3e43c0f 100644 (file)
@@ -1,6 +1,7 @@
-from django.db import models
 from django import forms
 from django.core.exceptions import FieldError, ValidationError
+from django.db import models
+from django.db.models.fields import NOT_PROVIDED
 from django.utils import simplejson as json
 from django.utils.text import capfirst
 from philo.signals import entity_class_prepared
@@ -13,11 +14,13 @@ __all__ = ('JSONAttribute', 'ForeignKeyAttribute', 'ManyToManyAttribute')
 class EntityProxyField(object):
        descriptor_class = None
        
-       def __init__(self, *args, **kwargs):
+       def __init__(self, verbose_name=None, help_text=None, default=NOT_PROVIDED, editable=True, *args, **kwargs):
                if self.descriptor_class is None:
                        raise NotImplementedError('EntityProxyField subclasses must specify a descriptor_class.')
-               self.verbose_name = kwargs.get('verbose_name', None)
-               self.help_text = kwargs.get('help_text', None)
+               self.verbose_name = verbose_name
+               self.help_text = help_text
+               self.default = default
+               self.editable = editable
        
        def actually_contribute_to_class(self, sender, **kwargs):
                sender._entity_meta.add_proxy_field(self)
@@ -39,6 +42,9 @@ class EntityProxyField(object):
        
        def value_from_object(self, obj):
                return getattr(obj, self.attname)
+       
+       def has_default(self):
+               return self.default is not NOT_PROVIDED
 
 
 class AttributeFieldDescriptor(object):
@@ -47,49 +53,49 @@ class AttributeFieldDescriptor(object):
        
        def __get__(self, instance, owner):
                if instance:
-                       if self.field.key in instance._added_attribute_registry:
-                               return instance._added_attribute_registry[self.field.key]
-                       if self.field.key in instance._removed_attribute_registry:
+                       if self.field in instance._added_attribute_registry:
+                               return instance._added_attribute_registry[self.field]
+                       if self.field in instance._removed_attribute_registry:
                                return None
                        try:
                                return instance.attributes[self.field.key]
                        except KeyError:
                                return None
                else:
-                       raise AttributeError('The \'%s\' attribute can only be accessed from %s instances.' % (self.field.name, owner.__name__))
+                       return None
        
        def __set__(self, instance, value):
                raise NotImplementedError('AttributeFieldDescriptor subclasses must implement a __set__ method.')
        
        def __delete__(self, instance):
-               if self.field.key in instance._added_attribute_registry:
-                       del instance._added_attribute_registry[self.field.key]
-               instance._removed_attribute_registry.append(self.field.key)
+               if self.field in instance._added_attribute_registry:
+                       del instance._added_attribute_registry[self.field]
+               instance._removed_attribute_registry.append(self.field)
 
 
 class JSONAttributeDescriptor(AttributeFieldDescriptor):
        def __set__(self, instance, value):
-               if self.field.key in instance._removed_attribute_registry:
-                       instance._removed_attribute_registry.remove(self.field.key)
-               instance._added_attribute_registry[self.field.key] = value
+               if self.field in instance._removed_attribute_registry:
+                       instance._removed_attribute_registry.remove(self.field)
+               instance._added_attribute_registry[self.field] = value
 
 
 class ForeignKeyAttributeDescriptor(AttributeFieldDescriptor):
        def __set__(self, instance, value):
                if isinstance(value, (models.Model, type(None))):
-                       if self.field.key in instance._removed_attribute_registry:
-                               instance._removed_attribute_registry.remove(self.field.key)
-                       instance._added_attribute_registry[self.field.key] = value
+                       if self.field in instance._removed_attribute_registry:
+                               instance._removed_attribute_registry.remove(self.field)
+                       instance._added_attribute_registry[self.field] = value
                else:
                        raise AttributeError('The \'%s\' attribute can only be set using existing Model objects.' % self.field.name)
 
 
 class ManyToManyAttributeDescriptor(AttributeFieldDescriptor):
        def __set__(self, instance, value):
-               if isinstance(value, models.QuerySet):
-                       if self.field.key in instance._removed_attribute_registry:
-                               instance._removed_attribute_registry.remove(self.field.key)
-                       instance._added_attribute_registry[self.field.key] = value
+               if isinstance(value, models.query.QuerySet):
+                       if self.field in instance._removed_attribute_registry:
+                               instance._removed_attribute_registry.remove(self.field)
+                       instance._added_attribute_registry[self.field] = value
                else:
                        raise AttributeError('The \'%s\' attribute can only be set to a QuerySet.' % self.field.name)
 
@@ -99,6 +105,17 @@ class AttributeField(EntityProxyField):
                super(AttributeField, self).contribute_to_class(cls, name)
                if self.key is None:
                        self.key = name
+       
+       def set_attribute_value(self, attribute, value, value_class):
+               if not isinstance(attribute.value, value_class):
+                       if isinstance(attribute.value, models.Model):
+                               attribute.value.delete()
+                       new_value = value_class()
+               else:
+                       new_value = attribute.value
+               new_value.value = value
+               new_value.save()
+               attribute.value = new_value
 
 
 class JSONAttribute(AttributeField):
@@ -113,11 +130,22 @@ class JSONAttribute(AttributeField):
        
        def formfield(self, **kwargs):
                defaults = {'required': False, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
+               if self.has_default():
+                       defaults['initial'] = self.default
                defaults.update(kwargs)
                return self.field_template.formfield(**defaults)
        
        def value_from_object(self, obj):
-               return getattr(obj, self.attname).value
+               try:
+                       return getattr(obj, self.attname)
+               except AttributeError:
+                       return None
+       
+       def set_attribute_value(self, attribute, value, value_class=None):
+               if value_class is None:
+                       from philo.models.base import JSONValue
+                       value_class = JSONValue
+               super(JSONAttribute, self).set_attribute_value(attribute, value, value_class)
 
 
 class ForeignKeyAttribute(AttributeField):
@@ -133,17 +161,36 @@ class ForeignKeyAttribute(AttributeField):
        
        def formfield(self, form_class=forms.ModelChoiceField, **kwargs):
                defaults = {'required': False, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
+               if self.has_default():
+                       defaults['initial'] = self.default
                defaults.update(kwargs)
                return form_class(self.model._default_manager.complex_filter(self.limit_choices_to), **defaults)
        
        def value_from_object(self, obj):
-               relobj = super(ForeignKeyAttribute, self).value_from_object(obj).value
+               try:
+                       relobj = super(ForeignKeyAttribute, self).value_from_object(obj)
+               except AttributeError:
+                       return None
                return getattr(relobj, 'pk', None)
+       
+       def set_attribute_value(self, attribute, value, value_class=None):
+               if value_class is None:
+                       from philo.models.base import ForeignKeyValue
+                       value_class = ForeignKeyValue
+               super(ForeignKeyAttribute, self).set_attribute_value(attribute, value, value_class)
 
 
-class ManyToManyAttribute(AttributeField):
+class ManyToManyAttribute(ForeignKeyAttribute):
        descriptor_class = ManyToManyAttributeDescriptor
-       #FIXME: Add __init__ and formfield methods
+       
+       def formfield(self, form_class=forms.ModelMultipleChoiceField, **kwargs):
+               return super(ManyToManyAttribute, self).formfield(form_class, **kwargs)
+       
+       def set_attribute_value(self, attribute, value, value_class=None):
+               if value_class is None:
+                       from philo.models.base import ManyToManyValue
+                       value_class = ManyToManyValue
+               super(ManyToManyAttribute, self).set_attribute_value(attribute, value, value_class)
 
 
 class TemplateField(models.TextField):