rubocop-rails 2.5.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd5bcec81363b7952d67bc476f82e25fbe0e0a8e4eb62e490712ddb5cfb58807
-  data.tar.gz: 0eeec3b789aed712f41d0f842620ec0fd871dc884fe791819256b5777a0edb9d
+  metadata.gz: 8cffb4c138d270540b5821e23b2c5450a1939d4b01a2720ce400a8bb510ff90c
+  data.tar.gz: e0702c6ae4a7a43a01034b32d64ad67bac55659d6a5ec471685bda3c6d2a43fe
 SHA512:
-  metadata.gz: 4fb1e35ca0fab64ed16959e29d2144b5cb9aafaf5064d04c67f1bee3cba9eaa4cc2c7c87b71dc240d10c1d11a8361ccacb3cb7002b9e14ef0a3908bfe271f79d
-  data.tar.gz: 108de4501d9f50c50d7d3e23c93574a1a2eee389d5abef80b7e9982d3d7dba524dc263cf76986ae3caa1ab202fc4c7b20ce8106ac82dab5c43e7a578f4fe04ef
+  metadata.gz: 0ce7f6953d24239b8ce71a2e759da5007eb94a752f34ccb8d738273f5f75c63f57664042964f9766652c16e076996bb294edafc7d687a923c60ae2f56328afd3
+  data.tar.gz: b810b20d35548b34813946fff138c204fe0ce4f64a68b2f09e63a69c102ad44cf476a543b8bcf87f9caf42d5312ec277e14d23650100df21fb27fb14cc246216

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
@@ -57,22 +65,30 @@ Rails/ActiveSupportAliases:
 Rails/ApplicationController:
   Description: 'Check that controllers subclass ApplicationController.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '2.4'
+  VersionChanged: '2.5'
 
 Rails/ApplicationJob:
   Description: 'Check that jobs subclass ApplicationJob.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.49'
+  VersionChanged: '2.5'
 
 Rails/ApplicationMailer:
   Description: 'Check that mailers subclass ApplicationMailer.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '2.4'
+  VersionChanged: '2.5'
 
 Rails/ApplicationRecord:
   Description: 'Check that models subclass ApplicationRecord.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.49'
+  VersionChanged: '2.5'
 
 Rails/AssertNot:
   Description: 'Use `assert_not` instead of `assert !`.'
@@ -84,7 +100,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'
 
@@ -111,6 +127,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
@@ -137,6 +161,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
@@ -157,8 +187,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.'
@@ -176,7 +212,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'
 
@@ -212,6 +248,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'
@@ -237,7 +281,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:
@@ -278,6 +322,12 @@ Rails/IndexWith:
   Enabled: true
   VersionAdded: '2.5'
 
+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.'
   Enabled: true
@@ -303,8 +353,33 @@ 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'
+  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:
@@ -326,6 +401,32 @@ 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'
+
 Rails/PluralizationGrammar:
   Description: 'Checks for incorrect grammar when using methods like `3.day.ago`.'
   Enabled: true
@@ -353,6 +454,7 @@ Rails/RakeEnvironment:
   Enabled: true
   Safe: false
   VersionAdded: '2.4'
+  VersionChanged: '2.6'
   Include:
     - '**/Rakefile'
     - '**/*.rake'
