Manual de Referencia: ripley

Ripley — Linter Pedagógico de Reglas Institucionales 0xXXXXh y Microkernel de Auditoría¶

1. Propósito y Filosofía Pedagógica¶

La herramienta ripley forma parte del ecosistema oficial de software de la cátedra. Su diseño sigue principios pedagógicos rigurosos:

1. 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.

2. Acción Correctiva Concreta: Cada advertencia incluye la prescripción técnica inmediata para resolver el defecto sin recurrir a conjeturas.

3. Autonomía del Estudiante: Facilita la autoevaluación local antes de la entrega final del trabajo práctico.

4. 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:

2.2 Métodos de Instalación de ripley¶

Podés instalar ripley mediante cualquiera de los siguientes métodos estándar:

2.3 Autocompletado en la Shell¶

La interfaz CLI de ripley cuenta con autocompletado nativo para comandos, flags y archivos. Para configurarlo permanentemente en tu shell:

# Configuración automática en Bash / Zsh / Fish
ripley --install-completion

# Para cargar el autocompletado en la sesión actual de inmediato:
source ./install_tools.sh

2.4 Verificación del Entorno con doctor¶

Toda herramienta del ecosistema cuenta con el subcomando unificado doctor. Ejecutalo para auditar el estado del entorno:

ripley doctor

Comprobaciones Ejecutadas por el Diagnóstico:¶

• Compilador C: Verifica disponibilidad de gcc o clang con soporte de estándares C11 y C23.

• Depurador y Core Dumps: Comprueba que gdb esté instalado y que ulimit -c permita generación de core dumps.

• Herramientas de Memoria: Valida la presencia de valgrind y librerías libasan/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 ($\ge 0.11$) y dot (Graphviz).

Matriz de Resolución de Problemas:¶

3. Referencia Completa de Comandos CLI¶

A continuación se detallan los subcomandos principales disponibles en ripley:

4. Tutorial Paso a Paso con Ejemplos Reales¶

Caso de Estudio¶

Considerá el siguiente fragmento de código representativo:

1
2
3
4
5
// Violación de regla institucional 0x1001h (Estructura de control sin bloque de llaves)
void procesar(int a) {
    if (a > 0)
        a++; // Falla 0x1001h: Toda sentencia de control debe tener llaves {}
}

Ejecución de la Herramienta¶

Ejecutá el análisis desde tu terminal:

ripley check src/ include/

Salida Obtenida en Consola¶

⚠️ REPORTE DE AUDITORÍA RIPLEY (Reglas de Cátedra):
┌──────────────┬─────────┬────────────────────────────────────────────────────────┐
│ Archivo:L:C  │ Regla   │ Descripción del Diagnóstico                            │
├──────────────┼─────────┼────────────────────────────────────────────────────────┤
│ proc.c:3:5   │ 0x1001h │ Estructura de control 'if' sin bloque explícito '{}'.  │
│ proc.c:1:23  │ 0x000Bh │ Llave de apertura en estilo K&R (exigido: Allman).     │
└──────────────┴─────────┴────────────────────────────────────────────────────────┘
💡 Ejecutá 'ripley explain 0x1001h' para ver el ejemplo correcto y fundamento.

5. Ejercicios Prácticos y Desafíos¶

Practicá el uso avanzado de ripley resolviendo los siguientes ejercicios:

6. Integración en el Flujo de Trabajo y Makefile¶

Para incorporar ripley de forma automática a tu flujo de desarrollo, agregá la siguiente regla en el Makefile de tu proyecto:

check-ripley:
	@echo "=== Ejecutando verificación con ripley ==="
	ripley check src/ include/

.PHONY: check-ripley

Ejecutá make check-ripley 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 ripley implementa un motor de alta precisión basado en:

• Tecnología Núcleo: Python Microkernel Architecture + Pluggy Dynamic Plugin System + Multi-Format Reporter (Rich, JSON, MD).

• 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¶

• Estudiante (diagnósticos en terminal) | Informes Markdown, diagnósticos Rich, JSON, actas | | Sincronización | gaff, spunkmeyer, kaneda, zhora, motoko, wierzbowski, dredd | Validación cruzada, flags compartidos y autofix |

Pipeline de Integración Recomendado¶

Podés encadenar ripley con otras herramientas del ecosistema en una única línea de comando:

# Pipeline de integración típico
ripley check src/ include/ --md reporte_auditoria.md

9. Extensión, Desarrollo de Plugins y API Python¶

Para crear tus propias reglas, conectores de evaluación o integrar ripley programáticamente en pipelines de CI/CD:

• 👉 Consultá la guía completa: Guía de Extensión y Creación de Plugins