Merge pull request #970 from Baizley/simplify_get_name_format

gramps/gen/display/name.py

@@ -59,6 +59,7 @@ Specific symbols for parts of a name are defined:
 #-------------------------------------------------------------------------
 import re
 import logging
+
 LOG = logging.getLogger(".gramps.gen")
 
 #-------------------------------------------------------------------------
@@ -491,54 +492,29 @@ class NameDisplay:
                         only_custom=False,
                         only_active=True):
         """
-        Get a list of tuples (num, name,fmt_str,act)
+        Returns a list of name formats as tuples on
+        the form (index, name,fmt_str,act).
+        The will contain standard formats followed
+        by custom formats both in ascending order on
+        their indices.
         """
-        the_list = []
 
-        keys = sorted(self.name_formats, key=self.cmp_to_key(self._sort_name_format))
+        custom_formats = sorted([
+            (index, name, format_string, active)
+            for index, (name, format_string, active, *rest) in self.name_formats.items()
+            if index < 0 and (not only_active or active)
+        ])
 
-        for num in keys:
+        if only_custom:
-            if ((also_default or num) and
+            return custom_formats
-                (not only_custom or (num < 0)) and
-                (not only_active or self.name_formats[num][_F_ACT])):
-                the_list.append((num,) + self.name_formats[num][_F_NAME:_F_FN])
 
-        return the_list
+        standard_formats = sorted([
+            (index, name, format_string, active)
+            for index, (name, format_string, active, *rest) in self.name_formats.items()
+            if index >= 0 and (also_default or index) and (not only_active or active)
+        ])
 
-    def cmp_to_key(self, mycmp):
+        return standard_formats + custom_formats
-        """
-        python 2 to 3 conversion, python recipe http://code.activestate.com/recipes/576653/
-        Convert a :func:`cmp` function into a :func:`key` function
-        We use this in Gramps as understanding the old compare function is
-        not trivial. This should be replaced by a proper key function
-        """
-        class K:
-            def __init__(self, obj, *args):
-                self.obj = obj
-            def __lt__(self, other):
-                return mycmp(self.obj, other.obj) < 0
-            def __gt__(self, other):
-                return mycmp(self.obj, other.obj) > 0
-            def __eq__(self, other):
-                return mycmp(self.obj, other.obj) == 0
-            def __le__(self, other):
-                return mycmp(self.obj, other.obj) <= 0
-            def __ge__(self, other):
-                return mycmp(self.obj, other.obj) >= 0
-            def __ne__(self, other):
-                return mycmp(self.obj, other.obj) != 0
-        return K
-    def _sort_name_format(self, x, y):
-        if x < 0:
-            if y < 0:
-                return x+y
-            else:
-                return -x+y
-        else:
-            if y < 0:
-                return -x+y
-            else:
-                return x-y
 
     def _is_format_valid(self, num):
         try:

gramps/gen/display/test/name_test.py

