Extend functionalities

dcc/dcc/utils.py

@@ -1,7 +1,16 @@
 from django.utils.html import format_html
+from django.utils.text import slugify as django_slugify
 
 
 def get_image_preview(url):
     return format_html(
         '<img src="%s" style="max-width: 150px; max-height: 150px;'
         'background-color: #eee;" />' % url)
+
+
+def slugify(string, custom_separator=None):
+    # Make slug 'flat', both '-' and '_' are replaced with '-'
+    string = django_slugify(string).replace('_', '-')
+    if custom_separator is not None:
+        string = string.replace('-', custom_separator)
+    return string

dcc/driver/views.py

@@ -8,7 +8,7 @@ from dcc.parsers import PlainTextParser
 from driver.connector import Connector
 from driver.serializers import (
     FunctionSerializer, CabSerializer, InfraSerializer)
-from roster.models import Cab as CabModel
+from roster.models import RollingStock
 
 
 def addresschecker(f):
@@ -17,8 +17,8 @@ def addresschecker(f):
     """
     def addresslookup(request, address, *args):
         try:
-            CabModel.objects.get(address=address)
-        except CabModel.DoesNotExist:
+            RollingStock.objects.get(address=address)
+        except RollingStock.DoesNotExist:
             raise Http404
         return f(request, address, *args)
     return addresslookup

dcc/metadata/admin.py

@@ -1,5 +1,5 @@
 from django.contrib import admin
-from metadata.models import Decoder, Manufacturer, Company
+from metadata.models import Decoder, Manufacturer, Company, Tag
 
 
 @admin.register(Decoder)
@@ -15,3 +15,8 @@ class CompanyAdmin(admin.ModelAdmin):
 @admin.register(Manufacturer)
 class ManufacturerAdmin(admin.ModelAdmin):
     readonly_fields = ('logo_thumbnail',)
+
+
+@admin.register(Tag)
+class TagAdmin(admin.ModelAdmin):
+    readonly_fields = ('slug',)

dcc/metadata/migrations/0004_equipment.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.0.2 on 2022-03-06 19:50
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0003_metadata_extend'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Equipment',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('equipment_type', models.CharField(max_length=128, unique=True)),
+            ],
+        ),
+    ]

dcc/metadata/migrations/0005_tag_delete_equipment.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.0.2 on 2022-03-06 20:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0004_equipment'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Tag',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=128, unique=True)),
+                ('slug', models.CharField(max_length=128, unique=True)),
+            ],
+            options={
+                'verbose_name_plural': 'Equipment',
+            },
+        ),
+        migrations.DeleteModel(
+            name='Equipment',
+        ),
+    ]

dcc/metadata/migrations/0006_alter_tag_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.0.2 on 2022-03-06 20:15
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0005_tag_delete_equipment'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='tag',
+            options={},
+        ),
+    ]

dcc/metadata/models.py

@@ -1,7 +1,8 @@
 from django.db import models
+from django.dispatch.dispatcher import receiver
 from django_countries.fields import CountryField
 
-from dcc.utils import get_image_preview
+from dcc.utils import get_image_preview, slugify
 
 
 class Manufacturer(models.Model):
@@ -67,3 +68,16 @@ class Decoder(models.Model):
     def image_thumbnail(self):
         return get_image_preview(self.image.url)
     image_thumbnail.short_description = "Preview"
+
+
+class Tag(models.Model):
+    name = models.CharField(max_length=128, unique=True)
+    slug = models.CharField(max_length=128, unique=True)
+
+    def __str__(self):
+        return self.name
+
+
+@receiver(models.signals.pre_save, sender=Tag)
+def tag_pre_save(sender, instance, **kwargs):
+    instance.slug = slugify(instance.name)

dcc/roster/admin.py

@@ -1,9 +1,9 @@
 from django.contrib import admin
-from roster.models import Cab
+from roster.models import RollingStock
 
 
-@admin.register(Cab)
-class CabAdmin(admin.ModelAdmin):
+@admin.register(RollingStock)
+class RollingStockAdmin(admin.ModelAdmin):
     readonly_fields = ('image_thumbnail', 'creation_time', 'updated_time',)
     list_display = ('identifier', 'address', 'manufacturer', 'company')
     list_filter = list_display
@@ -12,6 +12,7 @@ class CabAdmin(admin.ModelAdmin):
     fieldsets = (
         (None, {
             'fields': ('identifier',
+                       'tags',
                        'address',
                        'manufacturer',
                        'decoder',

dcc/roster/migrations/0017_rename_cab_rollingstock.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.0.2 on 2022-03-06 19:42
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0003_metadata_extend'),
+        ('roster', '0016_alter_cab_image'),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='Cab',
+            new_name='RollingStock',
+        ),
+    ]

dcc/roster/migrations/0018_alter_rollingstock_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.0.2 on 2022-03-06 19:50
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('roster', '0017_rename_cab_rollingstock'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='rollingstock',
+            options={'ordering': ['address', 'identifier'], 'verbose_name_plural': 'Rolling stock'},
+        ),
+    ]

dcc/roster/migrations/0019_rollingstock_tags.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.0.2 on 2022-03-06 20:15
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0006_alter_tag_options'),
+        ('roster', '0018_alter_rollingstock_options'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='rollingstock',
+            name='tags',
+            field=models.ManyToManyField(related_name='rolling_stock', to='metadata.Tag'),
+        ),
+    ]

dcc/roster/migrations/0020_alter_rollingstock_address_alter_rollingstock_tags.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.0.2 on 2022-03-06 20:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0006_alter_tag_options'),
+        ('roster', '0019_rollingstock_tags'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='rollingstock',
+            name='address',
+            field=models.SmallIntegerField(default=3, null=True),
+        ),
+        migrations.AlterField(
+            model_name='rollingstock',
+            name='tags',
+            field=models.ManyToManyField(null=True, related_name='rolling_stock', to='metadata.Tag'),
+        ),
+    ]

dcc/roster/migrations/0021_alter_rollingstock_tags.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.0.2 on 2022-03-06 20:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0006_alter_tag_options'),
+        ('roster', '0020_alter_rollingstock_address_alter_rollingstock_tags'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='rollingstock',
+            name='tags',
+            field=models.ManyToManyField(blank=True, related_name='rolling_stock', to='metadata.Tag'),
+        ),
+    ]

dcc/roster/migrations/0022_alter_rollingstock_address.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.0.2 on 2022-03-06 20:18
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('roster', '0021_alter_rollingstock_tags'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='rollingstock',
+            name='address',
+            field=models.SmallIntegerField(blank=True, default=3, null=True),
+        ),
+    ]

dcc/roster/models.py

@@ -4,7 +4,7 @@ from django.db import models
 # from django.dispatch import receiver
 
 from dcc.utils import get_image_preview
-from metadata.models import Manufacturer, Decoder, Company
+from metadata.models import Manufacturer, Decoder, Company, Tag
 
 # class OverwriteMixin(FileSystemStorage):
 #     def get_available_name(self, name, max_length):
@@ -12,12 +12,16 @@ from metadata.models import Manufacturer, Decoder, Company
 #         return name
 
 
-class Cab(models.Model):
+class RollingStock(models.Model):
     uuid = models.UUIDField(
         primary_key=True, default=uuid4,
         editable=False)
     identifier = models.CharField(max_length=128, unique=False)
-    address = models.SmallIntegerField(default=3)
+    tags = models.ManyToManyField(
+        Tag,
+        related_name='rolling_stock',
+        blank=True)
+    address = models.SmallIntegerField(default=3, null=True, blank=True)
     manufacturer = models.ForeignKey(
         Manufacturer, on_delete=models.CASCADE,
         null=True, blank=True)
@@ -42,6 +46,7 @@ class Cab(models.Model):
 
     class Meta:
         ordering = ['address', 'identifier']
+        verbose_name_plural = "Rolling stock"
 
     def __str__(self):
         return "{0} {1}".format(self.manufacturer, self.identifier)

dcc/roster/serializers.py

@@ -1,15 +1,15 @@
 from rest_framework import serializers
-from roster.models import Cab
+from roster.models import RollingStock
 from metadata.serializers import (
     ManufacturerSerializer, CompanySerializer, DecoderSerializer)
 
 
-class CabSerializer(serializers.ModelSerializer):
+class RollingStockSerializer(serializers.ModelSerializer):
     manufacturer = ManufacturerSerializer()
     decoder = DecoderSerializer()
     company = CompanySerializer()
 
     class Meta:
-        model = Cab
+        model = RollingStock
         fields = "__all__"
         read_only_fields = ("creation_time", "updated_time")

dcc/roster/views.py

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