feat(app): Provide date 'collapsing' for same-month ranges

Closes #45
alexpovel · Sep 3, 2022 · 5e4cc52 · 5e4cc52
1 parent b6c97b5
commit 5e4cc52
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 2 deletions.
diff --git a/ancv/visualization/themes.py b/ancv/visualization/themes.py
@@ -22,6 +22,7 @@ def date_range(
         fmt: str,
         sep: str = "-",
         ongoing: str = "present",
+        collapse: bool = True,
     ) -> str:
         if start is None:
             if end is None:
@@ -31,6 +32,10 @@ def date_range(
         if end is None:
             return f"{start.strftime(fmt)} {sep} {ongoing}"
 
+        collapsible = start.month == end.month and start.year == end.year
+        if collapsible and collapse:
+            return f"{end.strftime(fmt)}"
+
         return f"{start.strftime(fmt)} {sep} {end.strftime(fmt)}"
 
 

diff --git a/tests/visualization/test_themes.py b/tests/visualization/test_themes.py
@@ -7,7 +7,7 @@
 
 
 @pytest.mark.parametrize(
-    ["start", "end", "fmt", "sep", "ongoing", "expected"],
+    ["start", "end", "fmt", "sep", "ongoing", "expected", "collapse"],
     [
         (
             None,
@@ -16,6 +16,7 @@
             "",
             "",
             "",
+            False,
         ),
         (
             None,
@@ -24,6 +25,7 @@
             "",
             "",
             "",
+            False,
         ),
         (
             None,
@@ -32,6 +34,7 @@
             "-",
             "",
             "",
+            False,
         ),
         (
             None,
@@ -40,6 +43,7 @@
             "-",
             "present",
             "",
+            False,
         ),
         (
             date(2020, 1, 1),
@@ -48,6 +52,7 @@
             "",
             "",
             "2020-01-01  ",
+            False,
         ),
         (
             date(2020, 1, 10),
@@ -56,6 +61,7 @@
             "",
             "",
             "2020-01-10  ",
+            False,
         ),
         (
             date(2020, 1, 1),
@@ -64,6 +70,7 @@
             "-",
             "",
             "2020-01-01 - ",
+            False,
         ),
         (
             date(2020, 1, 1),
@@ -72,6 +79,7 @@
             "-",
             "present",
             "2020-01-01 - present",
+            False,
         ),
         (
             date(2020, 1, 1),
@@ -80,6 +88,7 @@
             "...",
             "present",
             "2020-01-01 ... present",
+            False,
         ),
         (
             date(2020, 1, 1),
@@ -88,6 +97,7 @@
             "",
             "",
             "2020-01-01  2020-01-02",
+            False,
         ),
         (
             date(2020, 1, 1),
@@ -96,6 +106,7 @@
             "-",
             "",
             "2020-01-01 - 2020-01-02",
+            False,
         ),
         (
             None,
@@ -104,6 +115,7 @@
             "",
             "",
             " 2020-01-02",
+            False,
         ),
         (
             None,
@@ -112,6 +124,7 @@
             "-",
             "",
             "- 2020-01-02",
+            False,
         ),
         (
             None,
@@ -120,6 +133,61 @@
             "-",
             "present",
             "- 2020-01-02",
+            False,
+        ),
+        (
+            date(2020, 1, 1),
+            date(2020, 1, 2),
+            "%Y-%m",
+            "",
+            "",
+            "2020-01",
+            True,
+        ),
+        (
+            date(2020, 1, 1),
+            date(2020, 1, 2),
+            "%Y-%m",
+            "-",
+            "",
+            "2020-01",
+            True,
+        ),
+        (
+            date(2020, 1, 1),
+            date(2020, 1, 31),
+            "%Y-%m",
+            "-",
+            "",
+            "2020-01",
+            True,
+        ),
+        (
+            date(2020, 1, 1),
+            date(2020, 2, 1),
+            "%Y-%m",
+            "-",
+            "",
+            "2020-01 - 2020-02",
+            True,
+        ),
+        (
+            date(2020, 12, 1),
+            date(2020, 12, 31),
+            "%B %Y",
+            "-",
+            "",
+            "December 2020",
+            True,
+        ),
+        (
+            date(2020, 1, 1),
+            date(2020, 2, 1),
+            "%B %Y",
+            "-",
+            "",
+            "January 2020 - February 2020",
+            True,
         ),
     ],
 )
@@ -130,5 +198,6 @@ def test_default_date_range(
     sep: str,
     ongoing: str,
     expected: str,
+    collapse: bool,
 ) -> None:
-    assert Theme.date_range(start, end, fmt, sep, ongoing) == expected
+    assert Theme.date_range(start, end, fmt, sep, ongoing, collapse) == expected