rubocop-rails 2.9.0 → 2.11.1

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

@@ -44,9 +44,22 @@ module RuboCop
         RESTRICT_ON_SEND = %i[try try!].freeze
 
         def_node_matcher :try_call, <<~PATTERN
-          (send !nil? ${:try :try!} $_ ...)
+          (send _ ${:try :try!} $_ ...)
         PATTERN
 
+        # Monkey patching for `Style/RedundantSelf` of RuboCop core.
+        # rubocop:disable Style/ClassAndModuleChildren
+        class Style::RedundantSelf
+          def self.autocorrect_incompatible_with
+            [Rails::SafeNavigation]
+          end
+        end
+        # rubocop:enable Style/ClassAndModuleChildren
+
+        def self.autocorrect_incompatible_with
+          [Style::RedundantSelf]
+        end
+
         def on_send(node)
           try_call(node) do |try_method, dispatch|
             return if try_method == :try && !cop_config['ConvertTry']
@@ -64,7 +77,12 @@ module RuboCop
           method_node, *params = *node.arguments
           method = method_node.source[1..-1]
 
-          range = range_between(node.loc.dot.begin_pos, node.loc.expression.end_pos)
+          range = if node.receiver
+                    range_between(node.loc.dot.begin_pos, node.loc.expression.end_pos)
+                  else
+                    corrector.insert_before(node, 'self')
+                    node
+                  end
 
           corrector.replace(range, replacement(method, params))
         end

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

@@ -8,40 +8,33 @@ module RuboCop
       # Built on top of Ruby on Rails style guide (https://rails.rubystyle.guide#time)
       # and the article http://danilenko.org/2012/7/6/rails_timezones/
       #
-      # Two styles are supported for this cop. When EnforcedStyle is 'strict'
-      # then only use of Time.zone is allowed.
+      # Two styles are supported for this cop. When `EnforcedStyle` is 'strict'
+      # then only use of `Time.zone` is allowed.
       #
       # When EnforcedStyle is 'flexible' then it's also allowed
-      # to use Time.in_time_zone.
-      #
-      # @example EnforcedStyle: strict
-      #   # `strict` means that `Time` should be used with `zone`.
+      # to use `Time#in_time_zone`.
       #
+      # @example
       #   # bad
       #   Time.now
-      #   Time.parse('2015-03-02 19:05:37')
-      #
-      #   # bad
-      #   Time.current
-      #   Time.at(timestamp).in_time_zone
+      #   Time.parse('2015-03-02T19:05:37')
       #
       #   # good
+      #   Time.current
       #   Time.zone.now
-      #   Time.zone.parse('2015-03-02 19:05:37')
+      #   Time.zone.parse('2015-03-02T19:05:37')
+      #   Time.zone.parse('2015-03-02T19:05:37Z') # Respect ISO 8601 format with timezone specifier.
       #
-      # @example EnforcedStyle: flexible (default)
-      #   # `flexible` allows usage of `in_time_zone` instead of `zone`.
+      # @example EnforcedStyle: strict
+      #   # `strict` means that `Time` should be used with `zone`.
       #
       #   # bad
-      #   Time.now
-      #   Time.parse('2015-03-02 19:05:37')
+      #   Time.at(timestamp).in_time_zone
       #
-      #   # good
-      #   Time.zone.now
-      #   Time.zone.parse('2015-03-02 19:05:37')
+      # @example EnforcedStyle: flexible (default)
+      #   # `flexible` allows usage of `in_time_zone` instead of `zone`.
       #
       #   # good
-      #   Time.current
       #   Time.at(timestamp).in_time_zone
       class TimeZone < Base
         include ConfigurableEnforcedStyle
@@ -58,11 +51,13 @@ module RuboCop
 
         GOOD_METHODS = %i[zone zone_default find_zone find_zone!].freeze
 
-        DANGEROUS_METHODS = %i[now local new parse at current].freeze
+        DANGEROUS_METHODS = %i[now local new parse at].freeze
 
         ACCEPTED_METHODS = %i[in_time_zone utc getlocal xmlschema iso8601
                               jisx0301 rfc3339 httpdate to_i to_f].freeze
 
+        TIMEZONE_SPECIFIER = /[A-z]/.freeze
+
         def on_const(node)
           mod, klass = *node
           # we should only check core classes
@@ -116,9 +111,10 @@ module RuboCop
         end
 
         def check_time_node(klass, node)
+          return if attach_timezone_specifier?(node.first_argument)
+
           chain = extract_method_chain(node)
           return if not_danger_chain?(chain)
