v0.9.0

.gitignore

@@ -128,6 +128,9 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+# JS ignored folders
+node_modules
+
 # Custom
 .backup
 .data

apps/api/views.py

@@ -1,5 +1,5 @@
-from django.contrib.auth.models import Group, User
 from rest_framework import permissions, viewsets
+from rest_framework.permissions import IsAuthenticated, IsAuthenticatedOrReadOnly
 
 from ..website.models import Place, Share, WordFrequency
 from .serializers import PlaceSerializer, ShareSerializer, WordFrequencySerializer
@@ -10,20 +10,20 @@ class PlaceViewSet(viewsets.ModelViewSet):
 
     queryset = Place.objects.order_by("slug").all()
     serializer_class = PlaceSerializer
-    permission_classes = [permissions.IsAuthenticated]
+    permission_classes = [IsAuthenticatedOrReadOnly]
 
 
 class ShareViewSet(viewsets.ModelViewSet):
     """API endpoint for shares."""
 
     queryset = Share.objects.order_by("timestamp").all()
     serializer_class = ShareSerializer
-    permission_classes = [permissions.IsAuthenticated]
+    permission_classes = [IsAuthenticated]
 
 
 class WordFrequencyViewSet(viewsets.ModelViewSet):
     """API endpoint for word frequencies."""
 
     queryset = WordFrequency.objects.order_by("place", "word").all()
     serializer_class = WordFrequencySerializer
-    permission_classes = [permissions.IsAuthenticated]
+    permission_classes = [IsAuthenticatedOrReadOnly]

apps/showcase/templates/showcase/showcase.html

@@ -1,7 +1,7 @@
-{% extends "map.html" %}
+{% extends "website/map.html" %}
 
-{% load sass_tags %}
 {% load static %}
+{% load sass_tags %}
 
 {% block custom_meta %}
   {% if reload and reload > 0 %}
@@ -11,7 +11,7 @@
 
 {% block stylesheet %}
   {{ block.super }}
-  <link rel="stylesheet" href="{% sass_src 'showcase/css/scaling.scss' %}">
+  <link type="text/css" rel="stylesheet" href="{% sass_src 'showcase/css/scaling.scss' %}">
 {% endblock %}
 
 

apps/website/migrations/0013_share_place_share_words_alter_share_timestamp.py

@@ -0,0 +1,37 @@
+# Generated by Django 4.2.5 on 2023-09-16 19:06
+
+from django.db import migrations, models
+import django.db.models.deletion
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("website", "0012_landscape_enabled_alter_landscape_domain"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="share",
+            name="place",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="shares",
+                to="website.place",
+            ),
+        ),
+        migrations.AddField(
+            model_name="share",
+            name="words",
+            field=models.ManyToManyField(
+                blank=True, related_name="shares", to="website.word"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="share",
+            name="timestamp",
+            field=models.DateTimeField(default=django.utils.timezone.now),
+        ),
+    ]

apps/website/models.py

@@ -7,6 +7,7 @@
 from django.contrib.gis.geos import Point
 from django.db.models import F, Max, Q, Sum
 from django.shortcuts import get_object_or_404
+from django.utils import timezone
 from django.utils.translation import gettext as _
 
 from .fields import UniqueBooleanField
@@ -50,16 +51,6 @@ class Meta:
         abstract = True
 
 
