rubocop-rails 2.4.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9d8cbc9fa9fc0752a334a92dd7af50f2a33331ac1b9604dc7c1f27efbc141e6
-  data.tar.gz: 81833c9b0dbc71254f75f18eb59a13147025efdff95342c3ba1855e773301fc2
+  metadata.gz: b6b55ee8df864d6eaee4a491f4324343ee2274eafcb352952a81ff045832aa22
+  data.tar.gz: 344ea324a589dc25ce3e87366c4af33bde4e392acf6acaccf9b9296066680824
 SHA512:
-  metadata.gz: a5ffc7a5e763076a13e5addebf2b4321ebfddbbb19e752bfe9697003eb4451e5d5eebc4ced8c2f3f55e1e10f24a81670e14b7ec48ee748d1c15996085618b5c8
-  data.tar.gz: 0e8b3557bfa819b2fb1304f992a48845afbb52db0c8c7beb970bbcc09c4345c5f9d2f9f273efb2692374f3a03c28c6d615824af20ca669c40359299dca53f41a
+  metadata.gz: 5bdccc2a5e2a45533cb5bb33b2df26872f806dd590c13d640d7449315e56ec6250aebdb876fb37812bb3dd47cdaeda61c6049bc5cf98b01b473a616e9061491b
+  data.tar.gz: 6f8673f2e8d0068bcdbe1599936793461bab38f4b333a4ac6e22e03e7162851d6fc20543ec58e3f2fabdf404764b09f8ff47e6a5c23d492f0c8bb28acd012296

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

@@ -18,7 +18,7 @@ gem install rubocop-rails
 or if you use bundler put this in your `Gemfile`
 
 ```ruby
-gem 'rubocop-rails'
+gem 'rubocop-rails', require: false
 ```
 
 ## Usage
@@ -76,11 +76,15 @@ Rails/FindBy:
     - lib/example.rb
 ```
 
+## Documentation
+
+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

@@ -1,5 +1,9 @@
 # Common configuration.
 
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
   Exclude:
     - bin/*
@@ -53,22 +57,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 !`.'
@@ -80,7 +92,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'
 
@@ -107,6 +119,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
@@ -153,8 +173,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.'
@@ -172,7 +198,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'
 
@@ -233,7 +259,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:
@@ -264,6 +290,16 @@ Rails/IgnoredSkipActionFilterOption:
   Include:
     - app/controllers/**/*.rb
 
+Rails/IndexBy:
+  Description: 'Prefer `index_by` over `each_with_object` or `map`.'
+  Enabled: true
+  VersionAdded: '2.5'
+
+Rails/IndexWith:
+  Description: 'Prefer `index_with` over `each_with_object` or `map`.'
+  Enabled: true
+  VersionAdded: '2.5'
+
 Rails/InverseOf:
   Description: 'Checks for associations where the inverse cannot be determined automatically.'
   Enabled: true
@@ -290,7 +326,7 @@ Rails/LinkToBlank:
   VersionAdded: '0.62'
 
 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:
@@ -312,6 +348,12 @@ Rails/OutputSafety:
   Enabled: true
   VersionAdded: '0.41'
 
+Rails/Pick:
+  Description: 'Prefer `pick` over `pluck(...).first`.'
+  Enabled: true
+  Safe: false
+  VersionAdded: '2.6'
+
 Rails/PluralizationGrammar:
   Description: 'Checks for incorrect grammar when using methods like `3.day.ago`.'
   Enabled: true
@@ -339,9 +381,12 @@ Rails/RakeEnvironment:
   Enabled: true
   Safe: false
   VersionAdded: '2.4'
+  VersionChanged: '2.6'
   Include:
     - '**/Rakefile'
     - '**/*.rake'
+  Exclude:
+    - 'lib/capistrano/tasks/**/*.rake'
 
 Rails/ReadWriteAttribute:
   Description: >-
@@ -363,6 +408,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
@@ -377,6 +427,10 @@ Rails/RefuteMethods:
   Description: 'Use `assert_not` methods instead of `refute` methods.'
   Enabled: true
   VersionAdded: '0.56'
+  EnforcedStyle: assert_not
+  SupportedStyles:
+    - assert_not
+    - refute
   Include:
     - '**/test/**/*'
 
