class Analyzer::Cfml::Fw1

Overview

FW/1 (Framework One) routing.

Routes live in Application.cfc as an array of single-key structs, where the key is an optional $METHOD followed by the pattern:

variables.framework = {
    routes = [
        { "$GET/todo/:id"    = "/main/get/id/:id" },
        { "$DELETE/todo/:id" = "/main/delete/id/:id" },
        { "$POST/todo/"      = "/main/save" },
        { 'hint' = 'Resource Routes', '$RESOURCES' = 'dogs' }
    ]
};

A key with no $ prefix answers every method. hint is a label the framework skips, not a route.

Defined in:

analyzer/analyzers/cfml/fw1.cr

Constant Summary

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

A key with no $ prefix, or an explicit $*, answers every method.

METHOD_PREFIX_RE = /\A\$([A-Za-z*]+)/

$METHOD prefix on the pattern. $* means every method.

NON_ROUTE_KEYS = Set {"hint"}

hint labels the entry rather than declaring a route. Only keys FW/1's own sources use as labels belong here — skipping a key the framework does treat as a pattern is a silent false negative.

RESOURCE_TEMPLATES = [{["GET"], "", false}, {["GET"], "/new", false}, {["POST"], "", false}, {["GET"], "", true}, {["PUT", "PATCH"], "", true}, {["DELETE"], "", true}]

framework/one.cfc defines these as resourceRouteTemplates. Note there is no edit route — FW/1 differs from Rails here.

RESOURCES_KEY = "$RESOURCES"
ROUTE_ENTRY_RE = /["']([^"']+)["']\s*[:=]\s*["']([^"']*)["']/

"$GET/todo/:id" = "/main/get/id/:id" — the value is the internal action, which is not part of the URL.

ROUTES_ARRAY_RE = /\broutes\s*[:=]\s*\[/i

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]