Render page notes differently than annotations (#11)

src/slack_annotations/format.py

@@ -6,8 +6,8 @@
 
 
 def _format_annotation(annotation: dict[str, Any]) -> dict[str, Any]:
-    fields = _build_annotation_fields(annotation)
     summary = _build_annotation_summary(annotation)
+    fields = _build_annotation_fields(annotation)
     return {
         "type": "section",
         "text": {"type": "mrkdwn", "text": summary},
@@ -85,17 +85,28 @@ def _build_annotation_summary(annotation: dict[str, Any]) -> str:
 
 
 def _build_annotation_fields(annotation: dict[str, Any]) -> list[dict[str, Any]]:
+    quote = None
     try:
         quote = _get_quote(annotation)
     except Exception:  # pylint:disable=broad-exception-caught
-        quote = NONE_TEXT
-
-    return [
-        {"type": "mrkdwn", "text": "*Quote:*"},
-        {
-            "type": "mrkdwn",
-            "text": f"*Annotation* (<{annotation['links']['incontext']}|in-context link>):",
-        },
-        {"type": "plain_text", "text": quote},
-        {"type": "plain_text", "text": _get_text(annotation)},
-    ]
+        pass
+    incontext_link = annotation["links"]["incontext"]
+
+    if quote:
+        fields = [
+            {"type": "mrkdwn", "text": "*Quote:*"},
+            {
+                "type": "mrkdwn",
+                "text": f"*Annotation* (<{incontext_link}|in-context link>):",
+            },
+            {"type": "plain_text", "text": quote},
+        ]
+    else:
+        fields = [
+            {
+                "type": "mrkdwn",
+                "text": f"*Page Note* (<{incontext_link}|in-context link>):",
+            },
+        ]
+    fields.append({"type": "plain_text", "text": _get_text(annotation)})
+    return fields

tests/functional/cli_test.py

@@ -98,12 +98,10 @@ def slack_annotations():
                     "text": "`test_user_1` (md............................) annotated <https://example.com/|Annotating the law | Hypothes.is>:",
                 },
                 "fields": [
-                    {"type": "mrkdwn", "text": "*Quote:*"},
                     {
                         "type": "mrkdwn",
-                        "text": "*Annotation* (<https://hyp.is/test_annotation_id_1/example.com/|in-context link>):",
+                        "text": "*Page Note* (<https://hyp.is/test_annotation_id_1/example.com/|in-context link>):",
                     },
-                    {"type": "plain_text", "text": "(None)"},
                     {"type": "plain_text", "text": "test_user_1 reply"},
                 ],
             },

tests/unit/slack_annotations/core_test.py

@@ -112,12 +112,10 @@ def slack_annotations():
                     "text": "`test_user_1` (md............................) annotated <https://example.com/|Annotating the law | Hypothes.is>:",
                 },
                 "fields": [
-                    {"type": "mrkdwn", "text": "*Quote:*"},
                     {
                         "type": "mrkdwn",
-                        "text": "*Annotation* (<https://hyp.is/test_annotation_id_1/example.com/|in-context link>):",
+                        "text": "*Page Note* (<https://hyp.is/test_annotation_id_1/example.com/|in-context link>):",
                     },
-                    {"type": "plain_text", "text": "(None)"},
                     {"type": "plain_text", "text": "test_user_1 reply"},
                 ],
             },

tests/unit/slack_annotations/format_test.py

@@ -48,6 +48,12 @@ def test_without_title(self):
             "uri": "https://example.com/",
             "links": {"incontext": "https://hyp.is/test_annotation_id_1/example.com/"},
             "user_info": {"display_name": "md............................"},
+            "target": [
+                {
+                    "source": "https://web.hypothes.is/blog/step-by-step-guide-to-using-hypothesis-for-collaborative-projects/",
+                    "selector": [{"exact": "Annotated text"}],
+                }
+            ],
         }
 
         assert _format_annotation(annotation) == {
@@ -62,7 +68,7 @@ def test_without_title(self):
                     "type": "mrkdwn",
                     "text": "*Annotation* (<https://hyp.is/test_annotation_id_1/example.com/|in-context link>):",
                 },
-                {"type": "plain_text", "text": "(None)"},
+                {"type": "plain_text", "text": "Annotated text"},
                 {"type": "plain_text", "text": "(None)"},
             ],
         }
@@ -83,12 +89,33 @@ def test_without_user_info(self):
                 "text": "`test_user_1` annotated <https://example.com/|Annotation title>:",
             },
             "fields": [
-                {"type": "mrkdwn", "text": "*Quote:*"},
                 {
                     "type": "mrkdwn",
-                    "text": "*Annotation* (<https://hyp.is/test_annotation_id_1/example.com/|in-context link>):",
+                    "text": "*Page Note* (<https://hyp.is/test_annotation_id_1/example.com/|in-context link>):",
                 },
                 {"type": "plain_text", "text": "(None)"},
+            ],
+        }
+
+    def test_page_note(self):
+        annotation = {
+            "user": "acct:[email protected]",
+            "uri": "https://example.com/",
+            "links": {"incontext": "https://hyp.is/test_annotation_id_1/example.com/"},
+            "user_info": {"display_name": "md............................"},
+        }
+
+        assert _format_annotation(annotation) == {
+            "type": "section",
+            "text": {
+                "type": "mrkdwn",
+                "text": "`test_user_1` (md............................) annotated https://example.com/:",
+            },
+            "fields": [
+                {
+                    "type": "mrkdwn",
+                    "text": "*Page Note* (<https://hyp.is/test_annotation_id_1/example.com/|in-context link>):",
+                },
                 {"type": "plain_text", "text": "(None)"},
             ],
         }