-
           return check_localtime(node) if need_check_localtime?(chain)
 
           method_name = (chain & DANGEROUS_METHODS).join('.')
@@ -132,6 +128,10 @@ module RuboCop
           end
         end
 
+        def attach_timezone_specifier?(date)
+          date.respond_to?(:value) && TIMEZONE_SPECIFIER.match?(date.value.to_s[-1])
+        end
+
         def build_message(klass, method_name, node)
           if flexible?
             format(

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks for the use of `Time.zone=` method.
+      #
+      # The `zone` attribute persists for the rest of the Ruby runtime, potentially causing
+      # unexpected behavior at a later time.
+      # Using `Time.use_zone` ensures the code passed in the block is the only place Time.zone is affected.
+      # It eliminates the possibility of a `zone` sticking around longer than intended.
+      #
+      # @example
+      #   # bad
+      #   Time.zone = 'EST'
+      #
+      #   # good
+      #   Time.use_zone('EST') do
+      #   end
+      #
+      class TimeZoneAssignment < Base
+        MSG = 'Use `Time.use_zone` with block instead of `Time.zone=`.'
+        RESTRICT_ON_SEND = %i[zone=].freeze
+
+        def_node_matcher :time_zone_assignement?, <<~PATTERN
+          (send (const nil? :Time) :zone= ...)
+        PATTERN
+
+        def on_send(node)
+          return unless time_zone_assignement?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

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

@@ -62,7 +62,7 @@ module RuboCop
           # DidYouMean::SpellChecker is not available in all versions of Ruby,
           # and even on versions where it *is* available (>= 2.3), it is not
           # always required correctly. So we do a feature check first. See:
-          # https://github.com/rubocop-hq/rubocop/issues/7979
+          # https://github.com/rubocop/rubocop/issues/7979
           similar_names = if defined?(DidYouMean::SpellChecker)
                             spell_checker = DidYouMean::SpellChecker.new(dictionary: environments)
                             spell_checker.correct(name)

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop suggests you remove a column that does not exist in the schema from `ignored_columns`.
+      # `ignored_columns` is necessary to drop a column from RDBMS, but you don't need it after the migration
+      # to drop the column. You avoid forgetting to remove `ignored_columns` by this cop.
+      #
+      # @example
+      #   # bad
+      #   class User < ApplicationRecord
+      #     self.ignored_columns = [:already_removed_column]
+      #   end
+      #
+      #   # good
+      #   class User < ApplicationRecord
+      #     self.ignored_columns = [:still_existing_column]
+      #   end
+      #
+      class UnusedIgnoredColumns < Base
+        include ActiveRecordHelper
+
+        MSG = 'Remove `%<column_name>s` from `ignored_columns` because the column does not exist.'
+        RESTRICT_ON_SEND = %i[ignored_columns=].freeze
+
+        def_node_matcher :ignored_columns, <<~PATTERN
+          (send self :ignored_columns= $array)
+        PATTERN
+
+        def_node_matcher :column_name, <<~PATTERN
+          ({str sym} $_)
+        PATTERN
+
+        def on_send(node)
+          return unless (columns = ignored_columns(node))
+          return unless schema
+
+          table = table(node)
+          return unless table
+
+          columns.children.each do |column_node|
+            check_column_existence(column_node, table)
+          end
+        end
+
+        private
+
+        def check_column_existence(column_node, table)
+          column_name = column_name(column_node)
+          return unless column_name
+          return if table.with_column?(name: column_name.to_s)
+
+          message = format(MSG, column_name: column_name)
+          add_offense(column_node, message: message)
+        end
+
+        def class_node(node)
+          node.each_ancestor.find(&:class_type?)
+        end
+
+        def table(node)
+          klass = class_node(node)
+          schema.table_by(name: table_name(klass))
+        end
+      end
+    end
+  end
+end

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

@@ -13,11 +13,13 @@ module RuboCop
       #   User.where('name IS NULL')
       #   User.where('name IN (?)', ['john', 'jane'])
       #   User.where('name IN (:names)', names: ['john', 'jane'])
+      #   User.where('users.name = :name', name: 'Gabe')
       #
       #   # good
       #   User.where(name: 'Gabe')
       #   User.where(name: nil)
       #   User.where(name: ['john', 'jane'])
+      #   User.where(users: { name: 'Gabe' })
       class WhereEquals < Base
         include RangeHelp
         extend AutoCorrector
@@ -68,7 +70,7 @@ module RuboCop
             when EQ_ANONYMOUS_RE, IN_ANONYMOUS_RE
               value_node.source
             when EQ_NAMED_RE, IN_NAMED_RE
-              return unless value_node.hash_type?
+              return unless value_node&.hash_type?
 
               pair = value_node.pairs.find { |p| p.key.value.to_sym == Regexp.last_match(2).to_sym }
               pair.value.source
@@ -83,7 +85,9 @@ module RuboCop
 
         def build_good_method(column, value)
           if column.include?('.')
-            "where('#{column}' => #{value})"
+            table, column = column.split('.')
+
+            "where(#{table}: { #{column}: #{value} })"
           else
             "where(#{column}: #{value})"
           end

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

@@ -11,6 +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:
+      #
+      # [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.
+      # ----
+      #
       # @example EnforcedStyle: exists (default)
       #   # bad
       #   User.where(name: 'john').exists?

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

@@ -15,11 +15,13 @@ module RuboCop
       #   User.where('name IS NOT NULL')
       #   User.where('name NOT IN (?)', ['john', 'jane'])
       #   User.where('name NOT IN (:names)', names: ['john', 'jane'])
+      #   User.where('users.name != :name', name: 'Gabe')
       #
       #   # good
       #   User.where.not(name: 'Gabe')
       #   User.where.not(name: nil)
       #   User.where.not(name: ['john', 'jane'])
+      #   User.where.not(users: { name: 'Gabe' })
       #
       class WhereNot < Base
         include RangeHelp
@@ -86,7 +88,9 @@ module RuboCop
 
         def build_good_method(column, value)
           if column.include?('.')
-            "where.not('#{column}' => #{value})"
+            table, column = column.split('.')
+
+            "where.not(#{table}: { #{column}: #{value} })"
           else
             "where.not(#{column}: #{value})"
           end

data/lib/rubocop/cop/rails_cops.rb

@@ -10,6 +10,7 @@ require_relative 'rails/active_record_aliases'
 require_relative 'rails/active_record_callbacks_order'
 require_relative 'rails/active_record_override'
 require_relative 'rails/active_support_aliases'
+require_relative 'rails/add_column_index'
 require_relative 'rails/after_commit_override'
 require_relative 'rails/application_controller'
 require_relative 'rails/application_job'
@@ -28,10 +29,13 @@ require_relative 'rails/default_scope'
 require_relative 'rails/delegate'
 require_relative 'rails/delegate_allow_blank'
 require_relative 'rails/dynamic_find_by'
+require_relative 'rails/eager_evaluation_log_message'
 require_relative 'rails/enum_hash'
 require_relative 'rails/enum_uniqueness'
 require_relative 'rails/environment_comparison'
+require_relative 'rails/environment_variable_access'
 require_relative 'rails/exit'
+require_relative 'rails/expanded_date_range'
 require_relative 'rails/file_path'
 require_relative 'rails/find_by'
 require_relative 'rails/find_by_id'
@@ -41,6 +45,7 @@ require_relative 'rails/has_many_or_has_one_dependent'
 require_relative 'rails/helper_instance_variable'
 require_relative 'rails/http_positional_arguments'
 require_relative 'rails/http_status'
+require_relative 'rails/i18n_locale_assignment'
 require_relative 'rails/ignored_skip_action_filter_option'
 require_relative 'rails/index_by'
 require_relative 'rails/index_with'
@@ -73,7 +78,9 @@ require_relative 'rails/relative_date_constant'
 require_relative 'rails/render_inline'
 require_relative 'rails/render_plain_text'
 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/safe_navigation'
 require_relative 'rails/safe_navigation_with_blank'
 require_relative 'rails/save_bang'
@@ -82,9 +89,11 @@ require_relative 'rails/short_i18n'
 require_relative 'rails/skips_model_validations'
 require_relative 'rails/squished_sql_heredocs'
 require_relative 'rails/time_zone'
+require_relative 'rails/time_zone_assignment'
 require_relative 'rails/uniq_before_pluck'
 require_relative 'rails/unique_validation_without_index'
 require_relative 'rails/unknown_env'
+require_relative 'rails/unused_ignored_columns'
 require_relative 'rails/validation'
 require_relative 'rails/where_equals'
 require_relative 'rails/where_exists'

data/lib/rubocop/rails.rb

@@ -8,5 +8,7 @@ module RuboCop
     CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+
+    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config', 'obsoletion.yml')
   end
 end

data/lib/rubocop/rails/schema_loader/schema.rb

@@ -114,7 +114,7 @@ module RuboCop
         attr_reader :name, :type, :not_null
 
         def initialize(node)
-          @name = node.first_argument.value
+          @name = node.first_argument.str_content
           @type = node.method_name
           @not_null = nil
 
@@ -128,9 +128,7 @@ module RuboCop
           return unless pairs.hash_type?
 
           pairs.each_pair do |k, v|
-            if k.value == :null
-              @not_null = v.true_type? ? false : true
-            end
+            @not_null = !v.true_type? if k.value == :null
           end
         end
       end

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.9.0'
+      STRING = '2.11.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.9.0
+  version: 2.11.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 1.7.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -56,7 +56,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 1.7.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -74,6 +74,7 @@ files:
 - README.md
 - bin/setup
 - config/default.yml
+- config/obsoletion.yml
 - lib/rubocop-rails.rb
 - lib/rubocop/cop/mixin/active_record_helper.rb
 - lib/rubocop/cop/mixin/enforce_superclass.rb
@@ -84,6 +85,7 @@ files:
 - lib/rubocop/cop/rails/active_record_callbacks_order.rb
 - lib/rubocop/cop/rails/active_record_override.rb
 - lib/rubocop/cop/rails/active_support_aliases.rb
+- lib/rubocop/cop/rails/add_column_index.rb
 - lib/rubocop/cop/rails/after_commit_override.rb
 - lib/rubocop/cop/rails/application_controller.rb
 - lib/rubocop/cop/rails/application_job.rb
@@ -102,10 +104,13 @@ files:
 - lib/rubocop/cop/rails/delegate.rb
 - lib/rubocop/cop/rails/delegate_allow_blank.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
 - lib/rubocop/cop/rails/enum_uniqueness.rb
 - lib/rubocop/cop/rails/environment_comparison.rb
+- lib/rubocop/cop/rails/environment_variable_access.rb
 - lib/rubocop/cop/rails/exit.rb
+- lib/rubocop/cop/rails/expanded_date_range.rb
 - lib/rubocop/cop/rails/file_path.rb
 - lib/rubocop/cop/rails/find_by.rb
 - lib/rubocop/cop/rails/find_by_id.rb
@@ -115,6 +120,7 @@ files:
 - lib/rubocop/cop/rails/helper_instance_variable.rb
 - lib/rubocop/cop/rails/http_positional_arguments.rb
 - lib/rubocop/cop/rails/http_status.rb
+- lib/rubocop/cop/rails/i18n_locale_assignment.rb
 - lib/rubocop/cop/rails/ignored_skip_action_filter_option.rb
 - lib/rubocop/cop/rails/index_by.rb
 - lib/rubocop/cop/rails/index_with.rb
@@ -147,7 +153,9 @@ files:
 - lib/rubocop/cop/rails/render_inline.rb
 - lib/rubocop/cop/rails/render_plain_text.rb
 - lib/rubocop/cop/rails/request_referer.rb
+- 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/safe_navigation.rb
 - lib/rubocop/cop/rails/safe_navigation_with_blank.rb
 - lib/rubocop/cop/rails/save_bang.rb
@@ -156,9 +164,11 @@ files:
 - lib/rubocop/cop/rails/skips_model_validations.rb
 - lib/rubocop/cop/rails/squished_sql_heredocs.rb
 - lib/rubocop/cop/rails/time_zone.rb
+- lib/rubocop/cop/rails/time_zone_assignment.rb
 - lib/rubocop/cop/rails/uniq_before_pluck.rb
 - lib/rubocop/cop/rails/unique_validation_without_index.rb
 - lib/rubocop/cop/rails/unknown_env.rb
+- lib/rubocop/cop/rails/unused_ignored_columns.rb
 - lib/rubocop/cop/rails/validation.rb
 - lib/rubocop/cop/rails/where_equals.rb
 - lib/rubocop/cop/rails/where_exists.rb
@@ -169,15 +179,15 @@ files:
 - lib/rubocop/rails/schema_loader.rb
 - lib/rubocop/rails/schema_loader/schema.rb
 - lib/rubocop/rails/version.rb
-homepage: https://github.com/rubocop-hq/rubocop-rails
+homepage: https://github.com/rubocop/rubocop-rails
 licenses:
 - MIT
 metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-rails/
-  changelog_uri: https://github.com/rubocop-hq/rubocop-rails/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/rubocop-hq/rubocop-rails/
-  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.9/
-  bug_tracker_uri: https://github.com/rubocop-hq/rubocop-rails/issues
+  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.11/
+  bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -186,14 +196,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.2.18
 signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.