Merge pull request #1476 from tdeo/packwerk_globs

Use glob patterns compatible with Packwerk and engines

Author: koic

changelog/change_use_packwerk_compatible_globs.md

@@ -0,0 +1 @@
+* [#234](https://github.com/rubocop/rubocop-rails/issues/234): Use globs that are compatible with Engine or Packwerk. ([@tdeo][])

config/default.yml

@@ -6,7 +6,7 @@ inherit_mode:
 
 AllCops:
   Exclude:
-    - app/assets/**/*
+    - '**/app/assets/**/*'
     - bin/*
     # Exclude db/schema.rb and db/[CONFIGURATION_NAMESPACE]_schema.rb by default.
     # See: https://guides.rubyonrails.org/active_record_multiple_databases.html#setting-up-your-application
@@ -121,8 +121,8 @@ Rails/ActionFilter:
     - action
     - filter
   Include:
-    - app/controllers/**/*.rb
-    - app/mailers/**/*.rb
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
 
 Rails/ActionOrder:
   Description: 'Enforce consistent ordering of controller actions.'
@@ -137,7 +137,7 @@ Rails/ActionOrder:
     - update
     - destroy
   Include:
-    - app/controllers/**/*.rb
+    - '**/app/controllers/**/*.rb'
 
 Rails/ActiveRecordAliases:
   Description: >-
@@ -154,7 +154,7 @@ Rails/ActiveRecordCallbacksOrder:
   Enabled: 'pending'
   VersionAdded: '2.7'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/ActiveRecordOverride:
   Description: >-
@@ -165,7 +165,7 @@ Rails/ActiveRecordOverride:
   VersionAdded: '0.67'
   VersionChanged: '2.18'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/ActiveSupportAliases:
   Description: >-
@@ -252,7 +252,7 @@ Rails/AttributeDefaultBlockValue:
   Enabled: pending
   VersionAdded: '2.9'
   Include:
-    - 'app/models/**/*'
+    - '**/app/models/**/*'
 
 Rails/BelongsTo:
   Description: >-
@@ -311,8 +311,8 @@ Rails/ContentTag:
   # https://puma.io/puma/Puma/DSL.html#tag-instance_method
   # No helpers are used in normal models and configs.
   Exclude:
-    - app/models/**/*.rb
-    - config/**/*.rb
+    - '**/app/models/**/*.rb'
+    - '**/config/**/*.rb'
 
 Rails/CreateTableWithTimestamps:
   Description: >-
@@ -373,7 +373,7 @@ Rails/Delegate:
   # violation. When set to false, this case is legal.
   EnforceForPrefixed: true
   Exclude:
-    - app/controllers/**/*.rb
+    - '**/app/controllers/**/*.rb'
 
 Rails/DelegateAllowBlank:
   Description: 'Do not use allow_blank as an option to delegate.'
@@ -444,22 +444,22 @@ Rails/EnumHash:
   Enabled: true
   VersionAdded: '2.3'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/EnumSyntax:
   Description: 'Use positional arguments over keyword arguments when defining enums.'
   Enabled: pending
   Severity: warning
   VersionAdded: '2.26'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/EnumUniqueness:
   Description: 'Avoid duplicate integers in hash-syntax `enum` declaration.'
   Enabled: true
   VersionAdded: '0.46'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/EnvLocal:
   Description: 'Use `Rails.env.local?` instead of `Rails.env.development? || Rails.env.test?`.'
@@ -478,11 +478,11 @@ Rails/EnvironmentVariableAccess:
   VersionAdded: '2.10'
   VersionChanged: '2.24'
   Include:
-    - app/**/*.rb
-    - config/initializers/**/*.rb
-    - lib/**/*.rb
+    - '**/app/**/*.rb'
+    - '**/config/initializers/**/*.rb'
+    - '**/lib/**/*.rb'
   Exclude:
-    - lib/**/*.rake
+    - '**/lib/**/*.rake'
   AllowReads: false
   AllowWrites: false
 
@@ -494,11 +494,11 @@ Rails/Exit:
   Enabled: true
   VersionAdded: '0.41'
   Include:
-    - app/**/*.rb
-    - config/**/*.rb
-    - lib/**/*.rb
+    - '**/app/**/*.rb'
+    - '**/config/**/*.rb'
+    - '**/lib/**/*.rb'
   Exclude:
-    - lib/**/*.rake
+    - '**/lib/**/*.rake'
 
 Rails/ExpandedDateRange:
   Description: 'Checks for expanded date range.'
@@ -560,22 +560,22 @@ Rails/HasAndBelongsToMany:
   Enabled: true
   VersionAdded: '0.12'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/HasManyOrHasOneDependent:
   Description: 'Define the dependent option to the has_many and has_one associations.'
   StyleGuide: 'https://rails.rubystyle.guide#has_many-has_one-dependent-option'
   Enabled: true
   VersionAdded: '0.50'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/HelperInstanceVariable:
   Description: 'Do not use instance variables in helpers.'
   Enabled: true
   VersionAdded: '2.0'
   Include:
-    - app/helpers/**/*.rb
+    - '**/app/helpers/**/*.rb'
 
 Rails/HttpPositionalArguments:
   Description: 'Use keyword arguments instead of positional arguments in http method calls.'
@@ -606,7 +606,7 @@ Rails/I18nLazyLookup:
     - lazy
     - explicit
   Include:
-    - 'app/controllers/**/*.rb'
+    - '**/app/controllers/**/*.rb'
 
 Rails/I18nLocaleAssignment:
   Description: 'Prefer the usage of `I18n.with_locale` instead of manually updating `I18n.locale` value.'
@@ -635,8 +635,8 @@ Rails/IgnoredSkipActionFilterOption:
   Enabled: true
   VersionAdded: '0.63'
   Include:
-    - app/controllers/**/*.rb
-    - app/mailers/**/*.rb
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
 
 Rails/IndexBy:
   Description: 'Prefer `index_by` over `each_with_object`, `to_h`, or `map`.'
@@ -665,7 +665,7 @@ Rails/InverseOf:
   VersionAdded: '0.52'
   IgnoreScopes: false
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/LexicallyScopedActionFilter:
   Description: "Checks that methods specified in the filter's `only` or `except` options are explicitly defined in the class."
@@ -674,8 +674,8 @@ Rails/LexicallyScopedActionFilter:
   Safe: false
   VersionAdded: '0.52'
   Include:
-    - app/controllers/**/*.rb
-    - app/mailers/**/*.rb
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
 
 Rails/LinkToBlank:
   Description: 'Checks that `link_to` with a `target: "_blank"` have a `rel: "noopener"` option passed to them.'
@@ -693,7 +693,7 @@ Rails/MailerName:
   SafeAutoCorrect: false
   VersionAdded: '2.7'
   Include:
-    - app/mailers/**/*.rb
+    - '**/app/mailers/**/*.rb'
 
 Rails/MatchRoute:
   Description: >-
@@ -703,8 +703,8 @@ Rails/MatchRoute:
   Enabled: 'pending'
   VersionAdded: '2.7'
   Include:
-    - config/routes.rb
-    - config/routes/**/*.rb
+    - '**/config/routes.rb'
+    - '**/config/routes/**/*.rb'
 
 Rails/MigrationClassName:
   Description: 'The class name of the migration should match its file name.'
@@ -720,8 +720,8 @@ Rails/MultipleRoutePaths:
   Severity: warning
   VersionAdded: '2.29'
   Include:
-    - config/routes.rb
-    - config/routes/**/*.rb
+    - '**/config/routes.rb'
+    - '**/config/routes/**/*.rb'
 
 Rails/NegateInclude:
   Description: 'Prefer `collection.exclude?(obj)` over `!collection.include?(obj)`.'
@@ -757,10 +757,10 @@ Rails/Output:
   VersionAdded: '0.15'
   VersionChanged: '0.19'
   Include:
-    - app/**/*.rb
-    - config/**/*.rb
+    - '**/app/**/*.rb'
+    - '**/config/**/*.rb'
     - db/**/*.rb
-    - lib/**/*.rb
+    - '**/lib/**/*.rb'
 
 Rails/OutputSafety:
   Description: 'The use of `html_safe` or `raw` may be a security risk.'
@@ -832,7 +832,7 @@ Rails/RakeEnvironment:
     - '**/Rakefile'
     - '**/*.rake'
   Exclude:
-    - 'lib/capistrano/tasks/**/*.rake'
+    - '**/lib/capistrano/tasks/**/*.rake'
 
 Rails/ReadWriteAttribute:
   Description: >-
@@ -843,7 +843,7 @@ Rails/ReadWriteAttribute:
   VersionAdded: '0.20'
   VersionChanged: '0.29'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/RedundantActiveRecordAllMethod:
   Description: Detect redundant `all` used as a receiver for Active Record query methods.
@@ -862,7 +862,7 @@ Rails/RedundantAllowNil:
   Enabled: true
   VersionAdded: '0.67'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/RedundantForeignKey:
   Description: 'Checks for associations where the `:foreign_key` option is redundant.'
@@ -1033,7 +1033,7 @@ Rails/ScopeArgs:
   VersionAdded: '0.19'
   VersionChanged: '2.12'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/SelectMap:
   Description: 'Checks for uses of `select(:column_name)` with `map(&:column_name)`.'
@@ -1102,7 +1102,7 @@ Rails/StrongParametersExpect:
   Reference: 'https://api.rubyonrails.org/classes/ActionController/Parameters.html#method-i-expect'
   Enabled: pending
   Include:
-    - app/controllers/**/*.rb
+    - '**/app/controllers/**/*.rb'
   SafeAutoCorrect: false
   VersionAdded: '2.29'
 
@@ -1113,7 +1113,7 @@ Rails/TableNameAssignment:
   Enabled: false
   VersionAdded: '2.14'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/ThreeStateBooleanColumn:
   Description: 'Add a default value and a `NOT NULL` constraint to boolean columns.'
@@ -1197,7 +1197,7 @@ Rails/UniqueValidationWithoutIndex:
   Enabled: true
   VersionAdded: '2.5'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/UnknownEnv:
   Description: 'Use correct environment name.'
@@ -1216,7 +1216,7 @@ Rails/UnusedIgnoredColumns:
   VersionAdded: '2.11'
   VersionChanged: '2.25'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/UnusedRenderContent:
   Description: 'Do not specify body content for a response with a non-content status code.'
@@ -1230,7 +1230,7 @@ Rails/Validation:
   VersionAdded: '0.9'
   VersionChanged: '0.41'
   Include:
-    - app/models/**/*.rb
+    - '**/app/models/**/*.rb'
 
 Rails/WhereEquals:
   Description: 'Pass conditions to `where` and `where.not` as a hash instead of manually constructing SQL.'

spec/project_spec.rb

@@ -151,6 +151,26 @@
         previous_key = key
       end
     end
+
+    it 'has clusivity patterns compatible with engines and packwerk', :aggregate_failures do
+      %w[Include Exclude].each do |clusivity_key|
+        cop_names.each do |name|
+          next if config[name][clusivity_key].nil?
+
+          config[name][clusivity_key].each do |clusivity_pattern|
+            expect(clusivity_pattern).to match(%r{\*\*/app/}), <<~ERROR if clusivity_pattern.match?(%r{\bapp/})
+              Invalid pattern for #{name} #{clusivity_key}: #{clusivity_pattern}
+            ERROR
+            expect(clusivity_pattern).to match(%r{\*\*/config/}), <<~ERROR if clusivity_pattern.match?(%r{\bconfig/})
+              Invalid pattern for #{name} #{clusivity_key}: #{clusivity_pattern}
+            ERROR
+            expect(clusivity_pattern).to match(%r{\*\*/lib/}), <<~ERROR if clusivity_pattern.match?(%r{\blib/})
+              Invalid pattern for #{name} #{clusivity_key}: #{clusivity_pattern}
+            ERROR
+          end
+        end
+      end
+    end
   end
 
   shared_examples 'has Changelog format' do