class Detector::Specification::Directus

Overview

directus schema snapshot writes the whole data model - collections, fields and relations - to a single file, and Directus generates its /items/<collection> REST surface from exactly that model.

A snapshot always carries a root directus: key holding the engine version that produced it. That key is what separates a real snapshot from any other document with collections: and fields: (Sanity exports, MongoDB configs, CI matrices), so it is required rather than merely preferred.

Defined in:

detector/detectors/specification/directus.cr

Constant Summary

SNAPSHOT_EXTENSIONS = {".yaml", ".yml", ".json"}
SNAPSHOT_MARKER = /^\s*directus\s*:|"directus"\s*:/m

Cheap gate before libyaml: one precompiled alternation beats chained String#includes? on Crystal (see analyzers/php/php.cr).

Instance Method Summary

Instance methods inherited from class Detector

applicable?(filename : String) : Bool applicable?, detect(filename : String, file_contents : String) : Bool detect, gemfile_dependency?(file_contents : String, gem_name : String) : Bool gemfile_dependency?, gemspec_dependency?(file_contents : String, gem_name : String) : Bool gemspec_dependency?, idempotent? : Bool idempotent?, logger : NoirLogger logger, name : String name, path_sensitive? : Bool path_sensitive?

Constructor methods inherited from class Detector

new(options : Hash(String, YAML::Any)) new

Instance Method Detail

def applicable?(filename : String) : Bool #
Description copied from class Detector

Cheap filename-only filter the detector pass uses to skip #detect on files the detector cannot possibly match. The default true preserves prior behavior (every detector runs on every file). Override with the same predicate the body of #detect starts with — e.g., filename.ends_with?(".py") for a Python framework detector — so the detector loop avoids the #detect dispatch on files outside the detector's language.

On large codebases (saleor's 4255 .py files) this lifts ~100 virtual #detect calls per file out of the hot loop because most detectors' inner first-line is exactly this kind of cheap filename check.


[View source]
def detect(filename : String, file_contents : String) : Bool #

[View source]
def idempotent? : Bool #

Registers each snapshot path in CodeLocator.


[View source]
def path_sensitive? : Bool #

libyaml parses JSON as a YAML subset, so one code path covers the --format json snapshot too. Memo safety: #applicable? consults the path (/directus/ and /snapshots/ gates), not just the basename.


[View source]
def set_name #

[View source]