Add Cop to block external references to "Internal" code #56
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new "Betterment/InternalsProtection" cop which enforces a pattern of putting internal code into
Internals
sub modules.If you have a module
MyModule
which has a submodule or class that you don't want accessed from other modules, you can place it underMyModule::Internals
(e.g.MyModule::Internals::MyPrivateClass
) to indicate that code in other modules should not access it. This cop enforces that by blocking references to constants defined withinInternals
modules from code in other modules.It also restricts string references to class names in ActiveRecord association definitions, and properly handles references in specs.