@@ -0,0 +1,247 @@
+#
+# Gramps - a GTK+/GNOME based genealogy program
+#
+# Copyright (C) 2000-2007  Donald N. Allingham
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+import unittest
+
+from gramps.gen.display.name import NameDisplay
+from gramps.gen.lib import Name
+
+
+class NameTest(unittest.TestCase):
+
+    def setUp(self):
+        self.name_display = NameDisplay()
+
+    def test_get_name_format_for_all_without_default_format(self):
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        actual_name_format = self.name_display.get_name_format(also_default=False, only_custom=False, only_active=False)
+
+        expected_name_format = [
+            (1, 'Surname, Given Suffix', '%l, %f %s', True),
+            (2, 'Given Surname Suffix', '%f %l %s', True),
+            (3, 'Patronymic, Given', '%y, %s %f', False),
+            (4, 'Given', '%f', True),
+            (5, 'Main Surnames, Given Patronymic Suffix Prefix', '%1m %2m %o, %f %1y %s %0m', True),
+            (-2, 'SURNAME, Given Suffix (Call)', 'SURNAME, Given Suffix (Call)', False),
+            (-1, 'Surname, Name|Common Suffix', 'Surname, Name|Common Suffix', True)
+        ]
+        self.assertEqual(expected_name_format, actual_name_format)
+
+    def test_get_name_format_for_all_active_without_default_format(self):
+
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        actual_name_format = self.name_display.get_name_format(also_default=False, only_custom=False, only_active=True)
+
+        expected_name_format = [
+            (1, 'Surname, Given Suffix', '%l, %f %s', True),
+            (2, 'Given Surname Suffix', '%f %l %s', True),
+            (4, 'Given', '%f', True),
+            (5, 'Main Surnames, Given Patronymic Suffix Prefix', '%1m %2m %o, %f %1y %s %0m', True),
+            (-1, 'Surname, Name|Common Suffix', 'Surname, Name|Common Suffix', True)
+        ]
+        self.assertEqual(expected_name_format, actual_name_format)
+
+    def test_get_name_format_for_all_custom_formats_without_default_format(self):
+
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        actual_name_format = self.name_display.get_name_format(also_default=False, only_custom=True, only_active=False)
+
+        expected_name_format = [
+            (-2, 'SURNAME, Given Suffix (Call)', 'SURNAME, Given Suffix (Call)', False),
+            (-1, 'Surname, Name|Common Suffix', 'Surname, Name|Common Suffix', True)
+        ]
+        self.assertEqual(expected_name_format, actual_name_format)
+
+    def test_get_name_format_for_active_custom_formats_without_default_format(self):
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        actual_name_format = self.name_display.get_name_format(also_default=False, only_custom=True, only_active=True)
+
+        expected_name_format = [
+            (-1, 'Surname, Name|Common Suffix', 'Surname, Name|Common Suffix', True)
+        ]
+        self.assertEqual(expected_name_format, actual_name_format)
+
+    def test_get_name_format_for_all(self):
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        actual_name_format = self.name_display.get_name_format(also_default=True, only_custom=False, only_active=False)
+
+        expected_name_format = [
+            (0, 'Default format (defined by Gramps preferences)', '', True),
+            (1, 'Surname, Given Suffix', '%l, %f %s', True),
+            (2, 'Given Surname Suffix', '%f %l %s', True),
+            (3, 'Patronymic, Given', '%y, %s %f', False),
+            (4, 'Given', '%f', True),
+            (5, 'Main Surnames, Given Patronymic Suffix Prefix', '%1m %2m %o, %f %1y %s %0m', True),
+            (-2, 'SURNAME, Given Suffix (Call)', 'SURNAME, Given Suffix (Call)', False),
+            (-1, 'Surname, Name|Common Suffix', 'Surname, Name|Common Suffix', True)
+        ]
+        self.assertEqual(expected_name_format, actual_name_format)
+
+    def test_get_name_format_for_all_active(self):
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        actual_name_format = self.name_display.get_name_format(also_default=True, only_custom=False, only_active=True)
+
+        expected_name_format = [
+            (0, 'Default format (defined by Gramps preferences)', '', True),
+            (1, 'Surname, Given Suffix', '%l, %f %s', True),
+            (2, 'Given Surname Suffix', '%f %l %s', True),
+            (4, 'Given', '%f', True),
+            (5, 'Main Surnames, Given Patronymic Suffix Prefix', '%1m %2m %o, %f %1y %s %0m', True),
+            (-1, 'Surname, Name|Common Suffix', 'Surname, Name|Common Suffix', True)
+        ]
+        self.assertEqual(expected_name_format, actual_name_format)
+
+    def test_get_name_format_for_all_custom_formats(self):
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        actual_name_format = self.name_display.get_name_format(also_default=True, only_custom=True, only_active=False)
+
+        expected_name_format = [
+            (-2, 'SURNAME, Given Suffix (Call)', 'SURNAME, Given Suffix (Call)', False),
+            (-1, 'Surname, Name|Common Suffix', 'Surname, Name|Common Suffix', True)
+        ]
+        self.assertEqual(expected_name_format, actual_name_format)
+
+    def test_get_name_format_for_active_custom_formats(self):
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        actual_name_format = self.name_display.get_name_format(also_default=True, only_custom=True, only_active=True)
+
+        expected_name_format = [
+            (-1, 'Surname, Name|Common Suffix', 'Surname, Name|Common Suffix', True)
+        ]
+        self.assertEqual(expected_name_format, actual_name_format)
+
+    def test_clear_custom_formats(self):
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        self.name_display.clear_custom_formats()
+
+        actual_name_format = self.name_display.get_name_format(also_default=False, only_custom=True, only_active=False)
+
+        self.assertEqual([], actual_name_format)
+
+    def test_do_not_clear_default_formats(self):
+        self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.add_inactive_custom_name_format('SURNAME, Given Suffix (Call)')
+
+        self.name_display.clear_custom_formats()
+
+        actual_name_format = self.name_display.get_name_format(also_default=True, only_custom=False, only_active=False)
+
+        expected_name_format = [
+            (0, 'Default format (defined by Gramps preferences)', '', True),
+            (1, 'Surname, Given Suffix', '%l, %f %s', True),
+            (2, 'Given Surname Suffix', '%f %l %s', True),
+            (3, 'Patronymic, Given', '%y, %s %f', False),
+            (4, 'Given', '%f', True),
+            (5, 'Main Surnames, Given Patronymic Suffix Prefix', '%1m %2m %o, %f %1y %s %0m', True),
+        ]
+
+        self.assertEqual(expected_name_format, actual_name_format)
+
+    def test_set_name_format(self):
+        standard_formats_overrides = [
+            (0, "Default", '', True),
+            (1, "Surname", '%l', True),
+            (2, "Suffix", '%s', True),
+            (3, "Given", '%s', False),
+            (4, "Patronymic", '%y', True),
+            (5, "Prefix", '%0m', True),
+        ]
+
+        self.name_display.set_name_format(standard_formats_overrides)
+
+        actual_name_format = self.name_display.get_name_format(also_default=True, only_custom=False, only_active=False)
+
+        self.assertEqual(standard_formats_overrides, actual_name_format)
+
+    def test_add_existing_name_format(self):
+        self.assertEqual(
+            self.add_custom_name_format('Surname, Name|Common Suffix'),
+            self.add_custom_name_format('Surname, Name|Common Suffix')
+        )
+
+    def test_delete_name_format(self):
+        index = self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.name_display.del_name_format(index)
+
+        actual_name_format = self.name_display.get_name_format(also_default=True, only_custom=True, only_active=True)
+
+        self.assertEqual([], actual_name_format)
+
+    def test_set_default_format_to_custom_format(self):
+        index = self.add_custom_name_format('Surname, Name|Common Suffix')
+        self.name_display.set_default_format(index)
+        self.assertEqual(index, self.name_display.get_default_format())
+
+    def test_set_default_format_to_non_existing_format(self):
+        index = self.name_display.get_default_format()
+        self.name_display.set_default_format(-100)
+        self.assertEqual(index, self.name_display.get_default_format())
+
+    def test_display_name_with_valid_format(self):
+        name = Name()
+        name.set_first_name('William')
+        name.set_call_name('Will')
+        name.set_display_as(4)
+
+        actual_display_name = self.name_display.display_name(name)
+
+        self.assertEqual('William', actual_display_name)
+
+    def test_display_name_with_invalid_format(self):
+        name = Name()
+        name.set_first_name('William')
+        name.set_call_name('Will')
+        name.set_display_as(-100)
+
+        display_name = self.name_display.display_name(name)
+
+        self.assertEqual(', William', display_name)
+
+    def test_display_no_name(self):
+        self.assertEqual('', self.name_display.display_name(None))
+
+    def add_custom_name_format(self, name_format):
+        return self.name_display.add_name_format(name_format, name_format)
+
+    def add_inactive_custom_name_format(self, name_format):
+        index = self.name_display.add_name_format(name_format, name_format)
+        self.name_display.set_format_inactive(index)
+
+
+if __name__ == '__main__':
+    unittest.main()