class Analyzer::Rust::Gotham

Overview

Gotham analyzer (tree-sitter port). Gotham wires routes with a builder chain that pairs each verb call with a following .to:

Router::builder()
    .get("/users/:id").to(user_handler)
    .post("/users").to(create_user_handler)

The analyzer walks call_expression nodes whose function is a field_expression named to — the receiver of .to(handler) is the .<verb>("/path") call, so each routing entry has both pieces locally and we don't need to thread state through the chain.

Defined in:

analyzer/analyzers/rust/gotham.cr

Constant Summary

HTTP_VERBS = Set {"get", "post", "put", "delete", "patch", "head", "options"}
TERMINAL_NAMES = Set {"to", "to_file", "to_dir", "to_new_handler", "to_async_borrowing"}

Route terminals: .to(handler) binds a handler fn; .to_file / .to_dir / .to_new_handler bind static/dynamic handlers (no fn name, but still a real route).

Class Method Summary

Instance Method Summary

Class methods inherited from class Analyzer::Rust::RustEngine

collect_cfg_test_regions(source : String) : Array(Tuple(Int32, Int32)) collect_cfg_test_regions, fan_out_verbs(verb : String) : Array(String) fan_out_verbs, inside_test_region?(node : LibTreeSitter::TSNode, regions : Array(Tuple(Int32, Int32))) : Bool inside_test_region?, test_path?(relative_path : String) : Bool test_path?

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_file(path : String) : Array(Endpoint) #

[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]