class Analyzer::Swift::Vapor

Defined in:

analyzer/analyzers/swift/vapor.cr

Constant Summary

FUNCTION_SIGNATURE_PATTERN = /\bfunc\s+([A-Za-z_]\w*)\s*\(/
GROUP_ASSIGN_PATTERN = /\b(?:let|var)\s+([A-Za-z_]\w*)\s*=\s*(?:([A-Za-z_]\w*(?:\.[A-Za-z_]\w*)*)\.)?grouped\s*\(/

The base may be a dotted receiver (app.routes.grouped(...)), an implicit self (bare grouped(...)), or a single identifier (router.grouped(...)).

GROUP_CLOSURE_PATTERN = /([A-Za-z_]\w*)\.group(?:ed)?\s*\(/
LOOKAHEAD_LIMIT = 20

Maximum number of lines to look ahead for function parameters

ON_ROUTE_PATTERN = /([A-Za-z_]\w*(?:\.[A-Za-z_]\w*)*)\.on\s*\(/
ROUTE_PATTERN = /([A-Za-z_]\w*(?:\.[A-Za-z_]\w*)*)\.(get|post|put|delete|patch)\s*\(/

Patterns for route definitions in Vapor: app.get("path") { ... } app.post("path", "segment") { ... } routes.get("path", ":param") { ... }

ROUTER_BINDING_PATTERN = /\b(?:let|var)\s+([A-Za-z_]\w*)\s*=\s*(?:try\s+|await\s+)*Application\b/
ROUTER_EXTENSION_PATTERN = /\bextension\s+(?:RoutesBuilder|Router)\b/

extension RoutesBuilder { ... self.get(...) ... } — inside such an extension self (and bare grouped(...), handled by GROUP_ASSIGN_PATTERN) is router-like.

ROUTER_PARAM_PATTERN = /(?:_\s+)?([A-Za-z_]\w*)\s*:\s*(?:some\s+|any\s+|inout\s+)*(?:RoutesBuilder|Router|Application)\b/

A function parameter (or binding) typed as a Vapor router: func routes(_ app: Application), func boot(routes: RoutesBuilder), func boot(router: Router) (Vapor 3), let app = Application(...). Tracking these makes route detection receiver-aware, so that non-router .get/.delete/... calls — Environment.get("DATABASE_URL"), model.delete(on: req.db), req.client.get(url) — stop surfacing as phantom endpoints.

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?, 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, url : String url

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Analyzer

define_getter_methods(names) define_getter_methods

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