rubocop-rails 2.15.2 → 2.20.2

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

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Use `Rails.root` IO methods instead of passing it to `File`.
+      #
+      # `Rails.root` is an instance of `Pathname`
+      # so we can apply many IO methods directly.
+      #
+      # This cop works best when used together with
+      # `Style/FileRead`, `Style/FileWrite` and `Rails/RootJoinChain`.
+      #
+      # @safety
+      #   This cop is unsafe for autocorrection because `Dir`'s `children`, `each_child`, `entries`, and `glob`
+      #   methods return string element, but these methods of `Pathname` return `Pathname` element.
+      #
+      # @example
+      #   # bad
+      #   File.open(Rails.root.join('db', 'schema.rb'))
+      #   File.open(Rails.root.join('db', 'schema.rb'), 'w')
+      #   File.read(Rails.root.join('db', 'schema.rb'))
+      #   File.binread(Rails.root.join('db', 'schema.rb'))
+      #   File.write(Rails.root.join('db', 'schema.rb'), content)
+      #   File.binwrite(Rails.root.join('db', 'schema.rb'), content)
+      #
+      #   # good
+      #   Rails.root.join('db', 'schema.rb').open
+      #   Rails.root.join('db', 'schema.rb').open('w')
+      #   Rails.root.join('db', 'schema.rb').read
+      #   Rails.root.join('db', 'schema.rb').binread
+      #   Rails.root.join('db', 'schema.rb').write(content)
+      #   Rails.root.join('db', 'schema.rb').binwrite(content)
+      #
+      class RootPathnameMethods < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = '`%<rails_root>s` is a `Pathname` so you can just append `#%<method>s`.'
+
+        DIR_METHODS = %i[children delete each_child empty? entries exist? glob mkdir open rmdir unlink].to_set.freeze
+
+        FILE_METHODS = %i[
+          atime
+          basename
+          binread
+          binwrite
+          birthtime
+          blockdev?
+          chardev?
+          chmod
+          chown
+          ctime
+          delete
+          directory?
+          dirname
+          empty?
+          executable?
+          executable_real?
+          exist?
+          expand_path
+          extname
+          file?
+          fnmatch
+          fnmatch?
+          ftype
+          grpowned?
+          join
+          lchmod
+          lchown
+          lstat
+          mtime
+          open
+          owned?
+          pipe?
+          read
+          readable?
+          readable_real?
+          readlines
+          readlink
+          realdirpath
+          realpath
+          rename
+          setgid?
+          setuid?
+          size
+          size?
+          socket?
+          split
+          stat
+          sticky?
+          symlink?
+          sysopen
+          truncate
+          unlink
+          utime
+          world_readable?
+          world_writable?
+          writable?
+          writable_real?
+          write
+          zero?
+        ].to_set.freeze
+
+        FILE_TEST_METHODS = %i[
+          blockdev?
+          chardev?
+          directory?
+          empty?
+          executable?
+          executable_real?
+          exist?
+          file?
+          grpowned?
+          owned?
+          pipe?
+          readable?
+          readable_real?
+          setgid?
+          setuid?
+          size
+          size?
+          socket?
+          sticky?
+          symlink?
+          world_readable?
+          world_writable?
+          writable?
+          writable_real?
+          zero?
+        ].to_set.freeze
+
+        FILE_UTILS_METHODS = %i[chmod chown mkdir mkpath rmdir rmtree].to_set.freeze
+
+        RESTRICT_ON_SEND = (DIR_METHODS + FILE_METHODS + FILE_TEST_METHODS + FILE_UTILS_METHODS).to_set.freeze
+
+        def_node_matcher :pathname_method, <<~PATTERN
+          {
+            (send (const {nil? cbase} :Dir) $DIR_METHODS $_ $...)
+            (send (const {nil? cbase} {:IO :File}) $FILE_METHODS $_ $...)
+            (send (const {nil? cbase} :FileTest) $FILE_TEST_METHODS $_ $...)
+            (send (const {nil? cbase} :FileUtils) $FILE_UTILS_METHODS $_ $...)
+          }
+        PATTERN
+
+        def_node_matcher :dir_glob?, <<~PATTERN
+          (send
+            (const {cbase nil?} :Dir) :glob ...)
+        PATTERN
+
+        def_node_matcher :rails_root_pathname?, <<~PATTERN
+          {
+            $#rails_root?
+            (send $#rails_root? :join ...)
+          }
+        PATTERN
+
+        # @!method rails_root?(node)
+        def_node_matcher :rails_root?, <<~PATTERN
+          (send (const {nil? cbase} :Rails) {:root :public_path})
+        PATTERN
+
+        def on_send(node)
+          evidence(node) do |method, path, args, rails_root|
+            add_offense(node, message: format(MSG, method: method, rails_root: rails_root.source)) do |corrector|
+              replacement = if dir_glob?(node)
+                              build_path_glob_replacement(path, method)
+                            else
+                              build_path_replacement(path, method, args)
+                            end
+
+              corrector.replace(node, replacement)
+            end
+          end
+        end
+
+        private
+
+        def evidence(node)
+          return if node.method?(:open) && node.parent&.send_type?
+          return unless (method, path, args = pathname_method(node)) && (rails_root = rails_root_pathname?(path))
+
+          yield(method, path, args, rails_root)
+        end
+
+        def build_path_glob_replacement(path, method)
+          receiver = range_between(path.source_range.begin_pos, path.children.first.loc.selector.end_pos).source
+
+          argument = path.arguments.one? ? path.first_argument.source : join_arguments(path.arguments)
+
+          "#{receiver}.#{method}(#{argument})"
+        end
+
+        def build_path_replacement(path, method, args)
+          path_replacement = path.source
+          if path.arguments? && !path.parenthesized_call?
+            path_replacement[' '] = '('
+            path_replacement << ')'
+          end
+
+          replacement = "#{path_replacement}.#{method}"
+          replacement += "(#{args.map(&:source).join(', ')})" unless args.empty?
+          replacement
+        end
+
+        def include_interpolation?(arguments)
+          arguments.any? do |argument|
+            argument.children.any? { |child| child.respond_to?(:begin_type?) && child.begin_type? }
+          end
+        end
+
+        def join_arguments(arguments)
+          use_interpolation = false
+
+          joined_arguments = arguments.map do |arg|
+            if arg.respond_to?(:value)
+              arg.value
+            else
+              use_interpolation = true
+              "\#{#{arg.source}}"
+            end
+          end.join('/')
+          quote = enforce_double_quotes? || include_interpolation?(arguments) || use_interpolation ? '"' : "'"
+
+          "#{quote}#{joined_arguments}#{quote}"
+        end
+
+        def enforce_double_quotes?
+          string_literals_config['EnforcedStyle'] == 'double_quotes'
+        end
+
+        def string_literals_config
+          config.for_cop('Style/StringLiterals')
+        end
+      end
+    end
+  end
+end

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

@@ -73,7 +73,7 @@ module RuboCop
           method = method_node.source[1..]
 
           range = if node.receiver
-                    range_between(node.loc.dot.begin_pos, node.loc.expression.end_pos)
+                    range_between(node.loc.dot.begin_pos, node.source_range.end_pos)
                   else
                     corrector.insert_before(node, 'self')
                     node

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

@@ -31,9 +31,7 @@ module RuboCop
       class SafeNavigationWithBlank < Base
         extend AutoCorrector
 
-        MSG =
-          'Avoid calling `blank?` with the safe navigation operator ' \
-          'in conditionals.'
+        MSG = 'Avoid calling `blank?` with the safe navigation operator in conditionals.'
 
         def_node_matcher :safe_navigation_blank_in_conditional?, <<~PATTERN
           (if $(csend ... :blank?) ...)

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

@@ -121,18 +121,12 @@ module RuboCop
         include NegativeConditional
         extend AutoCorrector
 
-        MSG = 'Use `%<prefer>s` instead of `%<current>s` if the return ' \
-              'value is not checked.'
-        CREATE_MSG = (MSG +
-                      ' Or check `persisted?` on model returned from ' \
-                      '`%<current>s`.').freeze
-        CREATE_CONDITIONAL_MSG = '`%<current>s` returns a model which is ' \
-                                 'always truthy.'
-
-        CREATE_PERSIST_METHODS = %i[create create_or_find_by
-                                    first_or_create find_or_create_by].freeze
-        MODIFY_PERSIST_METHODS = %i[save
-                                    update update_attributes destroy].freeze
+        MSG = 'Use `%<prefer>s` instead of `%<current>s` if the return value is not checked.'
+        CREATE_MSG = "#{MSG} Or check `persisted?` on model returned from `%<current>s`."
+        CREATE_CONDITIONAL_MSG = '`%<current>s` returns a model which is always truthy.'
+
+        CREATE_PERSIST_METHODS = %i[create create_or_find_by first_or_create find_or_create_by].freeze
+        MODIFY_PERSIST_METHODS = %i[save update update_attributes destroy].freeze
         RESTRICT_ON_SEND = (CREATE_PERSIST_METHODS + MODIFY_PERSIST_METHODS).freeze
 
         def self.joining_forces
@@ -244,8 +238,7 @@ module RuboCop
           parent = node.parent
           return false unless parent
 
-          operator_or_single_negative?(parent) ||
-            (conditional?(parent) && node == parent.condition)
+          operator_or_single_negative?(parent) || (conditional?(parent) && node == parent.condition)
         end
 
         def operator_or_single_negative?(node)
@@ -294,9 +287,7 @@ module RuboCop
         # NameSpace::Const != ::Const
         # Const != NameSpace::Const
         def const_matches?(const, allowed_const)
-          parts = allowed_const.split('::').reverse.zip(
-            const.split('::').reverse
-          )
+          parts = allowed_const.split('::').reverse.zip(const.split('::').reverse)
           parts.all? do |(allowed_part, const_part)|
             allowed_part == const_part.to_s
           end
@@ -335,9 +326,7 @@ module RuboCop
         end
 
         def persist_method?(node, methods = RESTRICT_ON_SEND)
-          methods.include?(node.method_name) &&
-            expected_signature?(node) &&
-            !allowed_receiver?(node)
+          methods.include?(node.method_name) && expected_signature?(node) && !allowed_receiver?(node)
         end
 
         # Check argument signature as no arguments or one hash
@@ -345,8 +334,7 @@ module RuboCop
           !node.arguments? ||
             (node.arguments.one? &&
               node.method_name != :destroy &&
-              (node.first_argument.hash_type? ||
-              !node.first_argument.literal?))
+              (node.first_argument.hash_type? || !node.first_argument.literal?))
         end
       end
     end

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

