class Analyzer::Python::Masonite

Overview

Reference: https://docs.masoniteproject.com/features/routing

Masonite (current v4/v5 API) routes live in routes/web.py (and sibling routes/*.py modules such as routes/api.py) as a plain list assigned to ROUTES, built from classmethods on masonite.routes.Route:

Route.get/post/put/patch/delete/options(url, controller, **opts) Route.any(url, controller) -> all six verbs Route.match([methods], url, controller) Route.group([...routes...], prefix=, middleware=, name=, domain=) Route.resource(base_url, controller) -> 7 REST routes Route.api(base_url, controller) -> 5 REST-API routes Route.view(url, template, data) -> GET, no controller Route.redirect/permanent_redirect(url, new) -> GET, no controller

controller is either the documented string binding ('WelcomeController@show', defaulting to __call__ with no @) or a direct class/method reference (WelcomeController.show) — both are handled. Route.fallback(...) (a catch-all with no concrete path) and route .name(...)/.domain(...) are intentionally not modeled — they carry no attack-surface information Noir tracks.

NOTE — Masonite ≤3 used a different, now-legacy routing API: bare Get/Post/RouteGroup classes imported directly from masonite.routes (e.g. Get('/x', 'C@m'), RouteGroup([...], prefix=...)) with controllers resolved under app/http/controllers. That shape is NOT handled here; this analyzer targets the current Route.* DSL used by the official project skeleton (MasoniteFramework/cookie-cutter, app/controllers) and current docs. A legacy-style project still gets detected as Masonite (the detector only looks for masonite imports) but yields no routes from this analyzer.

Defined in:

analyzer/analyzers/python/masonite.cr

Constant Summary

ANY_METHODS = ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS"]
API_RESOURCE_ACTIONS = [{["GET"], "", "index"}, {["POST"], "", "store"}, {["GET"], "/@id", "show"}, {["PUT", "PATCH"], "/@id", "update"}, {["DELETE"], "/@id", "destroy"}]

Route.api(base_url, controller) — API-style subset (no create/edit HTML forms).

HTTP_VERB_METHODS = {"get" => ["GET"], "post" => ["POST"], "put" => ["PUT"], "patch" => ["PATCH"], "delete" => ["DELETE"], "options" => ["OPTIONS"]}
RESOURCE_ACTIONS = [{["GET"], "", "index"}, {["GET"], "/create", "create"}, {["POST"], "", "store"}, {["GET"], "/@id", "show"}, {["GET"], "/@id/edit", "edit"}, {["PUT", "PATCH"], "/@id", "update"}, {["DELETE"], "/@id", "destroy"}]

Route.resource(base_url, controller) — see masonite.routes.Route.resource: seven conventional REST routes.

ROUTE_CALL_VERBS = Set {"get", "post", "put", "patch", "delete", "options", "any", "match", "group", "resource", "api", "view", "redirect", "permanent_redirect"}

Verbs recognized while scanning Route.<verb>(...) call sites. Anything else (.compile, .set_controller_locations, .fallback, .default, ...) is deliberately left unmatched.

Class Method Summary

Instance Method Summary

Instance methods inherited from class Analyzer::Python::PythonEngine

build_callees_from(body : String, body_start_line : Int32, path : String, *, definition_base_path : String | Nil = nil, source : String | Nil = nil) : Array(Callee) build_callees_from, find_def_line(lines : Array(String), decorator_line : Int32) : Int32 | Nil find_def_line, find_imported_modules(app_base_path : String, file_path : String, content : String | Nil = nil) : Hash(String, Tuple(String, Int32)) find_imported_modules, find_imported_package(package_path : String, dotted_as_names : String) : Array(Tuple(String, String, Int32)) find_imported_package, find_json_params(codeblock_lines : Array(String), json_var_names : Array(String)) : Array(Param) find_json_params, join_until_python_call_closes(lines : Array(String), index : Int32, line : String) : String join_until_python_call_closes, parse_code_block(data : String | Array(String), after : Regex | Nil = nil) : String | Nil parse_code_block, parse_function_def(source_lines : Array(String), start_index : Int32) : FunctionDefinition | Nil parse_function_def, push_callees_from(endpoint : Endpoint, body : String, body_start_line : Int32, path : String, *, definition_base_path : String | Nil = nil, source : String | Nil = nil) : Nil push_callees_from, python_bracket_delta(line : String) : Int32 python_bracket_delta, python_paren_delta(line : String) : Int32 python_paren_delta, python_signature_line_span(lines : Array(String)) : Int32 python_signature_line_span, return_literal_value(data : String) : String return_literal_value

Class methods inherited from class Analyzer::Python::PythonEngine

python_test_path?(path : String, base_path : String | Nil = nil) : Bool python_test_path?

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]