From d9f24307acc9f3f7cfa01c5e47f161b3aa390a81 Mon Sep 17 00:00:00 2001
From: Rhet Turnbull <rturnbull+git@gmail.com>
Date: Sun, 11 Apr 2021 19:45:50 -0700
Subject: [PATCH] Added {favorite} template, partial fix for #289

---
 README.md                  |   5 +++++
 docs/osxphotos.pdf         | Bin 253052 -> 253052 bytes
 osxphotos/phototemplate.py |   3 +++
 tests/photoinfo_mock.py    |   8 ++++++++
 tests/test_template.py     |  11 +++++++++++
 5 files changed, 27 insertions(+)

diff --git a/README.md b/README.md
index 4e4e9283..cfc748a8 100644
--- a/README.md
+++ b/README.md
@@ -962,6 +962,10 @@ Substitution                    Description
                                 True/False value, use in format
                                 '{edited?VALUE_IF_TRUE,VALUE_IF_FALSE}'
 
+{favorite}                      Photo has been marked as favorite?; True/False
+                                value, use in format
+                                '{favorite?VALUE_IF_TRUE,VALUE_IF_FALSE}'
+
 {created.date}                  Photo's creation date in ISO format, e.g.
                                 '2020-03-22'
 
@@ -2705,6 +2709,7 @@ The following template field substitutions are availabe for use with `PhotoInfo.
 |{photo_or_video}|'photo' or 'video' depending on what type the image is. To customize, use default value as in '{photo_or_video,photo=fotos;video=videos}'|
 |{hdr}|Photo is HDR?; True/False value, use in format '{hdr?VALUE_IF_TRUE,VALUE_IF_FALSE}'|
 |{edited}|Photo has been edited (has adjustments)?; True/False value, use in format '{edited?VALUE_IF_TRUE,VALUE_IF_FALSE}'|
+|{favorite}|Photo has been marked as favorite?; True/False value, use in format '{favorite?VALUE_IF_TRUE,VALUE_IF_FALSE}'|
 |{created.date}|Photo's creation date in ISO format, e.g. '2020-03-22'|
 |{created.year}|4-digit year of photo creation time|
 |{created.yy}|2-digit year of photo creation time|
diff --git a/docs/osxphotos.pdf b/docs/osxphotos.pdf
index c3a3a787d8e87008888c8fbb3f74f1c203ab1e1e..0b3634a607455943392842e42949cc08dda99ec5 100644
GIT binary patch
delta 361
zcmeyfga6MC{td-K^%g1)w|GzF-eQcn$tNrOTENEcofYR1zx_|2{QjrGBCW8a{ENQ5
zOtg@}iUy;^45dBq?i9Ih*!Gu+qqy%w>8`EJ@{?29{og%2R2qEe>s)^YIa5vNO6K!&
zi?xnuXsijiwqeb$ht>Pv_Wuo7f9g;N&zdr+KOSc!ihB%%kEZNZf3VT_?XBkv*XGXD
zayoyaB<*s1nM`nUm%y8gFM0BBKX#dB75ufbqJHJkO|R=juSqubbg3nGSY1;WnaT6{
zZ=#Svyl?Y_4<7L~2XhPU?<@<*ovwI?QMfrsxIIXi5r~<#2MIIBZr3(6G_*7^F*egR
zFjqG)P}k(r_svgnNi0cK&~ULbGB7eUFo7xAe(MyoGK;gRnVE~Di?e}?vzxPpiHWJP
fxv`6zi;1b3lcTYTrHiqhf(;=h+a1m`+wcMaKpc(A

delta 361
zcmeyfga6MC{td-K^&CP9Z`q!hy=7Rl!P)(|6-$5r?l7i}m-8)u?z87QC@pZu^4E0v
zK3z_U5QmutCW3Kgd0W+P+^FMhv2_1ob@x_d|H)0w?&bB*cImzQbWL5Lf7X<Rdz#Yw
z14WZWM8Y(rBSQav*n9um@wye)Q!`!I!mN4gRK$8L-6A@YHr*5caKX3i?d1#Cw)u!I
zOi!70^UHME<5y-Vu~e7LdYD^1=R{EYDm(u7=eI_b-Ccjk%6UTI#T1^v<G)&zCO^!o
zpRxM$Q4<c%{x3Jh?}&V7zPm7>WV+%VM&afl;r1Y5Mj&R|9wf{hyItGB(!ku<)WlfV
zz+BzHKwXnd-#0(SC9xz`LBqw$$iT?Zzyzjb`>j*V$}G+XPHq;4ZZ2jPPL7VoZsrz7
f#zxKtmTs1Y76vYk=57Xd3O0n4Y<D=%Y{LrxIk=5Z

diff --git a/osxphotos/phototemplate.py b/osxphotos/phototemplate.py
index 2e1c94e5..d8082ade 100644
--- a/osxphotos/phototemplate.py
+++ b/osxphotos/phototemplate.py
@@ -48,6 +48,7 @@ TEMPLATE_SUBSTITUTIONS = {
     "{photo_or_video}": "'photo' or 'video' depending on what type the image is. To customize, use default value as in '{photo_or_video,photo=fotos;video=videos}'",
     "{hdr}": "Photo is HDR?; True/False value, use in format '{hdr?VALUE_IF_TRUE,VALUE_IF_FALSE}'",
     "{edited}": "Photo has been edited (has adjustments)?; True/False value, use in format '{edited?VALUE_IF_TRUE,VALUE_IF_FALSE}'",
+    "{favorite}": "Photo has been marked as favorite?; True/False value, use in format '{favorite?VALUE_IF_TRUE,VALUE_IF_FALSE}'",
     "{created.date}": "Photo's creation date in ISO format, e.g. '2020-03-22'",
     "{created.year}": "4-digit year of photo creation time",
     "{created.yy}": "2-digit year of photo creation time",
@@ -539,6 +540,8 @@ class PhotoTemplate:
             value = "hdr" if self.photo.hdr else None
         elif field == "edited":
             value = "edited" if self.photo.hasadjustments else None
+        elif field == "favorite":
+            value = "favorite" if self.photo.favorite else None
         elif field == "created.date":
             value = DateTimeFormatter(self.photo.date).date
         elif field == "created.year":
diff --git a/tests/photoinfo_mock.py b/tests/photoinfo_mock.py
index ad029487..942fc55f 100644
--- a/tests/photoinfo_mock.py
+++ b/tests/photoinfo_mock.py
@@ -23,6 +23,14 @@ class PhotoInfoMock(PhotoInfo):
             else self._photo.hdr
         )
 
+    @property
+    def favorite(self):
+        return (
+            self._mock_favorite
+            if getattr(self, "_mock_favorite", None) is not None
+            else self._photo.favorite
+        )
+
     @property
     def hasadjustments(self):
         return (
diff --git a/tests/test_template.py b/tests/test_template.py
index 1f71eefe..2a19ddd3 100644
--- a/tests/test_template.py
+++ b/tests/test_template.py
@@ -28,6 +28,7 @@ UUID_DICT = {
     "mojave_album_1": "15uNd7%8RguTEgNPKHfTWw",
     "date_modified": "A9B73E13-A6F2-4915-8D67-7213B39BAE9F",
     "date_not_modified": "128FB4C6-0B16-4E7D-9108-FB2E90DA1546",
+    "favorite": "E9BC5C36-7CD1-40A1-A72B-8B8FAC227D51",
 }
 
 UUID_MEDIA_TYPE = {
@@ -176,6 +177,8 @@ TEMPLATE_VALUES = {
     "{exif.lens_model}": "iPhone 6s back camera 4.15mm f/2.2",
     "{album?{folder_album},{created.year}/{created.mm}}": "2020/02",
     "{title?Title is '{title} - {descr}',No Title}": "Title is 'Glen Ord - Jack Rose Dining Saloon'",
+    "{favorite}": "_",
+    "{favorite?FAV,NOTFAV}": "NOTFAV",
 }
 
 
@@ -831,6 +834,14 @@ def test_edited(photosdb):
     assert rendered == ["edited"]
 
 
+def test_favorite(photosdb):
+    """ Test favorite"""
+    photo = photosdb.get_photo(UUID_MULTI_KEYWORDS)
+    photomock = PhotoInfoMock(photo, favorite=True)
+    rendered, _ = photomock.render_template("{favorite}")
+    assert rendered == ["favorite"]
+
+
 def test_nested_template_bool(photosdb):
     photo = photosdb.get_photo(UUID_MULTI_KEYWORDS)
     template = "{hdr?{edited?HDR_EDITED,HDR_NOT_EDITED},{edited?NOT_HDR_EDITED,NOT_HDR_NOT_EDITED}}"