Fixed relation name issue brought up by Django 2.2. #3

Author: ses4j

README.md

@@ -81,4 +81,8 @@ Compare two sets of models by `key_fields`.
         'updated': list of all updated objects.
         'updated_details': dict of {obj: {field_name: (old_value, new_value)}} for all changed fields in each updated object.
         'removed': list of all removed objects.
-    } ```
+    } ```
+
+## Frameworks Supported
+
+This library is tested using Python 3 against Django 1.11 and Django 2.2.

bulk_sync/__init__.py

@@ -125,18 +125,19 @@ def compare_objs(obj1, obj2, ignore_fields=None):
     `key_fields`: Identifying attribute name(s) to match up `new_models` items with database rows.  If a foreign key
             is being used as a key field, be sure to pass the `fieldname_id` rather than the `fieldname`.
     `ignore_fields`: (optional) If set, provide field names that should not be considered when comparing objects.
+            If a foreign key is being used as an ignore_field, be sure to pass the `fieldname_id` rather than the `fieldname`.
 
     Returns: dict of changed fields and their old/new values: {field_name: (old_value, new_value)}
     """
 
     ret = {}
     fields = obj1._meta.get_fields()
     for f in fields:
-        if ignore_fields and f.name in ignore_fields:
+        if ignore_fields and f.attname in ignore_fields:
             continue
 
-        v1 = f.to_python(getattr(obj1, f.name))
-        v2 = f.to_python(getattr(obj2, f.name))
+        v1 = f.to_python(getattr(obj1, f.attname))
+        v2 = f.to_python(getattr(obj2, f.attname))
         if v1 != v2:
             ret[f.name] = (v1, v2)
 

tests/tests.py

@@ -8,6 +8,8 @@
 
 
 class BulkSyncTests(TestCase):
+    """ Test `bulk_sync` method """
+
     def setUp(self):
         pass
 
@@ -75,6 +77,8 @@ def test_pk_set_but_keyfield_changes_ignores_pk(self):
 
 
 class BulkCompareTests(TestCase):
+    """ Test `bulk_compare` method """
+
     @classmethod
     def setUpTestData(cls):
         cls.c1 = Company.objects.create(name="Foo Products, Ltd.")
@@ -107,7 +111,7 @@ def test_bulk_compare(self):
         self.assertEqual({new_objs[0]: {"age": (40, 41)}}, ret["updated_details"])
         self.assertEqual([new_objs[1]], ret["unchanged"])
 
-    def test_bulk_compare_with_ignore_fields(self):
+    def test_bulk_compare_with_ignore_int_field(self):
         c1 = self.c1
         e3 = self.e3
         new_objs = self.new_objs
@@ -124,3 +128,21 @@ def test_bulk_compare_with_ignore_fields(self):
         self.assertEqual([], ret["updated"])
         self.assertEqual({}, ret["updated_details"])
         self.assertEqual([new_objs[0], new_objs[1]], ret["unchanged"])
+
+    def test_bulk_compare_with_ignore_relation_field(self):
+        c1 = self.c1
+        e3 = self.e3
+        new_objs = self.new_objs
+
+        ret = bulk_compare(
+            old_models=Employee.objects.filter(company=c1).order_by("name"),
+            new_models=new_objs,
+            key_fields=("name",),
+            ignore_fields=("company_id",),
+        )
+
+        self.assertEqual([new_objs[2], new_objs[3]], ret["added"])
+        self.assertEqual([e3], list(ret["removed"]))
+        self.assertEqual([new_objs[0]], ret["updated"])
+        self.assertEqual({new_objs[0]: {'age': (40, 41)}}, ret["updated_details"])
+        self.assertEqual([new_objs[1]], ret["unchanged"])