class Analyzer::Dart::Angel3

Overview

Angel3 (package:angel3_framework/angel3_framework.dart) is a full-featured, Express-style Dart server framework. Routes are registered against an Angel() instance with a method per verb:

var app = Angel(); app.get('/users', (req, res) => _listUsers(req)); app.post('/users', createUser); app.all('/health', (req, res) => 'ok');

Routes can be grouped under a shared prefix with group, whose second argument is a closure receiving a child router:

app.chain([cors()]).group('/api', (router) { router.get('/version', (req, res) => 'v0'); // GET /api/version });

group blocks nest, composing their prefixes. Path captures use the Express-style :id syntax, surfaced as {id} path params.

Routes are bound to variables holding an Angel() instance (or an Angel-typed parameter) and to the child-router parameter of a group closure, so calls on unrelated receivers (e.g. the package:http client's http.get(url)) are never mistaken for routes.

Not yet handled: reflection-based @Expose controller classes and the chain([...]).<verb>(...) form where the verb is called directly on a chain(...) result rather than a bound router variable.

Defined in:

analyzer/analyzers/dart/angel3.cr

Constant Summary

ALL_VERBS = ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]
ANGEL_ASSIGN_REGEX = /(?:^|[;{}=(,\s])(?:final|var|const|late)\s+(?:Angel\s+)?([A-Za-z_]\w*)\s*=\s*(?:await\s+)?Angel\s*\(/

Variables holding an Angel() instance, plus parameters/fields typed Angel (so Future configureServer(Angel app) is picked up too).

ANGEL_TYPED_REGEX = /(?:^|[;{}(,])\s*Angel\s+([A-Za-z_]\w*)/
CALL_REGEX = /(?<![\w$.])([A-Za-z_]\w*)\s*\.\s*([a-zA-Z]+)\s*\(/

Receiver .verb( calls; (?<![\w$.]) keeps the receiver to a single identifier so chain([...]).post( (receiver is a )) is skipped.

GROUP_REGEX = /\.group\s*\(/
HTTP_METHOD_MAP = {"get" => "GET", "post" => "POST", "put" => "PUT", "patch" => "PATCH", "delete" => "DELETE", "head" => "HEAD", "options" => "OPTIONS"}

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]