Le nouvel écosystème d'analyse de code Laravel — surveyor / ranger / roster

composer require laravel/surveyor

use Laravel\Surveyor\Analyzer\Analyzer;

$analyzer = app(Analyzer::class);

// Analyser par chemin de fichier
$result = $analyzer->analyze('/path/to/your/File.php');

// Accéder au scope analysé
$scope = $result->analyzed();

// Accéder au résultat de la classe
$classResult = $result->result();

$result = $analyzer->analyzeClass(\App\Models\User::class);
$classResult = $result->result();

$classResult = $analyzer->analyzeClass(App\Models\User::class)->result();

// Infos de classe
$name = $classResult->name();            // 'App\Models\User'
$namespace = $classResult->namespace();  // 'App\Models'
$filePath = $classResult->filePath();

// Héritage
$extends = $classResult->extends();
$implements = $classResult->implements();

// Infos de méthode
$method = $classResult->getMethod('store');
$returnType = $method->returnType();
$parameters = $method->parameters();
$rules = $method->validationRules(); // Les règles de validation sont aussi accessibles

// Infos de propriété
$property = $classResult->getProperty('email');
$type = $property->type;
$visibility = $property->visibility; // 'public', 'protected', 'private'

// Listes des méthodes et propriétés publiques
$publicMethods = $classResult->publicMethods();
$publicProperties = $classResult->publicProperties();

use Laravel\Surveyor\Types\Type;

// Création de types divers
$stringType = Type::string();
$intType = Type::int();
$boolType = Type::bool();
$nullType = Type::null();

// Type union (string|null, etc.)
$unionType = Type::union(Type::string(), Type::null());

// Vérification de type
use Laravel\Surveyor\Types\StringType;

if (Type::is($returnType, StringType::class)) {
    // Traitement pour un type chaîne
}

use Laravel\Surveyor\Analyzer\AnalyzedCache;

// Activer le cache sur disque
AnalyzedCache::enableDiskCache(storage_path('surveyor-cache'));

// Vider le cache
AnalyzedCache::clear();

SURVEYOR_CACHE_ENABLED=true
SURVEYOR_CACHE_DIR=/path/to/cache

$result = $analyzer->analyzeClass(App\Models\User::class)->result();

// Les attributs de base sont détectés automatiquement
$emailProperty = $result->getProperty('email');

// Détecter une méthode de relation
$method = $result->getMethod('posts');
if ($method->isModelRelation()) {
    // Cette méthode est une relation
}

composer require laravel/ranger

use Laravel\Ranger\Ranger;
use Laravel\Ranger\Components;
use Illuminate\Support\Collection;

$ranger = app(Ranger::class);

// Appelé à chaque route découverte
$ranger->onRoute(function (Components\Route $route) {
    echo $route->uri();
});

// Appelé à chaque modèle découvert
$ranger->onModel(function (Components\Model $model) {
    foreach ($model->getAttributes() as $name => $type) {
        // Traitement du nom d'attribut et du type
    }
});

// Appelé à chaque Enum découvert
$ranger->onEnum(function (Components\Enum $enum) {
    //
});

// Appelé à chaque événement de broadcast découvert
$ranger->onBroadcastEvent(function (Components\BroadcastEvent $event) {
    //
});

// Appelé une seule fois après collecte de toutes les routes
$ranger->onRoutes(function (Collection $routes) {
    //
});

// Appelé une seule fois après collecte de tous les modèles
$ranger->onModels(function (Collection $models) {
    //
});

// Parcourir toute l'application et déclencher les callbacks
$ranger->walk();

composer require laravel/roster --dev

use Laravel\Roster\Roster;
use Laravel\Roster\Packages;

// Scanner un répertoire et obtenir le Roster
$roster = Roster::scan($directory);

// Liste des packages installés
$roster->packages();

// Uniquement les packages de production
$roster->packages()->production();

// Uniquement les packages de développement
$roster->packages()->dev();

// Vérifier la présence d'un package
$roster->uses(Packages::INERTIA);        // bool
$roster->uses(Packages::LIVEWIRE);       // bool

// Vérifier avec une contrainte de version
$roster->usesVersion(Packages::INERTIA, '2.0.0', '>=');   // Inertia >= 2.0.0 ?
$roster->usesVersion(Packages::LIVEWIRE, '3.0.0', '>=');  // Livewire >= 3.0.0 ?

// Détection du package manager JavaScript
$packageManager = $roster->nodePackageManager(); // 'npm', 'yarn', 'bun', etc.

use Laravel\Roster\Roster;
use Laravel\Roster\Packages;

$roster = Roster::scan(base_path());

if ($roster->uses(Packages::INERTIA)) {
    // Traitement pour Inertia
    if ($roster->usesVersion(Packages::INERTIA, '2.0.0', '>=')) {
        // Traitement pour Inertia v2 ou supérieur
    }
}

if ($roster->uses(Packages::LIVEWIRE)) {
    // Traitement pour Livewire
}

// Adapter la commande d'installation selon le package manager JavaScript
$pm = $roster->nodePackageManager();
echo "Run: {$pm} install your-package";

use Laravel\Ranger\Ranger;
use Laravel\Ranger\Components;

$ranger = app(Ranger::class);
$docs = [];

$ranger->onRoute(function (Components\Route $route) use (&$docs) {
    $docs['routes'][] = [
        'uri' => $route->uri(),
        // Vous pouvez aussi récupérer les règles de validation et le type de réponse
    ];
});

$ranger->onModel(function (Components\Model $model) use (&$docs) {
    $docs['models'][] = [
        'attributes' => $model->getAttributes(),
    ];
});

$ranger->walk();

// $docs contient les informations structurelles de toute l'application