class Analyzer::Elixir::Phoenix

Defined in:

analyzer/analyzers/elixir/elixir_phoenix.cr

Constant Summary

ELIXIR_INTERPOLATION_RE = /\#\{([^}]+)\}/

Elixir double-quoted strings interpolate #{expr}, and the Phoenix Router DSL captures the literal characters between quotes. Without normalization, get "/api/#{@version}/items" produced URL /api/#{@version}/items with the #{@…} syntax leaking into the path. Rewrite each interpolation site to a {name} placeholder (stripping any leading @ module- attribute sigil) so the path-parameter extractor recognises it and the URL template reads cleanly. Mirrors the Python f-string, Ruby #{}, PHP $var, and Crystal #{} fixes.

MODULE_NAME_RE = /^\s*defmodule\s+([A-Za-z_]\w*(?:\.[A-Za-z_]\w*)*)\s+do\b/m
PHOENIX_ROUTE_EVIDENCE_RE = /\ \b(?:get|post|put|patch|delete|options|head|match|resources|scope|socket|live|live_dashboard|forward) \s*(?:\(\s*)?(?:["']|unquote\b|:) |\bdefmacro\s+ /x

File-level gate for the route-extraction pass. Controllers, schemas, views, and most application modules never declare Phoenix routes, but #analyze_file used to line-scan every .ex file anyway. Match the DSL shape (verb + optional paren + string/unquote/atom) so common non-route uses like Map.get( or forget do not force a full scan. Custom route macros collected in the first pass are checked by name separately in may_contain_phoenix_routes?.

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

get/post/… → its precompiled route regex. add_standard_route runs once per verb per line of every .ex file; Regex.new there recompiled the same 7 PCRE2 patterns on every call (~3.4M recompiles on a 2400-file repo, the dominant scan cost). The pattern depends only on the fixed verb set, so build it once. See add_standard_route for the shape rationale.

STANDARD_ROUTE_PATTERNS = STANDARD_ROUTE_METHODS.keys.to_h do |verb| {verb, Regex.new("(?:^|[^.\\w])#{verb}\\s*(?:\\(\\s*)?['\"]([^'\"]+)['\"]\\s*,\\s*([A-Z]\\w*(?:\\.[A-Za-z_]\\w*)*|unquote\\(\\s*\\w+\\s*\\))(?=\\s*[,)]|\\s*$)(?:\\s*,\\s*:(\\w+[!?]?))?")} end

Instance Method Summary

Instance methods inherited from class Analyzer::Elixir::ElixirEngine

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

Class methods inherited from class Analyzer::Elixir::ElixirEngine

test_path?(path : String) : Bool test_path?

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, callees_needed? : Bool callees_needed?, 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, 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

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, 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_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

Instance Method Detail

def analyze #

[View source]
def analyze_file(path : String) : Array(Endpoint) #

[View source]
def extract_controller_params #

[View source]
def extract_params_from_controller(content : String, controller_name : String, controller_path : String) #

[View source]
def extract_params_from_function_block(lines : Array(String), start_index : Int32, end_index : Int32, method : String) : Array(Param) #

[View source]
def find_function_end(lines : Array(String), start_index : Int32) : Int32 #

[View source]
def line_to_endpoint(line : String, file_path : String, scope_prefix : String = "", scope_module : String = "", base : String = @base_path, string_bindings : Hash(String, String) = Hash(String, String).new) : Array(Endpoint) #

[View source]
def should_extract_params_for_endpoint?(endpoint : Endpoint, controller_name : String, action_name : String) : Bool #

[View source]