Rename DCC project into RAM

RAM: Railroad Assets Manager

ram/roster/admin.py

@@ -0,0 +1,107 @@
+from django.contrib import admin
+from roster.models import (
+    RollingClass,
+    RollingClassProperty,
+    RollingStock,
+    RollingStockImage,
+    RollingStockDocument,
+    RollingStockProperty,
+)
+
+
+class RollingClassPropertyInline(admin.TabularInline):
+    model = RollingClassProperty
+    min_num = 0
+    extra = 0
+
+
+@admin.register(RollingClass)
+class RollingClass(admin.ModelAdmin):
+    inlines = (RollingClassPropertyInline,)
+    list_display = ("__str__", "type", "company")
+    list_filter = ("company", "type__category", "type")
+    search_fields = list_display
+
+
+class RollingStockDocInline(admin.TabularInline):
+    model = RollingStockDocument
+    min_num = 0
+    extra = 0
+
+
+class RollingStockImageInline(admin.TabularInline):
+    model = RollingStockImage
+    min_num = 0
+    extra = 0
+    readonly_fields = ("image_thumbnail",)
+
+
+class RollingStockPropertyInline(admin.TabularInline):
+    model = RollingStockProperty
+    min_num = 0
+    extra = 0
+
+
+@admin.register(RollingStock)
+class RollingStockAdmin(admin.ModelAdmin):
+    inlines = (
+        RollingStockPropertyInline,
+        RollingStockImageInline,
+        RollingStockDocInline,
+    )
+    readonly_fields = ("creation_time", "updated_time")
+    list_display = (
+        "__str__",
+        "address",
+        "manufacturer",
+        "scale",
+        "sku",
+        "company",
+        "country",
+    )
+    list_filter = (
+        "rolling_class__type__category",
+        "rolling_class__type",
+        "scale",
+        "manufacturer",
+    )
+    search_fields = list_display
+
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "rolling_class",
+                    "road_number",
+                    "scale",
+                    "manufacturer",
+                    "sku",
+                    "era",
+                    "production_year",
+                    "purchase_date",
+                    "notes",
+                    "tags",
+                )
+            },
+        ),
+        (
+            "DCC",
+            {
+                "fields": (
+                    "decoder",
+                    "address",
+                )
+            },
+        ),
+        (
+            "Audit",
+            {
+                "classes": ("collapse",),
+                "fields": (
+                    "creation_time",
+                    "updated_time",
+                ),
+            },
+        ),
+    )

ram/roster/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class RosterConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "roster"

ram/roster/migrations/0001_initial.py

@@ -0,0 +1,104 @@
+# Generated by Django 4.0.3 on 2022-04-07 09:25
+
+from django.db import migrations, models
+import django.db.models.deletion
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('metadata', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='RollingClass',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('identifier', models.CharField(max_length=128)),
+                ('description', models.CharField(blank=True, max_length=256)),
+                ('company', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='metadata.company')),
+                ('manufacturer', models.ForeignKey(blank=True, limit_choices_to={'category': 'real'}, null=True, on_delete=django.db.models.deletion.CASCADE, to='metadata.manufacturer')),
+                ('type', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='metadata.rollingstocktype')),
+            ],
+            options={
+                'verbose_name': 'Class',
+                'verbose_name_plural': 'Classes',
+                'ordering': ['company', 'identifier'],
+            },
+        ),
+        migrations.CreateModel(
+            name='RollingStock',
+            fields=[
+                ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
+                ('road_number', models.CharField(max_length=128)),
+                ('sku', models.CharField(blank=True, max_length=32)),
+                ('address', models.SmallIntegerField(blank=True, default=None, null=True)),
+                ('era', models.CharField(blank=True, max_length=32)),
+                ('production_year', models.SmallIntegerField(blank=True, null=True)),
+                ('purchase_date', models.DateField(blank=True, null=True)),
+                ('notes', models.TextField(blank=True)),
+                ('creation_time', models.DateTimeField(auto_now_add=True)),
+                ('updated_time', models.DateTimeField(auto_now=True)),
+                ('decoder', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='metadata.decoder')),
+                ('manufacturer', models.ForeignKey(blank=True, limit_choices_to={'category': 'model'}, null=True, on_delete=django.db.models.deletion.CASCADE, to='metadata.manufacturer')),
+                ('rolling_class', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='roster.rollingclass', verbose_name='Class')),
+                ('scale', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='metadata.scale')),
+                ('tags', models.ManyToManyField(blank=True, related_name='rolling_stock', to='metadata.tag')),
+            ],
+            options={
+                'verbose_name_plural': 'Rolling stock',
+                'ordering': ['rolling_class', 'road_number'],
+            },
+        ),
+        migrations.CreateModel(
+            name='RollingStockProperty',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('value', models.CharField(max_length=256)),
+                ('property', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='metadata.property')),
+                ('rolling_stock', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='roster.rollingstock')),
+            ],
+            options={
+                'verbose_name_plural': 'Properties',
+            },
+        ),
+        migrations.CreateModel(
+            name='RollingClassProperty',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('value', models.CharField(max_length=256)),
+                ('property', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='metadata.property')),
+                ('rolling_class', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='roster.rollingclass', verbose_name='Class')),
+            ],
+            options={
+                'verbose_name_plural': 'Properties',
+            },
+        ),
+        migrations.CreateModel(
+            name='RollingStockImage',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('image', models.ImageField(blank=True, null=True, upload_to='images/')),
+                ('rolling_stock', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='roster.rollingstock')),
+            ],
+            options={
+                'unique_together': {('rolling_stock', 'image')},
+            },
+        ),
+        migrations.CreateModel(
+            name='RollingStockDocument',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('description', models.CharField(blank=True, max_length=128)),
+                ('file', models.FileField(blank=True, null=True, upload_to='files/')),
+                ('rolling_stock', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='roster.rollingstock')),
+            ],
+            options={
+                'unique_together': {('rolling_stock', 'file')},
+            },
+        ),
+    ]

