class Detector::Elixir::Plug

Defined in:

detector/detectors/elixir/plug.cr

Constant Summary

FORWARD_RE = /(?:^|\n)[ \t]*forward[ \t(]+["'][^"'\n]*["'][^\n]*\bto:/

forward "/api", to: SomeRouter — Plug.Router's mount macro, in the bare and parenthesized call forms.

The marker this replaces was "forward " AND "do:", and neither half is Plug's: do: is Elixir's one-line function body and appears in nearly every module, while forward is an ordinary identifier. Any context module with a forward variable and a def …, do: … was detected as Plug, so a plain Phoenix/Ecto project ran the Plug analyzer over its whole tree for nothing.

to: is matched anywhere after the path rather than as the first option, because forward/2 takes :host, :init_opts, :private and :assigns in any order (forward "/", host: "api.", to: Api).

Class Method Summary

Instance Method Summary

Instance methods inherited from class Detector

applicable?(filename : String) : Bool applicable?, base_relative_path(filename : String) : String base_relative_path, content_matches?(file_contents : String, markers : Regex) : Bool content_matches?, detect(filename : String, file_contents : String) : Bool detect, gemfile_dependency?(file_contents : String, gem_name : String) : Bool gemfile_dependency?, gemspec_dependency?(file_contents : String, gem_name : String) : Bool gemspec_dependency?, idempotent? : Bool idempotent?, logger : NoirLogger logger, name : String name, path_sensitive? : Bool path_sensitive?, record_unparsable_document(filename : String, error : Exception) : Nil record_unparsable_document

Constructor methods inherited from class Detector

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Detector

detector_for(tech, extensions = nil, basenames = nil, path_segments = nil, idempotent = nil) detector_for

Class Method Detail

def self.tech_name : String #

The tech name without needing an instance, so the registry can be read off the classes themselves rather than from a parallel list.


[View source]

Instance Method Detail

def applicable?(filename : String) : Bool #
Description copied from class Detector

Cheap filename-only filter the detector pass uses to skip #detect on files the detector cannot possibly match. The default true preserves prior behavior (every detector runs on every file). Override with the same predicate the body of #detect starts with — e.g., filename.ends_with?(".py") for a Python framework detector — so the detector loop avoids the #detect dispatch on files outside the detector's language.

On large codebases (saleor's 4255 .py files) this lifts ~100 virtual #detect calls per file out of the hot loop because most detectors' inner first-line is exactly this kind of cheap filename check.


[View source]
def detect(filename : String, file_contents : String) : Bool #

[View source]
def set_name #

[View source]