-class Share(LocationModel):
-    timestamp = models.DateTimeField(auto_now_add=True)
-    message = models.TextField(max_length=500)
-    landscape = models.ForeignKey("Landscape", on_delete=models.CASCADE)
-
-    def __str__(self):
-        message = textwrap.shorten(self.message, width=20, placeholder="...")
-        return f"{super().__str__()} [{message}]"
-
-
 class LeafletProvider(TitledModel):
     name = models.CharField(
         max_length=100,
@@ -133,6 +124,25 @@ def __str__(self):
         return ("🚩 " if not self.visible else "") + self.text
 
 
+class Share(LocationModel):
+    timestamp = models.DateTimeField(default=timezone.now)
+    message = models.TextField(max_length=500)
+    landscape = models.ForeignKey("Landscape", on_delete=models.CASCADE)
+
+    place = models.ForeignKey(
+        Place,
+        related_name="shares",
+        null=True,
+        blank=True,
+        on_delete=models.SET_NULL,
+    )
+    words = models.ManyToManyField(Word, related_name="shares", blank=True)
+
+    def __str__(self):
+        message = textwrap.shorten(self.message, width=20, placeholder="...")
+        return f"{super().__str__()} [{message}]"
+
+
 class WordFrequency(models.Model):
     word = models.ForeignKey(
         Word,

apps/website/scripts/add_demo_shares.py

@@ -11,7 +11,7 @@
 
 from django.conf import settings
 from django.contrib.gis.geos import Point
-from loguru import logger
+from django.utils import timezone
 from tqdm import tqdm
 
 from .. import models
@@ -21,12 +21,20 @@
 TEXT_ROW_RE = re.compile(r"[A-Za-z]")
 
 
+def random_timestamp(delta=1440):
+    minutes = round(random.gauss(0, delta))
+    return timezone.now() + timezone.timedelta(minutes=minutes)
+
+
 def save_share(location: Point, message: str, landscape: models.Landscape):
-    defaults = {"location": location, "message": message, "landscape": landscape}
-    share = models.Share(**defaults)
+    share = models.Share(
+        location=location,
+        message=message,
+        landscape=landscape,
+        timestamp=random_timestamp(),
+    )
     share.full_clean()
     share.save()
-    logger.debug(f"Created Share: {share}")
     return share
 
 
@@ -42,16 +50,13 @@ def run():
         shares = fp.readlines()
 
     landscape = models.Landscape.visible_objects.get_default()
-    places = list(landscape.places.all())
+    places = [p.coordinates for p in landscape.places.all()]
 
     for message in tqdm(shares):
         if not TEXT_ROW_RE.match(message):
             continue
 
-        point = random.choice(places).location
-
-        lat = point.x + random.gauss(0, 0.5)
-        lon = point.y + random.gauss(0, 0.5)
+        lat, lon = random.choice(places)
         location = Point(x=lon, y=lat)
 
         save_share(location, message, landscape)

apps/website/scripts/recalculate_shares.py

@@ -0,0 +1,46 @@
+import re
+
+import spacy.symbols
+from django.conf import settings
+from django.contrib.gis.db.models.functions import Distance
+from loguru import logger
+from tqdm import tqdm
+
+from .. import models
+
+# For more info see:
+# https://stackoverflow.com/questions/9662346/python-code-to-remove-html-tags-from-a-string
+HTML_TAG_RE = re.compile("<.*?>|&([a-z0-9]+|#[0-9]{1,6}|#x[0-9a-f]{1,6});")
+
+try:
+    nlp = spacy.load(settings.SPACY_MODEL_NAME)
+except IOError:
+    logger.info("Spacy model not found downloading it")
+    spacy.cli.download(settings.SPACY_MODEL_NAME)
+    nlp = spacy.load(settings.SPACY_MODEL_NAME)
+
+
+def recalculate_share(instance: models.Share):
+    place = (
+        models.Place.objects.filter(landscape=instance.landscape)
+        .annotate(distance=Distance("location", instance.location))
+        .order_by("distance")
+        .first()
+    )
+
+    instance.place = place
+    instance.save()
+
+    for token in nlp(instance.message):
+        if token.pos not in settings.SPACY_VALID_TOKENS:
+            continue
+
+        text = HTML_TAG_RE.sub("", token.lemma_).strip().lower()
+
+        word, created = models.Word.objects.get_or_create(text=text)
+        instance.words.add(word)
+
+
+def run():
+    for share in tqdm(models.Share.objects.all()):
+        recalculate_share(share)

apps/website/signals.py

@@ -38,6 +38,9 @@ def on_share_creation_update_frequencies(
         .first()
     )
 
+    instance.place = place
+    instance.save()
+
     logger.debug(
         f"Receive share near [{place}], update WordFrequency "
         f"(message: {instance.message})"
@@ -59,6 +62,8 @@ def on_share_creation_update_frequencies(
         word.full_clean()
         word.save()
 
+        instance.words.add(word)
+
         wf, _ = models.WordFrequency.objects.get_or_create(place=place, word=word)
         wf.frequency = F("frequency") + 1
         wf.save()

apps/website/static/website/css/map.scss

@@ -1,13 +1,15 @@
 /* Leaflet map related styles */
 
+@import "../../../../../static/css/palette";
+
 .canvas span {
   /* Better solution only available in firefox 
       -webkit-text-stroke: 2px white;    
       paint-order: stroke fill; */
-  $size: 2px;
+  $size: 1px;
   $blur: 0;
 
-  $color: white;
+  $color: $color-background;
   text-shadow:  
     $size  $size $blur $color,
    -$size  $size $blur $color,
@@ -17,7 +19,7 @@
 
 
   &:hover { 
-    $color: silver;
+    $color: var(--color-gray, Gray);
     text-shadow:
       $size  $size $blur $color,
      -$size  $size $blur $color,

apps/website/static/website/css/share.scss

@@ -1,12 +1,12 @@
 /* Share page custom style rules */ 
 
-@import "palette";
+@import "../../../../../static/css/palette";
 
 
 #location-auto-icon svg{
-  color: gray;
+  color: $gray;
 
-  &[data-state="disabled"] { color: lightgray; }
+  &[data-state="disabled"] { color: $light-gray; }
   &[data-state="processing"] { color: $orange; }
   &[data-state="success"] { color: $green; }
   &[data-state="error"] { color: $red; }
@@ -17,7 +17,7 @@ $animation-colors: ("red": $red, "gray": $gray);
 @each $name, $color in $animation-colors {
   @keyframes color-animation--#{$name} {
     from {
-      color: $white;
+      color: $color-background;
     }
     to {
       color: $color;
@@ -55,5 +55,4 @@ a#record-button {
     background-color: $gray; 
     animation-name: color-animation--gray;
   }
-
 }