Laravel 신규 코드 해석 에코시스템 — surveyor / ranger / roster

composer require laravel/surveyor

use Laravel\Surveyor\Analyzer\Analyzer;

$analyzer = app(Analyzer::class);

// 파일 경로로 해석
$result = $analyzer->analyze('/path/to/your/File.php');

// 해석된 스코프에 액세스
$scope = $result->analyzed();

// 클래스 결과에 액세스
$classResult = $result->result();

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

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

// 클래스 정보
$name = $classResult->name();            // 'App\Models\User'
$namespace = $classResult->namespace();  // 'App\Models'
$filePath = $classResult->filePath();

// 상속 관계
$extends = $classResult->extends();
$implements = $classResult->implements();

// 메서드 정보
$method = $classResult->getMethod('store');
$returnType = $method->returnType();
$parameters = $method->parameters();
$rules = $method->validationRules(); // 유효성 검증 룰도 취득 가능

// 프로퍼티 정보
$property = $classResult->getProperty('email');
$type = $property->type;
$visibility = $property->visibility; // 'public', 'protected', 'private'

// 공개 메서드 · 프로퍼티 일람
$publicMethods = $classResult->publicMethods();
$publicProperties = $classResult->publicProperties();

use Laravel\Surveyor\Types\Type;

// 각종 타입 생성
$stringType = Type::string();
$intType = Type::int();
$boolType = Type::bool();
$nullType = Type::null();

// 유니온 타입 (string|null 등)
$unionType = Type::union(Type::string(), Type::null());

// 타입 판정
use Laravel\Surveyor\Types\StringType;

if (Type::is($returnType, StringType::class)) {
    // 문자열 타입 처리
}

use Laravel\Surveyor\Analyzer\AnalyzedCache;

// 디스크 캐시 활성화
AnalyzedCache::enableDiskCache(storage_path('surveyor-cache'));

// 캐시 클리어
AnalyzedCache::clear();

SURVEYOR_CACHE_ENABLED=true
SURVEYOR_CACHE_DIR=/path/to/cache

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

// 데이터베이스 속성이 자동 검출됨
$emailProperty = $result->getProperty('email');

// 릴레이션 메서드 판정
$method = $result->getMethod('posts');
if ($method->isModelRelation()) {
    // 이 메서드는 릴레이션
}

composer require laravel/ranger

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

$ranger = app(Ranger::class);

// 라우트가 발견될 때마다 호출
$ranger->onRoute(function (Components\Route $route) {
    echo $route->uri();
});

// 모델이 발견될 때마다 호출
$ranger->onModel(function (Components\Model $model) {
    foreach ($model->getAttributes() as $name => $type) {
        // 속성명과 타입 처리
    }
});

// Enum이 발견될 때마다 호출
$ranger->onEnum(function (Components\Enum $enum) {
    //
});

// 브로드캐스트 이벤트가 발견될 때마다 호출
$ranger->onBroadcastEvent(function (Components\BroadcastEvent $event) {
    //
});

// 모든 라우트가 수집된 후 한 번만 호출
$ranger->onRoutes(function (Collection $routes) {
    //
});

// 모든 모델이 수집된 후 한 번만 호출
$ranger->onModels(function (Collection $models) {
    //
});

// 애플리케이션 전체를 워크스루하여 콜백 발화
$ranger->walk();

composer require laravel/roster --dev

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

// 디렉터리를 스캔하여 Roster 취득
$roster = Roster::scan($directory);

// 설치된 패키지 목록
$roster->packages();

// 프로덕션용 패키지만
$roster->packages()->production();

// 개발 전용 패키지만
$roster->packages()->dev();

// 특정 패키지의 유무 확인
$roster->uses(Packages::INERTIA);        // bool
$roster->uses(Packages::LIVEWIRE);       // bool

// 버전 조건 지정 확인
$roster->usesVersion(Packages::INERTIA, '2.0.0', '>=');   // Inertia 2.0.0 이상인가?
$roster->usesVersion(Packages::LIVEWIRE, '3.0.0', '>=');  // Livewire 3.0.0 이상인가?

// JavaScript 패키지 매니저 검출
$packageManager = $roster->nodePackageManager(); // 'npm', 'yarn', 'bun' 등

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

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

if ($roster->uses(Packages::INERTIA)) {
    // Inertia용 처리
    if ($roster->usesVersion(Packages::INERTIA, '2.0.0', '>=')) {
        // Inertia v2 이상용 처리
    }
}

if ($roster->uses(Packages::LIVEWIRE)) {
    // Livewire용 처리
}

// 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(),
        // 라우트의 유효성 검증 룰 · 응답 타입 등도 취득 가능
    ];
});

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

$ranger->walk();

// $docs에 앱 전체의 구조 정보가 수집됨