rubocop-rails 2.12.2 → 2.13.1

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop enforces the use of the `comment` option when adding a new table or column
+      # to the database during a migration.
+      #
+      # @example
+      #   # bad (no comment for a new column or table)
+      #   add_column :table, :column, :integer
+      #
+      #   create_table :table do |t|
+      #     t.type :column
+      #   end
+      #
+      #   # good
+      #   add_column :table, :column, :integer, comment: 'Number of offenses'
+      #
+      #   create_table :table, comment: 'Table of offenses data' do |t|
+      #     t.type :column, comment: 'Number of offenses'
+      #   end
+      #
+      class SchemaComment < Base
+        include ActiveRecordMigrationsHelper
+
+        COLUMN_MSG = 'New database column without `comment`.'
+        TABLE_MSG = 'New database table without `comment`.'
+        RESTRICT_ON_SEND = %i[add_column create_table].freeze
+        CREATE_TABLE_COLUMN_METHODS = Set[
+          *(
+            RAILS_ABSTRACT_SCHEMA_DEFINITIONS |
+            RAILS_ABSTRACT_SCHEMA_DEFINITIONS_HELPERS |
+            POSTGRES_SCHEMA_DEFINITIONS |
+            MYSQL_SCHEMA_DEFINITIONS
+          )
+        ].freeze
+
+        # @!method comment_present?(node)
+        def_node_matcher :comment_present?, <<~PATTERN
+          (hash <(pair {(sym :comment) (str "comment")} (_ [present?])) ...>)
+        PATTERN
+
+        # @!method add_column?(node)
+        def_node_matcher :add_column?, <<~PATTERN
+          (send nil? :add_column _table _column _type _?)
+        PATTERN
+
+        # @!method add_column_with_comment?(node)
+        def_node_matcher :add_column_with_comment?, <<~PATTERN
+          (send nil? :add_column _table _column _type #comment_present?)
+        PATTERN
+
+        # @!method create_table?(node)
+        def_node_matcher :create_table?, <<~PATTERN
+          (send nil? :create_table _table _?)
+        PATTERN
+
+        # @!method create_table?(node)
+        def_node_matcher :create_table_with_comment?, <<~PATTERN
+          (send nil? :create_table _table #comment_present? ...)
+        PATTERN
+
+        # @!method t_column?(node)
+        def_node_matcher :t_column?, <<~PATTERN
+          (send _var CREATE_TABLE_COLUMN_METHODS ...)
+        PATTERN
+
+        # @!method t_column_with_comment?(node)
+        def_node_matcher :t_column_with_comment?, <<~PATTERN
+          (send _var CREATE_TABLE_COLUMN_METHODS _column _type? #comment_present?)
+        PATTERN
+
+        def on_send(node)
+          if add_column_without_comment?(node)
+            add_offense(node, message: COLUMN_MSG)
+          elsif create_table?(node)
+            if create_table_without_comment?(node)
+              add_offense(node, message: TABLE_MSG)
+            elsif create_table_column_call_without_comment?(node)
+              add_offense(node.parent.body, message: COLUMN_MSG)
+            end
+          end
+        end
+
+        private
+
+        def add_column_without_comment?(node)
+          add_column?(node) && !add_column_with_comment?(node)
+        end
+
+        def create_table_without_comment?(node)
+          create_table?(node) && !create_table_with_comment?(node)
+        end
+
+        def create_table_column_call_without_comment?(node)
+          create_table_with_block?(node.parent) &&
+            t_column?(node.parent.body) &&
+            !t_column_with_comment?(node.parent.body)
+        end
+      end
+    end
+  end
+end

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

@@ -5,8 +5,10 @@ module RuboCop
     module Rails
       #
       # Checks SQL heredocs to use `.squish`.
-      # Some SQL syntax (e.g. PostgreSQL comments and functions) requires newlines
-      # to be preserved in order to work, thus auto-correction for this cop is not safe.
+      #
+      # @safety
+      #   Some SQL syntax (e.g. PostgreSQL comments and functions) requires newlines
+      #   to be preserved in order to work, thus auto-correction for this cop is not safe.
       #
       # @example
       #   # bad

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

@@ -14,6 +14,9 @@ module RuboCop
       # When EnforcedStyle is 'flexible' then it's also allowed
       # to use `Time#in_time_zone`.
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because it may change handling time.
+      #
       # @example
       #   # bad
       #   Time.now

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

@@ -3,47 +3,46 @@
 module RuboCop
   module Cop
     module Rails
-      # Prefer the use of distinct, before pluck instead of after.
+      # Prefer using `distinct` before `pluck` instead of `uniq` after `pluck`.
       #
-      # The use of distinct before pluck is preferred because it executes within
+      # The use of distinct before pluck is preferred because it executes by
       # the database.
       #
       # This cop has two different enforcement modes. When the EnforcedStyle
-      # is conservative (the default) then only calls to pluck on a constant
-      # (i.e. a model class) before distinct are added as offenses.
+      # is `conservative` (the default), then only calls to `pluck` on a constant
+      # (i.e. a model class) before `uniq` are added as offenses.
       #
-      # When the EnforcedStyle is aggressive then all calls to pluck before
+      # When the EnforcedStyle is `aggressive` then all calls to `pluck` before
       # distinct are added as offenses. This may lead to false positives
-      # as the cop cannot distinguish between calls to pluck on an
+      # as the cop cannot distinguish between calls to `pluck` on an
       # ActiveRecord::Relation vs a call to pluck on an
       # ActiveRecord::Associations::CollectionProxy.
       #
-      # This cop is unsafe because the behavior may change depending on the
-      # database collation.
-      # Autocorrect is disabled by default for this cop since it may generate
-      # false positives.
+      # @safety
+      #   This cop is unsafe for autocorrection because the behavior may change
+      #   depending on the database collation.
       #
       # @example EnforcedStyle: conservative (default)
-      #   # bad
-      #   Model.pluck(:id).uniq
+      #   # bad - redundantly fetches duplicate values
+      #   Album.pluck(:band_name).uniq
       #
       #   # good
-      #   Model.distinct.pluck(:id)
+      #   Album.distinct.pluck(:band_name)
       #
       # @example EnforcedStyle: aggressive
-      #   # bad
-      #   # this will return a Relation that pluck is called on
-      #   Model.where(cond: true).pluck(:id).uniq
+      #   # bad - redundantly fetches duplicate values
+      #   Album.pluck(:band_name).uniq
       #
-      #   # bad
-      #   # an association on an instance will return a CollectionProxy
-      #   instance.assoc.pluck(:id).uniq
+      #   # bad - redundantly fetches duplicate values
+      #   Album.where(year: 1985).pluck(:band_name).uniq
       #
-      #   # bad
-      #   Model.pluck(:id).uniq
+      #   # bad - redundantly fetches duplicate values
+      #   customer.favourites.pluck(:color).uniq
       #
       #   # good
-      #   Model.distinct.pluck(:id)
+      #   Album.distinct.pluck(:band_name)
+      #   Album.distinct.where(year: 1985).pluck(:band_name)
+      #   customer.favourites.distinct.pluck(:color)
       #
       class UniqBeforePluck < Base
         include ConfigurableEnforcedStyle
@@ -51,10 +50,9 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Use `distinct` before `pluck`.'
-        RESTRICT_ON_SEND = %i[uniq distinct pluck].freeze
+        RESTRICT_ON_SEND = %i[uniq].freeze
         NEWLINE = "\n"
-        PATTERN = '[!^block (send (send %<type>s :pluck ...) ' \
-                  '${:uniq :distinct} ...)]'
+        PATTERN = '[!^block (send (send %<type>s :pluck ...) :uniq ...)]'
 
         def_node_matcher :conservative_node_match,
                          format(PATTERN, type: 'const')
@@ -63,13 +61,13 @@ module RuboCop
                          format(PATTERN, type: '_')
 
         def on_send(node)
-          method = if style == :conservative
-                     conservative_node_match(node)
-                   else
-                     aggressive_node_match(node)
-                   end
+          uniq = if style == :conservative
+                   conservative_node_match(node)
+                 else
+                   aggressive_node_match(node)
+                 end
 
-          return unless method
+          return unless uniq
 
           add_offense(node.loc.selector) do |corrector|
             method = node.method_name
@@ -81,10 +79,6 @@ module RuboCop
 
         private
 
-        def style_parameter_name
-          'EnforcedStyle'
-        end
-
         def dot_method_with_whitespace(method, node)
           range_between(dot_method_begin_pos(method, node),
                         node.loc.selector.end_pos)

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

@@ -27,7 +27,7 @@ module RuboCop
       class UniqueValidationWithoutIndex < Base
         include ActiveRecordHelper
 
-        MSG = 'Uniqueness validation should be with a unique index.'
+        MSG = 'Uniqueness validation should have a unique index on the database column.'
         RESTRICT_ON_SEND = %i[validates].freeze
 
         def on_send(node)

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

@@ -61,6 +61,8 @@ module RuboCop
 
         def table(node)
           klass = class_node(node)
+          return unless klass
+
           schema.table_by(name: table_name(klass))
         end
       end

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

@@ -6,6 +6,10 @@ module RuboCop
       # This cop identifies places where manually constructed SQL
       # in `where` can be replaced with `where(attribute: value)`.
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because is may change SQL.
+      #   See: https://github.com/rubocop/rubocop-rails/issues/403
+      #
       # @example
       #   # bad
       #   User.where('name = ?', 'Gabe')

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

@@ -11,16 +11,17 @@ module RuboCop
       # When EnforcedStyle is 'where' then the cop enforces
       # `where(...).exists?` over `exists?(...)`.
       #
-      # This cop is unsafe for auto-correction because the behavior may change on the following case:
+      # @safety
+      #   This cop is unsafe for auto-correction because the behavior may change on the following case:
       #
-      # [source,ruby]
-      # ----
-      # Author.includes(:articles).where(articles: {id: id}).exists?
-      # #=> Perform `eager_load` behavior (`LEFT JOIN` query) and get result.
+      #   [source,ruby]
+      #   ----
+      #   Author.includes(:articles).where(articles: {id: id}).exists?
+      #   #=> Perform `eager_load` behavior (`LEFT JOIN` query) and get result.
       #
-      # Author.includes(:articles).exists?(articles: {id: id})
-      # #=> Perform `preload` behavior and `ActiveRecord::StatementInvalid` error occurs.
-      # ----
+      #   Author.includes(:articles).exists?(articles: {id: id})
+      #   #=> Perform `preload` behavior and `ActiveRecord::StatementInvalid` error occurs.
+      #   ----
       #
       # @example EnforcedStyle: exists (default)
       #   # bad

data/lib/rubocop/cop/rails_cops.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'mixin/active_record_helper'
+require_relative 'mixin/active_record_migrations_helper'
 require_relative 'mixin/enforce_superclass'
 require_relative 'mixin/index_method'
 require_relative 'mixin/target_rails_version'
@@ -22,12 +23,14 @@ require_relative 'rails/attribute_default_block_value'
 require_relative 'rails/belongs_to'
 require_relative 'rails/blank'
 require_relative 'rails/bulk_change_table'
+require_relative 'rails/compact_blank'
 require_relative 'rails/content_tag'
 require_relative 'rails/create_table_with_timestamps'
 require_relative 'rails/date'
 require_relative 'rails/default_scope'
 require_relative 'rails/delegate'
 require_relative 'rails/delegate_allow_blank'
+require_relative 'rails/duration_arithmetic'
 require_relative 'rails/dynamic_find_by'
 require_relative 'rails/eager_evaluation_log_message'
 require_relative 'rails/enum_hash'
@@ -71,6 +74,7 @@ require_relative 'rails/rake_environment'
 require_relative 'rails/read_write_attribute'
 require_relative 'rails/redundant_allow_nil'
 require_relative 'rails/redundant_foreign_key'
+require_relative 'rails/redundant_presence_validation_on_belongs_to'
 require_relative 'rails/redundant_receiver_in_with_options'
 require_relative 'rails/redundant_travel_back'
 require_relative 'rails/reflection_class_name'
@@ -82,9 +86,11 @@ require_relative 'rails/request_referer'
 require_relative 'rails/require_dependency'
 require_relative 'rails/reversible_migration'
 require_relative 'rails/reversible_migration_method_definition'
+require_relative 'rails/root_join_chain'
 require_relative 'rails/safe_navigation'
 require_relative 'rails/safe_navigation_with_blank'
 require_relative 'rails/save_bang'
+require_relative 'rails/schema_comment'
 require_relative 'rails/scope_args'
 require_relative 'rails/short_i18n'
 require_relative 'rails/skips_model_validations'

data/lib/rubocop/rails/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Rails
     # This module holds the RuboCop Rails version information.
     module Version
-      STRING = '2.12.2'
+      STRING = '2.13.1'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.12.2
+  version: 2.13.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-11 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -78,6 +78,7 @@ files:
 - config/obsoletion.yml
 - lib/rubocop-rails.rb
 - lib/rubocop/cop/mixin/active_record_helper.rb
+- lib/rubocop/cop/mixin/active_record_migrations_helper.rb
 - lib/rubocop/cop/mixin/enforce_superclass.rb
 - lib/rubocop/cop/mixin/index_method.rb
 - lib/rubocop/cop/mixin/target_rails_version.rb
@@ -98,12 +99,14 @@ files:
 - lib/rubocop/cop/rails/belongs_to.rb
 - lib/rubocop/cop/rails/blank.rb
 - lib/rubocop/cop/rails/bulk_change_table.rb
+- lib/rubocop/cop/rails/compact_blank.rb
 - lib/rubocop/cop/rails/content_tag.rb
 - lib/rubocop/cop/rails/create_table_with_timestamps.rb
 - lib/rubocop/cop/rails/date.rb
 - lib/rubocop/cop/rails/default_scope.rb
 - lib/rubocop/cop/rails/delegate.rb
 - lib/rubocop/cop/rails/delegate_allow_blank.rb
+- lib/rubocop/cop/rails/duration_arithmetic.rb
 - lib/rubocop/cop/rails/dynamic_find_by.rb
 - lib/rubocop/cop/rails/eager_evaluation_log_message.rb
 - lib/rubocop/cop/rails/enum_hash.rb
@@ -147,6 +150,7 @@ files:
 - lib/rubocop/cop/rails/read_write_attribute.rb
 - lib/rubocop/cop/rails/redundant_allow_nil.rb
 - lib/rubocop/cop/rails/redundant_foreign_key.rb
+- lib/rubocop/cop/rails/redundant_presence_validation_on_belongs_to.rb
 - lib/rubocop/cop/rails/redundant_receiver_in_with_options.rb
 - lib/rubocop/cop/rails/redundant_travel_back.rb
 - lib/rubocop/cop/rails/reflection_class_name.rb
@@ -158,9 +162,11 @@ files:
 - lib/rubocop/cop/rails/require_dependency.rb
 - lib/rubocop/cop/rails/reversible_migration.rb
 - lib/rubocop/cop/rails/reversible_migration_method_definition.rb
+- lib/rubocop/cop/rails/root_join_chain.rb
 - lib/rubocop/cop/rails/safe_navigation.rb
 - lib/rubocop/cop/rails/safe_navigation_with_blank.rb
 - lib/rubocop/cop/rails/save_bang.rb
+- lib/rubocop/cop/rails/schema_comment.rb
 - lib/rubocop/cop/rails/scope_args.rb
 - lib/rubocop/cop/rails/short_i18n.rb
 - lib/rubocop/cop/rails/skips_model_validations.rb
@@ -188,8 +194,9 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-rails/
   changelog_uri: https://github.com/rubocop/rubocop-rails/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop-rails/
-  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.12/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.13/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -205,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.18
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.