@@ -44,15 +44,12 @@ module RuboCop
 
         MSG = 'Use `%<good_method>s` instead of `%<bad_method>s`.'
 
-        PREFERRED_METHODS = {
-          translate: :t,
-          localize: :l
-        }.freeze
+        PREFERRED_METHODS = { translate: :t, localize: :l }.freeze
 
         RESTRICT_ON_SEND = PREFERRED_METHODS.keys.freeze
 
         def_node_matcher :long_i18n?, <<~PATTERN
-          (send {nil? (const nil? :I18n)} ${:translate :localize} ...)
+          (send {nil? (const {nil? cbase} :I18n)} ${:translate :localize} ...)
         PATTERN
 
         def on_send(node)

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

@@ -57,7 +57,7 @@ module RuboCop
 
         def_node_matcher :good_touch?, <<~PATTERN
           {
-            (send (const nil? :FileUtils) :touch ...)
+            (send (const {nil? cbase} :FileUtils) :touch ...)
             (send _ :touch {true false})
           }
         PATTERN
@@ -93,8 +93,7 @@ module RuboCop
         end
 
         def allowed_method?(node)
-          METHODS_WITH_ARGUMENTS.include?(node.method_name.to_s) &&
-            !node.arguments?
+          METHODS_WITH_ARGUMENTS.include?(node.method_name.to_s) && !node.arguments?
         end
 
         def forbidden_methods

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