ram/roster/migrations/0002_alter_rollingstockimage_unique_together_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.0.3 on 2022-04-08 21:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('roster', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name='rollingstockimage',
+            unique_together=set(),
+        ),
+        migrations.AddField(
+            model_name='rollingstockimage',
+            name='is_thumbnail',
+            field=models.BooleanField(default=False),
+            preserve_default=False,
+        ),
+    ]

ram/roster/migrations/0003_alter_rollingstockimage_rolling_stock.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.0.3 on 2022-04-08 22:45
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('roster', '0002_alter_rollingstockimage_unique_together_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='rollingstockimage',
+            name='rolling_stock',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='thumbnail', to='roster.rollingstock'),
+        ),
+    ]

ram/roster/models.py

@@ -0,0 +1,168 @@
+import os
+from uuid import uuid4
+from django.db import models
+
+# from django.core.files.storage import FileSystemStorage
+# from django.dispatch import receiver
+
+from ram.utils import get_image_preview
+from metadata.models import (
+    Property,
+    Scale,
+    Manufacturer,
+    Decoder,
+    Company,
+    Tag,
+    RollingStockType,
+)
+
+# class OverwriteMixin(FileSystemStorage):
+#     def get_available_name(self, name, max_length):
+#         self.delete(name)
+#         return name
+
+
+class RollingClass(models.Model):
+    identifier = models.CharField(max_length=128, unique=False)
+    type = models.ForeignKey(
+        RollingStockType, on_delete=models.CASCADE, null=True, blank=True
+    )
+    company = models.ForeignKey(
+        Company, on_delete=models.CASCADE, null=True, blank=True
+    )
+    description = models.CharField(max_length=256, blank=True)
+    manufacturer = models.ForeignKey(
+        Manufacturer, on_delete=models.CASCADE, null=True, blank=True,
+        limit_choices_to={"category": "real"}
+    )
+
+    class Meta:
+        ordering = ["company", "identifier"]
+        verbose_name = "Class"
+        verbose_name_plural = "Classes"
+
+    def __str__(self):
+        return "{0} {1}".format(self.company, self.identifier)
+
+
+class RollingClassProperty(models.Model):
+    rolling_class = models.ForeignKey(
+        RollingClass,
+        on_delete=models.CASCADE,
+        null=False,
+        blank=False,
+        verbose_name="Class",
+    )
+    property = models.ForeignKey(Property, on_delete=models.CASCADE)
+    value = models.CharField(max_length=256)
+
+    def __str__(self):
+        return self.property.name
+
+    class Meta:
+        verbose_name_plural = "Properties"
+
+
+class RollingStock(models.Model):
+    uuid = models.UUIDField(primary_key=True, default=uuid4, editable=False)
+    rolling_class = models.ForeignKey(
+        RollingClass,
+        on_delete=models.CASCADE,
+        null=False,
+        blank=False,
+        verbose_name="Class",
+    )
+    road_number = models.CharField(max_length=128, unique=False)
+    manufacturer = models.ForeignKey(
+        Manufacturer, on_delete=models.CASCADE, null=True, blank=True,
+        limit_choices_to={"category": "model"}
+    )
+    scale = models.ForeignKey(Scale, on_delete=models.CASCADE)
+    sku = models.CharField(max_length=32, blank=True)
+    decoder = models.ForeignKey(
+        Decoder, on_delete=models.CASCADE, null=True, blank=True
+    )
+    address = models.SmallIntegerField(default=None, null=True, blank=True)
+    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 = models.TextField(blank=True)
+    tags = models.ManyToManyField(
+        Tag, related_name="rolling_stock", blank=True
+    )
+    creation_time = models.DateTimeField(auto_now_add=True)
+    updated_time = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        ordering = ["rolling_class", "road_number"]
+        verbose_name_plural = "Rolling stock"
+
+    def __str__(self):
+        return "{0} {1}".format(self.rolling_class, self.road_number)
+
+    def country(self):
+        return str(self.rolling_class.company.country)
+
+    def company(self):
+        return str(self.rolling_class.company)
+
+
+class RollingStockDocument(models.Model):
+    rolling_stock = models.ForeignKey(RollingStock, on_delete=models.CASCADE)
+    description = models.CharField(max_length=128, blank=True)
+    file = models.FileField(upload_to="files/", null=True, blank=True)
+
+    class Meta(object):
+        unique_together = ("rolling_stock", "file")
+
+    def __str__(self):
+        return "{0}".format(os.path.basename(self.file.name))
+        # return "{0}".format(self.description)
+
+
+class RollingStockImage(models.Model):
+    rolling_stock = models.ForeignKey(
+        RollingStock,
+        on_delete=models.CASCADE,
+        related_name="thumbnail")
+    image = models.ImageField(upload_to="images/", null=True, blank=True)
+    is_thumbnail = models.BooleanField()
+
+    def image_thumbnail(self):
+        return get_image_preview(self.image.url)
+
+    image_thumbnail.short_description = "Preview"
+
+    def __str__(self):
+        return "{0}".format(os.path.basename(self.image.name))
+
+    def save(self, **kwargs):
+        if self.is_thumbnail:
+            RollingStockImage.objects.filter(
+                rolling_stock=self.rolling_stock).update(is_thumbnail=False)
+        super().save(**kwargs)
+
+
+class RollingStockProperty(models.Model):
+    rolling_stock = models.ForeignKey(
+        RollingStock,
+        on_delete=models.CASCADE,
+        null=False,
+        blank=False
+    )
+    property = models.ForeignKey(Property, on_delete=models.CASCADE)
+    value = models.CharField(max_length=256)
+
+    def __str__(self):
+        return self.property.name
+
+    class Meta:
+        verbose_name_plural = "Properties"
+
+
+# @receiver(models.signals.post_delete, sender=Cab)
+# def post_save_image(sender, instance, *args, **kwargs):
+#     try:
+#         instance.image.delete(save=False)
+#     except Exception:
+#         pass

