class Analyzer::Cpp::Drogon

Defined in:

analyzer/analyzers/cpp/drogon.cr

Constant Summary

CPP_EXTENSIONS = [".cpp", ".cc", ".cxx", ".h", ".hpp"]
EVIDENCE_RE = Regex.union("drogon", "registerHandler", "PATH_LIST_BEGIN", "PATH_ADD", "METHOD_LIST_BEGIN", "METHOD_ADD", "ADD_METHOD_TO", "ADD_METHOD_VIA_REGEX")

Precompiled union for the per-file evidence gate in #analyze, so it costs a single PCRE2 match instead of up to eight naive substring scans.

HTTP_METHODS = {"Get" => "GET", "Post" => "POST", "Put" => "PUT", "Delete" => "DELETE", "Patch" => "PATCH", "Head" => "HEAD", "Options" => "OPTIONS"}
JSON_ACCESS_RE = Regex.union("->getJsonObject(", "->getJsonValue(")

extract_params's per-line JSON-body-access check is used twice (once positively, once negated) on the same line buffer; precompile it once instead of repeating the two-way includes? OR each time.

MACRO_CALL_PATTERNS = {"METHOD_ADD" => /\bMETHOD_ADD\s*\(/, "ADD_METHOD_TO" => /\bADD_METHOD_TO\s*\(/, "ADD_METHOD_VIA_REGEX" => /\bADD_METHOD_VIA_REGEX\s*\(/, "PATH_ADD" => /\bPATH_ADD\s*\(/, "WS_PATH_ADD" => /\bWS_PATH_ADD\s*\(/, "WS_ADD_PATH_VIA_REGEX" => /\bWS_ADD_PATH_VIA_REGEX\s*\(/}

Crystal recompiles an interpolated regex literal on every evaluation (a full PCRE2 JIT compile). The macro set is fixed, so precompile its matchers once; the method/class matchers interpolate discovered names and are memoized per name instead.

METHOD_BLOCK = /\{\s*((?:drogon::)?(?:Get|Post|Put|Delete|Patch|Head|Options)\b[^{}]*)\}/

{Get, Post} method list: brace block whose first token is a verb.

REGEX_REGISTER_HANDLER = /app\(\)\s*\.?\s*registerHandler(?:ViaRegex)?\s*\(\s*"([^"]+)"/

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 analyze_file(path : String, content : String, include_callee : Bool = false) #

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