@@ -3,7 +3,6 @@
 module RuboCop
   module Cop
     module Rails
-      #
       # Checks SQL heredocs to use `.squish`.
       #
       # @safety
@@ -48,6 +47,7 @@ module RuboCop
         SQL = 'SQL'
         SQUISH = '.squish'
         MSG = 'Use `%<expect>s` instead of `%<current>s`.'
+        SQL_IDENTIFIER_MARKERS = /(".+?")|('.+?')|(\[.+?\])/.freeze
 
         def on_heredoc(node)
           return unless offense_detected?(node)
@@ -60,7 +60,7 @@ module RuboCop
         private
 
         def offense_detected?(node)
-          sql_heredoc?(node) && !using_squish?(node)
+          sql_heredoc?(node) && !using_squish?(node) && !singleline_comments_present?(node)
         end
 
         def sql_heredoc?(node)
@@ -71,12 +71,14 @@ module RuboCop
           node.parent&.send_type? && node.parent&.method?(:squish)
         end
 
+        def singleline_comments_present?(node)
+          sql = node.children.map { |c| c.is_a?(String) ? c : c.source }.join('\n')
+
+          sql.gsub(SQL_IDENTIFIER_MARKERS, '').include?('--')
+        end
+
         def message(node)
-          format(
-            MSG,
-            expect: "#{node.source}#{SQUISH}",
-            current: node.source
-          )
+          format(MSG, expect: "#{node.source}#{SQUISH}", current: node.source)
         end
       end
     end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Enforces that boolean columns are created with default values (`false` or `true`) and
