class Analyzer::Perl::Dancer2

Overview

Dancer2 route DSL analyzer.

Dancer2 (https://github.com/PerlDancer/Dancer2) exposes routes through a keyword DSL exported by use Dancer2:

get '/' => sub { ... }; post '/users' => sub { ... }; del '/users/:id' => sub { ... }; # del, not delete any ['get','post'] => '/feed' => sub { ... }; any '/all' => sub { ... }; # every HTTP verb

prefix '/api' => sub { # block-scoped prefix get '/status' => sub { ... }; # => /api/status }; prefix '/v2'; # procedural prefix get '/ping' => sub { ... }; # => /v2/ping

Route paths support named placeholders (:id, with optional type constraints :id[Int]), splat (*) / megasplat (**) wildcards, and regex routes (qr{...}). Handlers read input through the modern accessors (route_parameters, query_parameters, body_parameters, cookies, request->header, upload) as well as the legacy param/params helpers.

Defined in:

analyzer/analyzers/perl/dancer2.cr

Constant Summary

ANY_BARE_RE = /^\s*any\s+(['"])([^'"]*)\1/
ANY_LIST_RE = /^\s*any\s*\[([^\]]*)\]\s*=>\s*(['"])([^'"]*)\2/
ANY_LIST_VERBS = ["get", "head", "post", "put", "del", "delete", "patch", "options"] of ::String

Verb spellings accepted inside an any [...] method list. Dancer2 normalizes del to delete and registers HEAD alongside GET, so the arrayref form takes both the route-keyword spelling (del) and the HTTP-method spelling (delete, head).

ANY_METHODS = ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"] of ::String
CODEREF_RE = /=>\s*\\&\s*([A-Za-z_]\w*)/
PREFIX_BLOCK_RE = /^\s*prefix\s+(['"])([^'"]*)\1\s*=>\s*sub\b/
PREFIX_PROC_RE = /^\s*prefix\s+(['"])([^'"]*)\1\s*;/
PREFIX_RESET_RE = /^\s*prefix\s+(?:undef|''|""|'\/'|"\/")\s*;/
VERB_QR_RE = /^\s*(get|post|put|patch|options|del)\s+qr\s*(?:\{([^}]*)\}|\/((?:[^\/\\]|\\.)*)\/|!([^!]*)!|#([^#]*)#|\(([^)]*)\))/
VERB_STRING_RE = /^\s*(get|post|put|patch|options|del)\s+(['"])([^'"]*)\2/

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 #

[View source]
def analyze_content(content : String, file_path : String, include_callee : Bool) : Array(Endpoint) #

[View source]
def analyze_content(content : String, file_path : String) : Array(Endpoint) #

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