class Analyzer::Cfml::Wheels

Overview

Wheels routing.

Routes are one fluent chain in config/routes.cfm:

mapper()
    .get(name="login", pattern="login", to="sessions##new")
    .resources("users")
    .scope(path="admin", package="admin")
        .resources(name="users", nested=true)
            .member()
                .post("assume")
            .end()
        .end()
    .end()
    .root(to="tweets##index", method="get")
.end();

The chain is order-dependent, so it is walked sequentially with a prefix stack: scope, namespace, a nested resources and member each push a path segment, and end() pops it. Without that, every admin route would be emitted at the top level.

Defined in:

analyzer/analyzers/cfml/wheels.cr

Constant Summary

DSL_CALL_RE = /\.\s*([A-Za-z_]\w*)\s*\(/
KEY_SEGMENT = "[key]"

Default key segment for a member route.

MAPPER_RE = /(?<![\w.])mapper\s*\(/i
PLACEHOLDER_RE = /\[([A-Za-z_]\w*)\]/

Wheels writes path variables in brackets, not colons.

RESOURCE_ROUTES = [{"new", ["GET"], "/new"}, {"create", ["POST"], ""}, {"show", ["GET"], ""}, {"edit", ["GET"], "/edit"}, {"update", ["PUT", "PATCH"], ""}, {"delete", ["DELETE"], ""}]

Singular resource has no index and no key segment — it always acts on the one record implied by the session.

RESOURCES_ROUTES = [{"index", ["GET"], ""}, {"new", ["GET"], "/new"}, {"create", ["POST"], ""}, {"show", ["GET"], "/[key]"}, {"edit", ["GET"], "/[key]/edit"}, {"update", ["PUT", "PATCH"], "/[key]"}, {"delete", ["DELETE"], "/[key]"}]

Wheels' plural resource set. update answers both PUT and PATCH.

ROUTES_FILE = "routes.cfm"
VERB_CALLS = Set {"get", "post", "put", "patch", "delete", "head", "options"}

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]