+      # `NOT NULL` constraint.
+      #
+      # @example
+      #   # bad
+      #   add_column :users, :active, :boolean
+      #   t.column :active, :boolean
+      #   t.boolean :active
+      #
+      #   # good
+      #   add_column :users, :active, :boolean, default: true, null: false
+      #   t.column :active, :boolean, default: true, null: false
+      #   t.boolean :active, default: true, null: false
+      #
+      class ThreeStateBooleanColumn < Base
+        MSG = 'Boolean columns should always have a default value and a `NOT NULL` constraint.'
+
+        RESTRICT_ON_SEND = %i[add_column column boolean].freeze
+
+        def_node_matcher :three_state_boolean?, <<~PATTERN
+          {
+            (send nil? :add_column _ $_ {(sym :boolean) (str "boolean")} $_ ?)
+            (send !nil? :column $_ {(sym :boolean) (str "boolean")} $_ ?)
+            (send !nil? :boolean $_ $_ ?)
+          }
+        PATTERN
+
+        def_node_matcher :required_options?, <<~PATTERN
+          (hash <(pair (sym :default) !nil?) (pair (sym :null) false) ...>)
+        PATTERN
+
+        def_node_search :change_column_null?, <<~PATTERN
+          (send nil? :change_column_null %1 %2 false)
+        PATTERN
+
+        def on_send(node)
+          three_state_boolean?(node) do |column_node, options_node|
+            options_node = options_node.first
+
+            return if required_options?(options_node)
+
+            def_node = node.each_ancestor(:def, :defs).first
+            table_node = table_node(node)
+            return if def_node && (table_node.nil? || change_column_null?(def_node, table_node, column_node))
+
+            add_offense(node)
+          end
+        end
+
+        private
+
+        def table_node(node)
+          case node.method_name
+          when :add_column
+            node.first_argument
+          when :column, :boolean
+            ancestor = node.each_ancestor(:block).find do |n|
+              n.method?(:create_table) || n.method?(:change_table)
+            end
+            ancestor&.send_node&.first_argument
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -43,23 +43,19 @@ module RuboCop
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        MSG = 'Do not use `%<current>s` without zone. Use `%<prefer>s` ' \
-              'instead.'
+        MSG = 'Do not use `%<current>s` without zone. Use `%<prefer>s` instead.'
 
-        MSG_ACCEPTABLE = 'Do not use `%<current>s` without zone. ' \
-                         'Use one of %<prefer>s instead.'
+        MSG_ACCEPTABLE = 'Do not use `%<current>s` without zone. Use one of %<prefer>s instead.'
 
-        MSG_LOCALTIME = 'Do not use `Time.localtime` without ' \
-                        'offset or zone.'
+        MSG_LOCALTIME = 'Do not use `Time.localtime` without offset or zone.'
 
         GOOD_METHODS = %i[zone zone_default find_zone find_zone!].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
+        ACCEPTED_METHODS = %i[in_time_zone utc getlocal xmlschema iso8601 jisx0301 rfc3339 httpdate to_i to_f].freeze
 
-        TIMEZONE_SPECIFIER = /[A-z]/.freeze
+        TIMEZONE_SPECIFIER = /([A-Za-z]|[+-]\d{2}:?\d{2})\z/.freeze
 
         def on_const(node)
           mod, klass = *node
@@ -74,7 +70,7 @@ module RuboCop
 
         def autocorrect(corrector, node)
           # add `.zone`: `Time.at` => `Time.zone.at`
-          corrector.insert_after(node.children[0].source_range, '.zone')
+          corrector.insert_after(node.children[0], '.zone')
 
           case node.method_name
           when :current
@@ -85,7 +81,7 @@ module RuboCop
           end
 
           # prefer `Time` over `DateTime` class
-          corrector.replace(node.children.first.source_range, 'Time') if strict?
+          corrector.replace(node.children.first, 'Time') if strict?
           remove_redundant_in_time_zone(corrector, node)
         end
 
@@ -100,13 +96,11 @@ module RuboCop
         # remove redundant `.in_time_zone` from `Time.zone.now.in_time_zone`
         def remove_redundant_in_time_zone(corrector, node)
           time_methods_called = extract_method_chain(node)
-          return unless time_methods_called.include?(:in_time_zone) ||
-                        time_methods_called.include?(:zone)
+          return unless time_methods_called.include?(:in_time_zone) || time_methods_called.include?(:zone)
 
           while node&.send_type?
             if node.children.last == :in_time_zone
