photo-objects 0.9.5__tar.gz → 0.9.6__tar.gz

{photo_objects-0.9.5 → photo_objects-0.9.6}/PKG-INFO

@@ -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 → photo_objects-0.9.6}/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-0.9.5 → photo_objects-0.9.6}/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-0.9.5 → photo_objects-0.9.6}/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-0.9.5 → photo_objects-0.9.6}/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-0.9.5 → photo_objects-0.9.6}/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-0.9.5 → photo_objects-0.9.6}/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-0.9.5 → photo_objects-0.9.6}/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-0.9.6/photo_objects/django/views/utils.py

@@ -0,0 +1,86 @@
+from django.http import HttpRequest
+from django.utils.dateformat import format as format_date
+
+from photo_objects.django.models import Album, Photo, SiteSettings
+from photo_objects.utils import first_paragraph_textcontent
+
+
+class BackLink:
+    def __init__(self, text: str, url: str):
+        self.text = text
+        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 ''
+    return f"Album with {count} photo{plural} in {request.site.name}."
+
+
+def _default_photo_description(photo: Photo) -> str:
+    date_str = format_date(photo.timestamp, "F Y")
+    return f"Photo from {date_str} in {photo.album.title} album."
+
+
+def meta_description(
+        request: HttpRequest,
+        resource: Album | Photo | str = None) -> str:
+    text = None
+    if isinstance(resource, Album):
+        return (
+            first_paragraph_textcontent(resource.description) or
+            _default_album_description(request, resource))
+
+    if isinstance(resource, Photo):
+        return (
+            first_paragraph_textcontent(resource.description) or
+            _default_photo_description(resource))
+
+    if isinstance(resource, str):
+        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 → photo_objects-0.9.6}/photo_objects.egg-info/PKG-INFO

@@ -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 → photo_objects-0.9.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "photo-objects"
-version = "0.9.5"
+version = "0.9.6"
 dependencies = [
     "markdown~=3.7",
     "minio>=7.2.0,<7.2.19",

photo_objects-0.9.5/photo_objects/django/views/utils.py

@@ -1,42 +0,0 @@
-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.utils import first_paragraph_textcontent
-
-
-class BackLink:
-    def __init__(self, text: str, url: str):
-        self.text = text
-        self.url = url
-
-
-def _default_album_description(request: HttpRequest, album: Album) -> str:
-    count = album.photo_set.count()
-    plural = 's' if count != 1 else ''
-    return f"Album with {count} photo{plural} in {request.site.name}."
-
-
-def _default_photo_description(photo: Photo) -> str:
-    date_str = format_date(photo.timestamp, "F Y")
-    return f"Photo from {date_str} in {photo.album.title} album."
-
-
-def meta_description(
-        request: HttpRequest,
-        resource: Album | Photo | str | None) -> str:
-    text = None
-    if isinstance(resource, Album):
-        text = (
-            first_paragraph_textcontent(resource.description) or
-            _default_album_description(request, resource))
-
-    if isinstance(resource, Photo):
-        text = (
-            first_paragraph_textcontent(resource.description) or
-            _default_photo_description(resource))
-
-    if isinstance(resource, str):
-        text = first_paragraph_textcontent(resource)
-
-    return text or "A simple self-hosted photo server."