rubocop-rails 2.5.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad01eddf8f7245cdbba5eef8c2c7f73656707bde4dd3e1dc08e6604284e2c5b
-  data.tar.gz: b4542ee0b28af39310b2fbf6e5b7e276249144050edf90208036b8b9dafe64da
+  metadata.gz: 6e89f00783e4dce6642e43ba4a4bf8ee29d078131f71404230db8fd2a1f87248
+  data.tar.gz: bfbca38eb400e89e260b572babc327afec01b25bad89178179e8276ef7ce651c
 SHA512:
-  metadata.gz: d3c643803fcbeb378b60bf8c811bda542445d03ded462975d2c89f3a49e3f36b0c4f46468adbbbc768923a4f01545e5b03159ee2a675687bd49906b81dd28912
-  data.tar.gz: a471837a24adbb346243c23a2e88d0daceb2214632e7b92fc075b4936897fec91b06cb56d6131e65ea9716a643f3a635317357053364f29f6a7663ccefd62f32
+  metadata.gz: 241d43809d5cbfa4684fa83c1b92c9069447bae05ca0235d137e6934a2a9ad35ff3e00fba46928e793045ee1cf35dc3a520cca9f177e8c3280530282eb52ac06
+  data.tar.gz: 7019b400331651ad86a94e9562f93e31c32025ae5ed9c8c5da0f62c65974b21052438908a535da9314a6b903ea3ff6815dc7a0a6350ce3db9d6ab1d0ac18d015

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-18 Bozhidar Batsov
+Copyright (c) 2012-20 Bozhidar Batsov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -78,13 +78,13 @@ Rails/FindBy:
 
 ## Documentation
 
