Improve page layout on mobile

* Enforce ordering on some metadata models
* Fix a 500 error while accessing flat pages
* Clean up HTML and fix cards (missing class)
* Make the "driver" app optional and disabled by default

.github/workflows/django.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       max-parallel: 2
       matrix:
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
     steps:
     - uses: actions/checkout@v3

ram/bookshelf/migrations/0008_alter_author_options_alter_publisher_options.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.6 on 2023-10-09 21:08
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("bookshelf", "0007_alter_book_options"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="author",
+            options={"ordering": ["last_name", "first_name"]},
+        ),
+        migrations.AlterModelOptions(
+            name="publisher",
+            options={"ordering": ["name"]},
+        ),
+    ]

ram/bookshelf/models.py

@@ -16,6 +16,9 @@ class Publisher(models.Model):
     country = CountryField(blank=True)
     website = models.URLField(blank=True)
 
+    class Meta:
+        ordering = ["name"]
+
     def __str__(self):
         return self.name
 
@@ -24,6 +27,9 @@ class Author(models.Model):
     first_name = models.CharField(max_length=100)
     last_name = models.CharField(max_length=100)
 
+    class Meta:
+        ordering = ["last_name", "first_name"]
+
     def __str__(self):
         return f"{self.last_name}, {self.first_name}"
 

ram/metadata/admin.py

@@ -15,6 +15,7 @@ from metadata.models import (
 
 @admin.register(Property)
 class PropertyAdmin(admin.ModelAdmin):
+    list_display = ("name", "private")
     search_fields = ("name",)
 
 

ram/metadata/migrations/0013_decoderdocument_private.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.5 on 2023-10-06 19:48
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0012_alter_decoder_manufacturer_decoderdocument"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="decoderdocument",
+            name="private",
+            field=models.BooleanField(default=False),
+        ),
+    ]

ram/metadata/migrations/0014_alter_decoder_options_alter_tag_options.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.6 on 2023-10-10 12:44
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("metadata", "0013_decoderdocument_private"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="decoder",
+            options={"ordering": ["manufacturer", "name"]},
+        ),
+        migrations.AlterModelOptions(
+            name="tag",
+            options={"ordering": ["name"]},
+        ),
+    ]

ram/metadata/models.py

@@ -95,6 +95,9 @@ class Decoder(models.Model):
         upload_to="images/", storage=DeduplicatedStorage, null=True, blank=True
     )
 
+    class Meta(object):
+        ordering = ["manufacturer", "name"]
+
     def __str__(self):
         return "{0} - {1}".format(self.manufacturer, self.name)
 
@@ -163,6 +166,9 @@ class Tag(models.Model):
     name = models.CharField(max_length=128, unique=True)
     slug = models.CharField(max_length=128, unique=True)
 
+    class Meta(object):
+        ordering = ["name"]
+
     def __str__(self):
         return self.name
 

ram/portal/models.py

@@ -66,12 +66,11 @@ class Flatpage(models.Model):
         return reverse("flatpage", kwargs={"flatpage": self.path})
 
     def get_link(self):