ram/roster/serializers.py

@@ -0,0 +1,32 @@
+from rest_framework import serializers
+from roster.models import RollingClass, RollingStock
+from metadata.serializers import (
+    RollingStockTypeSerializer,
+    ManufacturerSerializer,
+    ScaleSerializer,
+    CompanySerializer,
+    DecoderSerializer,
+    TagSerializer,
+)
+
+
+class RollingClassSerializer(serializers.ModelSerializer):
+    company = CompanySerializer()
+    type = RollingStockTypeSerializer()
+
+    class Meta:
+        model = RollingClass
+        fields = "__all__"
+
+
+class RollingStockSerializer(serializers.ModelSerializer):
+    rolling_class = RollingClassSerializer()
+    manufacturer = ManufacturerSerializer()
+    decoder = DecoderSerializer()
+    scale = ScaleSerializer()
+    tags = TagSerializer(many=True)
+
+    class Meta:
+        model = RollingStock
+        fields = "__all__"
+        read_only_fields = ("creation_time", "updated_time")

ram/roster/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

ram/roster/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+from roster.views import RosterList, RosterGet, RosterAddress, RosterIdentifier
+
+urlpatterns = [
+    path("list", RosterList.as_view()),
+    path("get/<str:uuid>", RosterGet.as_view()),
+    path("address/<int:address>", RosterAddress.as_view()),
+    path("identifier/<str:identifier>", RosterIdentifier.as_view()),
+]

ram/roster/views.py

@@ -0,0 +1,27 @@
+from rest_framework.generics import ListAPIView, RetrieveAPIView
+
+from roster.models import RollingStock
+from roster.serializers import RollingStockSerializer
+
+
+class RosterList(ListAPIView):
+    queryset = RollingStock.objects.all()
+    serializer_class = RollingStockSerializer
+
+
+class RosterGet(RetrieveAPIView):
+    queryset = RollingStock.objects.all()
+    serializer_class = RollingStockSerializer
+    lookup_field = "uuid"
+
+
+class RosterAddress(ListAPIView):
+    queryset = RollingStock.objects.all()
+    serializer_class = RollingStockSerializer
+    lookup_field = "address"
+
+
+class RosterIdentifier(RetrieveAPIView):
+    queryset = RollingStock.objects.all()
+    serializer_class = RollingStockSerializer
+    lookup_field = "identifier"