class Analyzer::Swift::Kitura

Defined in:

analyzer/analyzers/swift/kitura.cr

Constant Summary

FUNCTION_SIGNATURE_PATTERN = /\bfunc\s+([A-Za-z_]\w*)\s*\(/
LOOKAHEAD_LIMIT = 20

Maximum number of lines to look ahead for function parameters

ROUTE_BODY_LOOKAHEAD_LIMIT = LOOKAHEAD_LIMIT
ROUTE_CALL_RE = Regex.union(".get(", ".post(", ".put(", ".delete(", ".patch(", ".all(")

route_definition? runs on every scanned line (route detection, param lookahead, body-boundary checks). One precompiled Regex.union scan (PCRE2 JIT) replaces six naive String#includes? char scans; union auto-escapes each literal so it is provably equivalent to the OR-of-substrings it replaces.

ROUTE_PATTERN = /(\w+)\.(get|post|put|delete|patch|all)\(([^)]+)\)/

Patterns for route definitions in Kitura: router.get("path") { ... } router.post("path", handler: handler) router.all("/path") { ... }

ROUTER_ASSIGN_PATTERN = /\b(?:let|var)\s+([A-Za-z_]\w*)\s*=\s*Router\s*[(<]/

let router = Router() / func boot(router: Router) — the receivers a Kitura route is registered on. Tracking them makes detection receiver-aware, so look-alike .get/.delete/... calls on models or services (Grade.delete(id:), cache.get(...)) stop becoming phantom endpoints.

ROUTER_PARAM_PATTERN = /([A-Za-z_]\w*)\s*:\s*Router\b/

Instance Method Summary

Instance methods inherited from class Analyzer::Swift::SwiftEngine

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

Class methods inherited from class Analyzer::Swift::SwiftEngine

swift_test_path?(path : String) : Bool swift_test_path?, swift_vendor_path?(path : String) : Bool swift_vendor_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]
def extract_function_params(lines : Array(String), start_index : Int32, endpoint : Endpoint) #

Extract parameters from function body


[View source]
def extract_path_params(route : String, endpoint : Endpoint) #

Extract path parameters from the route pattern (e.g., :id, :userID)


[View source]
def parse_route_path(route_args : String) : String #

Parse route path from route arguments Examples: "/hello" -> /hello "/users/:id" -> /users/:id "/api/users/:userID" -> /api/users/:userID


[View source]