Merge pull request #778 from pawl/fix_sort_joins

Fix sorting and searching for relation objects

flask_admin/contrib/sqla/view.py

@@ -341,6 +341,18 @@ class ModelView(BaseModelView):
         else:
             attr = name
 
+            # determine joins if Table.column (relation object) is given
+            if isinstance(name, InstrumentedAttribute):
+                columns = self._get_columns_for_field(name)
+
+                if len(columns) > 1:
+                    raise Exception('Can only handle one column for %s' % name)
+
+                column = columns[0]
+
+                if self._need_join(column.table):
+                    join_tables.append(column.table)
+
         return join_tables, attr
 
     def _need_join(self, table):
@@ -441,18 +453,18 @@ class ModelView(BaseModelView):
             for c in self.column_sortable_list:
                 if isinstance(c, tuple):
                     join_tables, column = self._get_field_with_path(c[1])
-
-                    result[c[0]] = column
-
-                    if join_tables:
-                        self._sortable_joins[c[0]] = join_tables
+                    column_name = c[0]
+                elif isinstance(c, InstrumentedAttribute):
+                    join_tables, column = self._get_field_with_path(c)
+                    column_name = str(c)
                 else:
                     join_tables, column = self._get_field_with_path(c)
+                    column_name = c
 
-                    result[c] = column
+                result[column_name] = column
 
-                    if join_tables:
-                        self._sortable_joins[c] = join_tables
+                if join_tables:
+                    self._sortable_joins[column_name] = join_tables
 
             return result
 

flask_admin/model/base.py

@@ -1003,10 +1003,12 @@ class BaseModelView(BaseView, ActionsMixin):
         """
             Verify if column is sortable.
 
+            Not case-sensitive.
+
             :param name:
                 Column name.
         """
-        return name in self._sortable_columns
+        return name.lower() in (x.lower() for x in self._sortable_columns)
 
     def is_editable(self, name):
         """

flask_admin/tests/sqla/test_basic.py

@@ -285,18 +285,31 @@ def test_complex_searchable_list():
                            column_searchable_list=['model1.test1'])
     admin.add_view(view)
 
-    m1 = Model1('model1')
+    m1 = Model1('model1-test1-val')
+    m2 = Model1('model1-test2-val')
     db.session.add(m1)
-    db.session.add(Model2('model2', model1=m1))
-    db.session.add(Model2('model3'))
+    db.session.add(m2)
+    db.session.add(Model2('model2-test1-val', model1=m1))
+    db.session.add(Model2('model2-test2-val', model1=m2))
     db.session.commit()
 
     client = app.test_client()
 
-    rv = client.get('/admin/model2/?search=model1')
+    # test relation string - 'model1.test1'
+    rv = client.get('/admin/model2/?search=model1-test1')
     data = rv.data.decode('utf-8')
-    ok_('model1' in data)
-    ok_('model3' not in data)
+    ok_('model2-test1-val' in data)
+    ok_('model2-test2-val' not in data)
+
+    view2 = CustomModelView(Model1, db.session,
+                           column_searchable_list=[Model2.string_field])
+    admin.add_view(view2)
+
+    # test relation object - Model2.string_field
+    rv = client.get('/admin/model1/?search=model2-test1')
+    data = rv.data.decode('utf-8')
+    ok_('model1-test1-val' in data)
+    ok_('model1-test2-val' not in data)
 
 
 def test_complex_searchable_list_missing_children():
@@ -1357,6 +1370,7 @@ def test_complex_sort():
 
     db.session.commit()
 
+    # test sorting on relation string - 'model1.test1'
     view = CustomModelView(M2, db.session,
                            column_list = ['string_field', 'model1.test1'],
                            column_sortable_list = ['model1.test1'])
@@ -1367,6 +1381,19 @@ def test_complex_sort():
     rv = client.get('/admin/model2/?sort=1')
     eq_(rv.status_code, 200)
 
+    # test sorting on relation object - M2.string_field
+    view2 = CustomModelView(M1, db.session,
+                           column_list = ['model2.string_field'],
+                           column_sortable_list = [M2.string_field])
+    admin.add_view(view2)
+
+    client = app.test_client()
+
+    rv = client.get('/admin/model1/?sort=1')
+    eq_(rv.status_code, 200)
+    data = rv.data.decode('utf-8')
+    ok_('Sort by' in data)
+
 
 def test_default_complex_sort():
     app, db, admin = setup()