class Detector::Specification::Hasura

Overview

Hasura tracks tables in its metadata directory and generates GraphQL root fields for each. Two layouts exist and both are current:

A detector written to the first shape alone finds nothing in a modern project, so both are accepted.

- table: on its own is a plausible shape in unrelated YAML (dbt models, Airflow, Metabase), so a /metadata/ path segment is required and the document must also carry a key from Hasura's own permission/relationship vocabulary.

Defined in:

detector/detectors/specification/hasura.cr

Constant Summary

HASURA_VOCABULARY = /\b(?:select_permissions|insert_permissions|update_permissions|delete_permissions|object_relationships|array_relationships|configuration|is_enum|apollo_federation_config|remote_relationships|computed_fields|event_triggers)\b/

Keys that only a Hasura table definition carries, as one precompiled alternation rather than a dozen String#includes? passes — each of those is a full scan of the file.

METADATA_SEGMENT = "/metadata/"
REST_MARKER = /^\s*(?:-\s+)?url\s*:/m
TABLE_MARKER = /^\s*(?:-\s+)?table\s*:/m

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 every metadata path in CodeLocator.


[View source]
def path_sensitive? : Bool #

Memo safety: #applicable? consults the path (metadata/** directory gate), not just the basename.


[View source]
def set_name #

[View source]