@@ -379,6 +481,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
@@ -407,6 +514,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
@@ -426,7 +547,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!`.
@@ -464,6 +585,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.
@@ -471,20 +602,27 @@ 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/TimeZone:
   Description: 'Checks the correct usage of time zone aware methods.'
@@ -505,7 +643,7 @@ Rails/UniqBeforePluck:
   Description: 'Prefer the use of uniq or distinct before pluck.'
   Enabled: true
   VersionAdded: '0.40'
-  VersionChanged: '0.47'
+  VersionChanged: '2.6'
   EnforcedStyle: conservative
   SupportedStyles:
     - conservative
@@ -535,3 +673,12 @@ Rails/Validation:
   VersionChanged: '0.41'
   Include:
     - app/models/**/*.rb
+
+Rails/WhereExists:
+  Description: 'Prefer `exists?(...)` over `where(...).exists?`.'
+  Enabled: 'pending'
+  VersionAdded: '2.7'
+
+# 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

@@ -112,7 +112,14 @@ module RuboCop
         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
 

data/lib/rubocop/cop/rails/active_record_callbacks_order.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks that Active Record callbacks are declared
+      # in the order in which they will be executed.
+      #
+      # @example
+      #   # bad
+      #   class Person < ApplicationRecord
+      #     after_commit :after_commit_callback
+      #     before_validation :before_validation_callback
+      #   end
+      #
+      #   # good
+      #   class Person < ApplicationRecord
+      #     before_validation :before_validation_callback
+      #     after_commit :after_commit_callback
+      #   end
+      #
+      class ActiveRecordCallbacksOrder < Cop
+        MSG = '`%<current>s` is supposed to appear before `%<previous>s`.'
+
+        CALLBACKS_IN_ORDER = %i[
+          after_initialize
+          before_validation
+          after_validation
+          before_save
+          around_save
+          before_create
+          around_create
+          after_create
+          before_update
+          around_update
+          after_update
+          before_destroy
+          around_destroy
+          after_destroy
+          after_save
+          after_commit
+          after_rollback
+          after_find
+          after_touch
+        ].freeze
+
+        CALLBACKS_ORDER_MAP = Hash[
+          CALLBACKS_IN_ORDER.map.with_index { |name, index| [name, index] }
+        ].freeze
+
+        def on_class(class_node)
+          previous_index = -1
+          previous_callback = nil
+
+          defined_callbacks(class_node).each do |node|
+            callback = node.method_name
+            index = CALLBACKS_ORDER_MAP[callback]
+
+            if index < previous_index
+              message = format(MSG, current: callback,
+                                    previous: previous_callback)
+              add_offense(node, message: message)
+            end
+            previous_index = index
+            previous_callback = callback
+          end
+        end
+
+        # Autocorrect by swapping between two nodes autocorrecting them
+        def autocorrect(node)
+          previous = left_siblings_of(node).find do |sibling|
+            callback?(sibling)
+          end
+
+          current_range = source_range_with_comment(node)
+          previous_range = source_range_with_comment(previous)
+
+          lambda do |corrector|
+            corrector.insert_before(previous_range, current_range.source)
+            corrector.remove(current_range)
+          end
+        end
+
+        private
+
+        def defined_callbacks(class_node)
+          class_def = class_node.body
+
+          if class_def
+            class_def.each_child_node.select { |c| callback?(c) }
+          else
+            []
+          end
+        end
+
+        def callback?(node)
+          node.send_type? && CALLBACKS_ORDER_MAP.key?(node.method_name)
+        end
+
+        def left_siblings_of(node)
+          siblings_of(node)[0, node.sibling_index]
+        end
+
+        def siblings_of(node)
+          node.parent.children
+        end
+
+        def source_range_with_comment(node)
+          begin_pos = begin_pos_with_comment(node)
+          end_pos = end_position_for(node)
+
+          Parser::Source::Range.new(buffer, begin_pos, end_pos)
+        end
+
+        def end_position_for(node)
+          end_line = buffer.line_for_position(node.loc.expression.end_pos)
+          buffer.line_range(end_line).end_pos
+        end
+
+        def begin_pos_with_comment(node)
+          annotation_line = node.first_line - 1
+          first_comment = nil
+
+          processed_source.comments_before_line(annotation_line)
+                          .reverse_each do |comment|
+            if comment.location.line == annotation_line
+              first_comment = comment
+              annotation_line -= 1
+            end
+          end
+
+          start_line_position(first_comment || node)
+        end
+
+        def start_line_position(node)
+          buffer.line_range(node.loc.line).begin_pos - 1
+        end
+
+        def buffer
+          processed_source.buffer
+        end
+      end
+    end
+  end
+end