#296 added data attribute data-id in base_data_table row to easily di…

…stinct rows

CHANGELOG.md

@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Always reference the ticket number at the end of the issue description.
 
 
+## Pending
+
+### Added
+
+- added data attribute data-id in base_data_table row to easily distinct rows
+
+
 ## 1.1.1
 
 ### Changed

arctic/generics.py

@@ -437,7 +437,10 @@ def get_list_items(self, objects):  # noqa: C901
 
         for obj in objects:
             field_classes = self.get_field_classes(obj)
-            row = []
+            row = {
+                'id': getattr(obj, self.primary_key),  # for row data id attr
+                'fields': []
+            }
 
             for field_name in fields:
                 field = {'type': 'field', 'field': field_name}
@@ -464,16 +467,17 @@ def get_list_items(self, objects):  # noqa: C901
                         field_links[field_name], obj)
                 if field_name in field_classes:
                     field['class'] = field_classes[field_name]
-                row.append(field)
+                row['fields'].append(field)
+
             actions = self._get_field_actions(obj)
             if actions:
-                row.append(actions)
+                row['fields'].append(actions)
                 self.has_action_links = True
             if self.sorting_field:
                 sort = {'type': 'sorting',
                         'id': getattr(obj, self.primary_key),
                         'value': getattr(obj, self.sorting_field)}
-                row.insert(0, sort)
+                row['fields'].insert(0, sort)
             items.append(row)
         return items
 
@@ -643,20 +647,23 @@ def get_list_items(self, objects):
                           else field)
         for obj in objects:
             field_classes = self.get_field_classes(obj)
-            row = []
+            row = {
+                'id': getattr(obj, 'id', ''),
+                'fields': []
+            }
             for field_name in fields:
                 field = {'field': field_name, 'type': 'field'}
                 field['value'] = self.get_field_value(field_name, obj)
                 if field_name in field_links.keys():
                     field['url'] = self._reverse_field_link(
-                        field_links[field_name], obj, self.primary_key)
+                        field_links[field_name], obj)
                 if field_name in field_classes:
                     field['class'] = field_classes[field_name]
-                row.append(field)
+                row['fields'].append(field)
             items.append(row)
             actions = self._get_field_actions(obj)
             if actions:
-                row.append(actions)
+                row['fields'].append(actions)
                 self.has_action_links = True
         return items
 

arctic/templates/arctic/partials/base_data_table.html

@@ -102,8 +102,8 @@ <h4 class="arctic-card__title">
                         </thead>
                         <tbody {% if list_items.0.0.type == 'sorting' %}data-sorting-url="{{ sorting_url }}"{% endif %}>
                             {% for row in list_items %}
-                                <tr>
-                                    {% for column in row %}
+                                <tr data-id="{{ row.id }}">
+                                    {% for column in row.fields %}
                                         {% if column.type == 'field' %}
                                             <td {% if column.class %}class="{{ column.class }}"{%endif%}>
                                                 {% if column.url %}

tests/test_articles.py

@@ -4,7 +4,7 @@
 def test_article_list(admin_client, article):
     response = admin_client.get(reverse('articles:list'))
     assert response.status_code == 200
-    list_items = response.context['list_items'][0]
+    list_items = response.context['list_items'][0]['fields']
     item_dict = {}
     for item in list_items:
         try:

tests/test_field_classes.py

@@ -19,5 +19,6 @@ def test_field_classes(self, admin_client):
         ArticleFactory(published=False)
         response = self._request(admin_client)
 
-        assert response.context_data['list_items'][0][2]['class'] == 'online'
-        assert response.context_data['list_items'][1][2]['class'] == 'offline'
+        list_items = response.context_data['list_items']
+        assert list_items[0]['fields'][2]['class'] == 'online'
+        assert list_items[1]['fields'][2]['class'] == 'offline'

tests/test_generics/test_list_view.py

@@ -27,9 +27,9 @@ def test_single_item(self, admin_client):
         article = ArticleFactory()
         response = self._request(admin_client)
         self._assert_list_items_len(response, 1)
-        field = response.context_data['list_items'][0][0]['field']
-        assert response.context_data['list_items'][0][0]['value'] == \
-            getattr(article, field)
+        lst_items = response.context_data['list_items']
+        field = lst_items[0]['fields'][0]['field']
+        assert lst_items[0]['fields'][0]['value'] == getattr(article, field)
 
     def test_paginated_items(self, admin_client):
         """
@@ -95,8 +95,10 @@ def test_simple_search_form(self, admin_client):
         # search filled, filter content
         response = admin_client.get(reverse('articles:list'),
                                     {'search': 'le1'})
-        assert len(response.context_data['list_items']) == 1
-        assert response.context_data['list_items'][0][0]['value'] == 'title1'
+
+        list_items = response.context_data['list_items']
+        assert len(list_items) == 1
+        assert list_items[0]['fields'][0]['value'] == 'title1'
 
     def test_advanced_search_form(self, admin_client):
         """
