Commits

aleray committed 32ba3cb

Renamed all variables/fields named pathname to dashboard_id

I was previously using the pathname of the admin urls as a unique identifier
for the dashboards. So I introduced the DashboardPreference field "pathname",
and used that word too for misc related variables in the code. But as Mikhail
Korobov suggested it[1] it makes more sense to use the dashboard.get_id()
method instead of computing a uid from some request attribute. This is what I
did in my previous commit. So to be consistant I renamed in this commit
everything named "pathname" to "dashboard_id" in the code.

  • Participants
  • Parent commits 589d78f

Comments (0)

Files changed (6)

admin_tools/dashboard/forms.py

     the user field. It expects the user to be passed in from the view.
     """
 
-    def __init__(self, user, pathname, *args, **kwargs):
+    def __init__(self, user, dashboard_id, *args, **kwargs):
         super(DashboardPreferencesForm, self).__init__(*args, **kwargs)
         self.user = user
-        self.pathname = pathname
+        self.dashboard_id = dashboard_id
 
     def save(self, *args, **kwargs):
         preferences = super(DashboardPreferencesForm, self).save(
             **kwargs
         )
         preferences.user = self.user
-        preferences.pathname = self.pathname
+        preferences.dashboard_id = self.dashboard_id
         preferences.save()
         return preferences
 
     class Meta:
-        fields = ('pathname', 'data',)
+        fields = ('dashboard_id', 'data',)
         model = DashboardPreferences

admin_tools/dashboard/migrations/0003_auto__del_field_dashboardpreferences_pathname__add_field_dashboardpref.py

+# encoding: utf-8
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        
+        # Deleting field 'DashboardPreferences.pathname'
+        db.delete_column('admin_tools_dashboard_preferences', 'pathname')
+
+        # Adding field 'DashboardPreferences.dashboard_id'
+        db.add_column('admin_tools_dashboard_preferences', 'dashboard_id', self.gf('django.db.models.fields.TextField')(default=''), keep_default=False)
+
+
+    def backwards(self, orm):
+        
+        # Adding field 'DashboardPreferences.pathname'
+        db.add_column('admin_tools_dashboard_preferences', 'pathname', self.gf('django.db.models.fields.TextField')(default='', blank=True), keep_default=False)
+
+        # Deleting field 'DashboardPreferences.dashboard_id'
+        db.delete_column('admin_tools_dashboard_preferences', 'dashboard_id')
+
+
+    models = {
+        'auth.group': {
+            'Meta': {'object_name': 'Group'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
+            'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+        },
+        'auth.permission': {
+            'Meta': {'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
+            'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        },
+        'auth.user': {
+            'Meta': {'object_name': 'User'},
+            'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
+            'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True', 'blank': 'True'}),
+            'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False', 'blank': 'True'}),
+            'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False', 'blank': 'True'}),
+            'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
+            'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
+        },
+        'contenttypes.contenttype': {
+            'Meta': {'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
+            'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        },
+        'dashboard.dashboardpreferences': {
+            'Meta': {'object_name': 'DashboardPreferences', 'db_table': "'admin_tools_dashboard_preferences'"},
+            'dashboard_id': ('django.db.models.fields.TextField', [], {}),
+            'data': ('django.db.models.fields.TextField', [], {}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"})
+        }
+    }
+
+    complete_apps = ['dashboard']

admin_tools/dashboard/models.py

     This model represents the dashboard preferences for a user.
     """
     user = models.ForeignKey('auth.User')
-    pathname = models.TextField(blank=True)
+    dashboard_id = models.TextField()
     data = models.TextField()
 
     def __unicode__(self):
-        return "%s dashboard preferences" % self.user.username
+        return "%s dashboard preferences for %s" % (self.user.username, self.dashboard_id)
 
     class Meta:
         db_table = 'admin_tools_dashboard_preferences'
-        ordering = ('user',)
+        ordering = ('user', 'dashboard_id')
 
 
 # warnings for deprecated imports

admin_tools/dashboard/templatetags/admin_tools_dashboard_tags.py

 
     try:
         preferences = DashboardPreferences.objects.get(user=context['request'].user, \
-                pathname=dashboard.get_id()).data
+                dashboard_id=dashboard.get_id()).data
     except DashboardPreferences.DoesNotExist:
         preferences = '{}'
 

admin_tools/dashboard/views.py

     """
     try:
         preferences = DashboardPreferences.objects.get(user=request.user, \
-                pathname=request.POST['pathname'])
+                dashboard_id=request.POST['dashboard_id'])
     except (DashboardPreferences.DoesNotExist, MultiValueDictKeyError):
         preferences = None
     if request.method == "POST":
         form = DashboardPreferencesForm(
             user=request.user,
-            pathname=request.POST['pathname'],
+            dashboard_id=request.POST['dashboard_id'],
             data=request.POST,
             instance=preferences
         )
         elif request.is_ajax():
             return HttpResponse('false')
     else:
-        form = DashboardPreferencesForm(user=request.user, pathname="", instance=preferences)
+        form = DashboardPreferencesForm(user=request.user, dashboard_id="", instance=preferences)
     return direct_to_template(request, 'admin_tools/dashboard/preferences_form.html', {
         'form': form,   
     })

admin_tools/media/admin_tools/js/dashboard.js

             return preferences;
         },
         'save_preferences_function': function(options, preferences) {
-            jQuery.post(url, { pathname: options.dashboard_id, data: JSON.stringify(preferences) });
+            jQuery.post(url, { dashboard_id: options.dashboard_id, data: JSON.stringify(preferences) });
         }
     });
     $(".group-tabs").tabs();