@@ -406,7 +460,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!`.
@@ -485,13 +539,20 @@ 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
     - aggressive
   AutoCorrect: false
 
+Rails/UniqueValidationWithoutIndex:
+  Description: 'Uniqueness validation should be with a unique index.'
+  Enabled: true
+  VersionAdded: '2.5'
+  Include:
+    - app/models/**/*.rb
+
 Rails/UnknownEnv:
   Description: 'Use correct environment name.'
   Enabled: true
@@ -508,3 +569,7 @@ Rails/Validation:
   VersionChanged: '0.41'
   Include:
     - app/models/**/*.rb
+
+# Accept `redirect_to(...) and return` and similar cases.
+Style/AndOr:
+  EnforcedStyle: conditionals

data/lib/rubocop-rails.rb

@@ -2,10 +2,13 @@
 
 require 'rubocop'
 require 'rack/utils'
+require 'active_support/inflector'
 
 require_relative 'rubocop/rails'
 require_relative 'rubocop/rails/version'
 require_relative 'rubocop/rails/inject'
+require_relative 'rubocop/rails/schema_loader'
+require_relative 'rubocop/rails/schema_loader/schema'
 
 RuboCop::Rails::Inject.defaults!
 

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # A mixin to extend cops for Active Record features
+    module ActiveRecordHelper
+      extend NodePattern::Macros
+
+      def_node_search :find_set_table_name, <<~PATTERN
+        (send self :table_name= {str sym})
+      PATTERN
+
+      def_node_search :find_belongs_to, <<~PATTERN
+        (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
+
+        namespaces = class_node.each_ancestor(:class, :module)
+        [class_node, *namespaces]
+          .reverse
+          .map { |klass| klass.identifier.children[1] }.join('_')
+          .tableize
+      end
+
+      # Resolve relation into column name.
+      # It just returns column_name if the column exists.
+      # Or it tries to resolve column_name as a relation.
+      # It returns `nil` if it can't resolve.
+      #
+      # @param name [String]
+      # @param class_node [RuboCop::AST::Node]
+      # @param table [RuboCop::Rails::SchemaLoader::Table]
+      # @return [String, nil]
+      def resolve_relation_into_column(name:, class_node:, table:)
+        return name if table.with_column?(name: name)
+
+        find_belongs_to(class_node) do |belongs_to|
+          next unless belongs_to.first_argument.value.to_s == name
+
+          fk = foreign_key_of(belongs_to) || "#{name}_id"
+          return fk if table.with_column?(name: fk)
+        end
+        nil
+      end
+
+      def foreign_key_of(belongs_to)
+        options = belongs_to.last_argument
+        return unless options.hash_type?
+
+        options.each_pair.find do |pair|
+          next unless pair.key.sym_type? && pair.key.value == :foreign_key
+          next unless pair.value.sym_type? || pair.value.str_type?
+
+          break pair.value.value.to_s
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Common functionality for Rails/IndexBy and Rails/IndexWith
+    module IndexMethod # rubocop:disable Metrics/ModuleLength
+      def on_block(node)
+        on_bad_each_with_object(node) do |*match|
+          handle_possible_offense(node, match, 'each_with_object')
+        end
+      end
+
+      def on_send(node)
+        on_bad_map_to_h(node) do |*match|
+          handle_possible_offense(node, match, 'map { ... }.to_h')
+        end
+
+        on_bad_hash_brackets_map(node) do |*match|
+          handle_possible_offense(node, match, 'Hash[map { ... }]')
+        end
+      end
+
+      def on_csend(node)
+        on_bad_map_to_h(node) do |*match|
+          handle_possible_offense(node, match, 'map { ... }.to_h')
+        end
+      end
+
+      def autocorrect(node)
+        lambda do |corrector|
+          correction = prepare_correction(node)
+          execute_correction(corrector, node, correction)
+        end
+      end
+
+      private
+
+      # @abstract Implemented with `def_node_matcher`
+      def on_bad_each_with_object(_node)
+        raise NotImplementedError
+      end
+
+      # @abstract Implemented with `def_node_matcher`
+      def on_bad_map_to_h(_node)
+        raise NotImplementedError
+      end
+
+      # @abstract Implemented with `def_node_matcher`
+      def on_bad_hash_brackets_map(_node)
+        raise NotImplementedError
+      end
+
+      def handle_possible_offense(node, match, match_desc)
+        captures = extract_captures(match)
+
+        return if captures.noop_transformation?
+
+        add_offense(
+          node,
+          message: "Prefer `#{new_method_name}` over `#{match_desc}`."
+        )
+      end
+
+      def extract_captures(match)
+        argname, body_expr = *match
+        Captures.new(argname, body_expr)
+      end
+
+      def new_method_name
+        raise NotImplementedError
+      end
+
+      def prepare_correction(node)
+        if (match = on_bad_each_with_object(node))
+          Autocorrection.from_each_with_object(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))
+          Autocorrection.from_hash_brackets_map(node, match)
+        else
+          raise 'unreachable'
+        end
+      end
+
+      def execute_correction(corrector, node, correction)
+        correction.strip_prefix_and_suffix(node, corrector)
+        correction.set_new_method_name(new_method_name, corrector)
+
+        captures = extract_captures(correction.match)
+        correction.set_new_arg_name(captures.transformed_argname, corrector)
+        correction.set_new_body_expression(
+          captures.transforming_body_expr,
+          corrector
+        )
+      end
+
+      # Internal helper class to hold match data
+      Captures = Struct.new(
+        :transformed_argname,
+        :transforming_body_expr
+      ) do
+        def noop_transformation?
+          transforming_body_expr.lvar_type? &&
+            transforming_body_expr.children == [transformed_argname]
+        end
+      end
+
+      # Internal helper class to hold autocorrect data
+      Autocorrection = Struct.new(:match, :block_node, :leading, :trailing) do # rubocop:disable Metrics/BlockLength
+        def self.from_each_with_object(node, match)
+          new(match, node, 0, 0)
+        end
+
+        def self.from_map_to_h(node, match)
+          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
+
+        def self.from_hash_brackets_map(node, match)
+          new(match, node.children.last, 'Hash['.length, ']'.length)
+        end
+
+        def strip_prefix_and_suffix(node, corrector)
+          expression = node.loc.expression
+          corrector.remove_leading(expression, leading)
+          corrector.remove_trailing(expression, trailing)
+        end
+
+        def set_new_method_name(new_method_name, corrector)
+          range = block_node.send_node.loc.selector
+          if (send_end = block_node.send_node.loc.end)
+            # If there are arguments (only true in the `each_with_object` case)
+            range = range.begin.join(send_end)
+          end
+          corrector.replace(range, new_method_name)
+        end
+
+        def set_new_arg_name(transformed_argname, corrector)
+          corrector.replace(
+            block_node.arguments.loc.expression,
+            "|#{transformed_argname}|"
+          )
+        end
+
+        def set_new_body_expression(transforming_body_expr, corrector)
+          corrector.replace(
+            block_node.body.loc.expression,
+            transforming_body_expr.loc.expression.source
+          )
+        end
+      end
+    end
+  end
+end