class Analyzer::Crystal::Kemal

Defined in:

analyzer/analyzers/crystal/kemal.cr

Constant Summary

KEMAL_EXTRA_ROUTES = [{"QUERY", QUERY_ROUTE_PATTERN}] of Tuple(String, Regex)
MACRO_VAR_PATTERN = /\{\{\s*(\w+)\s*=\s*([A-Za-z_][\w:]*)\s*\}\}/

Compile-time macro var assignment, e.g. {{namespace = Routes::API::V1}}. invidious sets it once, then registers 50+ routes as get "/…", {{namespace}}::Videos, :videos — substituting it back lets those routes resolve their controller and carry callees.

MOUNT_PATTERN = /^\s*mount\s+["'](.+?)["']\s*,\s*(\w+)/
NAMESPACE_PATTERN = /^(\s*)(?:(\w+)\.)?namespace\s+["'](.+?)["']/
QUERY_ROUTE_PATTERN = /(?:^|[^.\w])query\s*(?:\(\s*)?['"](.+?)['"]/

Kemal's query route DSL (RFC 10008, kemalcr/kemal#769) is Kemal-specific, unlike get/post/etc. which the shared engine's SIMPLE_ROUTE_RE already covers for every Crystal analyzer (Amber, Lucky). It's stitched in via match_crystal_simple_route(..., extra:) instead of touching that shared pattern, mirroring Lucky's TRACE extra route. The same (?:^|[^.\w]) lead-in that keeps before_get / after_get from matching get also keeps before_query / after_query filters from matching here — they must not emit endpoints.

ROUTER_PATTERN = /^\s*(\w+)\s*=\s*Kemal::Router\.new/
SERVE_STATIC_DISABLED_RE = Regex.union("serve_static false", "serve_static(false)")

serve_static false / serve_static(false) — checked on every source line, so the two fixed OR-ed String#includes? substring scans are precompiled into a single regex union (one PCRE2 JIT scan per line instead of two naive substring scans).

Class Method Summary

Instance Method Summary

Instance methods inherited from class FileScanEngine

analyze analyze, analyze_file(path : String) : Array(Endpoint) analyze_file

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, tech : String tech, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

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

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def analyze_file(path : String) : Array(Endpoint) #

[View source]
def line_to_endpoint(content : String) : Endpoint #

[View source]
def line_to_param(content : String) : Param #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]