-You can read a lot more about RuboCop Rails in its [official docs](https://docs.rubocop.org/projects/rails/).
+You can read a lot more about RuboCop Rails in its [official docs](https://docs.rubocop.org/rubocop-rails/).
 
 ## Compatibility
 
 Rails cops support the following versions:
 
-- Rails 4.0+
+- Rails 4.2+
 
 ## Contributing
 

data/config/default.yml

@@ -37,6 +37,14 @@ Rails/ActiveRecordAliases:
   VersionAdded: '0.53'
   SafeAutoCorrect: false
 
+Rails/ActiveRecordCallbacksOrder:
+  Description: 'Order callback declarations in the order in which they will be executed.'
+  StyleGuide: 'https://rails.rubystyle.guide/#callbacks-order'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
+  Include:
+    - app/models/**/*.rb
+
 Rails/ActiveRecordOverride:
   Description: >-
                   Check for overriding Active Record methods instead of using
@@ -54,6 +62,14 @@ Rails/ActiveSupportAliases:
   Enabled: true
   VersionAdded: '0.48'
 
+Rails/AfterCommitOverride:
+  Description: >-
+                  This cop enforces that there is only one call to `after_commit`
+                  (and its aliases - `after_create_commit`, `after_update_commit`,
+                  and `after_destroy_commit`) with the same callback name per model.
+  Enabled: 'pending'
+  VersionAdded: '2.8'
+
 Rails/ApplicationController:
   Description: 'Check that controllers subclass ApplicationController.'
   Enabled: true
@@ -92,7 +108,7 @@ Rails/AssertNot:
 Rails/BelongsTo:
   Description: >-
                   Use `optional: true` instead of `required: false` for
-                  `belongs_to` relations'
+                  `belongs_to` relations.
   Enabled: true
   VersionAdded: '0.62'
 
@@ -119,6 +135,14 @@ Rails/BulkChangeTable:
   Include:
     - db/migrate/*.rb
 
+Rails/ContentTag:
+  Description: 'Use `tag` instead of `content_tag`.'
+  Reference:
+    - 'https://github.com/rails/rails/issues/25195'
+    - 'https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-content_tag'
+  Enabled: true
+  VersionAdded: '2.6'
+
 Rails/CreateTableWithTimestamps:
   Description: >-
                   Checks the migration for which timestamps are not included
@@ -145,6 +169,12 @@ Rails/Date:
     - strict
     - flexible
 
+Rails/DefaultScope:
+  Description: 'Avoid use of `default_scope`.'
+  StyleGuide: 'https://rails.rubystyle.guide#avoid-default-scope'
+  Enabled: false
+  VersionAdded: '2.7'
+
 Rails/Delegate:
   Description: 'Prefer delegate method for delegations.'
   Enabled: true
@@ -165,8 +195,14 @@ Rails/DynamicFindBy:
   StyleGuide: 'https://rails.rubystyle.guide#find_by'
   Enabled: true
   VersionAdded: '0.44'
+  VersionChanged: '2.6'
+  # The `Whitelist` has been deprecated, Please use `AllowedMethods` instead.
   Whitelist:
     - find_by_sql
+  AllowedMethods:
+    - find_by_sql
+  AllowedReceivers:
+    - Gem::Specification
 
 Rails/EnumHash:
   Description: 'Prefer hash syntax over array syntax when defining enums.'
@@ -184,7 +220,7 @@ Rails/EnumUniqueness:
     - app/models/**/*.rb
 
 Rails/EnvironmentComparison:
-  Description: "Favor `Rails.env.production?` over `Rails.env == 'production'`"
+  Description: "Favor `Rails.env.production?` over `Rails.env == 'production'`."
   Enabled: true
   VersionAdded: '0.52'
 
@@ -220,6 +256,14 @@ Rails/FindBy:
   Include:
     - app/models/**/*.rb
 
+Rails/FindById:
+  Description: >-
+                Favor the use of `find` over `where.take!`, `find_by!`, and `find_by_id!` when you
+                need to retrieve a single record by primary key when you expect it to be found.
+  StyleGuide: 'https://rails.rubystyle.guide/#find'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
+
 Rails/FindEach:
   Description: 'Prefer all.find_each over all.find.'
   StyleGuide: 'https://rails.rubystyle.guide#find-each'
@@ -245,7 +289,7 @@ Rails/HasManyOrHasOneDependent:
     - app/models/**/*.rb
 
 Rails/HelperInstanceVariable:
-  Description: 'Do not use instance variables in helpers'
+  Description: 'Do not use instance variables in helpers.'
   Enabled: true
   VersionAdded: '2.0'
   Include:
@@ -277,14 +321,22 @@ Rails/IgnoredSkipActionFilterOption:
     - app/controllers/**/*.rb
 
 Rails/IndexBy:
-  Description: 'Prefer `index_by` over `each_with_object` or `map`.'
+  Description: 'Prefer `index_by` over `each_with_object`, `to_h`, or `map`.'
   Enabled: true
   VersionAdded: '2.5'
+  VersionChanged: '2.8'
 
 Rails/IndexWith:
-  Description: 'Prefer `index_with` over `each_with_object` or `map`.'
+  Description: 'Prefer `index_with` over `each_with_object`, `to_h`, or `map`.'
   Enabled: true
   VersionAdded: '2.5'
+  VersionChanged: '2.8'
+
+Rails/Inquiry:
+  Description: "Prefer Ruby's comparison operators over Active Support's `Array#inquiry` and `String#inquiry`."
+  StyleGuide: 'https://rails.rubystyle.guide/#inquiry'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
 
 Rails/InverseOf:
   Description: 'Checks for associations where the inverse cannot be determined automatically.'
@@ -311,13 +363,47 @@ Rails/LinkToBlank:
   Enabled: true
   VersionAdded: '0.62'
 
+Rails/MailerName:
+  Description: 'Mailer should end with `Mailer` suffix.'
+  StyleGuide: 'https://rails.rubystyle.guide/#mailer-name'
+  Enabled: 'pending'
+  SafeAutoCorrect: false
+  VersionAdded: '2.7'
+  Include:
+    - app/mailers/**/*.rb
+
+Rails/MatchRoute:
+  Description: >-
+                  Don't use `match` to define any routes unless there is a need to map multiple request types
+                  among [:get, :post, :patch, :put, :delete] to a single action using the `:via` option.
+  StyleGuide: 'https://rails.rubystyle.guide/#no-match-routes'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
+  Include:
+    - config/routes.rb
+    - config/routes/**/*.rb
+
+Rails/NegateInclude:
+  Description: 'Prefer `collection.exclude?(obj)` over `!collection.include?(obj)`.'
+  StyleGuide: 'https://rails.rubystyle.guide#exclude'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
+
 Rails/NotNullColumn:
-  Description: 'Do not add a NOT NULL column without a default value'
+  Description: 'Do not add a NOT NULL column without a default value.'
   Enabled: true
   VersionAdded: '0.43'
   Include:
     - db/migrate/*.rb
 
+Rails/OrderById:
+  Description: >-
+                  Do not use the `id` column for ordering.
+                  Use a timestamp column to order chronologically.
+  StyleGuide: 'https://rails.rubystyle.guide/#order-by-id'
+  Enabled: false
+  VersionAdded: '2.8'
+
 Rails/Output:
   Description: 'Checks for calls to puts, print, etc.'
   Enabled: true
@@ -334,6 +420,37 @@ Rails/OutputSafety:
   Enabled: true
   VersionAdded: '0.41'
 
+Rails/Pick:
+  Description: 'Prefer `pick` over `pluck(...).first`.'
+  StyleGuide: 'https://rails.rubystyle.guide#pick'
+  Enabled: true
+  Safe: false
+  VersionAdded: '2.6'
+
+Rails/Pluck:
+  Description: 'Prefer `pluck` over `map { ... }`.'
+  StyleGuide: 'https://rails.rubystyle.guide#pluck'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
+
+Rails/PluckId:
+  Description: 'Use `ids` instead of `pluck(:id)` or `pluck(primary_key)`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#ids'
+  Enabled: false
+  Safe: false
+  VersionAdded: '2.7'
+
+Rails/PluckInWhere:
+  Description: 'Use `select` instead of `pluck` in `where` query methods.'
+  Enabled: 'pending'
+  Safe: false
+  VersionAdded: '2.7'
+  VersionChanged: '2.8'
+  EnforcedStyle: conservative
+  SupportedStyles:
+    - conservative
+    - aggressive
+
 Rails/PluralizationGrammar:
   Description: 'Checks for incorrect grammar when using methods like `3.day.ago`.'
   Enabled: true
@@ -361,6 +478,7 @@ Rails/RakeEnvironment:
   Enabled: true
   Safe: false
   VersionAdded: '2.4'
+  VersionChanged: '2.6'
   Include:
     - '**/Rakefile'
     - '**/*.rake'
@@ -387,6 +505,11 @@ Rails/RedundantAllowNil:
   Include:
     - app/models/**/*.rb
 
+Rails/RedundantForeignKey:
+  Description: 'Checks for associations where the `:foreign_key` option is redundant.'
+  Enabled: true
+  VersionAdded: '2.6'
+
 Rails/RedundantReceiverInWithOptions:
   Description: 'Checks for redundant receiver in `with_options`.'
   Enabled: true
@@ -415,6 +538,20 @@ Rails/RelativeDateConstant:
   VersionChanged: '0.59'
   AutoCorrect: false
 
+Rails/RenderInline:
+  Description: 'Prefer using a template over inline rendering.'
+  StyleGuide: 'https://rails.rubystyle.guide/#inline-rendering'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
+
+Rails/RenderPlainText:
+  Description: 'Prefer `render plain:` over `render text:`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#plain-text-rendering'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
+  # Convert only when `content_type` is explicitly set to `text/plain`.
+  ContentTypeCompatibility: true
+
 Rails/RequestReferer:
   Description: 'Use consistent syntax for request.referer.'
   Enabled: true
@@ -434,7 +571,7 @@ Rails/ReversibleMigration:
     - db/migrate/*.rb
 
 Rails/SafeNavigation:
-  Description: "Use Ruby's safe navigation operator (`&.`) instead of `try!`"
+  Description: "Use Ruby's safe navigation operator (`&.`) instead of `try!`."
   Enabled: true
   VersionAdded: '0.43'
   # This will convert usages of `try` to use safe navigation as well as `try!`.
@@ -472,6 +609,16 @@ Rails/ScopeArgs:
   Include:
     - app/models/**/*.rb
 
+Rails/ShortI18n:
+  Description: 'Use the short form of the I18n methods: `t` instead of `translate` and `l` instead of `localize`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#short-i18n'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
+  EnforcedStyle: conservative
+  SupportedStyles:
+    - conservative
+    - aggressive
+
 Rails/SkipsModelValidations:
   Description: >-
                  Use methods that skips model validations with caution.
@@ -479,20 +626,33 @@ Rails/SkipsModelValidations:
   Reference: 'https://guides.rubyonrails.org/active_record_validations.html#skipping-validations'
   Enabled: true
   VersionAdded: '0.47'
-  VersionChanged: '0.60'
-  Blacklist:
+  VersionChanged: '2.7'
+  ForbiddenMethods:
     - decrement!
     - decrement_counter
     - increment!
     - increment_counter
+    - insert
+    - insert!
+    - insert_all
+    - insert_all!
     - toggle!
     - touch
+    - touch_all
     - update_all
     - update_attribute
     - update_column
     - update_columns
     - update_counters
-  Whitelist: []
+    - upsert
+    - upsert_all
+  AllowedMethods: []
+
+Rails/SquishedSQLHeredocs:
+  Description: 'Checks SQL heredocs to use `.squish`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#squished-heredocs'
+  Enabled: 'pending'
+  VersionAdded: '2.8'
 
 Rails/TimeZone:
   Description: 'Checks the correct usage of time zone aware methods.'
@@ -513,11 +673,12 @@ Rails/UniqBeforePluck:
   Description: 'Prefer the use of uniq or distinct before pluck.'
   Enabled: true
   VersionAdded: '0.40'
-  VersionChanged: '0.47'
+  VersionChanged: '2.8'
   EnforcedStyle: conservative
   SupportedStyles:
     - conservative
     - aggressive
+  SafeAutoCorrect: false
   AutoCorrect: false
 
 Rails/UniqueValidationWithoutIndex:
@@ -543,3 +704,23 @@ Rails/Validation:
   VersionChanged: '0.41'
   Include:
     - app/models/**/*.rb
+
+Rails/WhereExists:
+  Description: 'Prefer `exists?(...)` over `where(...).exists?`.'
+  Enabled: 'pending'
+  EnforcedStyle: exists
+  SupportedStyles:
+    - exists
+    - where
+  VersionAdded: '2.7'
+  VersionChanged: '2.8'
+
+Rails/WhereNot:
+  Description: 'Use `where.not(...)` instead of manually constructing negated SQL in `where`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#where-not'
+  Enabled: 'pending'
+  VersionAdded: '2.8'
+
+# Accept `redirect_to(...) and return` and similar cases.
+Style/AndOr:
+  EnforcedStyle: conditionals

data/lib/rubocop/cop/mixin/active_record_helper.rb

@@ -6,6 +6,8 @@ module RuboCop
     module ActiveRecordHelper
       extend NodePattern::Macros
 
+      WHERE_METHODS = %i[where rewhere].freeze
+
       def_node_search :find_set_table_name, <<~PATTERN
         (send self :table_name= {str sym})
       PATTERN
@@ -14,6 +16,21 @@ module RuboCop
         (send nil? :belongs_to {str sym} ...)
       PATTERN
 
+      def external_dependency_checksum
+        return @external_dependency_checksum if defined?(@external_dependency_checksum)
+
+        schema_path = RuboCop::Rails::SchemaLoader.db_schema_path
+        return nil if schema_path.nil?
+
+        schema_code = File.read(schema_path)
+
+        @external_dependency_checksum ||= Digest::SHA1.hexdigest(schema_code)
+      end
+
+      def schema
+        RuboCop::Rails::SchemaLoader.load(target_ruby_version)
+      end
+
       def table_name(class_node)
         table_name = find_set_table_name(class_node).to_a.last&.first_argument
         return table_name.value.to_s if table_name
@@ -57,6 +74,11 @@ module RuboCop
           break pair.value.value.to_s
         end
       end
+
+      def in_where?(node)
+        send_node = node.each_ancestor(:send).first
+        send_node && WHERE_METHODS.include?(send_node.method_name)
+      end
     end
   end
 end

data/lib/rubocop/cop/mixin/index_method.rb

@@ -8,6 +8,12 @@ module RuboCop
         on_bad_each_with_object(node) do |*match|
           handle_possible_offense(node, match, 'each_with_object')
         end
+
+        return if target_ruby_version < 2.6
+
+        on_bad_to_h(node) do |*match|
+          handle_possible_offense(node, match, 'to_h { ... }')
+        end
       end
 
       def on_send(node)
@@ -40,6 +46,11 @@ module RuboCop
         raise NotImplementedError
       end
 
+      # @abstract Implemented with `def_node_matcher`
+      def on_bad_to_h(_node)
+        raise NotImplementedError
+      end
+
       # @abstract Implemented with `def_node_matcher`
       def on_bad_map_to_h(_node)
         raise NotImplementedError
@@ -73,6 +84,8 @@ module RuboCop
       def prepare_correction(node)
         if (match = on_bad_each_with_object(node))
           Autocorrection.from_each_with_object(node, match)
+        elsif (match = on_bad_to_h(node))
+          Autocorrection.from_to_h(node, match)
         elsif (match = on_bad_map_to_h(node))
           Autocorrection.from_map_to_h(node, match)
         elsif (match = on_bad_hash_brackets_map(node))
@@ -111,8 +124,19 @@ module RuboCop
           new(match, node, 0, 0)
         end
 
+        def self.from_to_h(node, match)
+          new(match, node, 0, 0)
+        end
+
         def self.from_map_to_h(node, match)
-          strip_trailing_chars = node.parent&.block_type? ? 0 : '.to_h'.length
+          strip_trailing_chars = 0
+
+          unless node.parent&.block_type?
+            map_range = node.children.first.source_range
+            node_range = node.source_range
+            strip_trailing_chars = node_range.end_pos - map_range.end_pos
+          end
+
           new(match, node.children.first, 0, strip_trailing_chars)
         end