class Analyzer::Cfml::Taffy

Overview

Taffy REST resources.

Taffy is the most declarative of the CFML frameworks: a resource CFC carries its path as a component-level attribute, and the HTTP verb is the name of the handler function. Path, method and parameters are therefore all statically known.

<cfcomponent extends="taffy.core.resource" taffy_uri="/artist/{id}">
    <cffunction name="get">
        <cfargument name="id" type="string" required="true">

component extends="taffy.core.resource" taffy:uri="/echo" {
    function post(string name = "", string value = "") {}

Defined in:

analyzer/analyzers/cfml/taffy.cr

Constant Summary

PATH_TOKEN_RE = /\{([^}]+)\}/
QUERY_VERBS = Set {"GET", "HEAD", "OPTIONS", "DELETE"}

Verbs whose arguments arrive in the query string rather than a body.

RESOURCE_BASE_RE = /extends\s*=\s*["'][^"']*\bresource\b["']/i
SCRIPT_FUNCTION_TAIL_LIMIT = 200
SCRIPT_FUNCTION_TAIL_RE = /\A[^{;]*/

function name(...) taffy_verb="PATCH" { — the attribute sits between the closing paren and the body brace. The window is bounded because slicing the whole remaining file per declaration made the pass O(n^2) in file size.

URI_ATTRIBUTES = ["taffy_uri", "taffy:uri"]

Both spellings are officially supported — taffy/core/api.cfc reads taffy_uri and falls back to taffy:uri.

VERB_ATTRIBUTES = ["taffy_verb", "taffy:verb"]
VERB_FUNCTIONS = Set {"get", "post", "put", "delete", "head", "options", "patch"}

Taffy dispatches an incoming request to the function named after the HTTP verb.

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]