rbx.cp 0.14.0__tar.gz → 0.16.0__tar.gz

{rbx_cp-0.14.0 → rbx_cp-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rbx.cp
-Version: 0.14.0
+Version: 0.16.0
 Summary: 
 Author: Roberto Sales
 Requires-Python: >=3.9.1,<4.0.0
@@ -40,6 +40,7 @@ Requires-Dist: requests (>=2.32.3,<3.0.0)
 Requires-Dist: rich (>=13.9.4,<14.0.0)
 Requires-Dist: ruamel-yaml (>=0.18.14,<0.19.0)
 Requires-Dist: ruyaml (>=0.91.0,<0.92.0)
+Requires-Dist: semver (>=3.0.4,<4.0.0)
 Requires-Dist: sqlitedict (>=2.1.0,<3.0.0)
 Requires-Dist: syncer (>=2.0.3,<3.0.0)
 Requires-Dist: textual (>=3.1.1,<4.0.0)

{rbx_cp-0.14.0 → rbx_cp-0.16.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rbx.cp"
-version = "0.14.0"
+version = "0.16.0"
 description = ""
 packages = [
   {include = "rbx"}
@@ -52,6 +52,7 @@ iso639-lang = "^2.6.1"
 sqlitedict = "^2.1.0"
 throttlex = "^1.0.0"
 typing-extensions = "^4.14.1"
+semver = "^3.0.4"
 
 [tool.poetry.scripts]
 rbx = "rbx.box.main:app"
@@ -83,6 +84,10 @@ version_provider = "poetry"
 update_changelog_on_bump = true
 major_version_zero = true
 annotated_tag = true
+version_files = [
+  "rbx/__version__.py",
+  "rbx/resources/presets/default/preset.rbx.yml:^version",
+]
 
 [build-system]
 requires = ["poetry-core"]

rbx_cp-0.16.0/rbx/__version__.py

@@ -0,0 +1 @@
+__version__ = '0.16.0'

rbx_cp-0.16.0/rbx/box/git_utils.py

@@ -0,0 +1,56 @@
+import pathlib
+import subprocess
+from typing import List, Optional
+
+import git
+import semver
+
+
+def get_repo_or_nil(
+    root: pathlib.Path = pathlib.Path(), search_parent_directories: bool = False
+) -> Optional[git.Repo]:
+    try:
+        return git.Repo(root, search_parent_directories=search_parent_directories)
+    except git.InvalidGitRepositoryError:
+        return None
+
+
+def is_repo(path: pathlib.Path) -> bool:
+    return get_repo_or_nil(path, search_parent_directories=False) is not None
+
+
+def is_within_repo(path: pathlib.Path) -> bool:
+    return get_repo_or_nil(path, search_parent_directories=True) is not None
+
+
+def get_any_remote(repo: git.Repo) -> Optional[git.Remote]:
+    for remote in repo.remotes:
+        if remote.exists():
+            return remote
+    return None
+
+
+def _parse_tag_from_ref(ref: str) -> str:
+    return ref.split('/')[-1].split('^{}')[0]
+
+
+def ls_remote_tags(uri: str) -> List[str]:
+    completed_process = subprocess.run(
+        ['git', 'ls-remote', '--tags', uri],
+        check=True,
+        capture_output=True,
+        text=True,
+    )
+    return [
+        _parse_tag_from_ref(line.split('\t')[1])
+        for line in completed_process.stdout.split('\n')
+        if line
+    ]
+
+
+def latest_remote_tag(uri: str) -> str:
+    tags = ls_remote_tags(uri)
+    valid_tags = [tag for tag in tags if semver.Version.is_valid(tag)]
+    if not valid_tags:
+        raise ValueError(f'No valid tags found for {uri}')
+    return sorted(valid_tags, key=semver.VersionInfo.parse)[-1]

{rbx_cp-0.14.0 → rbx_cp-0.16.0}/rbx/box/presets/__init__.py

@@ -1,15 +1,23 @@
+import functools
 import os
 import pathlib
 import shutil
 import tempfile
 from typing import Annotated, Iterable, List, Optional, Sequence, Set, Tuple, Union
 
+import questionary
 import ruyaml
+import semver
 import typer
 
 from rbx import console, utils
 from rbx.box import cd
-from rbx.box.presets.fetch import PresetFetchInfo, get_preset_fetch_info
+from rbx.box.git_utils import latest_remote_tag
+from rbx.box.presets.fetch import (
+    PresetFetchInfo,
+    get_preset_fetch_info,
+    get_remote_uri_from_tool_preset,
+)
 from rbx.box.presets.lock_schema import LockedAsset, PresetLock, SymlinkInfo
 from rbx.box.presets.schema import Preset, TrackedAsset
 from rbx.config import get_default_app_path
@@ -17,7 +25,7 @@ from rbx.grading.judge.digester import digest_cooperatively
 
 app = typer.Typer(no_args_is_help=True)
 
-_FALLBACK_PRESET_URI = 'rsalesc/rbx/rbx/resources/presets/default'
+_FALLBACK_PRESET_NAME = 'default'
 
 
 def find_preset_yaml(root: pathlib.Path = pathlib.Path()) -> Optional[pathlib.Path]:
@@ -27,6 +35,30 @@ def find_preset_yaml(root: pathlib.Path = pathlib.Path()) -> Optional[pathlib.Pa
     return None
 
 
+@functools.cache
+def _check_preset_compatibility(preset_name: str, preset_version: str) -> None:
+    compatibility = utils.check_version_compatibility(preset_version)
+    if compatibility == utils.SemVerCompatibility.OUTDATED:
+        console.console.print(
+            f'[error]Preset [item]{preset_name}[/item] requires rbx at version [item]{preset_version}[/item], but the current version is [item]{utils.get_version()}[/item].[/error]'
+        )
+        console.console.print(
+            f'[error]Please update rbx.cp to the latest compatible version using [item]{utils.get_upgrade_command(preset_version)}[/item].[/error]'
+        )
+        raise typer.Exit(1)
+    if compatibility == utils.SemVerCompatibility.BREAKING_CHANGE:
+        console.console.print(
+            f'[error]Preset [item]{preset_name}[/item] requires rbx at version [item]{preset_version}[/item], but the current version is [item]{utils.get_version()}[/item].[/error]'
+        )
+        console.console.print(
+            '[error]rbx version is newer, but is in a later major version, which might have introduced breaking changes.[/error]'
+        )
+        console.console.print(
+            '[error]If you are sure that the preset is compatible with the current rbx version, you can change the [item]min_version[/item] field in the preset file ([item].local.rbx/preset.rbx.yml)[/item] to the current version.[/error]'
+        )
+        raise typer.Exit(1)
+
+
 def get_preset_yaml(root: pathlib.Path = pathlib.Path()) -> Preset:
     found = find_preset_yaml(root)
     if not found:
@@ -34,7 +66,9 @@ def get_preset_yaml(root: pathlib.Path = pathlib.Path()) -> Preset:
             f'[error][item]preset.rbx.yml[/item] not found in [item]{root.absolute()}[/item][/error]'
         )
         raise typer.Exit(1)
-    return utils.model_from_yaml(Preset, found.read_text())
+    preset = utils.model_from_yaml(Preset, found.read_text())
+    _check_preset_compatibility(preset.name, preset.min_version)
+    return preset
 
 
 def _find_preset_lock(root: pathlib.Path = pathlib.Path()) -> Optional[pathlib.Path]:
@@ -478,7 +512,7 @@ def get_preset_fetch_info_with_fallback(
         # Use active preset if any, otherwise use the default preset.
         if get_active_preset_or_null() is not None:
             return None
-        default_preset = get_preset_fetch_info(_FALLBACK_PRESET_URI)
+        default_preset = get_preset_fetch_info(_FALLBACK_PRESET_NAME)
         if default_preset is None:
             console.console.print(
                 '[error]Internal error: could not find [item]default[/item] preset.[/error]'
@@ -527,6 +561,15 @@ def install_preset_from_dir(
             f'[error]Preset [item]{preset.name}[/item] does not have a problem package definition.[/error]'
         )
         raise typer.Exit(1)
+
+    try:
+        _check_preset_compatibility(preset.name, preset.min_version)
+    except Exception:
+        console.console.print(
+            f'[error]Error updating preset [item]{preset.name}[/item] to its latest version.[/error]'
+        )
+        raise
+
     dest.parent.mkdir(parents=True, exist_ok=True)
     copy_tree_normalizing_gitdir(src, dest, update=update)
 
@@ -614,6 +657,29 @@ def _install_preset_from_resources(
     yaml_path = rsrc_preset_path / 'preset.rbx.yml'
     if not yaml_path.is_file():
         return False
+    preset_uri = get_remote_uri_from_tool_preset(fetch_info.name)
+    remote_fetch_info = get_preset_fetch_info(preset_uri)
+    if remote_fetch_info is None or remote_fetch_info.fetch_uri is None:
+        console.console.print(
+            f'[error]Preset [item]{fetch_info.name}[/item] not found.[/error]'
+        )
+        raise typer.Exit(1)
+
+    # Check if the latest release has breaking changes.
+    latest_tag = latest_remote_tag(remote_fetch_info.fetch_uri)
+    latest_version = semver.VersionInfo.parse(latest_tag)
+    if latest_version.major > utils.get_semver().major:
+        console.console.print(
+            f'[error]You are not in rbx.cp latest major version ({latest_version.major}), but are installing a built-in preset from rbx.cp.[/error]'
+        )
+        console.console.print(
+            f'[error]To allow for a better experience for users that clone your repository, please update rbx.cp to the latest major version using [item]{utils.get_upgrade_command(latest_version)}[/item].[/error]'
+        )
+        if not questionary.confirm(
+            'If you want to proceed anyway, press [y]', default=False
+        ).ask():
+            raise typer.Exit(1)
+
     console.console.print(
         f'Installing preset [item]{fetch_info.name}[/item] from resources...'
     )
@@ -622,7 +688,7 @@ def _install_preset_from_resources(
         dest,
         ensure_contest,
         ensure_problem,
-        override_uri=str(utils.abspath(rsrc_preset_path)),
+        override_uri=preset_uri,
         update=update,
     )
     return True
@@ -653,15 +719,14 @@ def _install_preset_from_fetch_info(
             update=update,
         )
         return
-    # NOTE: Disabled for now.
-    # if _install_preset_from_resources(
-    #     fetch_info,
-    #     dest,
-    #     ensure_contest=ensure_contest,
-    #     ensure_problem=ensure_problem,
-    #     update=update,
-    # ):
-    #     return
+    if _install_preset_from_resources(
+        fetch_info,
+        dest,
+        ensure_contest=ensure_contest,
+        ensure_problem=ensure_problem,
+        update=update,
+    ):
+        return
     console.console.print(
         f'[error]Preset [item]{fetch_info.name}[/item] not found.[/error]'
     )

{rbx_cp-0.14.0 → rbx_cp-0.16.0}/rbx/box/presets/fetch.py

@@ -25,6 +25,14 @@ class PresetFetchInfo(BaseModel):
         return bool(self.inner_dir) and not self.is_remote()
 
 
+def get_inner_dir_from_tool_preset(tool_preset: str) -> str:
+    return f'rbx/resources/presets/{tool_preset}'
+
+
+def get_remote_uri_from_tool_preset(tool_preset: str) -> str:
+    return f'rsalesc/rbx/{get_inner_dir_from_tool_preset(tool_preset)}'
+
+
 def get_preset_fetch_info(uri: Optional[str]) -> Optional[PresetFetchInfo]:
     if uri is None:
         return None
@@ -64,7 +72,7 @@ def get_preset_fetch_info(uri: Optional[str]) -> Optional[PresetFetchInfo]:
             return None
         return PresetFetchInfo(name=path.name, inner_dir=str(path))
 
-    def get_local_fetch_info(s: str) -> Optional[PresetFetchInfo]:
+    def get_tool_fetch_info(s: str) -> Optional[PresetFetchInfo]:
         pattern = r'[\w\-]+'
         compiled = re.compile(pattern)
         match = compiled.match(s)
@@ -76,7 +84,7 @@ def get_preset_fetch_info(uri: Optional[str]) -> Optional[PresetFetchInfo]:
         get_github_fetch_info,
         get_short_github_fetch_info,
         get_local_dir_fetch_info,
-        get_local_fetch_info,
+        get_tool_fetch_info,
     ]
 
     for extract in extractors:

{rbx_cp-0.14.0 → rbx_cp-0.16.0}/rbx/box/presets/schema.py

@@ -1,8 +1,9 @@
 import pathlib
 from typing import List, Optional
 
+import semver
 import typer
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, field_validator
 
 from rbx import console
 from rbx.box.presets.fetch import PresetFetchInfo, get_preset_fetch_info
@@ -42,6 +43,9 @@ class Preset(BaseModel):
     # Should usually be a GitHub repository.
     uri: str
 
+    # Minimum version of rbx.cp required to use this preset.
+    min_version: str = '0.14.0'
+
     # Path to the environment file that will be installed with this preset.
     # When copied to the box environment, the environment will be named `name`.
     env: Optional[pathlib.Path] = None
@@ -57,6 +61,17 @@ class Preset(BaseModel):
     # package changes in the preset, or when a latex template is changed.
     tracking: Tracking = Field(default_factory=Tracking)
 
+    @field_validator('min_version')
+    @classmethod
+    def validate_min_version(cls, value: str) -> str:
+        try:
+            semver.Version.parse(value)
+        except ValueError as err:
+            raise ValueError(
+                "min_version must be a valid SemVer string (e.g., '1.2.3' or '1.2.3-rc.1')"
+            ) from err
+        return value
+
     @property
     def fetch_info(self) -> PresetFetchInfo:
         res = get_preset_fetch_info(self.uri)

{rbx_cp-0.14.0 → rbx_cp-0.16.0}/rbx/resources/presets/default/contest/statement/info.rbx.tex

@@ -1,14 +1,6 @@
-\documentclass{article}
-\usepackage[a4paper, margin=1in]{geometry}
-\usepackage{multirow}
-\usepackage{multicol}
-\usepackage{graphicx}
-\usepackage{amsfonts}
-\usepackage[brazil]{babel}
-\usepackage[utf8]{inputenc}
-\usepackage[T1]{fontenc}
-
-\usepackage[utf8]{inputenc}
+\documentclass[a4paper, 11pt]{article}
+
+\def\lang{\VAR{lang}}
 \usepackage{icpc}
 
 %\pagestyle{myheadings}
@@ -35,7 +27,7 @@
 
 \begin{center}
 \begin{tabular}{c|ccc|c}
-& \multicolumn{3}{c|}{\strTimeLimit (ms)} & \multirow{2}{*}{\strMemoryLimit (MiB)} \\
+& \multicolumn{3}{c|}{{\strTimeLimit} (ms)} & \multirow{2}{*}{{\strMemoryLimit} (MiB)} \\
 %\cline{2-4}
 {\sf \strProblem} & {\sf C/C++} &{\sf Java} & {\sf Python3} & \\
 \hline
@@ -51,4 +43,4 @@
 \end{center}
 \vspace*{\fill}
 \end{titlepage}
-\end{document}
+\end{document}

{rbx_cp-0.14.0 → rbx_cp-0.16.0}/rbx/resources/presets/default/preset.rbx.yml

@@ -1,6 +1,7 @@
 ---
 # yaml-language-server: $schema=https://rsalesc.github.io/rbx/schemas/Preset.json
 name: "default"
+min_version: "0.15.0"
 uri: "rsalesc/rbx/rbx/resources/presets/default"
 problem: "problem"
 contest: "contest"

{rbx_cp-0.14.0 → rbx_cp-0.16.0}/rbx/resources/presets/default/shared/icpc.sty

@@ -308,7 +308,7 @@
 \newcommand{\InsertTitlePage}
 {
 	\pagestyle{myheadings}
-	\markright{\Title -- \Year}
+	\markright{{\Title} -- \Year}
 
 	%%% Title Page
 	\begin{titlepage}
@@ -347,7 +347,7 @@
 \newcommand{\InsertEditorialTitlePage}
 {
 	\pagestyle{myheadings}
-	\markright{\Title -- \Year}
+	\markright{{\Title} -- \Year}
 
 	%%% Title Page
 	\begin{titlepage}

{rbx_cp-0.14.0 → rbx_cp-0.16.0}/rbx/utils.py

@@ -1,4 +1,5 @@
 import contextlib
+import enum
 import fcntl
 import functools
 import json
@@ -17,19 +18,63 @@ import rich.markup
 import rich.prompt
 import rich.status
 import ruyaml
+import semver
 import typer
 import yaml
 from pydantic import BaseModel
 from rich import text
 from rich.highlighter import JSONHighlighter
 
+from rbx import __version__
 from rbx.console import console
 
 T = TypeVar('T', bound=BaseModel)
 APP_NAME = 'rbx'
+PIP_NAME = 'rbx.cp'
 PathOrStr = Union[pathlib.Path, str]
 
 
+class SemVerCompatibility(enum.Enum):
+    COMPATIBLE = 'compatible'
+    OUTDATED = 'outdated'
+    BREAKING_CHANGE = 'breaking_change'
+
+
+def get_version() -> str:
+    return __version__.__version__
+
+
+def get_semver() -> semver.VersionInfo:
+    return semver.VersionInfo.parse(get_version())
+
+
+def get_upgrade_command(
+    version: Optional[Union[str, semver.VersionInfo]] = None,
+) -> str:
+    parsed_version = (
+        semver.VersionInfo.parse(version) if isinstance(version, str) else version
+    ) or get_semver()
+    return f'pipx install --upgrade {PIP_NAME}@{parsed_version.major}'
+
+
+def check_version_compatibility_between(
+    installed: str,
+    required: str,
+) -> SemVerCompatibility:
+    installed_version = semver.VersionInfo.parse(installed)
+    required_version = semver.VersionInfo.parse(required)
+    if installed_version < required_version:
+        return SemVerCompatibility.OUTDATED
+    if installed_version.major > required_version.major:
+        return SemVerCompatibility.BREAKING_CHANGE
+    return SemVerCompatibility.COMPATIBLE
+
+
+def check_version_compatibility(required: str) -> SemVerCompatibility:
+    installed = get_version()
+    return check_version_compatibility_between(installed, required)
+
+
 def create_and_write(path: pathlib.Path, *args, **kwargs):
     path.parent.mkdir(parents=True, exist_ok=True)
     path.write_text(*args, **kwargs)

rbx_cp-0.14.0/rbx/box/git_utils.py

@@ -1,28 +0,0 @@
-import pathlib
-from typing import Optional
-
-import git
-
-
-def get_repo_or_nil(
-    root: pathlib.Path = pathlib.Path(), search_parent_directories: bool = False
-) -> Optional[git.Repo]:
-    try:
-        return git.Repo(root, search_parent_directories=search_parent_directories)
-    except git.InvalidGitRepositoryError:
-        return None
-
-
-def is_repo(path: pathlib.Path) -> bool:
-    return get_repo_or_nil(path, search_parent_directories=False) is not None
-
-
-def is_within_repo(path: pathlib.Path) -> bool:
-    return get_repo_or_nil(path, search_parent_directories=True) is not None
-
-
-def get_any_remote(repo: git.Repo) -> Optional[git.Remote]:
-    for remote in repo.remotes:
-        if remote.exists():
-            return remote
-    return None