class Analyzer::Dart::Shelf

Overview

Shelf (package:shelf_router/shelf_router.dart) is the foundational Dart HTTP server library. The Router API exposes a method per verb (router.get, router.post, ...) and a mount('/prefix', subRouter) composition primitive. Handlers are typically wired with cascade operators on a fresh Router():

final router = Router() ..get('/users', _listUsers) ..post('/users', _createUser) ..get('/users/', _getUser) ..mount('/api/v1', apiRouter.call);

Direct method calls (router.get('/foo', _handler)) and .all(...) — which registers a handler against every verb — are also supported. Path captures use angle brackets (<id>, <id|[0-9]+>) which we surface as {id} path params.

Mounts are resolved across files: a Router variable mounted under /prefix contributes its routes (recursively) under that prefix in the parent router. Each top-level router (not mounted anywhere) is emitted as a separate set of endpoints.

Defined in:

analyzer/analyzers/dart/shelf.cr

Constant Summary

ALL_VERBS = ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]
HTTP_METHOD_MAP = {"get" => "GET", "post" => "POST", "put" => "PUT", "patch" => "PATCH", "delete" => "DELETE", "head" => "HEAD", "options" => "OPTIONS"}
ROUTE_ANNOTATION_REGEX = /@Route\s*(?:\.\s*([A-Za-z]+))?\s*\(/

Matches the official @Route.<verb>('/path') annotation and the shelf_router_classes @Route('VERB', '/path') variant. Capture 1 is the dotted verb (nil for the string-arg form).

ROUTE_PREFIX_REGEX = /@RoutePrefix\s*\(/

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]