class AnalyzerExample

Overview

Template for a new framework adapter (layer L2).

Copy this file to src/analyzer/analyzers/{language}/{framework}.cr, rename the class, and point it at your language's engine. See AGENTS.md §"Analyzer Layering" and docs/content/development/analyzer_architecture/ for the full walkthrough.

The three layers, and which one this file is:

L0 Language Engine src/analyzer/engines/{lang}_engine.cr Owns the file set and the walk. Inherit it. L1 Route Extractor src/miniparsers/{lang}_route_extractor*.cr Owns parsing. Call it. L2 Framework Adapter THIS FILE Owns framework-specific route/param rules.

Rule: an adapter receives routes. It does not walk the filesystem and it does not parse tokens. If you find yourself reaching for Dir.glob, File.open or each_line here, the work belongs in L0 or L1 instead.

AnalyzerExample deliberately sits outside the Analyzer:: namespace so the registry sweep in initialize_analyzers skips it — which is also why it carries no analyzer_for. Your real analyzer needs both.

Defined in:

analyzer/analyzers/example.cr

Instance Method Summary

Instance methods inherited from class FileScanEngine

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

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

Instance Method Detail

def analyze_file(path : String) : Array(Endpoint) #

Shape A — per-file extraction.

FileScanEngine#analyze drives the walk and concatenates whatever each call returns. Use this shape unless you need state that spans files.


[View source]