class Analyzer::Dart::Alfred

• Analyzer::Dart::Alfred
• Analyzer
• Reference
• Object

Overview

Alfred (package:alfred/alfred.dart) is a minimalist, Express-style Dart server framework. Routes are registered against an Alfred() instance with a method per verb:

final app = Alfred(); app.get('/users', (req, res) => _listUsers(req)); app.post('/users', _createUser); app.get('/users/:id', (req, res) => _getUser(req)); app.all('*', _catchAll);

Path captures use Express-style :id segments, optionally with a type matcher (:id:int, :date:date) which we strip down to the {id} / {date} path-param form. .all(...) registers a handler against every verb.

Routes are collected per file against the variable bound to an Alfred() instance (or a parameter/field typed Alfred), so calls on unrelated receivers (e.g. someMap.get('key')) are never mistaken for routes.

Defined in:

Constant Summary

ALFRED_ASSIGN_REGEX = /(?:^|[;{}=(,\s])(?:final|var|const|late)\s+(?:Alfred\s+)?([A-Za-z_]\w*)\s*=\s*Alfred\s*\(/

Names bound to an Alfred() instance, plus parameters/fields whose declared type is Alfred (so void configure(Alfred app) route registration is picked up too).

ALFRED_TYPED_REGEX = /(?:[;{}(,]\s*|\b(?:final|late|const|var|required)\s+)Alfred\s+([A-Za-z_]\w*)\b/

An Alfred-typed parameter (void f(Alfred app)) or field (final Alfred app;), so route registration that reaches Alfred through a constructor/parameter is picked up.

ALL_VERBS = ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]

HANDLER_REFERENCE_REGEX = /\A[A-Za-z_]\w*(?:\.[A-Za-z_]\w*)*\z/

Matches a bare handler reference (_createUser, auth.handler) passed as a route's handler argument.

HTTP_METHOD_MAP = {"get" => "GET", "post" => "POST", "put" => "PUT", "patch" => "PATCH", "delete" => "DELETE", "head" => "HEAD", "options" => "OPTIONS"}

ROUTE_ASSIGN_REGEX = /(?:^|[;{}=(,\s])(?:final|var|const|late)\s+(?:[A-Za-z_][\w<>,\s?]*\s+)?([A-Za-z_]\w*)\s*=\s*([A-Za-z_]\w*)\s*\.\s*route\s*\(/

final r = app.route('/base', ...) — a NestedRoute child bound to a variable. Capture 1 is the new variable, capture 2 its receiver.

ROUTE_CALL_REGEX = /(?<![\w$.])([A-Za-z_]\w*)\s*\.\s*route\s*\(/

A route() call whose result a cascade/chain of verb calls is attached to: app.route('/base')..get('sub', h)..post('sub2', h).

Instance Method Summary

• #analyze

Instance Method Detail