-        if self.published:
-            return mark_safe(
-                '<a href="{0}" target="_blank">Link</a>'.format(
-                    self.get_absolute_url()
-                )
+        return mark_safe(
+            '<a href="{0}" target="_blank">Link</a>'.format(
+                self.get_absolute_url()
             )
+        )
 
 
 @receiver(models.signals.pre_save, sender=Flatpage)

ram/portal/static/css/main.css

@@ -7,6 +7,11 @@ html[data-bs-theme='dark'] .navbar svg {
   width: 100%;
 }
 
+td > img.logo {
+  max-width: 200px;
+  max-height: 48px;
+}
+
 .btn > span {
   display: inline-block;
 }

ram/portal/templates/base.html

@@ -121,7 +121,7 @@
   </head>
   <body>
     <header>
-      <nav class="navbar navbar-expand-lg bg-body-tertiary shadow-sm">
+      <nav class="navbar navbar-expand-sm bg-body-tertiary shadow-sm">
         <div class="container d-flex">
           <div class="me-auto">
             <a href="{% url 'index' %}" class="navbar-brand d-flex align-items-center">
@@ -146,7 +146,10 @@
         <nav class="navbar navbar-expand-lg">
           <div class="container-fluid g-0">
             <a class="navbar-brand" href="{% url 'index' %}">Home</a>
-            <div class="navbar-collapse" id="navbarSupportedContent">
+            <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+            <span class="navbar-toggler-icon"></span>
+            </button>
+            <div class="collapse navbar-collapse" id="navbarSupportedContent">
               <ul class="navbar-nav me-auto mb-2 mb-lg-0">
                 <li class="nav-item dropdown">
                   <a class="nav-link dropdown-toggle" href="#" id="rosterDropdownMenu" role="button" data-bs-toggle="dropdown" aria-expanded="false">

ram/portal/templates/cards.html

@@ -3,7 +3,7 @@
         <p class="lead text-muted">Results found: {{ matches }}</p>
       {% endblock %}
       {% block cards_layout %}
-      <div class="row row-cols-1 row-cols-sm-2 row-cols-md-3 g-3">
+      <div class="row row-cols-1 row-cols-md-2 row-cols-lg-3 g-3">
       {% block cards %}
         {% for d in data %}
         {% if d.type == "rolling_stock" %}

ram/portal/templates/cards/book.html

@@ -1,11 +1,7 @@
         <div class="col">
           <div class="card shadow-sm">
-            {% if d.item.image.all %}
-            <a href="{{ d.item.get_absolute_url }}">
-              {% for r in d.item.image.all %}
-                {% if forloop.first %}<img src="{{ r.image.url }}" alt="Card image cap">{% endif %}
-              {% endfor %}
-              </a>
+            {% if d.item.image.exists %}
+            <a href="{{d.item.get_absolute_url}}"><img class="card-img-top" src="{{ d.item.image.first.image.url }}" alt="{{ d }}"></a>
             {% endif %}
             <div class="card-body">
               <p class="card-text" style="position: relative;">

ram/portal/templates/cards/consist.html

@@ -2,12 +2,10 @@
         <div class="card shadow-sm">
           <a href="{{ d.item.get_absolute_url }}">
           {% if d.item.image %}
-            <img src="{{ d.item.image.url }}" alt="Card image cap">
+            <img class="card-img-top" src="{{ d.item.image.url }}" alt="{{ d }}">
           {% else %}
             {% with d.item.consist_item.first.rolling_stock as r %}
-            {% for i in r.image.all %}
-              {% if forloop.first %}<img src="{{ i.image.url }}" alt="Card image cap">{% endif %}
-            {% endfor %}
+            <img class="card-img-top" src="{{ r.image.first.image.url }}" alt="{{ d }}"></a>
             {% endwith %}
           {% endif %}
           </a>
@@ -26,7 +24,7 @@
             <table class="table table-striped">
               <thead>
                 <tr>
-                  <th colspan="2" scope="row">Consist data</th>
+                  <th colspan="2" scope="row">Consist</th>
                 </tr>
               </thead>
               <tbody class="table-group-divider">

ram/portal/templates/cards/manufacturer.html

@@ -14,7 +14,7 @@
                   {% if d.item.logo %}
                   <tr>
                     <th class="w-33" scope="row">Logo</th>
-                    <td><img style="max-height: 48px" src="{{ d.item.logo.url }}" /></td>
+                    <td><img class="logo" src="{{ d.item.logo.url }}" /></td>
                   </tr>
                   {% endif %}
                   {% if d.item.website %}

ram/portal/templates/cards/rolling_stock.html

@@ -1,7 +1,7 @@
 {% load static %}
         <div class="col">
           <div class="card shadow-sm">
-            {% if d.item.image.count > 0 %}
+            {% if d.item.image.exists %}
             <a href="{{d.item.get_absolute_url}}"><img class="card-img-top" src="{{ d.item.image.first.image.url }}" alt="{{ d }}"></a>
             {% else %}
             <!-- Do not show the "Coming soon" image when running in a single card column mode (e.g. on mobile) -->

ram/portal/templates/includes/login.html

@@ -1,4 +1,7 @@
-      <div class="navbar-collapse justify-content-end" id="loginNavbar">
+     <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#loginNavbar" aria-controls="loginNavbar" aria-expanded="false" aria-label="Toggle navigation">
+     <span class="bi bi-box-arrow-in-right"></span>
+     </button>
+      <div class="collapse navbar-collapse justify-content-end" id="loginNavbar">
         <ul class="navbar-nav">
           <li class="nav-item dropdown">
             {% if request.user.is_staff %}
@@ -14,7 +17,6 @@
               <li><hr class="dropdown-divider"></li>
               <li><a class="dropdown-item" href="{% url 'admin:index' %}">Admin</a></li>
               <li><a class="dropdown-item" href="{% url 'admin:portal_siteconfiguration_changelist' %}">Site configuration</a></li>
-              <li><a class="dropdown-item" href="{% url 'admin:driver_driverconfiguration_changelist' %}">DCC configuration</a></li>
               <li><hr class="dropdown-divider"></li>
               <li><a class="dropdown-item text-danger" href="{% url 'admin:logout' %}?next={{ request.path }}">Logout</a></li>
             </ul>

ram/portal/templates/rollingstock.html

@@ -48,8 +48,8 @@
                 <button class="nav-link" id="nav-model-tab" data-bs-toggle="tab" data-bs-target="#nav-model" type="button" role="tab" aria-controls="nav-model" aria-selected="false">Model data</button>
                 <button class="nav-link" id="nav-class-tab" data-bs-toggle="tab" data-bs-target="#nav-class" type="button" role="tab" aria-controls="nav-class" aria-selected="false">Class data</button>
                 {% if rolling_stock.decoder %}<button class="nav-link" id="nav-dcc-tab" data-bs-toggle="tab" data-bs-target="#nav-dcc" type="button" role="tab" aria-controls="nav-dcc" aria-selected="false">DCC</button>{% endif %}
-                {% if rolling_stock.document.count > 0 or rolling_stock.decoder.document.count > 0 %}<button class="nav-link" id="nav-documents-tab" data-bs-toggle="tab" data-bs-target="#nav-documents" type="button" role="tab" aria-controls="nav-documents" aria-selected="false">Documents</button>{% endif %}
-                {% if rolling_stock_journal.count > 0 %}<button class="nav-link" id="nav-journal-tab" data-bs-toggle="tab" data-bs-target="#nav-journal" type="button" role="tab" aria-controls="nav-journal" aria-selected="false">Journal</button>{% endif %}
+                {% if documents or decoder_documents %}<button class="nav-link" id="nav-documents-tab" data-bs-toggle="tab" data-bs-target="#nav-documents" type="button" role="tab" aria-controls="nav-documents" aria-selected="false">Documents</button>{% endif %}
+                {% if journal %}<button class="nav-link" id="nav-journal-tab" data-bs-toggle="tab" data-bs-target="#nav-journal" type="button" role="tab" aria-controls="nav-journal" aria-selected="false">Journal</button>{% endif %}
                 {% if rolling_stock.notes %}<button class="nav-link" id="nav-notes-tab" data-bs-toggle="tab" data-bs-target="#nav-notes" type="button" role="tab" aria-controls="nav-notes" aria-selected="false">Notes</button>{% endif %}
               </nav>
               <div class="tab-content" id="nav-tabContent">
@@ -170,7 +170,7 @@
                       </tr>
                     </tbody>
                   </table>
-                  {% if rolling_stock_properties %}
+                  {% if properties %}
                   <table class="table table-striped">
                     <thead>
                       <tr>
@@ -178,7 +178,7 @@
                       </tr>
                     </thead>
                     <tbody class="table-group-divider">
-                    {% for p in rolling_stock_properties %}
+                    {% for p in properties %}
                       <tr>
                         <th class="w-33" scope="row">{{ p.property }}</th>
                         <td>{{ p.value }}</td>
@@ -244,7 +244,7 @@
                   <table class="table table-striped">
                     <thead>
                       <tr>
-                        <th colspan="2" scope="row">DCC data</th>
+                        <th colspan="2" scope="row">Decoder data</th>
                       </tr>
                     </thead>
                     <tbody class="table-group-divider">
@@ -276,7 +276,7 @@
                   </table>
                 </div>
                 <div class="tab-pane" id="nav-documents" role="tabpanel" aria-labelledby="nav-documents-tab">
-                  {% if rolling_stock.document.count > 0 %}
+                  {% if documents %}
                   <table class="table table-striped">
                     <thead>
                       <tr>
@@ -284,7 +284,7 @@
                       </tr>
                     </thead>
                     <tbody class="table-group-divider">
-                    {% for d in rolling_stock.document.all %}
+                    {% for d in documents.all %}
                       <tr>
                         <td class="w-33">{{ d.description }}</td>
                         <td><a href="{{ d.file.url }}" target="_blank">{{ d.filename }}</a></td>
@@ -294,7 +294,7 @@
                     </tbody>
                   </table>
                   {% endif %}
-                  {% if rolling_stock.decoder.document.count > 0 %}
+                  {% if decoder_documents %}
                   <table class="table table-striped">
                     <thead>
                       <tr>
@@ -302,7 +302,7 @@
                       </tr>
                     </thead>
                     <tbody class="table-group-divider">
-                    {% for d in rolling_stock.decoder.document.all %}
+                    {% for d in decoder_documents.all %}
                       <tr>
                         <td class="w-33">{{ d.description }}</td>
                         <td><a href="{{ d.file.url }}" target="_blank">{{ d.filename }}</a></td>
@@ -321,7 +321,7 @@
                       </tr>
                     </thead>
                     <tbody class="table-group-divider">
-                    {% for j in rolling_stock_journal %}
+                    {% for j in journal %}
                       <tr>
                         <th class="w-33" scope="row">{{ j.date }}</th>
                         <td>{{ j.log | safe }}</a></td>

ram/portal/templates/types.html

@@ -5,7 +5,7 @@
         <ul class="pagination justify-content-center mt-4 mb-0">
           {% if data.has_previous %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'scales_pagination' page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
+            <a class="page-link" href="{% url 'types_pagination' page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
           </li>
           {% else %}
           <li class="page-item disabled">
@@ -21,13 +21,13 @@
               {% if i == data.paginator.ELLIPSIS %}
               <li class="page-item"><span class="page-link">{{ i }}</span></li>
               {% else %}
-              <li class="page-item"><a class="page-link" href="{% url 'scales_pagination' page=i %}#main-content">{{ i }}</a></li>
+              <li class="page-item"><a class="page-link" href="{% url 'types_pagination' page=i %}#main-content">{{ i }}</a></li>
               {% endif %}
             {% endif %}
           {% endfor %}
           {% if data.has_next %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'scales_pagination' page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
+            <a class="page-link" href="{% url 'types_pagination' page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
           </li>
           {% else %}
           <li class="page-item disabled">

ram/portal/urls.py

@@ -26,9 +26,15 @@ urlpatterns = [
         GetFlatpage.as_view(),
         name="flatpage",
     ),
-    path("consists", Consists.as_view(), name="consists"),
     path(
-        "consists/<int:page>", Consists.as_view(), name="consists_pagination"
+        "consists",
+        Consists.as_view(template="consists.html"),
+        name="consists"
+    ),
+    path(
+        "consists/<int:page>",
+        Consists.as_view(template="consists.html"),
+        name="consists_pagination"
     ),
     path("consist/<uuid:uuid>", GetConsist.as_view(), name="consist"),
     path(

ram/portal/views.py

@@ -5,6 +5,7 @@ from urllib.parse import unquote
 
 from django.views import View
 from django.http import Http404, HttpResponseBadRequest
+from django.db.utils import OperationalError, ProgrammingError
 from django.db.models import Q
 from django.shortcuts import render, get_object_or_404
 from django.core.exceptions import ObjectDoesNotExist
@@ -15,11 +16,17 @@ from portal.models import Flatpage
 from roster.models import RollingStock
 from consist.models import Consist
 from bookshelf.models import Book
-from metadata.models import Company, Manufacturer, Scale, RollingStockType, Tag
+from metadata.models import (
+    Company, Manufacturer, Scale, DecoderDocument, RollingStockType, Tag
+)
 
 
 def order_by_fields():
-    order_by = get_site_conf().items_ordering
+    try:
+        order_by = get_site_conf().items_ordering
+    except (OperationalError, ProgrammingError):
+        order_by = "type"
+
     fields = [
         "rolling_class__type",
         "rolling_class__company",
@@ -300,24 +307,29 @@ class GetRollingStock(View):
         except ObjectDoesNotExist:
             raise Http404
 
-        class_properties = (
-            rolling_stock.rolling_class.property.all()
-            if request.user.is_authenticated
-            else rolling_stock.rolling_class.property.filter(
+        # FIXME there's likely a better and more efficient way of doing this
+        # but keeping KISS for now
+        decoder_documents = []
+        if request.user.is_authenticated:
+            class_properties = rolling_stock.rolling_class.property.all()
+            properties = rolling_stock.property.all()
+            documents = rolling_stock.document.all()
+            journal = rolling_stock.journal.all()
+            if rolling_stock.decoder:
+                decoder_documents = rolling_stock.decoder.document.all()
+        else:
+            class_properties = rolling_stock.rolling_class.property.filter(
                 property__private=False
             )
-        )
-        rolling_stock_properties = (
-            rolling_stock.property.all()
-            if request.user.is_authenticated
-            else rolling_stock.property.filter(property__private=False)
-        )
-
-        rolling_stock_journal = (
-            rolling_stock.journal.all()
-            if request.user.is_authenticated
-            else rolling_stock.journal.filter(private=False)
-        )
+            properties = rolling_stock.property.filter(
+                property__private=False
+            )
+            documents = rolling_stock.document.filter(private=False)
+            journal = rolling_stock.journal.filter(private=False)
+            if rolling_stock.decoder:
+                decoder_documents = rolling_stock.decoder.document.filter(
+                    private=False
+                )
 
         return render(
             request,
@@ -326,17 +338,18 @@ class GetRollingStock(View):
                 "title": rolling_stock,
                 "rolling_stock": rolling_stock,
                 "class_properties": class_properties,
-                "rolling_stock_properties": rolling_stock_properties,
-                "rolling_stock_journal": rolling_stock_journal,
+                "properties": properties,
+                "decoder_documents": decoder_documents,
+                "documents": documents,
+                "journal": journal,
             },
         )
 
 
 class Consists(GetData):
-    def __init__(self):
-        self.title = "Consists"
-        self.item_type = "consist"
-        self.queryset = Consist.objects.all()
+    title = "Consists"
+    item_type = "consist"
+    queryset = Consist.objects.all()
 
 
 class GetConsist(View):
@@ -431,10 +444,12 @@ class GetBook(View):
 
 class GetFlatpage(View):
     def get(self, request, flatpage):
+        _filter = Q(published=True)  # Show only published pages
+        if request.user.is_authenticated:
+            _filter = Q()  # Reset the filter if user is authenticated
+
         try:
-            flatpage = Flatpage.objects.get(
-                Q(Q(path=flatpage) & Q(published=True))
-            )
+            flatpage = Flatpage.objects.filter(_filter).get(path=flatpage)
         except ObjectDoesNotExist:
             raise Http404
 

ram/ram/__init__.py

@@ -1,4 +1,4 @@
 from ram.utils import git_suffix
 
-__version__ = "0.6.1"
+__version__ = "0.7.1"
 __version__ += git_suffix(__file__)

ram/ram/models.py

@@ -14,6 +14,7 @@ class Document(models.Model):
         null=True,
         blank=True,
     )
+    private = models.BooleanField(default=False)
 
     class Meta:
         abstract = True

ram/ram/settings.py

@@ -51,7 +51,7 @@ INSTALLED_APPS = [
     "rest_framework",
     "ram",
     "portal",
-    "driver",
+    # "driver",
     "metadata",
     "roster",
     "consist",

ram/ram/urls.py

@@ -13,6 +13,7 @@ Including another URLconf
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+from django.apps import apps
 from django.conf import settings
 from django.shortcuts import redirect
 from django.conf.urls.static import static
@@ -27,10 +28,15 @@ urlpatterns = [
     path("admin/", admin.site.urls),
     path("api/v1/consist/", include("consist.urls")),
     path("api/v1/roster/", include("roster.urls")),
-    path("api/v1/dcc/", include("driver.urls")),
     path("api/v1/bookshelf/", include("bookshelf.urls")),
 ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
 
+# Enable the "/dcc" routing only if the "driver" app is active
+if apps.is_installed("driver"):
+    urlpatterns += [
+        path("api/v1/dcc/", include("driver.urls")),
+    ]
+
 if settings.DEBUG:
     from django.views.generic import TemplateView
     from rest_framework.schemas import get_schema_view

ram/roster/admin.py

@@ -64,6 +64,7 @@ class RollingStockDocumentAdmin(admin.ModelAdmin):
         "__str__",
         "rolling_stock",
         "description",
+        "private",
         "download",
     )
     search_fields = (

ram/roster/migrations/0019_rollingstockdocument_private.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.5 on 2023-10-06 19:48
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0018_rename_sku_rollingstock_item_number"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rollingstockdocument",
+            name="private",
+            field=models.BooleanField(default=False),
+        ),
+    ]

requirements.txt

@@ -8,5 +8,8 @@ django-countries
 django-health-check
 django-admin-sortable2
 django-ckeditor
-# psycopg2-binary
-pySerial
+# Optional: # psycopg2-binary
+# Optional: # pySerial
+# Required by django-countries and not always installed
+# by default on modern venvs (like Python 3.12 on Fedora 39)
+setuptools