class Analyzer::Kotlin::Spring

Defined in:

analyzer/analyzers/kotlin/spring.cr

Constant Summary

CLASS_OR_OBJECT_RE = Regex.union("class", "object")
CONTROLLER_ANNOTATION_RE = Regex.union("RestController", "Controller")
FUNCTIONAL_ROUTER_MARKER_RE = Regex.union("coRouter", "router {")
GRAPHQL_ROUTE_MARKER_RE = Regex.union("@QueryMapping", "@MutationMapping", "@SubscriptionMapping", "@SchemaMapping")
IGNORED_PATH_SEGMENT_RE = Regex.union("/.git/", "/.gradle/", "/build/", "/out/", "/target/", "/node_modules/")

One precompiled Regex.union scan (PCRE2 JIT, auto-escapes each literal, including the . in /.git///.gradle/) replaces the six OR-ed String#includes? scans below. Both callers run this over every file in the configured base (not just Kotlin sources), once each in spring_kotlin_files and spring_src_dirs.

KOTLIN_EXTENSION = "kt"
SPRING_FRAMEWORK_CALLEE_NAMES = Set {"ok", "created", "accepted", "noContent", "notFound", "badRequest", "status", "body", "build", "buildAndAwait", "bodyValueAndAwait", "linkTo", "methodOn", "println", "toString", "toLong", "toInt", "toDouble", "toFloat", "toBoolean", "Integer.parseInt", "Long.parseLong", "UUID.fromString", "UUID.randomUUID", "uriBuilder.path", "let", "also", "apply", "run", "with", "listOf", "isEmpty", "isNotEmpty", "mutableListOf", "mutableSetOf", "mutableMapOf", "setOf", "mapOf", "emptyList", "emptySet", "emptyMap", "compareByDescending", "require", "requireNotNull", "check", "checkNotNull", "Instant.now", "LocalDate.now", "LocalDateTime.now", "OffsetDateTime.now", "ZonedDateTime.now", "SecurityContextHolder.getContext", "Thread.sleep", "Random.nextLong", "ResponseEntity", "coroutineScope", "async", "await", "incrementAndGet", "getAndIncrement", "delay", "Optional.of", "Optional.ofNullable", "Optional.empty", "java.util.Optional.of", "java.util.Optional.ofNullable", "java.util.Optional.empty"}
SPRING_FRAMEWORK_CALLEE_PREFIXES = ["log.", "logger.", "req.", "request.", "response.", "ServerResponse.", "ResponseEntity.", "BodyInserters.", "CollectionModel.", "URI.", "Mono.", "Flux."]
SPRING_MAPPING_ANNOTATION_RE = Regex.union("@RequestMapping", "@GetMapping", "@PostMapping", "@PutMapping", "@DeleteMapping", "@PatchMapping")

File-classification gates: several String#includes? calls OR-ed over the same buffer, replaced with a single precompiled Regex.union scan (PCRE2 JIT, auto-escapes each literal). Each of these runs once (sometimes twice) per Kotlin file in the scan.

STOMP_ROUTE_MARKER_RE = Regex.union("addEndpoint", "@MessageMapping", "@SubscribeMapping")

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]