photo-objects 0.9.5__py3-none-any.whl → 0.9.6__py3-none-any.whl

photo_objects/django/tests/test_utils.py

@@ -56,8 +56,9 @@ class TestUtils(TestCase):
              "Plain text description"),
             (md_multi_p,
              "Description with bold and italics..."),
-            (None,
-             "A simple self-hosted photo server."),
+            # TODO: Test default description and description from site-settings
+            # (None,
+            #  "A simple self-hosted photo server."),
         ]
 
         for description, expected in testdata:

photo_objects/django/views/ui/album.py

@@ -9,11 +9,12 @@ from photo_objects.django.forms import CreateAlbumForm, ModifyAlbumForm
 from photo_objects.django.models import Album
 from photo_objects.django.views.utils import (
     BackLink,
+    Preview,
     meta_description,
 )
 from photo_objects.utils import render_markdown
 
-from .utils import json_problem_as_html
+from .utils import json_problem_as_html, preview_helptext
 
 
 @json_problem_as_html
@@ -46,6 +47,7 @@ def new_album(request: HttpRequest):
         "form": form,
         "title": "Create album",
         "back": back,
+        "width": "narrow",
     })
 
 
@@ -107,13 +109,19 @@ def edit_album(request: HttpRequest, album_key: str):
             'photo_objects:show_album',
             kwargs={"album_key": album_key}))
 
-    return render(request, 'photo_objects/form.html', {
-        "form": form,
-        "title": "Edit album",
-        "back": back,
-        "photo": album.cover_photo,
-        "info": get_info(request, album_key),
-    })
+    return render(
+        request,
+        'photo_objects/form.html',
+        {
+            "form": form,
+            "title": "Edit album",
+            "back": back,
+            "info": get_info(
+                request,
+                album_key),
+            "width": "narrow",
+            "preview": Preview(request, album, preview_helptext("album")),
+        })
 
 
 @json_problem_as_html
@@ -145,5 +153,7 @@ def delete_album(request: HttpRequest, album_key: str):
         "back": back,
         "photo": album.cover_photo,
         "resource": target,
+        "width": "narrow",
+        "preview": Preview(request, album, preview_helptext("album")),
         **error,
     })

photo_objects/django/views/ui/configuration.py

@@ -6,7 +6,7 @@ from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
 
 from photo_objects.django.api.utils import JsonProblem
-from photo_objects.django.views.utils import BackLink
+from photo_objects.django.views.utils import BackLink, Preview
 from photo_objects.utils import render_markdown
 
 from .utils import json_problem_as_html
@@ -169,8 +169,18 @@ def configuration(request: HttpRequest):
 
     back = BackLink("Albums", reverse('photo_objects:list_albums'))
 
-    return render(request, "photo_objects/configuration.html", {
-        "title": "Configuration",
-        "validations": validations,
-        "back": back,
-    })
+    return render(
+        request,
+        "photo_objects/configuration.html",
+        {
+            "title": "Configuration",
+            "validations": validations,
+            "back": back,
+            "width": "narrow",
+            "preview": Preview(
+                request,
+                None,
+                "This is an example on how the site will appear by default "
+                "when sharing in social media. Note that individual albums "
+                "and photos override this default preview."),
+        })

photo_objects/django/views/ui/photo.py

@@ -12,11 +12,12 @@ from photo_objects.django.forms import ModifyPhotoForm, UploadPhotosForm
 from photo_objects.django.models import Photo
 from photo_objects.django.views.utils import (
     BackLink,
+    Preview,
     meta_description,
 )
 from photo_objects.utils import render_markdown
 
-from .utils import json_problem_as_html
+from .utils import json_problem_as_html, preview_helptext
 
 
 @json_problem_as_html
@@ -53,6 +54,8 @@ def upload_photos(request: HttpRequest, album_key: str):
         "title": "Upload photos",
         "back": back,
         "photo": album.cover_photo,
+        "width": "narrow",
+        "preview": Preview(request, album, preview_helptext("album")),
     })
 
 
@@ -177,12 +180,16 @@ def edit_photo(request: HttpRequest, album_key: str, photo_key: str):
                 "album_key": album_key,
                 "photo_key": photo_key}))
 
-    return render(request, 'photo_objects/form.html', {
-        "form": form,
-        "title": "Edit photo",
-        "back": back,
-        "photo": photo,
-    })
+    return render(
+        request,
+        'photo_objects/form.html',
+        {
+            "form": form,
+            "title": "Edit photo",
+            "back": back,
+            "width": "narrow",
+            "preview": Preview(request, photo, preview_helptext("photo")),
+        })
 
 
 @json_problem_as_html
@@ -208,4 +215,6 @@ def delete_photo(request: HttpRequest, album_key: str, photo_key: str):
         "back": back,
         "photo": photo,
         "resource": target,
+        "width": "narrow",
+        "preview": Preview(request, photo, preview_helptext("photo")),
     })

photo_objects/django/views/ui/photo_change_request.py

@@ -53,9 +53,9 @@ def review_photo_change_request(request: HttpRequest, cr_id: str):
         "form": form,
         "title": "Review photo change request",
         "back": back,