-              in_time_zone_with_dot =
-                node.loc.selector.adjust(begin_pos: -1)
+              in_time_zone_with_dot = node.loc.selector.adjust(begin_pos: -1)
               corrector.remove(in_time_zone_with_dot)
             end
             node = node.parent
@@ -132,7 +126,7 @@ module RuboCop
         end
 
         def attach_timezone_specifier?(date)
-          date.respond_to?(:value) && TIMEZONE_SPECIFIER.match?(date.value.to_s[-1])
+          date.respond_to?(:value) && TIMEZONE_SPECIFIER.match?(date.value.to_s)
         end
 
         def build_message(klass, method_name, node)
@@ -144,9 +138,7 @@ module RuboCop
             )
           else
             safe_method_name = safe_method(method_name, node)
-            format(MSG,
-                   current: "#{klass}.#{method_name}",
-                   prefer: "Time.zone.#{safe_method_name}")
+            format(MSG, current: "#{klass}.#{method_name}", prefer: "Time.zone.#{safe_method_name}")
           end
         end
 
@@ -227,10 +219,7 @@ module RuboCop
         end
 
         def acceptable_methods(klass, method_name, node)
-          acceptable = [
-            "`Time.zone.#{safe_method(method_name, node)}`",
-            "`#{klass}.current`"
-          ]
+          acceptable = ["`Time.zone.#{safe_method(method_name, node)}`", "`#{klass}.current`"]
 
           ACCEPTED_METHODS.each do |am|
             acceptable << "`#{klass}.#{method_name}.#{am}`"
@@ -239,12 +228,25 @@ module RuboCop
           acceptable
         end
 
-        # Time.new can be called with a time zone offset
+        # Time.new, Time.at, and Time.now can be called with a time zone offset
         # When it is, that should be considered safe
         # Example:
         # Time.new(1988, 3, 15, 3, 0, 0, "-05:00")
         def offset_provided?(node)
-          node.arguments.size >= 7
+          case node.method_name
+          when :new
+            node.arguments.size == 7 || offset_option_provided?(node)
+          when :at, :now
+            offset_option_provided?(node)
+          end
+        end
+
+        def offset_option_provided?(node)
+          options = node.last_argument
+          options&.hash_type? &&
+            options.each_pair.any? do |pair|
+              pair.key.sym_type? && pair.key.value == :in && !pair.value.nil_type?
+            end
         end
       end
     end

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

@@ -23,7 +23,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[zone=].freeze
 
         def_node_matcher :time_zone_assignment?, <<~PATTERN
-          (send (const nil? :Time) :zone= ...)
+          (send (const {nil? cbase} :Time) :zone= ...)
         PATTERN
 
         def on_send(node)

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Identifies passing any argument to `#to_s`.
+      #
+      # @safety
+      #   This cop is marked as unsafe because it may detect `#to_s` calls
+      #   that are not related to Active Support implementation.
+      #
+      # @example
+      #
+      #   # bad
+      #   obj.to_s(:delimited)
+      #
+      #   # good
+      #   obj.to_formatted_s(:delimited)
+      #
+      class ToSWithArgument < Base
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        # These types are defined by the following files in ActiveSupport:
+        #   lib/active_support/core_ext/array/conversions.rb
+        #   lib/active_support/core_ext/date/conversions.rb
+        #   lib/active_support/core_ext/date_time/conversions.rb
+        #   lib/active_support/core_ext/numeric/conversions.rb
+        #   lib/active_support/core_ext/range/conversions.rb
+        #   lib/active_support/core_ext/time/conversions.rb
+        #   lib/active_support/time_with_zone.rb
+        EXTENDED_FORMAT_TYPES = Set.new(
+          %i[
+            currency
+            db
+            delimited
+            human
+            human_size
+            inspect
+            iso8601
+            long
+            long_ordinal
+            nsec
+            number
+            percentage
+            phone
+            rfc822
+            rounded
+            short
+            time
+            usec
+          ]
+        )
+
+        MSG = 'Use `to_formatted_s` instead.'
+
+        RESTRICT_ON_SEND = %i[to_s].freeze
+
+        minimum_target_rails_version 7.0
+
+        def on_send(node)
+          return unless rails_extended_to_s?(node)
+
+          add_offense(node.loc.selector) do |corrector|
+            corrector.replace(node.loc.selector, 'to_formatted_s')
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def rails_extended_to_s?(node)
+          node.first_argument&.sym_type? && EXTENDED_FORMAT_TYPES.include?(node.first_argument.value)
+        end
+      end
+    end
+  end
+end