Manual de Referencia: moodle-toolbox
Moodle-Toolbox — Suite de Mantenimiento, Normalización y Conversión de Bancos GIFT/XML
Moodle-Toolbox — Suite de Mantenimiento, Normalización y Conversión de Bancos GIFT/XML¶
1. Propósito y Filosofía Pedagógica¶
La herramienta moodle-toolbox forma parte del ecosistema oficial de software de la cátedra. Su diseño sigue principios pedagógicos rigurosos:
Evidencia Técnica Directa: Todo diagnóstico se fundamenta en la norma ISO C (C11/C23), en el modelo de memoria del sistema o en convenciones arquitectónicas formales.
Acción Correctiva Concreta: Cada advertencia incluye la prescripción técnica inmediata para resolver el defecto sin recurrir a conjeturas.
Autonomía del Estudiante: Facilita la autoevaluación local antes de la entrega final del trabajo práctico.
Objetividad Docente: Estandariza la corrección automática removiendo discrepancias subjetivas en la evaluación.
2. Instalación y Verificación del Entorno¶
2.1 Requisitos Previos del Sistema¶
Instalá los paquetes del sistema requeridos según tu distribución o entorno:
sudo apt update && sudo apt install -y
build-essential
gcc
gdb
valgrind
clang-format
libclang-dev
bubblewrap
typst
graphviz
python3-pip
python3-venv
sudo pacman -S --needed
base-devel
gcc
gdb
valgrind
clang
bubblewrap
typst
graphviz
python-pip
uv
sudo dnf install -y
gcc
gcc-c++
gdb
valgrind
clang-tools-extra
bubblewrap
typst
graphviz
python3-pip
brew install gcc gdb clang-format typst graphviz uv
2.2 Métodos de Instalación de moodle-toolbox¶
Podés instalar moodle-toolbox mediante cualquiera de los siguientes métodos estándar:
Instalación aislada de alta velocidad con uv¶
uv tool install . --editable
O instalar todo el ecosistema de herramientas de la cátedra en lote:¶
source ./install_tools.sh
Crear y activar un entorno virtual¶
python3 -m venv .venv source .venv/bin/activate
Instalar en modo editable para desarrollo¶
pip install -e .
Instalación global aislada en tu PATH¶
pipx install --editable .
2.3 Autocompletado en la Shell¶
La interfaz CLI de questions cuenta con autocompletado nativo para comandos, flags y archivos. Para configurarlo permanentemente en tu shell:
# Configuración automática en Bash / Zsh / Fish
questions --install-completion
# Para cargar el autocompletado en la sesión actual de inmediato:
source ./install_tools.sh2.4 Verificación del Entorno con doctor¶
Toda herramienta del ecosistema cuenta con el subcomando unificado doctor. Ejecutalo para auditar el estado del entorno:
questions doctorComprobaciones Ejecutadas por el Diagnóstico:¶
Compilador C: Verifica disponibilidad de
gccoclangcon soporte de estándares C11 y C23.Depurador y Core Dumps: Comprueba que
gdbesté instalado y queulimit -cpermita generación de core dumps.Herramientas de Memoria: Valida la presencia de
valgrindy libreríaslibasan/libubsan.Formateo y Estilo: Verifica el binario
clang-format(versión 16+).Sandboxing de Kernel: Audita permisos no privilegiados de
bwrap(Bubblewrap namespaces).Generador de Tipografía y Documentos: Comprueba
typst() ydot(Graphviz).
Matriz de Resolución de Problemas:¶
Síntoma / Alerta de doctor | Causa Raíz | Acción Correctiva |
|---|---|---|
❌ gcc / clang no encontrado | Toolchain C faltante | Instalá build-essential o base-devel. |
❌ bwrap permisos insuficientes | User namespaces desactivados | Habilitá sysctl kernel.unprivileged_userns_clone=1. |
❌ typst no disponible | Motor de PDF faltante | Descargá Typst vía cargo install typst-cli o gestor de paquetes. |
❌ gdb no responde | GDB sin interfaz MI/Python | Reinstalá gdb completo desde el repositorio oficial. |
3. Referencia Completa de Comandos CLI¶
A continuación se detallan los subcomandos principales disponibles en questions:
| Sintaxis del Comando | Descripción y Efecto |
|---|---|
questions convert banco.gift -o banco.xml | Convierte preguntas de formato GIFT a Moodle XML. |
questions convert banco.xml -o banco.gift | Convierte Moodle XML a texto plano GIFT. |
questions validate banco.xml | Valida la integridad estructural, pesos de respuestas e imágenes embebidas. |
questions spellcheck banco.gift | Audita ortografía en enunciados y retroalimentaciones con LanguageTool. |
questions format banco.gift | Normaliza indentación y formato limpio en archivos GIFT. |
4. Tutorial Paso a Paso con Ejemplos Reales¶
Caso de Estudio¶
Considerá el siguiente fragmento de código representativo:
1 2 3 4 5 6 7 8 9 10 11// Categoría y pregunta GIFT normalizada por moodle-toolbox $CATEGORY: $course$/Parcial 1/Punteros ::Pregunta 01 - Aritmética de Punteros:: Dado el siguiente código en C: <pre><code>int v[3] = {1, 2, 3}; int *p = v + 1;</code></pre> ¿Cuál es el valor de <code>*p</code>? { =2 #¡Correcto! p apunta al segundo elemento (índice 1). ~1 #Incorrecto: v[0] es 1, pero p fue incrementado en 1. ~3 #Incorrecto: v[2] es 3. }
Ejecución de la Herramienta¶
Ejecutá el análisis desde tu terminal:
questions convert banco.gift -o banco.xmlSalida Obtenida en Consola¶
[✓] 50 preguntas convertidas de GIFT a Moodle XML: banco.xml
[✓] 0 errores de validación en pesos porcentuales (suma 100% en opciones correctas).
[✓] Corrección ortográfica: 0 faltas detectadas en enunciados.5. Ejercicios Prácticos y Desafíos¶
Practicá el uso avanzado de moodle-toolbox resolviendo los siguientes ejercicios:
6. Integración en el Flujo de Trabajo y Makefile¶
Para incorporar moodle-toolbox de forma automática a tu flujo de desarrollo, agregá la siguiente regla en el Makefile de tu proyecto:
check-moodle_toolbox:
@echo "=== Ejecutando verificación con moodle-toolbox ==="
questions check src/ include/
.PHONY: check-moodle_toolboxEjecutá make check-moodle_toolbox antes de cada commit para mantener que tu código conserve el estado de aprobación.
7. Arquitectura Interna y Mecanismo Técnico¶
La herramienta moodle-toolbox implementa un motor de alta precisión basado en:
Tecnología Núcleo:
Moodle XML Parser / Serializer + GIFT Grammar Lexer + LanguageTool REST Client.Aislamiento y Determinismo: Diseñada para operar sin efectos colaterales en entornos de integración continua (CI), terminales de estudiantes y servidores docentes headless.
Manejo de Errores Pedagógico: Todo fallo de sintaxis, memoria o lógica se traduce en una acción prescriptiva concreta con su respectiva justificación técnica.
8. Integración y Conexión con el Ecosistema¶
Diagrama de Flujo e Interoperabilidad¶
Matriz de Intercambio de Datos¶
| Canal | Herramientas Conectadas | Tipo de Datos Transferidos |
|---|---|---|
| Entradas (Inputs) | - Bancos GIFT y XML de Alucard, Idkfa y docentes | Código fuente, AST, binarios, testcases, contratos |
| Salidas (Outputs) | - Campus Virtual Moodle (bancos limpios) |
alucarD (preguntas normalizadas)| Informes Markdown, diagnósticos Rich, JSON, actas | | Sincronización |alucarD,idkfa,myst-tools| Validación cruzada, flags compartidos y autofix |
Pipeline de Integración Recomendado¶
Podés encadenar moodle-toolbox con otras herramientas del ecosistema en una única línea de comando:
# Pipeline de integración típico
questions convert banco.gift -o banco.xml && questions spellcheck banco.xml --premium9. Extensión, Desarrollo de Plugins y API Python¶
Para crear tus propias reglas, conectores de evaluación o integrar moodle-toolbox programáticamente en pipelines de CI/CD:
👉 Consultá la guía completa: Guía de Extensión y Creación de Plugins