Add guidance on making pull requests easier to review

[rails.git] / .rubocop_todo.yml

diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
index 35107e9b9b2ea961b3949d10ec50b4caef6ba16d..5303fb05112f1a7b89389b2d69d8f6f8b6d07562 100644 (file)
--- a/.rubocop_todo.yml
+++ b/.rubocop_todo.yml
@@ -1,131 +1,147 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
 # This configuration was generated by
 # `rubocop --auto-gen-config`

-# on 2018-09-19 14:24:02 +0100 using RuboCop version 0.58.2.
+# on 2022-10-25 17:25:58 UTC using RuboCop version 1.37.1.

 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 

-# Offense count: 32
+# Work around erblint issues.
+# https://github.com/openstreetmap/openstreetmap-website/issues/2472
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rake
+
+# Offense count: 555
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 248
+
+# Offense count: 29

 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
   Exclude:
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
   Exclude:

+    - 'app/controllers/accounts_controller.rb'
+    - 'app/controllers/api/traces_controller.rb'
+    - 'app/controllers/api/user_preferences_controller.rb'

     - 'app/controllers/application_controller.rb'
     - 'app/controllers/geocoder_controller.rb'
     - 'app/controllers/notes_controller.rb'
     - 'app/controllers/traces_controller.rb'
     - 'app/controllers/users_controller.rb'
     - 'app/controllers/application_controller.rb'
     - 'app/controllers/geocoder_controller.rb'
     - 'app/controllers/notes_controller.rb'
     - 'app/controllers/traces_controller.rb'
     - 'app/controllers/users_controller.rb'

-    - 'app/controllers/user_preferences_controller.rb'

     - 'app/helpers/application_helper.rb'
     - 'app/helpers/application_helper.rb'

-    - 'app/helpers/browse_helper.rb'

     - 'app/helpers/browse_tags_helper.rb'
     - 'app/helpers/browse_tags_helper.rb'

+    - 'app/mailers/user_mailer.rb'

     - 'app/models/client_application.rb'
     - 'app/models/client_application.rb'

-    - 'app/mailers/notifier.rb'

     - 'lib/nominatim.rb'
     - 'lib/osm.rb'
     - 'script/deliver-message'
 
     - 'lib/nominatim.rb'
     - 'lib/osm.rb'
     - 'script/deliver-message'
 

-# Offense count: 4
-Lint/HandleExceptions:
-  Exclude:
-    - 'app/controllers/amf_controller.rb'
-    - 'app/controllers/users_controller.rb'
-
-# Offense count: 692
+# Offense count: 676
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.

 Metrics/AbcSize:
 Metrics/AbcSize:

-  Max: 283
+  Max: 189

 
 

-# Offense count: 40
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+# Offense count: 72
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+# AllowedMethods: refine

 Metrics/BlockLength:
 Metrics/BlockLength:

-  Max: 262
+  Max: 71

 
 

-# Offense count: 11
+# Offense count: 15

 # Configuration parameters: CountBlocks.
 Metrics/BlockNesting:
   Max: 5
 
 # Configuration parameters: CountBlocks.
 Metrics/BlockNesting:
   Max: 5
 

-# Offense count: 63
-# Configuration parameters: CountComments.
+# Offense count: 25
+# Configuration parameters: CountComments, CountAsOne.

 Metrics/ClassLength:
 Metrics/ClassLength:

-  Max: 1627
+  Max: 316

 
 

-# Offense count: 72
+# Offense count: 58
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.

 Metrics/CyclomaticComplexity:
 Metrics/CyclomaticComplexity:

-  Max: 23
+  Max: 25

 
 

-# Offense count: 691
-# Configuration parameters: CountComments.
+# Offense count: 751
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.

 Metrics/MethodLength:
   Max: 179
 
 Metrics/MethodLength:
   Max: 179
 

-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 135
-
-# Offense count: 4
-# Configuration parameters: CountKeywordArgs.
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.

 Metrics/ParameterLists:
 Metrics/ParameterLists:

-  Max: 9
+  Max: 6

 
 

-# Offense count: 72
+# Offense count: 57
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.

 Metrics/PerceivedComplexity:
 Metrics/PerceivedComplexity:

-  Max: 23
+  Max: 26

 
 

-# Offense count: 6
-Naming/AccessorMethodName:
-  Exclude:
-    - 'app/controllers/application_controller.rb'
-    - 'app/helpers/title_helper.rb'
-    - 'app/models/old_way.rb'
-    - 'lib/osm.rb'
-    - 'lib/potlatch.rb'
+# Offense count: 559
+Minitest/MultipleAssertions:
+  Max: 52

 
 

-# Offense count: 8
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# Offense count: 1
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.

 # NamePrefix: is_, has_, have_
 # NamePrefix: is_, has_, have_

-# NamePrefixBlacklist: is_, has_, have_
-# NameWhitelist: is_a?
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?

 # MethodDefinitionMacros: define_method, define_singleton_method
 Naming/PredicateName:
   Exclude:
 # MethodDefinitionMacros: define_method, define_singleton_method
 Naming/PredicateName:
   Exclude:

-    - 'spec/**/*'
-    - 'app/models/changeset.rb'
-    - 'app/models/old_node.rb'
-    - 'app/models/old_relation.rb'
-    - 'app/models/old_way.rb'

     - 'app/models/user.rb'
     - 'app/models/user.rb'

-    - 'lib/classic_pagination/pagination.rb'

 
 

