Ungenericized get_item_queryset and added tag/issue queryset fetching methods to...
[philo.git] / models / fields.py
index 621d7a1..0289e57 100644 (file)
-from django.db import models
 from django import forms
-from django.core.exceptions import FieldError
-from django.utils.text import capfirst
-from philo.models.base import Entity
-from philo.signals import entity_class_prepared
-
-
-__all__ = ('AttributeField', 'RelationshipField')
+from django.db import models
+from django.utils import simplejson as json
+from philo.forms.fields import JSONFormField
+from philo.validators import TemplateValidator, json_validator
 
 
-class EntityProxyField(object):
-       descriptor_class = None
-       
-       def __init__(self, *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)
-       
-       def actually_contribute_to_class(self, sender, **kwargs):
-               sender._entity_meta.add_proxy_field(self)
-               setattr(sender, self.attname, self.descriptor_class(self))
-       
-       def contribute_to_class(self, cls, name):
-               if issubclass(cls, Entity):
-                       self.name = name
-                       self.attname = name
-                       if self.verbose_name is None and name:
-                               self.verbose_name = name.replace('_', ' ')
-                       entity_class_prepared.connect(self.actually_contribute_to_class, sender=cls)
-               else:
-                       raise FieldError('%s instances can only be declared on Entity subclasses.' % self.__class__.__name__)
-       
-       def formfield(self, *args, **kwargs):
-               raise NotImplementedError('EntityProxyField subclasses must implement a formfield method.')
-       
-       def value_from_object(self, obj):
-               return getattr(obj, self.attname)
+class TemplateField(models.TextField):
+       def __init__(self, allow=None, disallow=None, secure=True, *args, **kwargs):
+               super(TemplateField, self).__init__(*args, **kwargs)
+               self.validators.append(TemplateValidator(allow, disallow, secure))
 
 
-class AttributeFieldDescriptor(object):
+class JSONDescriptor(object):
        def __init__(self, field):
                self.field = field
        
        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:
-                               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__))
+               if instance is None:
+                       raise AttributeError # ?
+               
+               if self.field.name not in instance.__dict__:
+                       json_string = getattr(instance, self.field.attname)
+                       instance.__dict__[self.field.name] = json.loads(json_string)
+               
+               return instance.__dict__[self.field.name]
        
        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
+               instance.__dict__[self.field.name] = value
+               setattr(instance, self.field.attname, json.dumps(value))
        
        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)
+               del(instance.__dict__[self.field.name])
+               setattr(instance, self.field.attname, json.dumps(None))
 
 
-class AttributeField(EntityProxyField):
-       descriptor_class = AttributeFieldDescriptor
-       
-       def __init__(self, key, field_template=None):
-               super(AttributeField, self).__init__()
-               self.key = key
-               if field_template is None:
-                       field_template = models.CharField(max_length=255)
-               self.field_template = field_template
+class JSONField(models.TextField):
+       default_validators = [json_validator]
        
-       def formfield(self, **kwargs):
-               defaults = {'required': False, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
-               defaults.update(kwargs)
-               return self.field_template.formfield(**defaults)
-
-
-class RelationshipFieldDescriptor(object):
-       def __init__(self, field):
-               self.field = field
+       def get_attname(self):
+               return "%s_json" % self.name
        
-       def __get__(self, instance, owner):
-               if instance:
-                       if self.field.key in instance._added_relationship_registry:
-                               return instance._added_relationship_registry[self.field.key]
-                       if self.field.key in instance._removed_relationship_registry:
-                               return None
-                       try:
-                               return instance.relationships[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__))
+       def contribute_to_class(self, cls, name):
+               super(JSONField, self).contribute_to_class(cls, name)
+               setattr(cls, name, JSONDescriptor(self))
+               models.signals.pre_init.connect(self.fix_init_kwarg, sender=cls)
        
-       def __set__(self, instance, value):
-               if isinstance(value, (models.Model, type(None))):
-                       if self.field.key in instance._removed_relationship_registry:
-                               instance._removed_relationship_registry.remove(self.field.key)
-                       instance._added_relationship_registry[self.field.key] = value
-               else:
-                       raise AttributeError('The \'%s\' attribute can only be set using existing Model objects.' % self.field.name)
+       def fix_init_kwarg(self, sender, args, kwargs, **signal_kwargs):
+               if self.name in kwargs:
+                       kwargs[self.attname] = json.dumps(kwargs.pop(self.name))
        
-       def __delete__(self, instance):
-               if self.field.key in instance._added_relationship_registry:
-                       del instance._added_relationship_registry[self.field.key]
-               instance._removed_relationship_registry.append(self.field.key)
+       def formfield(self, *args, **kwargs):
+               kwargs["form_class"] = JSONFormField
+               return super(JSONField, self).formfield(*args, **kwargs)
 
 
-class RelationshipField(EntityProxyField):
-       descriptor_class = RelationshipFieldDescriptor
-       
-       def __init__(self, key, model, limit_choices_to=None):
-               super(RelationshipField, self).__init__()
-               self.key = key
-               self.model = model
-               if limit_choices_to is None:
-                       limit_choices_to = {}
-               self.limit_choices_to = limit_choices_to
-       
-       def formfield(self, form_class=forms.ModelChoiceField, **kwargs):
-               defaults = {'required': False, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
-               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(RelationshipField, self).value_from_object(obj)
-               return getattr(relobj, 'pk', None)
\ No newline at end of file
+try:
+       from south.modelsinspector import add_introspection_rules
+except ImportError:
+       pass
+else:
+       add_introspection_rules([], ["^philo\.models\.fields\.TemplateField"])
+       add_introspection_rules([], ["^philo\.models\.fields\.JSONField"])
\ No newline at end of file