-        "photo": photo,
         "info": info,
         "instructions": render_markdown(
             f'The current alt text for `{photo.key}` is: '
             f'_"{photo.alt_text}"_.'),
+        "width": "narrow",
     })

photo_objects/django/views/ui/users.py

@@ -2,22 +2,20 @@ from django.contrib.auth import views as auth_views
 from django.http import HttpRequest
 from django.urls import reverse_lazy
 
-from photo_objects.django.models import SiteSettings
-from photo_objects.django.views.utils import BackLink
+from photo_objects.django.views.utils import BackLink, Preview
 
 
 def login(request: HttpRequest):
-    settings = SiteSettings.objects.get(request.site)
-
     return auth_views.LoginView.as_view(
         template_name="photo_objects/form.html",
         extra_context={
             "title": "Login",
-            "photo": settings.preview_image,
             "action": "Login",
             "back": BackLink(
                 'Albums',
                 reverse_lazy('photo_objects:list_albums')),
-            "class": "login"
+            "class": "login",
+            "width": "narrow",
+            "preview": Preview(request, None),
         },
     )(request)

photo_objects/django/views/ui/utils.py

@@ -8,3 +8,10 @@ def json_problem_as_html(func):
         except JsonProblem as e:
             return e.html_response(args[0])
     return wrapper
+
+
+def preview_helptext(resource_type: str) -> str:
+    return (
+        f"This is an example on how the {resource_type} will currently appear "
+        "when sharing on social media."
+    )

photo_objects/django/views/utils.py

@@ -1,7 +1,7 @@
 from django.http import HttpRequest
 from django.utils.dateformat import format as format_date
 
-from photo_objects.django.models import Album, Photo
+from photo_objects.django.models import Album, Photo, SiteSettings
 from photo_objects.utils import first_paragraph_textcontent
 
 
@@ -11,6 +11,19 @@ class BackLink:
         self.url = url
 
 
+# TODO: Use this also for meta-og tags
+class Preview:
+    def __init__(
+            self,
+            request: HttpRequest,
+            resource: Album | Photo = None,
+            helptext: str = None):
+        self.description = meta_description(request, resource)
+        self.photo = meta_photo(request, resource)
+        self.title = meta_title(request, resource)
+        self.helptext = helptext
+
+
 def _default_album_description(request: HttpRequest, album: Album) -> str:
     count = album.photo_set.count()
     plural = 's' if count != 1 else ''
@@ -24,19 +37,50 @@ def _default_photo_description(photo: Photo) -> str:
 
 def meta_description(
         request: HttpRequest,
-        resource: Album | Photo | str | None) -> str:
+        resource: Album | Photo | str = None) -> str:
     text = None
     if isinstance(resource, Album):