-# Offense count: 6
+# Offense count: 5

 # Configuration parameters: Database, Include.
 # SupportedDatabases: mysql, postgresql
 # Include: db/migrate/*.rb
 Rails/BulkChangeTable:
   Exclude:
     - 'db/migrate/20111116184519_update_oauth.rb'
 # Configuration parameters: Database, Include.
 # SupportedDatabases: mysql, postgresql
 # Include: db/migrate/*.rb
 Rails/BulkChangeTable:
   Exclude:
     - 'db/migrate/20111116184519_update_oauth.rb'

-    - 'db/migrate/20120208122334_merge_acl_address_and_mask.rb'

     - 'db/migrate/20120208194454_add_domain_to_acl.rb'
     - 'db/migrate/20120404205604_add_user_and_description_to_redaction.rb'
 
 # Offense count: 2
 # Configuration parameters: Include.
     - 'db/migrate/20120208194454_add_domain_to_acl.rb'
     - 'db/migrate/20120404205604_add_user_and_description_to_redaction.rb'
 
 # Offense count: 2
 # Configuration parameters: Include.

-# Include: app/**/*.rb, config/**/*.rb, lib/**/*.rb
-Rails/Exit:
+# Include: app/models/**/*.rb
+Rails/HasAndBelongsToMany:

   Exclude:
   Exclude:

-    - 'lib/**/*.rake'
-    - 'lib/daemons/gpx_import.rb'
+    - 'app/models/changeset.rb'
+    - 'app/models/user.rb'

 
 

-# Offense count: 2
+# Offense count: 3

 # Configuration parameters: Include.
 # Configuration parameters: Include.

+# Include: app/helpers/**/*.rb
+Rails/HelperInstanceVariable:
+  Exclude:
+    - 'app/helpers/title_helper.rb'
+
+# Offense count: 16
+# Configuration parameters: IgnoreScopes, Include.

 # Include: app/models/**/*.rb
 # Include: app/models/**/*.rb

-Rails/HasAndBelongsToMany:
+Rails/InverseOf:

   Exclude:
     - 'app/models/changeset.rb'
   Exclude:
     - 'app/models/changeset.rb'

+    - 'app/models/diary_entry.rb'
+    - 'app/models/friendship.rb'
+    - 'app/models/issue.rb'
+    - 'app/models/message.rb'
+    - 'app/models/note.rb'

     - 'app/models/user.rb'
 
     - 'app/models/user.rb'
 

+# Offense count: 2
+# Configuration parameters: Include.
+# Include: app/controllers/**/*.rb, app/mailers/**/*.rb
+Rails/LexicallyScopedActionFilter:
+  Exclude:
+    - 'app/controllers/oauth2_applications_controller.rb'
+    - 'app/controllers/oauth2_authorizations_controller.rb'
+

 # Offense count: 5
 # Configuration parameters: Include.
 # Include: db/migrate/*.rb
 # Offense count: 5
 # Configuration parameters: Include.
 # Include: db/migrate/*.rb


@@ -137,57 +153,33 @@ Rails/NotNullColumn:
     - 'db/migrate/025_add_end_time_to_changesets.rb'
     - 'db/migrate/20120404205604_add_user_and_description_to_redaction.rb'
 
     - 'db/migrate/025_add_end_time_to_changesets.rb'
     - 'db/migrate/20120404205604_add_user_and_description_to_redaction.rb'
 

-# Offense count: 20
+# Offense count: 9

 Rails/OutputSafety:
   Exclude:
 Rails/OutputSafety:
   Exclude:

+    - 'app/controllers/sessions_controller.rb'

     - 'app/controllers/users_controller.rb'
     - 'app/helpers/application_helper.rb'
     - 'app/controllers/users_controller.rb'
     - 'app/helpers/application_helper.rb'

-    - 'app/helpers/changesets_helper.rb'
-    - 'app/helpers/geocoder_helper.rb'
-    - 'app/helpers/note_helper.rb'
-    - 'app/helpers/open_graph_helper.rb'
-    - 'app/helpers/user_blocks_helper.rb'
-    - 'app/helpers/user_roles_helper.rb'

     - 'lib/rich_text.rb'
     - 'test/helpers/application_helper_test.rb'
 
     - 'lib/rich_text.rb'
     - 'test/helpers/application_helper_test.rb'
 

-# Offense count: 86
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: strict, flexible
-Rails/TimeZone:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: AllowedChars.
-Style/AsciiComments:
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+Rake/Desc:

   Exclude:
   Exclude:

-    - 'test/models/message_test.rb'
+    - 'lib/tasks/auto_annotate_models.rake'
+    - 'lib/tasks/eslint.rake'
+    - 'lib/tasks/subscribe_diary_authors.rake'
+    - 'lib/tasks/subscribe_old_changesets.rake'

 
 

-# Offense count: 230
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 462
-# Cop supports --auto-correct.
+# Offense count: 625
+# This cop supports unsafe autocorrection (--autocorrect-all).

 # Configuration parameters: EnforcedStyle.
 # Configuration parameters: EnforcedStyle.

-# SupportedStyles: when_needed, always, never
+# SupportedStyles: always, always_true, never

 Style/FrozenStringLiteralComment:
   Enabled: false
 
 Style/FrozenStringLiteralComment:
   Enabled: false
 

-# Offense count: 2
-# Cop supports --auto-correct.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'app/controllers/ways_controller.rb'
-
-# Offense count: 70
-# Cop supports --auto-correct.
-# Configuration parameters: Strict.
+# Offense count: 72
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Strict, AllowedNumbers, AllowedPatterns.

 Style/NumericLiterals:
 Style/NumericLiterals:

-  MinDigits: 11
-
-# Offense count: 3080
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 1073
+  MinDigits: 15