class Analyzer::Java::JaxRs

Defined in:

analyzer/analyzers/java/jaxrs.cr

Constant Summary

APPLICATION_PATH_RE = Regex.union("ApplicationPath")
DERIVATIVE_MANIFEST_BASENAMES = Set {"pom.xml", "build.gradle", "build.gradle.kts"}

Manifest basenames a derivative framework can only show up in. Helidon MP's own quickstart is the concrete case: its JAX-RS resource classes carry no io.helidon import at all — the runtime is pulled in solely via pom.xml's io.helidon.microprofile.* dependencies, so a .java-only scan would never see the marker and JAX-RS would double-count those routes under java_jaxrs too.

DERIVATIVE_MARKERS = ["io.quarkus", "io.dropwizard", "io.helidon.microprofile"]

Frameworks that ride on JAX-RS but ship their own analyzer. Listing them here keeps the JAX-RS analyzer the fallback for vanilla Jersey / RESTEasy resources without double-counting. io.helidon.microprofile routes to Analyzer::Java::HelidonMp, which drives this same extractor under the java_helidon_mp tech.

DERIVATIVE_MARKERS_RE = Regex.union(DERIVATIVE_MARKERS)
JAVA_EXTENSION = "java"
JAXRS_OR_WEBSOCKET_SOURCE_RE = Regex.union("jakarta.ws.rs", "javax.ws.rs", "jakarta.websocket", "javax.websocket", "@ServerEndpoint")

jaxrs_or_websocket_source? gates the per-file tree-sitter parse; one precompiled Regex.union scan (PCRE2 JIT, auto-escapes each literal) replaces 5 separate String#includes? passes over the same buffer.

WS_RS_PACKAGE_RE = Regex.union("jakarta.ws.rs", "javax.ws.rs")

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]