class Detector::Ruby::Rails

Defined in:

detector/detectors/ruby/rails.cr

Constant Summary

RAILS_GEMFILE_MARKERS = ["gem 'rails'", "gem \"rails\"", "gem 'railties'", "gem \"railties\""]

Modern Rails apps frequently skip the umbrella gem "rails" line and pull the individual frameworks they actually use (railties + actionpack + activerecord + ...). Treat railties as a unique marker — it has no standalone use outside Rails — so those apps are still detected.

RAILS_GEMSPEC_MARKERS = ["add_dependency 'rails'", "add_dependency \"rails\"", "add_dependency 'railties'", "add_dependency \"railties\"", "add_runtime_dependency 'rails'", "add_runtime_dependency \"rails\"", "add_runtime_dependency 'railties'", "add_runtime_dependency \"railties\""]

Multi-engine Rails projects (Spree, Solidus, larger Solidus forks) push their Gemfile to just gemspec and declare s.add_dependency 'rails' / s.add_dependency 'railties' inside <gem>.gemspec files. Match both common DSL accessor names (s, spec) and the runtime-dependency variant.

Instance Method Summary

Instance methods inherited from class Detector

applicable?(filename : String) : Bool applicable?, detect(filename : String, file_contents : String) : Bool detect, idempotent? : Bool idempotent?, logger : NoirLogger logger, name : String name

Constructor methods inherited from class Detector

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

Macros inherited from class Detector

define_getter_methods(names) define_getter_methods

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]