@@ -113,8 +115,9 @@ def test_advanced_search_form(self, admin_client):
         # search filled, filter content
         response = admin_client.get(reverse('articles:list'),
                                     {'description': 'tion2'})
-        assert len(response.context_data['list_items']) == 1
-        assert response.context_data['list_items'][0][0]['value'] == 'title2'
+        list_items = response.context_data['list_items']
+        assert len(list_items) == 1
+        assert list_items[0]['fields'][0]['value'] == 'title2'
 
     def test_simple_search_form_quick_filters(self, admin_client):
         """
@@ -133,12 +136,14 @@ def test_simple_search_form_quick_filters(self, admin_client):
 
         response = admin_client.get(reverse('articles:list'),
                                     {'published': 'published'})
-        assert len(response.context_data['list_items']) == 1
-        assert response.context_data['list_items'][0][0]['value'] == 'title1'
+        list_items = response.context_data['list_items']
+        assert len(list_items) == 1
+        assert list_items[0]['fields'][0]['value'] == 'title1'
 
         response = admin_client.get(reverse('articles:list'),
                                     {'published': 'drafts'})
-        assert response.context_data['list_items'][0][0]['value'] == 'title2'
+        list_items = response.context_data['list_items']
+        assert list_items[0]['fields'][0]['value'] == 'title2'
 
     def test_field_actions(self, admin_client):
         ArticleFactory(title='title1', description='description1',
@@ -148,8 +153,9 @@ def test_field_actions(self, admin_client):
 
         response = admin_client.get(reverse('articles:list'),
                                     {'description': ''})
-        assert len(response.context_data['list_items'][0][-1]['actions']) == 1
-        assert len(response.context_data['list_items'][1][-1]['actions']) == 2
+        list_items = response.context_data['list_items']
+        assert len(list_items[0]['fields'][-1]['actions']) == 1
+        assert len(list_items[1]['fields'][-1]['actions']) == 2
 
     def test_field_actions_allowing(self, admin_client):
         def get_field_actions(self, obj):
@@ -171,5 +177,6 @@ def get_field_actions(self, obj):
 
         response = admin_client.get(reverse('articles:list'),
                                     {'description': ''})
-        assert len(response.context_data['list_items'][0][-1]['actions']) == 1
-        assert len(response.context_data['list_items'][1][-1]['actions']) == 2
+        list_items = response.context_data['list_items']
+        assert len(list_items[0]['fields'][-1]['actions']) == 1
+        assert len(list_items[1]['fields'][-1]['actions']) == 2

tests/test_generics/test_ordering.py

@@ -27,5 +27,5 @@ def test_virtual_ordering_field(self, admin_client):
         assert lst_headers[3]['order_url'] == '/articles/?order=category__name'
         assert lst_headers[3]['order_direction'] == 'desc'
         assert len(lst_items) == 2
-        assert lst_items[0][0]['value'] == 'Article 1'
-        assert lst_items[1][0]['value'] == 'Article 0'
+        assert lst_items[0]['fields'][0]['value'] == 'Article 1'
+        assert lst_items[1]['fields'][0]['value'] == 'Article 0'

tests/test_virtual_fields.py

@@ -28,9 +28,9 @@ def test_virtual_field(self, admin_client):
         self._assert_list_items_len(response, 1)
 
         item = response.context_data['list_items'][0]
-        assert item[0]['value'] == article.title
-        assert item[1]['value'] == article.description
-        assert item[3]['value'] == article.category.name
+        assert item['fields'][0]['value'] == article.title
+        assert item['fields'][1]['value'] == article.description
+        assert item['fields'][3]['value'] == article.category.name
 
     def test_missing_virtual_field(self, admin_client):
         """
@@ -42,7 +42,7 @@ def test_missing_virtual_field(self, admin_client):
         response = self._request(admin_client)
 
         search_virtual_field = False
-        for field in response.context_data['list_items'][0]:
+        for field in response.context_data['list_items'][0]['fields']:
             if field['type'] == 'field' and 'virtual_field' in field['field']:
                 search_virtual_field = True