class Analyzer::Scala::Tapir

Defined in:

analyzer/analyzers/scala/tapir.cr

Constant Summary

BASE_ENDPOINT_RE = /(?<![.\w])(?:[A-Za-z_]\w*[Ee]ndpoint|endpoint|infallibleEndpoint)\b/
HTTP_METHODS = ["get", "post", "put", "delete", "patch", "head", "options", "connect", "trace"] of ::String
IN_TOKEN_RE = Regex.new("\"(?<literal>[^\"]+)\"|path\\[(?<path_type>#{TYPE_PATTERN})\\](?:\\s*\\(\\s*\"(?<path_name>[^\"]+)\"\\s*\\))?|query\\[(?<query_type>#{TYPE_PATTERN})\\]\\s*\\(\\s*\"(?<query_name>[^\"]+)\"\\s*\\)|queries\\[(?<queries_type>#{TYPE_PATTERN})\\]\\s*\\(\\s*\"(?<queries_name>[^\"]+)\"\\s*\\)|header\\[(?<header_type>#{TYPE_PATTERN})\\]\\s*\\(\\s*\"(?<header_name>[^\"]+)\"\\s*\\)|header\\s*\\(\\s*\"(?<header_name2>[^\"]+)\"|cookie\\[(?<cookie_type>#{TYPE_PATTERN})\\]\\s*\\(\\s*\"(?<cookie_name>[^\"]+)\"\\s*\\)|(?<body>jsonBody|xmlBody|stringBody|plainBody|binaryBody|byteArrayBody|byteBufferBody|formBody|multipartBody|rawBinaryBody|fileBody)(?:\\[(?<body_type>#{TYPE_PATTERN})\\])?")
METHOD_CALL_PATTERNS = HTTP_METHODS.map do |m| {m, /\.#{m}\b/} end

Crystal recompiles an interpolated regex literal on every evaluation (a full PCRE2 JIT compile) — precompile the fixed per-verb matchers once at load time instead of per chain.

MODIFIERS = "(?:(?:private|protected|implicit|lazy|final|override)\\s+)*"
PARAM_CONST_RE = Regex.new("^\\s*#{MODIFIERS}val\\s+(\\w+)\\s*=\\s*((?:query|queries|header|cookie|path)\\[#{TYPE_PATTERN}\\]\\s*\\(\\s*\"[^\"]+\"\\s*\\)|header\\s*\\(\\s*\"[^\"]+\"\\s*\\))")

val limitParameter = query[Option[Int]]("limit")... — a reusable input combinator bound to a val. Only the combinator core is captured so any trailing .description(...) is dropped.

PATH_CONST_RE = Regex.new("^\\s*#{MODIFIERS}val\\s+(\\w+)\\s*(?::\\s*String\\s*)?=\\s*(\"(?:[^\"\\\\]|\\\\.)*\"(?:\\s*/\\s*\"(?:[^\"\\\\]|\\\\.)*\")*)\\s*$")

val UserPath = "user" (optionally /-joined literals). The captured value is already in literal form, so substituting it back into a .in(...) block lets the normal path-literal scan pick up the segments.

TYPE_PATTERN = "(?:[^\\[\\]]|\\[[^\\[\\]]*\\])+"

Type token allows one level of nested brackets (e.g. Option[String], List[User]).

VAL_DEF_RE = /^\s*(?:(?:private|protected|implicit|lazy|final|override)\s+)*val\s+(\w+)\s*(?::\s*[^=]+?\s*)?=(?![=>])\s*/

Leading val NAME [: TYPE] = of a definition. Group 1 captures the name; match.end marks where the right-hand side (the actual endpoint chain) begins. =(?![=>]) avoids stopping on ==/=>.

Class Method Summary

Instance Method Summary

Instance methods inherited from class FileScanEngine

analyze analyze, analyze_file(path : String) : Array(Endpoint) analyze_file

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_file(path : String) : Array(Endpoint) #

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