website-v2/versions/models.py

import re
from django.db import models
from django.urls import reverse
from django.utils.functional import cached_property
from django.utils.text import slugify

from .managers import VersionManager, VersionFileManager


class Version(models.Model):
    name = models.CharField(
        max_length=256, null=False, blank=False, help_text="Version name"
    )
    slug = models.SlugField(blank=True, null=True)
    release_date = models.DateField(auto_now=False, auto_now_add=False, null=True)
    description = models.TextField(blank=True)
    active = models.BooleanField(
        default=True,
        help_text="Control whether or not this version is available on the website",
    )
    github_url = models.URLField(
        max_length=500,
        blank=True,
        null=True,
        help_text="The URL of the Boost version's GitHub repository.",
    )
    beta = models.BooleanField(
        default=False, help_text="Whether this is a beta release"
    )
    full_release = models.BooleanField(
        default=True,
        help_text="Whether this is a full release and not a "
        "beta release or a development version",
    )
    data = models.JSONField(default=dict)

    objects = VersionManager()

    def __str__(self):
        return self.name

    def save(self, *args, **kwargs):
        if not self.slug:
            self.slug = self.get_slug()
        return super(Version, self).save(*args, **kwargs)

    def get_absolute_url(self):
        return reverse("release-detail", args=[str(self.slug)])

    def get_slug(self):
        if self.slug:
            return self.slug
        name = self.name.replace(".", " ").replace("boost_", "")
        return slugify(name)[:50]

    @cached_property
    def display_name(self):
        return self.name.replace("boost-", "")

    @cached_property
    def boost_url_slug(self):
        """Return the slug for the version that is used in the Boost URL to get to
        the existing Boost docs. The GitHub slug and the Boost slug don't match, so
        this method converts the GitHub slug to the Boost slug.

        Example:
        - "boost-1.75.0" --> "boost_1_75_0"
        - "develop" --> "develop"
        """
        return self.slug.replace("-", "_").replace(".", "_")

    @cached_property
    def stripped_boost_url_slug(self):
        """Return the only the numbers and underscores for this version

        Example:
        - "boost-1.75.0" --> "1_75_0"
        - "develop" --> "develop"
        """
        return self.slug.replace("-", "_").replace(".", "_").replace("boost_", "")

    @cached_property
    def boost_release_notes_url(self):
        """Return the URL path to the release notes for this version of Boost on
        the existing Boost.org website.
        """
        slug = self.boost_url_slug.replace("boost", "version")
        return f"https://www.boost.org/users/history/{slug}.html"

    @cached_property
    def documentation_url(self):
        """Return the URL path to documentation for this version of Boost.
        This maps to the appropriate directory in the S3 bucket. See the
        static content config file for the mapping from the site_path to the
        S3 path."""
        site_path = "/doc/libs/"
        slug = self.slug.replace("-", "_").replace(".", "_").replace("boost_", "")
        return f"{site_path}{slug}"

    @cached_property
    def cleaned_version_parts(self):
        """Returns only the release data from the name. Also omits "boost", "beta"
        information from the name."""
        if not self.name:
            return

        cleaned = re.sub(r"^[^0-9]*", "", self.name).split("beta")[0]
        return [part for part in cleaned.split(".") if part]

    @cached_property
    def cleaned_version_parts_int(self):
        """Returns the release data as a list of integers."""
        if not self.cleaned_version_parts:
            return []
        return [int(x) if x.isdigit() else 0 for x in self.cleaned_version_parts]

    @cached_property
    def release_notes_cache_key(self):
        """Returns the cahe key used to access the release notes in the
        RenderedContent model."""
        version = "-".join(self.cleaned_version_parts)
        return f"release_notes_boost-{version}"


class VersionFile(models.Model):
    Unix = "Unix"
    Windows = "Windows"
    OPERATING_SYSTEM_CHOICES = (
        (Unix, "Unix"),
        (Windows, "Windows"),
    )

    version = models.ForeignKey(
        Version, related_name="downloads", on_delete=models.CASCADE
    )
    operating_system = models.CharField(
        choices=OPERATING_SYSTEM_CHOICES, max_length=15, default=Unix
    )
    checksum = models.CharField(max_length=64, unique=True, default=None)
    url = models.URLField()
    display_name = models.CharField(max_length=256, blank=True, null=True)

    objects = VersionFileManager()