rbx.cp 0.6.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

rbx/box/linting.py

@@ -0,0 +1,95 @@
+import difflib
+import pathlib
+from typing import Optional, Type
+
+import yamlfix
+import yamlfix.model
+from pydantic import BaseModel
+
+from rbx import console
+from rbx.box.cd import is_contest_package, is_preset_package, is_problem_package
+from rbx.box.contest.schema import Contest
+from rbx.box.presets import get_preset_yaml
+from rbx.box.presets.schema import Preset
+from rbx.box.schema import Package
+from rbx.box.stats import find_problem_packages_from_contest
+from rbx.utils import uploaded_schema_path
+
+
+def fix_language_server(path: pathlib.Path, model_cls: Type[BaseModel]) -> bool:
+    stream = []
+    with path.open('r') as f:
+        for line in f:
+            if line.strip().startswith('# yaml-language-server:'):
+                continue
+            stream.append(line)
+            if line.startswith('---'):
+                stream.append(
+                    f'# yaml-language-server: $schema={uploaded_schema_path(model_cls)}\n'
+                )
+    content = ''.join(stream)
+    orig_text = path.read_text()
+    path.write_text(content)
+    return orig_text != content
+
+
+def fix_yaml(
+    path: pathlib.Path,
+    verbose: bool = True,
+    print_diff: bool = False,
+    model_cls: Optional[Type[BaseModel]] = None,
+):
+    orig_text = path.read_text()
+
+    # Config to go hand-to-hand with VSCode YAML extension,
+    # which we offer first class support to. Unfortunately,
+    # YAML extension is not perfect :(
+    config = yamlfix.model.YamlfixConfig(
+        quote_basic_values=True,
+        quote_representation='"',
+        comments_min_spaces_from_content=1,
+    )
+    _, changed = yamlfix.fix_files([str(path)], dry_run=False, config=config)
+
+    if model_cls is not None:
+        if fix_language_server(path, model_cls):
+            changed = True
+
+    if changed and verbose:
+        console.console.print(
+            f'Formatting [item]{path}[/item].',
+        )
+
+    if print_diff and changed:
+        unified_diff = difflib.unified_diff(
+            orig_text.splitlines(), path.read_text().splitlines()
+        )
+        console.console.print(
+            f'Diff for [item]{path}[/item].\n' + '\n'.join(unified_diff),
+        )
+
+
+def fix_package(root: pathlib.Path = pathlib.Path(), print_diff: bool = False):
+    if is_preset_package(root):
+        fix_yaml(root / 'preset.rbx.yml', model_cls=Preset, print_diff=print_diff)
+        preset = get_preset_yaml(root)
+        if preset.problem is not None:
+            fix_yaml(
+                root / preset.problem / 'problem.rbx.yml',
+                model_cls=Package,
+                print_diff=print_diff,
+            )
+        if preset.contest is not None:
+            fix_package(root / preset.contest, print_diff=print_diff)
+        return
+
+    if is_problem_package(root):
+        fix_yaml(root / 'problem.rbx.yml', model_cls=Package, print_diff=print_diff)
+    if is_contest_package(root):
+        fix_yaml(root / 'contest.rbx.yml', model_cls=Contest, print_diff=print_diff)
+        for problem in find_problem_packages_from_contest(root):
+            fix_yaml(
+                problem / 'problem.rbx.yml',
+                model_cls=Package,
+                print_diff=print_diff,
+            )

rbx/box/package.py

@@ -10,10 +10,9 @@ import ruyaml
 import typer
 from pydantic import ValidationError
 
-from rbx import config, console, utils
-from rbx.box import cd, environment
+from rbx import console, utils
+from rbx.box import cd
 from rbx.box.environment import get_sandbox_type
-from rbx.box.presets import get_installed_preset_or_null, get_preset_lock
 from rbx.box.schema import (
     CodeItem,
     ExpectedOutcome,
@@ -38,33 +37,6 @@ TEMP_DIR = None
 CACHE_STEP_VERSION = 1
 
 
-def warn_preset_deactivated(root: pathlib.Path = pathlib.Path()):
-    preset_lock = get_preset_lock(root)
-    if preset_lock is None:
-        return
-
-    preset = get_installed_preset_or_null(preset_lock.preset_name)
-    if preset is None:
-        console.console.print(
-            f'[warning]WARNING: [item]{preset_lock.preset_name}[/item] is not installed. '
-            'Run [item]rbx presets sync && rbx activate[/item] to install and activate this preset.'
-        )
-        console.console.print()
-        return
-
-    if preset.env is not None and (
-        not environment.get_environment_path(preset.name).is_file()
-        or config.get_config().boxEnvironment != preset.name
-    ):
-        console.console.print(
-            '[warning]WARNING: This package uses a preset that configures a custom environment, '
-            f' but instead you are using the environment [item]{config.get_config().boxEnvironment}[/item]. '
-            'Run [item]rbx activate[/item] to use the environment configured by your preset.'
-        )
-        console.console.print()
-        return
-
-
 @functools.cache
 def find_problem_yaml(root: pathlib.Path = pathlib.Path()) -> Optional[pathlib.Path]:
     root = root.resolve()
@@ -74,7 +46,6 @@ def find_problem_yaml(root: pathlib.Path = pathlib.Path()) -> Optional[pathlib.P
         problem_yaml_path = root / YAML_NAME
     if not problem_yaml_path.is_file():
         return None
-    warn_preset_deactivated(root)
     return problem_yaml_path
 
 
@@ -130,9 +101,7 @@ def save_package(
 def get_ruyaml(root: pathlib.Path = pathlib.Path()) -> Tuple[ruyaml.YAML, ruyaml.Any]:
     problem_yaml_path = find_problem_yaml(root)
     if problem_yaml_path is None:
-        console.console.print(
-            f'Problem not found in {pathlib.Path().absolute()}', style='error'
-        )
+        console.console.print(f'[error]Problem not found in {root.absolute()}[/error]')
         raise typer.Exit(1)
     res = ruyaml.YAML()
     return res, res.load(problem_yaml_path.read_text())