Refactored names to make better sense.

Author: runekaagaard

flexselect/__init__.py

@@ -32,15 +32,15 @@ def choices_from_queryset(queryset):
 def choices_from_instance(instance, widget):
     """
     Builds choices from a model instance using the widgets queryset() method. 
-    If any of the widgets trigger fields is not defined on the instance or the
+    If any of the widgets trigger_field fields is not defined on the instance or the
     instance itself is None, None is returned.
     
     instance: An instance of the model used on the current admin page.
     widget: A widget instance given to the FlexSelectWidget.
     """
     try:
-        for trigger in widget.triggers:
-            getattr(instance, trigger)
+        for trigger_field in widget.trigger_fields:
+            getattr(instance, trigger_field)
     except ObjectDoesNotExist:
         return [('', widget.empty_choices_text(instance))]
 
@@ -49,16 +49,16 @@ def choices_from_instance(instance, widget):
 def details_from_instance(instance, widget):
     """
     Builds html from a model instance using the widgets details() method. If
-    any of the widgets trigger fields is not defined on the instance or the
+    any of the widgets trigger_field fields is not defined on the instance or the
     instance itself is None, None is returned.
     
     instance: An instance of the model used on the current admin page.
     widget: A widget instance given to the FlexSelectWidget.
     """
     try:
-        for trigger in widget.triggers:
-            getattr(instance, trigger)
-        related_instance = getattr(instance, widget.db_field.name)
+        for trigger_field in widget.trigger_fields:
+            getattr(instance, trigger_field)
+        related_instance = getattr(instance, widget.base_field.name)
     except ObjectDoesNotExist:
         return u''
     return widget.details(related_instance, instance)
@@ -70,15 +70,15 @@ def instance_from_request(request, widget):
         """
         items = dict(request.POST.items())
         values = {}
-        for f in widget.db_field.model._meta.fields:
+        for f in widget.base_field.model._meta.fields:
             if f.name in items:
                 try:
                     value = f.formfield().to_python(items[f.name])
                     if value is not None:
                         values[f.name] = value
                 except ValidationError:
                     pass
-        return widget.db_field.model(**values)
+        return widget.base_field.model(**values)
 
 class FlexSelectWidget(Select):
     """
@@ -93,7 +93,7 @@ class FlexSelectWidget(Select):
         # First a widget class for the field that should update when other
         # fields change must be defined.
         class CustomerContactRenderer(object):
-            triggers = ['client']
+            trigger_fields = ['client']
             empty_choices_text = 'Please update the client field first'
             
             def details(self, instance):
@@ -105,16 +105,16 @@ def queryset(self, instance):
                 
         # Then the formfield_for_foreignkey() method of the ModelAdmin must be
         # overwritten. 
-        def formfield_for_foreignkey(self, db_field, request, **kwargs):
-            if db_field.name == "customer_contact":
+        def formfield_for_foreignkey(self, base_field, request, **kwargs):
+            if base_field.name == "customer_contact":
                 kwargs['widget'] =  FlexSelectWidget(
                     # An instance of the widget class defined above.
                     widget=CustomerContactRenderer()
-                    db_field=db_field,
+                    base_field=base_field,
                     modeladmin=self,
                     request=request,
                 )
-            return super(CaseAdmin, self).formfield_for_foreignkey(db_field, 
+            return super(CaseAdmin, self).formfield_for_foreignkey(base_field, 
                 request, **kwargs)
     """
     instances = {}
@@ -131,7 +131,7 @@ class Media:
     def __init__(self, db_field, modeladmin, request, *args, 
                  **kwargs):
 
-        self.db_field = db_field
+        self.base_field = db_field
         self.modeladmin = modeladmin
         self.request = request
 
@@ -146,7 +146,7 @@ def _hashed_name(self):
         """
         salted_string = "".join([
               settings.SECRET_KEY,
-              self.db_field.name, 
+              self.base_field.name, 
               self.modeladmin.__class__.__name__,         
         ])
         return hashlib.sha1(salted_string).hexdigest()
@@ -167,21 +167,21 @@ def _get_instance(self):
 
     def _build_js(self):
         """
-        Adds the widgets hashed_name as the key with an array of its triggers
+        Adds the widgets hashed_name as the key with an array of its trigger_fields
         as the value to flexselect.selects.
         """
         return """
             <script>
                 var flexselect = flexselect || {};
-                flexselect.triggers = flexselect.triggers || {};
-                flexselect.triggers.%(field)s = flexselect.triggers.%(field)s || 
+                flexselect.trigger_fields = flexselect.trigger_fields || {};
+                flexselect.trigger_fields.%(field)s = flexselect.trigger_fields.%(field)s || 
                                                                              [];
-                flexselect.triggers.%(field)s.push(%(triggers)s);
+                flexselect.trigger_fields.%(field)s.push(%(trigger_fields)s);
             </script>""" % {
-                'field': self.db_field.name,
-                'triggers': 
+                'field': self.base_field.name,
+                'trigger_fields': 
                     ",".join('["%s", "%s"]' % (t, self.hashed_name) 
-                    for t in self.triggers),
+                    for t in self.trigger_fields),
             };
 
 

flexselect/static/flexselect/js/flexselect.js

@@ -4,16 +4,16 @@
 var flexselect = flexselect || {};
 
 /**
- * Binds the flexselect triggers.
+ * Binds the flexselect trigger_fields.
  */
 flexselect.bind_events = function() {
-    var triggers = that.flexselect.triggers; 
-	for (base_field in triggers) {
-		flexselect.bind_base_field(base_field, triggers[base_field][0][1]);
-		for (j in triggers[base_field])
+    var trigger_fields = that.flexselect.trigger_fields; 
+	for (base_field in trigger_fields) {
+		flexselect.bind_base_field(base_field, trigger_fields[base_field][0][1]);
+		for (j in trigger_fields[base_field])
 			flexselect.bind_trigger_field(
-				triggers[base_field][j][0], 
-				triggers[base_field][j][1], 
+				trigger_fields[base_field][j][0], 
+				trigger_fields[base_field][j][1], 
 				base_field
 			);
 	}
@@ -31,7 +31,8 @@ flexselect.bind_base_field = function(base_field, hashed_name) {
 }
 
 /**
- * Binds the change event of a field to the flexselect.trigger_field_changed function.
+ * Binds the change event of a field to the flexselect.trigger_field_changed 
+ * function.
  */
 flexselect.bind_trigger_field = function(trigger_field, hashed_name, 
 base_field) {
@@ -86,7 +87,7 @@ flexselect.move_after_plussign = function() {
 };
 
 /**
- * Overrides the original dismissAddAnotherPopup and triggers a change event
+ * Overrides the original dismissAddAnotherPopup and trigger_fields a change event
  * on field after the popup has been added.
  */
 var _dismissAddAnotherPopup = dismissAddAnotherPopup;

flexselect/views.py

@@ -25,7 +25,7 @@ def wrapper(*args,**kwargs):
 @login_required
 def trigger_field_changed(request):
     """
-    Ajax callback called when on of the trigger fields is changed. Returns
+    Ajax callback called when a trigger field or base field has changed. Returns
     html for new options and details for the dependent field as json.
     """
     hashed_name = request.POST.__getitem__('hashed_name')

test_flexselect/tests/models.py

@@ -18,7 +18,7 @@ def __unicode__(self):
         return self.name
 
 class CompanyContactPersonWidget(FlexSelectWidget):
-    triggers = ['client']
+    trigger_fields = ['client']
 
     def details(self, related_instance, instance):
         return """\