From 4b74a69f3f6f8a07b4e5f709d53b52605b678ba2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniele=20Vigan=C3=B2?= <daniele@vigano.me>
Date: Sat, 2 Mar 2024 15:45:42 +0100
Subject: [PATCH] Add the possbility to provide descriptions (#32)

to class, rolling stock, book
---
 .../migrations/0013_book_description.py       | 19 +++++++++++++++++++
 ram/bookshelf/models.py                       |  1 +
 ram/portal/templates/bookshelf/book.html      |  1 +
 ram/portal/templates/rollingstock.html        |  2 ++
 ram/ram/__init__.py                           |  2 +-
 ram/roster/admin.py                           |  1 +
 .../0023_alter_rollingclass_description.py    | 19 +++++++++++++++++++
 .../0024_rollingstock_description.py          | 19 +++++++++++++++++++
 ram/roster/models.py                          |  5 +++--
 9 files changed, 66 insertions(+), 3 deletions(-)
 create mode 100644 ram/bookshelf/migrations/0013_book_description.py
 create mode 100644 ram/roster/migrations/0023_alter_rollingclass_description.py
 create mode 100644 ram/roster/migrations/0024_rollingstock_description.py

diff --git a/ram/bookshelf/migrations/0013_book_description.py b/ram/bookshelf/migrations/0013_book_description.py
new file mode 100644
index 0000000..a835829
--- /dev/null
+++ b/ram/bookshelf/migrations/0013_book_description.py
@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-03-02 14:31
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0012_alter_book_notes"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="book",
+            name="description",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]
diff --git a/ram/bookshelf/models.py b/ram/bookshelf/models.py
index 6c2dcf8..f4fa609 100644
--- a/ram/bookshelf/models.py
+++ b/ram/bookshelf/models.py
@@ -52,6 +52,7 @@ class Book(models.Model):
     )
     number_of_pages = models.SmallIntegerField(null=True, blank=True)
     publication_year = models.SmallIntegerField(null=True, blank=True)
+    description = tinymce.HTMLField(blank=True)
     purchase_date = models.DateField(null=True, blank=True)
     tags = models.ManyToManyField(
         Tag, related_name="bookshelf", blank=True
diff --git a/ram/portal/templates/bookshelf/book.html b/ram/portal/templates/bookshelf/book.html
index 630dde6..49c3d61 100644
--- a/ram/portal/templates/bookshelf/book.html
+++ b/ram/portal/templates/bookshelf/book.html
@@ -54,6 +54,7 @@
               <div class="tab-content" id="nav-tabContent">
                 <div class="tab-pane show active" id="nav-summary" role="tabpanel" aria-labelledby="nav-summary-tab">
                   <table class="table table-striped">
+                    {{ book.description | safe }}
                     <thead>
                       <tr>
                         <th colspan="2" scope="row">Book</th>
diff --git a/ram/portal/templates/rollingstock.html b/ram/portal/templates/rollingstock.html
index 253441c..f51ef5c 100644
--- a/ram/portal/templates/rollingstock.html
+++ b/ram/portal/templates/rollingstock.html
@@ -149,6 +149,7 @@
                   {% endif %}
                 </div>
                 <div class="tab-pane" id="nav-model" role="tabpanel" aria-labelledby="nav-model-tab">
+                  {{ rolling_stock.description | safe }}
                   <table class="table table-striped">
                     <thead>
                       <tr>
@@ -205,6 +206,7 @@
                   {% endif %}
                 </div>
                 <div class="tab-pane" id="nav-class" role="tabpanel" aria-labelledby="nav-class-tab">
+                  {{ class.description | safe }}
                   <table class="table table-striped">
                     <thead>
                       <tr>
diff --git a/ram/ram/__init__.py b/ram/ram/__init__.py
index 3c53cf0..3882321 100644
--- a/ram/ram/__init__.py
+++ b/ram/ram/__init__.py
@@ -1,4 +1,4 @@
 from ram.utils import git_suffix
 
-__version__ = "0.10.0"
+__version__ = "0.11.0"
 __version__ += git_suffix(__file__)
diff --git a/ram/roster/admin.py b/ram/roster/admin.py
index d419b8f..a32ddd4 100644
--- a/ram/roster/admin.py
+++ b/ram/roster/admin.py
@@ -142,6 +142,7 @@ class RollingStockAdmin(SortableAdminBase, admin.ModelAdmin):
                     "manufacturer",
                     "item_number",
                     "era",
+                    "description",
                     "production_year",
                     "purchase_date",
                     "notes",
diff --git a/ram/roster/migrations/0023_alter_rollingclass_description.py b/ram/roster/migrations/0023_alter_rollingclass_description.py
new file mode 100644
index 0000000..febe410
--- /dev/null
+++ b/ram/roster/migrations/0023_alter_rollingclass_description.py
@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-03-02 13:30
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0022_alter_rollingstock_notes_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="rollingclass",
+            name="description",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]
diff --git a/ram/roster/migrations/0024_rollingstock_description.py b/ram/roster/migrations/0024_rollingstock_description.py
new file mode 100644
index 0000000..7499045
--- /dev/null
+++ b/ram/roster/migrations/0024_rollingstock_description.py
@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-03-02 14:30
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0023_alter_rollingclass_description"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rollingstock",
+            name="description",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]
diff --git a/ram/roster/models.py b/ram/roster/models.py
index 80b9f86..13e7c5f 100644
--- a/ram/roster/models.py
+++ b/ram/roster/models.py
@@ -25,7 +25,7 @@ class RollingClass(models.Model):
     identifier = models.CharField(max_length=128, unique=False)
     type = models.ForeignKey(RollingStockType, on_delete=models.CASCADE)
     company = models.ForeignKey(Company, on_delete=models.CASCADE)
-    description = models.CharField(max_length=256, blank=True)
+    description = tinymce.HTMLField(blank=True)
     manufacturer = models.ForeignKey(
         Manufacturer,
         on_delete=models.CASCADE,
@@ -85,10 +85,11 @@ class RollingStock(models.Model):
     era = models.CharField(max_length=32, blank=True)
     production_year = models.SmallIntegerField(null=True, blank=True)
     purchase_date = models.DateField(null=True, blank=True)
-    notes = tinymce.HTMLField(blank=True)
+    description = tinymce.HTMLField(blank=True)
     tags = models.ManyToManyField(
         Tag, related_name="rolling_stock", blank=True
     )
+    notes = tinymce.HTMLField(blank=True)
     creation_time = models.DateTimeField(auto_now_add=True)
     updated_time = models.DateTimeField(auto_now=True)