Adding example of validating foreign key relations.

Author: runekaagaard

README.markdown

@@ -15,8 +15,6 @@ the customer_contact_persons company and email as additional details.
 In "models.py":
 
 ```python
-from django.db import models as m
-
 """
 No changes to the models are needed to use flexselect.
 """
@@ -46,6 +44,15 @@ class Case(m.Model):
     client = m.ForeignKey(Client)
     company_contact_person = m.ForeignKey(CompanyContactPerson)
 
+    def clean(self):
+        """
+        Make sure that the company for client is the same as the company for
+        the customer contact person.
+        """
+        if not self.client.company == self.company_contact_person.company:
+            raise ValidationError('The clients and the contacts company does'
+                                  ' not match.')
+    
     def __unicode__(self):
         return u'Case: %d' % self.id
 ```
@@ -117,7 +124,7 @@ class CaseAdmin(admin.ModelAdmin):
         """
         if db_field.name == "company_contact_person":
             kwargs['widget'] =  CompanyContactPersonWidget(
-                db_field=db_field,
+                base_field=db_field,
                 modeladmin=self,
                 request=request,
             )

flexselect/__init__.py

@@ -93,17 +93,17 @@ class Media:
             js.append('%s/jqueryui/1.8.13/jquery-ui.min.js' % googlecdn)
         js.append('flexselect/js/flexselect.js')
 
-    def __init__(self, db_field, modeladmin, request, *args, 
+    def __init__(self, base_field, modeladmin, request, *args, 
                  **kwargs):
 
-        self.base_field = db_field
+        self.base_field = base_field
         self.modeladmin = modeladmin
         self.request = request
 
         self.hashed_name = self._hashed_name()
         FlexSelectWidget.instances[self.hashed_name] = self
         super(FlexSelectWidget, self).__init__(*args, **kwargs)
-    
+        
     def _hashed_name(self):
         """
         Each widget will be unique by the name of the field and the class name 
@@ -179,4 +179,4 @@ def queryset(self, instance):
     def empty_choices_text(self, instance):
         raise NotImplementedError
 
-    
+    

test_flexselect/test_flexselect

@@ -63,7 +63,7 @@ def formfield_for_foreignkey(self, db_field, request, **kwargs):
         """
         if db_field.name == "company_contact_person":
             kwargs['widget'] =  CompanyContactPersonWidget(
-                db_field=db_field,
+                base_field=db_field,
                 modeladmin=self,
                 request=request,
             )
@@ -83,4 +83,4 @@ class CompanyAdmin(admin.ModelAdmin):
 admin.site.register(Case, CaseAdmin)
 admin.site.register(Client, ClientAdmin)
 admin.site.register(CompanyContactPerson, CompanyContactPersonAdmin)
-admin.site.register(Company, CompanyAdmin)
+admin.site.register(Company, CompanyAdmin)

test_flexselect/tests/admin.py

@@ -1,4 +1,5 @@
 from django.db import models as m
+from django.core.exceptions import ValidationError
 
 """
 No changes to the models are needed to use flexselect.
@@ -29,5 +30,14 @@ class Case(m.Model):
     client = m.ForeignKey(Client)
     company_contact_person = m.ForeignKey(CompanyContactPerson)
 
+    def clean(self):
+        """
+        Make sure that the company for client is the same as the company for
+        the customer contact person.
+        """
+        if not self.client.company == self.company_contact_person.company:
+            raise ValidationError('The clients and the contacts company does'
+                                  ' not match.')
+    
     def __unicode__(self):
-        return u'Case: %d' % self.id
+        return u'Case: %d' % self.id