post-build.py

# pyimpspec is licensed under the GPLv3 or later (https://www.gnu.org/licenses/gpl-3.0.html).
# Copyright 2024 pyimpspec developers
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
#
# The licenses of pyimpspec's dependencies and/or sources of portions of code are included in
# the LICENSES folder.

from dataclasses import dataclass
from datetime import date
from pathlib import Path
from re import search
from shutil import (
    copy,
    copytree,
    rmtree,
)
from typing import (
    IO,
    List,
    Match,
    Optional,
    Union,
)


PARENT_DIRECTORY: Path = Path(__file__).parent


def copy_html(src: Path, dst: Path):
    if dst.is_dir():
        rmtree(dst)
    
    files: List[Path] = []

    path: Path
    for path in src.glob("*"):
        if path.is_file():
            files.append(path)

    assert len(files) > 0
    
    files = [
        path
        for path in files
        if not str(path).startswith(".")
        and path.suffix.lower()
        in (
            ".html",
            ".js",
            ".png",
            ".py",
            ".svg",
        )
    ]
    
    dirs: List[Path] = list(map(Path, ("_images", "_static", "_sources")))
    
    if not dst.is_dir():
        dst.mkdir(parents=True)
    
    for path in files:
        copy(src.joinpath(path.name), dst.joinpath(path.name))
    
    for path in dirs:
        copytree(src.joinpath(path.name), dst.joinpath(path.name))


def copy_pdf(src: Path, dst: Path, name: str, version_path: Path):
    version: str = ""
    
    fp: IO
    with open(version_path, "r") as fp:
        version = fp.read().strip().replace(".", "-")
    
    assert version != ""
    
    ext: str = src.suffix
    dst = dst.joinpath(f"{name}-{version}{ext}")
    if dst.is_file():
        dst.unlink()
    
    copy(src, dst)


@dataclass(frozen=True)
class Version:
    major: int
    minor: int
    patch: int
    year: int
    month: int
    day: int


def validate_changelog(path: Path):
    def parse_version(match: Match) -> Version:
        return Version(
            major=int(match.group("major")),
            minor=int(match.group("minor")),
            patch=int(match.group("patch")),
            year=int(match.group("year")),
            month=int(match.group("month")),
            day=int(match.group("day")),
        )

    def validate_date(
        version: Version,
        comparison: Union[Version, date] = date.today(),
    ):
        assert version.year <= comparison.year, (version, comparison)
        assert 1 <= version.month <= 12, version
        assert 1 <= version.day <= 31, version
        if version.year == comparison.year:
            assert version.month <= comparison.month, (version, comparison)
            if version.month == comparison.month:
                assert version.day <= comparison.day, (version, comparison)

    def validate_version(earlier: Version, current: Version):
        assert earlier.major <= current.major, (earlier, current)
        
        if earlier.major < current.major:
            return
        
        assert earlier.minor <= current.minor, (earlier, current)
        
        if earlier.minor < current.minor:
            return
        
        assert earlier.patch < current.patch, (earlier, current)

    assert path.is_file(), path
    
    fp: IO
    with open(path, "r") as fp:
        lines: List[str] = fp.readlines()
    
    pattern: str = (
        r"# (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)"
        r" \((?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})\)"
    )
    
    try:
        match: Optional[Match] = search(pattern, lines.pop(0))
        assert match is not None, pattern
        
        versions: List[Version] = list(
            map(
                parse_version,
                [match]
                + [
                    match
                    for match in map(lambda _: search(pattern, _), lines)
                    if match is not None
                ],
            )
        )

        list(map(validate_date, versions))

        while len(versions) > 1:
            current: Version = versions.pop(0)
            earlier = versions[0]
            validate_date(earlier, current)
            validate_version(earlier, current)

    except AssertionError:
        raise Exception("The changelog needs to be updated!")


if __name__ == "__main__":
    copy_html(
        src=PARENT_DIRECTORY.joinpath("docs", "build", "html"),
        dst=PARENT_DIRECTORY.joinpath("dist", "html"),
    )
    copy_pdf(
        src=PARENT_DIRECTORY.joinpath("docs", "build", "latex", "latex", "pyimpspec.pdf"),
        dst=PARENT_DIRECTORY.joinpath("dist"),
        name="pyimpspec",
        version_path=PARENT_DIRECTORY.joinpath("version.txt"),
    )
    validate_changelog(PARENT_DIRECTORY.joinpath("CHANGELOG.md"))