Implement missing features around kind attribute

The query parser now recognizes the supported values and accepts any
prefix of them.  Unknown kind values result in a generic term query.

The "org" value is not transformed into "organisation" as this was some
awkward special case.

Author: lucc

khard/carddav_object.py

@@ -4,6 +4,11 @@
 which can be found here:
 - version 3.0: https://tools.ietf.org/html/rfc2426
 - version 4.0: https://tools.ietf.org/html/rfc6350
+
+For further details about the application and device values for the kind
+field see:
+- application: https://tools.ietf.org/html/rfc6473
+- device: https://tools.ietf.org/html/rfc6869
 """
 
 import copy
@@ -67,9 +72,13 @@ class VCardWrapper:
     by the vobject library are enforced here.
     """
 
-    _default_kind = "individual"
     _default_version = "3.0"
     _supported_versions = ("3.0", "4.0")
+    _default_kind = "individual"
+    # FIXME we support group for the kind attribute but we do not support
+    # member attributes in any way.
+    _supported_kinds = ("individual", "group", "org", "location",
+                        "application", "device")
 
     # vcard v3.0 supports the following type values
     phone_types_v3 = ("bbs", "car", "cell", "fax", "home", "isdn", "msg",
@@ -461,12 +470,16 @@ def _prepare_birthday_value(self, date: Date) -> tuple[Optional[str],
 
     @property
     def kind(self) -> str:
-        kind = self.get_first(self._kind_attribute_name().lower(), self._default_kind)
-        return kind if kind != "org" else "organisation"
+        return self.get_first(self._kind_attribute_name().lower(), self._default_kind)
 
     @kind.setter
     def kind(self, value: str) -> None:
-        value = value if value != "organisation" else "org"
+        if value == "":
+            self._delete_vcard_object(self._kind_attribute_name().lower())
+            return
+        value = value.lower()
+        if not any(k.startswith(value) for k in self._supported_kinds):
+            raise ValueError(f"Bad value for kind attribute: {value}")
         self.vcard.add(self._kind_attribute_name()).value = value
 
     def _kind_attribute_name(self) -> str:
@@ -1272,6 +1285,7 @@ def to_yaml(self) -> str:
 
         translation_table = {
             "Formatted name": self.formatted_name,
+            "Kind": self.kind,
             "Prefix": self._get_name_prefixes(),
             "First name": self._get_first_names(),
             "Additional": self._get_additional_names(),

khard/query.py

@@ -348,6 +348,11 @@ def parse(string: str) -> Union[TermQuery, FieldQuery]:
             return NameQuery(term)
         if field == FIELD_PHONE_NUMBERS:
             return PhoneNumberQuery(term)
+        if field == "kind":
+            for kind in carddav_object.CarddavObject._supported_kinds:
+                if kind.startswith(term.lower()):
+                    return FieldQuery(field, kind)
+            return TermQuery(string)
         if field in carddav_object.CarddavObject.get_properties():
             return FieldQuery(field, term)
     return TermQuery(string)

test/test_command_line_interface.py

@@ -219,9 +219,9 @@ def test_mixed_kinds(self):
         text = [line.rstrip() for line in stdout.getvalue().splitlines()]
         expected = [
             "Address book: tmp",
-            "Index    Name              Phone    Email    Kind            Uid",
-            "1        ACME Inc.                           organisation    4",
-            "2        Wile E. Coyote                      individual      1"]
+            "Index    Name              Phone    Email    Kind          Uid",
+            "1        ACME Inc.                           org           4",
+            "2        Wile E. Coyote                      individual    1"]
         self.assertListEqual(expected, text)
 
     def test_non_individual_kind(self):
@@ -230,8 +230,8 @@ def test_non_individual_kind(self):
         text = [line.rstrip() for line in stdout.getvalue().splitlines()]
         expected = [
             "Address book: tmp",
-            "Index    Name         Phone    Email    Kind            Uid",
-            "1        ACME Inc.                      organisation    4"]
+            "Index    Name         Phone    Email    Kind    Uid",
+            "1        ACME Inc.                      org     4"]
         self.assertListEqual(expected, text)
 
 

test/test_query.py

@@ -174,7 +174,7 @@ def test_individual_kind_query_without_kind_on_vcard(self):
 
     def test_org_kind_query_without_kind_on_vcard(self):
         vcard = load_contact("minimal.vcf")
-        query = FieldQuery("kind", "organisation")
+        query = FieldQuery("kind", "org")
         self.assertFalse(query.match(vcard))
 
     def test_kind_query_with_nonsensical_value(self):
@@ -183,12 +183,12 @@ def test_kind_query_with_nonsensical_value(self):
         self.assertFalse(query.match(vcard))
 
     def test_kind_query_with_explicit_match(self):
-        contact = TestCarddavObject(kind="organisation", version="4.0")
-        query = FieldQuery("kind", "organisation")
+        contact = TestCarddavObject(kind="org", version="4.0")
+        query = FieldQuery("kind", "org")
         self.assertTrue(query.match(contact))
 
     def test_kind_query_with_explicit_mismatch(self):
-        contact = TestCarddavObject(kind="organisation", version="4.0")
+        contact = TestCarddavObject(kind="org", version="4.0")
         query = FieldQuery("kind", "individual")
         self.assertFalse(query.match(contact))
 
@@ -254,10 +254,10 @@ def test_kind_queries(self):
         self.assertEqual(actual, expected)
 
     def test_non_sensical_kind_values_do_not_parse(self):
-        self.assertIsNone(parse("kind:foo"))
+        self.assertEqual(parse("kind:foo"), TermQuery("kind:foo"))
 
     def test_kind_queries_only_need_a_substring_of_the_enum(self):
         self.assertEqual(parse("kind:ind"), FieldQuery("kind", "individual"))
         self.assertEqual(parse("kind:i"), FieldQuery("kind", "individual"))
-        self.assertEqual(parse("kind:org"), FieldQuery("kind", "organisation"))
-        self.assertEqual(parse("kind:o"), FieldQuery("kind", "organisation"))
+        self.assertEqual(parse("kind:org"), FieldQuery("kind", "org"))
+        self.assertEqual(parse("kind:o"), FieldQuery("kind", "org"))

test/test_yaml.py

@@ -238,24 +238,25 @@ def test_update_fn(self):
     def test_update_kind(self):
         card = create_test_card(version="4.0")
         self.assertEqual(card.kind, "individual")
-        data = {"Kind": "organisation"}
+        data = {"Kind": "org"}
         data = to_yaml(data)
         card.update(data)
-        self.assertEqual(card.kind, "organisation")
+        self.assertEqual(card.kind, "org")
 
     def test_update_kind_on_3_0_card(self):
         card = create_test_card()
         self.assertEqual(card.kind, "individual")
-        data = {"Kind": "organisation"}
+        data = {"Kind": "org"}
         data = to_yaml(data)
         card.update(data)
-        self.assertEqual(card.kind, "organisation")
+        self.assertEqual(card.kind, "org")
 
     def test_update_with_bad_kind_field_fails(self):
         card = create_test_card(version="4.0")
         self.assertEqual(card.kind, "individual")
         data = to_yaml({"Kind": "foo"})
-        card.update(data)
+        with self.assertRaises(ValueError):
+            card.update(data)
         self.assertEqual(card.kind, "individual")
 
     def test_parse_field(self):