Naming/FileName cop's ExpectMatchingDefinition doesn't work with custom directories

[patbl]

Is your feature request related to a problem? Please describe.

In Rails, you can add directories to config.autoload_paths, and these directories don't have to conform to the standard Rails namespacing conventions.

For example, suppose you have the file app/models/news/photo_story.rb. Normally, you'd have to name the class in that file News::PhotoStory. But if you add app/models/news to config.autoload_paths, you can instead name the file PhotoStory, and autoloading will still work.

This usually isn't the best thing to do, but people do it.

If you have ExpectMatchingDefinition: true, Rubocop will say something like

photo_story.rb should define a class or module called News::PhotoStory.

Describe the solution you'd like

It would be nice if you could specify autoload_paths in the Rubocop configuration, and have Rubocop instead look for unnamespaced classes in those directories. Something like

Naming/FileName:
  Enabled: true
  ExpectMatchingDefinition: true
  CustomDirectories:
    - app/models/news

Then it would omit the News:: prefix when looking for constants in those files. It would still report an offense if you named the class something like PhotosStory.

Describe alternatives you've considered

I could exclude the relevant paths, but then I'd lose out the check for those files (including the snake-case filename check).

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contribution and understanding!

[stale]

This issues been automatically closed due to lack of activity. Feel free to re-open it if you ever come back to it.

[toupeira]

@patbl I wonder if you found a solution for this in the meantime?

I saw there's a new(ish) setting CheckDefinitionPathHierarchy: false which disables the path verification altogether, but it would be nice if we could keep that verification and define custom directories like you suggested.

In my case my projects are all in a ~/src directory, so the code at

rubocop/lib/rubocop/cop/naming/file_name.rb

Line 186 in 1d5621d

start = %w[lib spec test src]

always detects that as the "project root". So e.g. for a path ~/src/project/app/models/user.rb it wants a Project::App::Models namespace 😁

Related discussion: https://stackoverflow.com/questions/61689211/rubocop-naming-filename-cop-complains-about-standard-files-when-expectmatchingde

/cc @jschneid @bbatsov

[patbl]

@patbl I wonder if you found a solution for this in the meantime?

I added all the custom paths to the Exclude list for this cop. Maybe using CheckDefinitionPathHierarchy: false would be better—less thorough but more comprehensive and consistent.

[grosser]

I'd love a CheckDefinitionPathHierarchyRoots: ["foo"]
because I have parts/ folder and it does not complain about anything inside of there :/

[grosser]

opened #10220

[grosser]

PR that should fix it #10224