class Analyzer::CSharp::Carter

Overview

Extracts endpoints from Carter (https://github.com/CarterCommunity/Carter) modules. A Carter module is a class that either implements ICarterModule or derives from the CarterModule base class, and registers minimal-API routes inside AddRoutes(IEndpointRouteBuilder).

CarterModule additionally takes a base path through its constructor (public DirectorsModule() : base("/directors")), which every route in that module hangs off. Modules using that base were previously invisible to this analyzer (it required the literal string ICarterModule), so they fell through to cs_aspnet_core_minimal_api, which emitted their routes without the base path — GET / and GET /qs instead of GET /directors and GET /directors/qs.

Route parsing itself is the same job the minimal-API analyzer does, so it runs on the shared MinimalApiSupport helpers with the module base path passed in as a prefix. That also brings delegate parameter binding, MapGroup composition, method-group handlers and generic MapPut<T>("/x", …) registrations to Carter, none of which the previous hand-rolled copy supported.

Extraction is scoped to each module's AddRoutes body so MapGroup prefixes and base paths don't leak between modules declared in one file.

Included Modules

Defined in:

analyzer/analyzers/csharp/carter.cr

Constant Summary

ADD_ROUTES_RE = /\bAddRoutes\s*\(/
BASE_PATH_RE = /:\s*base\s*\(\s*@?"([^"]*)"/

public DirectorsModule() : base("/directors") — Carter's constructor base path. base() with no literal leaves the prefix empty.

MODULE_CLASS_RE = /\bclass\s+(\w+)(?:\s*<[^>]*>)?\s*:[^{]*\bI?CarterModule\b/

class X : ICarterModule / class X : CarterModule / with generics or extra interfaces in the base list.

Class Method Summary

Instance Method Summary

Class methods inherited from module Analyzer::CSharp::Common

aspnet_core_source?(content : String) : Bool aspnet_core_source?, aspnet_framework_source?(content : String) : Bool aspnet_framework_source?, carter_module_source?(content : String) : Bool carter_module_source?, csharp_service_type?(type_name : String) : Bool csharp_service_type?, csharp_test_path?(relative_path : String) : Bool csharp_test_path?, explicit_binding_name(param_def : String) : String | Nil explicit_binding_name, project_root_for(path : String, roots : Array(String)) : String | Nil project_root_for, project_roots(csproj_paths : Array(String)) : Array(String) project_roots, route_placeholder_name(raw : String) : String route_placeholder_name

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]