class Analyzer::Java::Dropwizard

Overview

Dropwizard ships Jersey under the hood, so JAX-RS resource classes are the routing surface. This analyzer drives the shared TreeSitterJaxRsExtractor against files in project roots that carry a Dropwizard framework-bootstrap reference. Resource classes are often pure JAX-RS and do not import Dropwizard directly.

Defined in:

analyzer/analyzers/java/dropwizard.cr

Constant Summary

CONFIG_DIRS = ["", "config", "src/main/resources"]

Directories a Dropwizard app conventionally keeps its server YAML in, relative to the project root. Non-recursive, as the Dir.glob this replaced was.

DROPWIZARD_BOOTSTRAP_MARKER_RE = /io\.dropwizard\.(?:core\.)?(?:Application\b|setup\.(?:Bootstrap|Environment)\b)|io\.dropwizard\.assets\.AssetsBundle\b/

A bare io.dropwizard substring also matches Dropwizard's standalone utility modules (io.dropwizard.util.Duration, io.dropwizard.validation., io.dropwizard.jackson.) that ship explicitly for use outside the Dropwizard web framework/server stack. Restrict project classification to actual bootstrap symbols (the Application base class, the Bootstrap/ Environment setup types, and the AssetsBundle helper) so a plain JAX-RS/RESTEasy project that merely borrows one of those helpers isn't misclassified as a Dropwizard project.

JAVA_EXTENSION = "java"

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]