class Analyzer::Java::Quarkus

Overview

Quarkus is JAX-RS-flavoured, so this analyzer just drives the shared TreeSitterJaxRsExtractor against files in project roots that carry a Quarkus marker. Resource classes are often plain Jakarta REST and do not import Quarkus directly. The extractor already understands Quarkus's @RestPath / @RestQuery / @RestHeader / @RestForm / @RestCookie shorthand annotations alongside the standard JAX-RS names, so no Quarkus-specific tree walking is needed.

Defined in:

analyzer/analyzers/java/quarkus.cr

Constant Summary

ANNOTATION_VALUE_PATTERNS = {"Param" => /@Param\s*\(\s*(?:(?:value|name)\s*=\s*)?(["'][^"']+["'])\s*\)/m, "Header" => /@Header\s*\(\s*(?:(?:value|name)\s*=\s*)?(["'][^"']+["'])\s*\)/m}

Crystal recompiles an interpolated regex literal on every evaluation (a full PCRE2 JIT compile). Only @Param/@Header are probed, so precompile their matchers once at load time.

HTTP_METHOD_NAMES = Set {"GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS", "TRACE"}
JAVA_EXTENSION = "java"
JAXRS_SOURCE_RE = Regex.union("jakarta.ws.rs", "javax.ws.rs")

quarkus_route_source?/jaxrs_source? gate per-file tree-sitter parses; one precompiled Regex.union scan (PCRE2 JIT, auto-escapes each literal) each replaces the chained String#includes? passes over the same buffer.

QUARKUS_MARKERS = ["io.quarkus", "quarkus.io"]
QUARKUS_ROUTE_SOURCE_RE = Regex.union("jakarta.ws.rs", "javax.ws.rs", "org.jboss.resteasy.reactive", "io.quarkus.vertx.web.Route")
SPLIT_ARGS_RULES = Noir::TopLevelSplit::Rules.new(nest: ((Noir::TopLevelSplit::Nest::Paren | Noir::TopLevelSplit::Nest::Bracket) | Noir::TopLevelSplit::Nest::Brace) | Noir::TopLevelSplit::Nest::Angle, quotes: "\"'", escape: Noir::TopLevelSplit::Escape::InQuotes, strip: true, empties: Noir::TopLevelSplit::Empties::DropTrailing, per_kind: false, clamp: true)

Rules::JAVA plus Nest::Angle, on the same shared depth counter. Not the shared Rules::JAVA preset: this splitter runs on a JAX-RS resource method's parameter list, where Map<String, List<Integer>> is one parameter and must not break in two. The cost is that a < used as a comparison — f(a < b, c) — raises the depth and swallows the comma, which cannot happen in a parameter list. File-local because quarkus is the only splitter with exactly this combination; wicket also counts angles but takes only " as a quote.

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]