class Analyzer::Rust::Rwf

Overview

RWF analyzer (tree-sitter port). RWF registers routes in a handful of shapes, all handled here:

route!("/path" => Controller) single route; the controller's Controller impl handle body enumerates verbs + params. crud!("/path" => Controller) six RESTful routes (the rest!("/path" => Controller) RestController/ModelController convention). Controller.route("/path") the same three as method calls Controller::new().rest("/p") (no macro), plus controller.wildcard("/path") a catch-all mount.

Registrations almost always sit inside Server::new(vec![ ... ]) / Engine::new(vec![ ... ]). tree-sitter leaves a vec! body as a flat token_tree with no macro_invocation / call_expression nodes, so we re-parse each route-bearing macro body as an expression fragment and scan it too, mapping line numbers back onto the file.

Defined in:

analyzer/analyzers/rust/rwf.cr

Constant Summary

HTTP_METHODS = ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"] of ::String
REST_ROUTES = [{"", "GET"}, {"", "POST"}, {"/:id", "GET"}, {"/:id", "PUT"}, {"/:id", "PATCH"}, {"/:id", "DELETE"}]

crud! / rest! register the standard REST surface. :id is the resource identifier param RWF uses for the member routes.

ROUTE_MACRO_EVIDENCE_RE = Regex.union("route", "crud", "rest", "wildcard")

Precompiled union for collect_route_macro_fragments' per-macro evidence gate, so it costs a single PCRE2 match instead of four naive substring scans.

Instance Method Summary

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

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

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?(path : String) : Bool test_path?

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, callees_needed? : Bool callees_needed?, 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, 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

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, 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_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

Instance Method Detail

def analyze_file(path : String) : Array(Endpoint) #

[View source]