class Analyzer::Zig::Httpz

Overview

http.zig (httpz) registers routes on a router object:

router.get("/api/user/:id", getUser, .{}); router.post("/api/users", createUser, .{}); router.all("/*", notFound, .{}); router.method("TEA", "/", teaList, .{});

Prefixed groups compose: var admin = router.group("/admin", .{}); followed by admin.get("/users", …) yields /admin/users. The handler is the second argument; its function body supplies the callees.

Defined in:

analyzer/analyzers/zig/httpz.cr

Constant Summary

GROUP_RE = /(?:var|const)\s+(\w+)\s*=\s*(\w+)\s*\.\s*group\s*\(\s*"([^"]*)"/
METHOD_RE = /(\w+)\s*\.\s*method\s*\(\s*"([^"]*)"\s*,\s*"(\/[^"]*)"\s*,\s*(@"[^"]*"|[A-Za-z_][\w.]*)/
ROUTE_RE = /(\w+)\s*\.\s*(get|post|put|delete|head|patch|trace|options|connect|all)\s*\(\s*"(\/[^"]*)"\s*,\s*(@"[^"]*"|[A-Za-z_][\w.]*)/

The handler is the 2nd argument. It can be a plain/qualified identifier (getUser, Users.list) or a @"…" quoted identifier — Zig spells a reserved word used as a name that way, so router.get("/error", @"error") is idiomatic. The @"…" alternative keeps that form from being dropped.

ROUTE_SIGNAL_RE = Regex.union("(\"/", ".group(")

Cheap routing-signal gate: one precompiled Regex.union scan (PCRE2 JIT) instead of two naive String#includes? char scans. Equivalent to includes?("(\"/") || includes?(".group(").

VERB_METHOD = {"get" => "GET", "post" => "POST", "put" => "PUT", "delete" => "DELETE", "head" => "HEAD", "patch" => "PATCH", "trace" => "TRACE", "options" => "OPTIONS", "connect" => "CONNECT", "all" => "GET"}
VERBS = ["get", "post", "put", "delete", "head", "patch", "trace", "options", "connect", "all"] of ::String

Class Method Summary

Instance Method Summary

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