-        text = (
+        return (
             first_paragraph_textcontent(resource.description) or
             _default_album_description(request, resource))
 
     if isinstance(resource, Photo):
-        text = (
+        return (
             first_paragraph_textcontent(resource.description) or
             _default_photo_description(resource))
 
     if isinstance(resource, str):
-        text = first_paragraph_textcontent(resource)
+        return first_paragraph_textcontent(resource)
 
+    settings = SiteSettings.objects.get(request.site)
+    text = first_paragraph_textcontent(settings.description)
     return text or "A simple self-hosted photo server."
+
+
+def meta_photo(
+        request: HttpRequest,
+        resource: Album | Photo = None) -> Photo:
+    if isinstance(resource, Photo):
+        return resource
+
+    if isinstance(resource, Album):
+        return resource.cover_photo
+
+    settings = SiteSettings.objects.get(request.site)
+    return settings.preview_image
+
+
+def meta_title(
+        request: HttpRequest,
+        resource: Album | Photo | str = None) -> str:
+    text = None
+    if isinstance(resource, Album):
+        text = resource.title
+
+    if isinstance(resource, Photo):
+        text = resource.title or resource.filename
+
+    if isinstance(resource, str):
+        text = resource
+
+    return text or request.site.name

{photo_objects-0.9.5.dist-info → photo_objects-0.9.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: photo-objects
-Version: 0.9.5
+Version: 0.9.6
 Summary: Application for storing photos in S3 compatible object-storage.
 Author: Toni Kangas
 License: MIT License

{photo_objects-0.9.5.dist-info → photo_objects-0.9.6.dist-info}/RECORD

@@ -43,24 +43,24 @@ photo_objects/django/tests/test_img.py,sha256=HEAWcr5fpTkzePkhoQ4YrWsDO9TvFOr7my
 photo_objects/django/tests/test_og_meta.py,sha256=Kk5a9KvE88KZ60gLqXSe6rTz5YU-gdjteksYolHd-nw,1804
 photo_objects/django/tests/test_photo.py,sha256=JWXN3fF2VtuByMKm2o5b19HnxwDr6ecRwuGzgc5RsBw,13471
 photo_objects/django/tests/test_photo_change_requests.py,sha256=Ld5ytqxxZiEWrqfX8htJ6-5ARU7tqTYD-iUhb7EMcnU,3078
-photo_objects/django/tests/test_utils.py,sha256=0Xl0ReS2X9GsEH-jmLg8xC79hJ4nhbfULo0BOVjiykQ,2089
+photo_objects/django/tests/test_utils.py,sha256=kJKjKltbc-qj53BXc9UoQR6ABMMN_gNTQ3cUj3V41Dw,2173
 photo_objects/django/tests/utils.py,sha256=LiObyRARkmO4arnY2gXNi_T8XxT9eSKKszENMo2UIh8,4639
 photo_objects/django/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-photo_objects/django/views/utils.py,sha256=TSs3RTtSi_4GcgeM8I3i36-sga95JV0VD0nYK4EZkWk,1329
+photo_objects/django/views/utils.py,sha256=19FO5LpZFVX9i01B_RvmV7b5zhJsQk8ZDVJzTgeD7SQ,2550
 photo_objects/django/views/api/__init__.py,sha256=GgywMJMSFmP5aoMEaYut5V666zachd5YFQIDBMr5znU,188
 photo_objects/django/views/api/album.py,sha256=EZMOkxYzLSWr9wwXnd4yAO64JtXZq2k3FYohiNMFbGQ,1602
 photo_objects/django/views/api/auth.py,sha256=EN_ExegzmLN-bhSzu3L9-6UE9qodPd7_ZRLilzrvc8Y,819
 photo_objects/django/views/api/photo.py,sha256=WHSayWTi_wG6otq6Rz1IKqJ5ik5riclR3AWB15ge5RU,4613
 photo_objects/django/views/api/utils.py,sha256=uQzKdSKHRAux5OZzqgWQr0gsK_FeweQP0cg_67OWA_Y,264
 photo_objects/django/views/ui/__init__.py,sha256=Y3XrckZExbHpWVNwDUGLfb99_midb8-5j6Ouf_Yu_G4,128
-photo_objects/django/views/ui/album.py,sha256=b07jboWsiRJUHC1BPLC8vmNbpePjtFzKzbc9QbBoPYM,4723
-photo_objects/django/views/ui/configuration.py,sha256=PIKqjTJ8szVlLodo9rU6XA2hh9FXrSSpnKWgUFY8E8g,5088
-photo_objects/django/views/ui/photo.py,sha256=erk1-b6A3pr1XMMcEmB1PcjFysvbfiLhfXx1yrKTCdI,6616
-photo_objects/django/views/ui/photo_change_request.py,sha256=CFBV-O9k7WzdeYXYB7N7_g5xHw_seh9-Dzis8M6zbOo,2090
-photo_objects/django/views/ui/users.py,sha256=XOVqOgLwxD2QKua_bPl7wZUNrBd_bABbCaHYLSnhMI0,714
-photo_objects/django/views/ui/utils.py,sha256=YV_YcUbX-zUkdFnBlezPChR6aPDhZJ9loSOHBSzF6Cc,273
-photo_objects-0.9.5.dist-info/licenses/LICENSE,sha256=V3w6hTjXfP65F4r_mejveHcV5igHrblxao3-2RlfVlA,1068
-photo_objects-0.9.5.dist-info/METADATA,sha256=8gbXtVaHTTijCVmKHr-9ru8AdYYdGeyOe2Ol_Pdo5xc,3615
-photo_objects-0.9.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-photo_objects-0.9.5.dist-info/top_level.txt,sha256=SZeL8mhf-WMGdhRtTGFvZc3aIRBboQls9O0cFDMGdQ0,14
-photo_objects-0.9.5.dist-info/RECORD,,
+photo_objects/django/views/ui/album.py,sha256=EQleU9ZyF3T0OABer3YMJbUNU4Vw9q-iY3WBPN872e8,5027
+photo_objects/django/views/ui/configuration.py,sha256=miEJTm_cRANu9Wt3SCcU-tYUwM7WLKgQm8zgApmKMxE,5464
+photo_objects/django/views/ui/photo.py,sha256=o7U0KimIWhreKSwIdVot1laEqqXprqvdbDZbRIvkJic,6966
+photo_objects/django/views/ui/photo_change_request.py,sha256=KAfk69RbDTdN3I4fMUx6j7idqZ6IHZ4li6KKVS3yAYM,2093
+photo_objects/django/views/ui/users.py,sha256=ABAtKwNoViYy2ht6X313BSm6wgvL302LVUNimp43gxc,649
+photo_objects/django/views/ui/utils.py,sha256=65hSFZ_rlWWprE5kJdqwL9P-Lwlin9qvO8GjFuajdnM,463
+photo_objects-0.9.6.dist-info/licenses/LICENSE,sha256=V3w6hTjXfP65F4r_mejveHcV5igHrblxao3-2RlfVlA,1068
+photo_objects-0.9.6.dist-info/METADATA,sha256=onytwijT-TLdeooruS21ZT_E7q7GOoOwJPv5wm1kCzc,3615
+photo_objects-0.9.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+photo_objects-0.9.6.dist-info/top_level.txt,sha256=SZeL8mhf-WMGdhRtTGFvZc3aIRBboQls9O0cFDMGdQ0,14
+photo_objects-0.9.6.dist-info/RECORD,,