Ruff maps

pyproject.toml

@@ -68,6 +68,7 @@ test = [
     "coverage==7.8.0",
     "factory_boy==3.3.3",
     "hypothesis==6.131.15",
+    "beautifulsoup4==4.13.4",
     "unittest-xml-reporting==3.2.0",
 ]
 
@@ -123,7 +124,8 @@ ignore = [
     "ANN001", # Missing type annotation for function argument ...
     "ANN201", # Missing return type annotation for public function ...
     "S101", # Allow use of assert
-    "S106", # Allow passwords in tests 
+    "S105", # Allow PASSWORD as password in tests 
+    "S106", # Allow passwords in tests
     "S113", # Probable use of requests call without timeout
     "E501", # Line too long
     "D104", # Missing docstring in public package

src/bornhack/environment_settings.py.dist

@@ -76,6 +76,9 @@ SCHEDULE_TIMESLOT_LENGTH_MINUTES=30
 SCHEDULE_EVENT_NOTIFICATION_MINUTES=10
 SPEAKER_AVAILABILITY_DAYCHUNK_HOURS=3 # how many hours per speaker_availability form checkbox
 
+# Map settings
+MAPS_USER_LOCATION_MAX = 50 # Maximum number of UserLocations a user can create
+
 # irc bot settings
 IRCBOT_CHECK_MESSAGE_INTERVAL_SECONDS=10
 IRCBOT_NICK='{{ django_ircbot_nickname }}'

src/bornhack/environment_settings.py.dist.dev

@@ -39,6 +39,9 @@ SCHEDULE_TIMESLOT_LENGTH_MINUTES = 30
 SCHEDULE_EVENT_NOTIFICATION_MINUTES = 10
 SPEAKER_AVAILABILITY_DAYCHUNK_HOURS=3
 
+# Map settings
+MAPS_USER_LOCATION_MAX = 50 # Maximum number of UserLocations a user can create
+
 PDF_TEST_MODE = True
 PDF_ARCHIVE_PATH = os.path.join(MEDIA_ROOT, "pdf_archive")
 

src/maps/__init__.py

@@ -0,0 +1 @@
+"""Maps Application."""

src/maps/admin.py

@@ -1,5 +1,9 @@
+"""Maps Django Admin."""
+
 from __future__ import annotations
 
+from typing import ClassVar
+
 from django.contrib import admin
 from leaflet.admin import LeafletGeoAdmin
 
@@ -13,47 +17,56 @@
 
 @admin.register(Feature)
 class FeatureAdmin(LeafletGeoAdmin, admin.ModelAdmin):
+    """Feature Admin."""
+
     display_raw = True
     save_as = True
-    list_display = [
+    list_display: ClassVar[list[str]] = [
         "name",
         "description",
     ]
-    list_filter = [
+    list_filter: ClassVar[list[str]] = [
         "layer",
     ]
 
-    def get_queryset(self, request):
-        self.request = request
-        return super().get_queryset(request)
 
 
 @admin.register(Layer)
 class LayerAdmin(admin.ModelAdmin):
+    """Layer admin."""
+
     save_as = True
-    list_display = ["name", "slug"]
+    list_display: ClassVar[list[str]] = ["name", "slug"]
 
 
 @admin.register(ExternalLayer)
 class ExternalLayerAdmin(admin.ModelAdmin):
+    """Layer admin."""
+
     save_as = True
-    list_display = ["name"]
+    list_display: ClassVar[list[str]] = ["name"]
 
 
 @admin.register(Group)
 class GroupAdmin(admin.ModelAdmin):
+    """Group admin."""
+
     save_as = True
-    list_display = ["name"]
+    list_display: ClassVar[list[str]] = ["name"]
 
 
 @admin.register(UserLocationType)
 class UserLocationTypeAdmin(admin.ModelAdmin):
+    """User Location Type admin."""
+
     save_as = True
-    list_display = ["name"]
+    list_display: ClassVar[list[str]] = ["name"]
 
 
 @admin.register(UserLocation)
 class UserLocationAdmin(admin.ModelAdmin):
+    """User Location admin."""
+
     save_as = True
-    list_display = ["name", "type", "user", "camp"]
-    list_filter = ["camp", "user"]
+    list_display: ClassVar[list[str]] = ["name", "type", "user", "camp"]
+    list_filter: ClassVar[list[str]] = ["camp", "user"]

src/maps/apps.py

@@ -1,7 +1,11 @@
+"""Apps for the Maps app."""
+
 from __future__ import annotations
 
 from django.apps import AppConfig
 
 
 class MapsConfig(AppConfig):
+    """Maps config."""
+
     name = "maps"

src/maps/mixins.py

@@ -1,5 +1,12 @@
+"""Mixins for Maps app."""
+
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from django.http import HttpRequest
+
 from django.contrib import messages
 from django.core.exceptions import PermissionDenied
 from django.shortcuts import get_object_or_404
@@ -14,19 +21,26 @@
     """A mixin to get the Layer object based on layer_slug in url kwargs."""
 
     def setup(self, *args, **kwargs) -> None:
+        """Set self.layer based on layer_slug in url kwargs."""
         super().setup(*args, **kwargs)
         self.layer = get_object_or_404(Layer, slug=self.kwargs["layer_slug"])
 
-    def get_context_data(self, *args, **kwargs):
+    def get_context_data(self, *args, **kwargs) -> dict:
+        """Add self.layer to context."""
         context = super().get_context_data(*args, **kwargs)
         context["layer"] = self.layer
         return context
 
 
 class LayerMapperViewMixin(LayerViewMixin):
-    """A mixin for views only available to users with mapper permission for the team responsible for the layer and/or Mapper team permission."""
+    """A mixin for LayerMapper.
 
-    def setup(self, request, *args, **kwargs) -> None:
+    For views only available to users with mapper permission for the team responsible
+    for the layer and/or Mapper team permission.
+    """
+
+    def setup(self, request: HttpRequest, *args, **kwargs) -> None:
+        """Check permissions."""
         super().setup(request, *args, **kwargs)
         if (
             self.layer.responsible_team
@@ -40,7 +54,8 @@
 class GisTeamViewMixin:
     """A mixin for views only available to users with `camps.gis_team_member` permission."""
 
-    def setup(self, request, *args, **kwargs) -> None:
+    def setup(self, request: HttpRequest, *args, **kwargs) -> None:
+        """Check permissions."""
         super().setup(request, *args, **kwargs)
         if self.request.user.has_perm("camps.gis_team_member"):
             return
@@ -52,6 +67,7 @@
     """A mixin to get the ExternalLayer object based on external_layer_uuid in url kwargs."""
 
     def setup(self, *args, **kwargs) -> None:
+        """Set self.layer."""
         super().setup(*args, **kwargs)
         self.layer = get_object_or_404(
             ExternalLayer,
@@ -60,9 +76,14 @@
 
 
 class ExternalLayerMapperViewMixin(ExternalLayerViewMixin):
-    """A mixin for views only available to users with mapper permission for the team responsible for the layer and/or Mapper team permission."""
+    """A mixin for views.
+
+    only available to users with mapper permission for the team responsible
+    for the layer and/or Mapper team permission.
+    """
 
-    def setup(self, request, *args, **kwargs) -> None:
+    def setup(self, request: HttpRequest, *args, **kwargs) -> None:
+        """Check permissions."""
         super().setup(request, *args, **kwargs)
         if (
             self.layer.responsible_team

src/maps/models.py

@@ -1,6 +1,14 @@
+"""Maps models."""
+
 from __future__ import annotations
 
 import logging
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from camps.models import Camp
+
+from typing import ClassVar
 
 from colorfield.fields import ColorField
 from django.contrib.auth.models import User
@@ -27,6 +35,7 @@ class Group(UUIDModel):
     )
 
     def __str__(self) -> str:
+        """String formatter."""
         return str(self.name)
 
 
@@ -73,13 +82,16 @@ class Layer(ExportModelOperationsMixin("layer"), UUIDModel):
     )
 
     @property
-    def camp(self):
+    def camp(self) -> Camp:
+        """Camp object reference."""
         return self.responsible_team.camp
 
     def __str__(self) -> str:
+        """String formatter."""
         return str(self.name)
 
     def save(self, **kwargs) -> None:
+        """Set slug and save."""
         self.slug = unique_slugify(
             str(self.name),
             slugs_in_use=self.__class__.objects.all().values_list(
@@ -134,22 +146,28 @@ class Feature(UUIDModel):
     )
 
     class Meta:
-        constraints = [
+        """Meta data."""
+
+        constraints: ClassVar[list] = [
             models.UniqueConstraint(
                 fields=["layer", "name"],
                 name="layer_and_name_uniq",
             ),
         ]
 
     def __str__(self) -> str:
+        """String formatter."""
         return str(self.name)
 
     @property
-    def camp(self):
+    def camp(self) -> Camp:
+        """Camp object reference."""
         return self.layer.team.camp
 
 
 class ExternalLayer(UUIDModel):
+    """External layer model."""
+
     name = models.CharField(
         max_length=100,
         help_text="Name or description of this layer",
@@ -177,13 +195,16 @@ class ExternalLayer(UUIDModel):
     )
 
     @property
-    def camp(self):
+    def camp(self) -> Camp:
+        """Camp object reference."""
         return self.responsible_team.camp
 
     def __str__(self) -> str:
+        """String formatter."""
         return str(self.name)
 
     def save(self, **kwargs) -> None:
+        """Set slug and save."""
         self.slug = unique_slugify(
             str(self.name),
             slugs_in_use=self.__class__.objects.all().values_list(
@@ -195,6 +216,8 @@ def save(self, **kwargs) -> None:
 
 
 class UserLocationType(UUIDModel):
+    """User Location Type model."""
+
     name = models.CharField(
         max_length=100,
         help_text="Name of the user location type",
@@ -220,9 +243,11 @@ class UserLocationType(UUIDModel):
     )
 
     def __str__(self) -> str:
+        """String formatter."""
         return self.name
 
     def save(self, **kwargs) -> None:
+        """Set slug and save."""
         if not self.slug:
             self.slug = unique_slugify(
                 self.name,
@@ -238,6 +263,8 @@ class UserLocation(
     UUIDModel,
     CampRelatedModel,
 ):
+    """UserLocation model."""
+
     name = models.CharField(
         max_length=100,
         help_text="Name of the location",
@@ -278,4 +305,5 @@ class UserLocation(
     )
 
     def __str__(self) -> str:
+        """String formatter."""
         return self.name

src/maps/templates/maps_map.html

@@ -22,7 +22,7 @@
   {{ mapData|json_script:"mapData" }}
   <script src="{% static 'js/maps/generic/mapVars.js' %}?v=1" type="text/javascript"></script>
   <script src="{% static 'js/maps/generic/mapProcessing.js' %}" type="text/javascript"></script>
-  <script src="{% static 'js/maps/generic/map.js?v=1' %}" type="text/javascript"></script>
+  <script src="{% static 'js/maps/generic/map.js' %}?v=1" type="text/javascript"></script>
 {% endblock extra_head %}
 
 {% block content %}