rubocop-rails 2.0.1 → 2.19.1

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Favor `Rails.public_path` over `Rails.root` with `'public'`
+      #
+      # @example
+      #   # bad
+      #   Rails.root.join('public')
+      #   Rails.root.join('public/file.pdf')
+      #   Rails.root.join('public', 'file.pdf')
+      #
+      #   # good
+      #   Rails.public_path
+      #   Rails.public_path.join('file.pdf')
+      #   Rails.public_path.join('file.pdf')
+      #
+      class RootPublicPath < Base
+        extend AutoCorrector
+
+        MSG = 'Use `Rails.public_path`.'
+
+        RESTRICT_ON_SEND = %i[join].to_set.freeze
+
+        PATTERN = %r{\Apublic(/|\z)}.freeze
+
+        def_node_matcher :rails_root_public, <<~PATTERN
+          (send
+            (send
+              $(const {nil? cbase} :Rails) :root) :join
+            (str $#public_path?) $...)
+        PATTERN
+
+        def on_send(node)
+          return unless (rails, maybe_public_path, other_args = rails_root_public(node))
+
+          add_offense(node) do |corrector|
+            first_args = maybe_public_path.gsub(PATTERN, '')
+
+            args = other_args.map(&:source)
+            args.unshift("'#{first_args}'") unless first_args.empty?
+
+            replacement = "#{rails.source}.public_path"
+            replacement += ".join(#{args.join(', ')})" unless args.empty?
+
+            corrector.replace(node, replacement)
+          end
+        end
+
+        private
+
+        def public_path?(string)
+          PATTERN.match?(string)
+        end
+      end
+    end
+  end
+end

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

@@ -3,73 +3,85 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop converts usages of `try!` to `&.`. It can also be configured
-      # to convert `try`. It will convert code to use safe navigation.
+      # Converts usages of `try!` to `&.`. It can also be configured
+      # to convert `try`. It will convert code to use safe navigation
+      # if the target Ruby version is set to 2.3+
       #
-      # @example
-      #   # ConvertTry: false
-      #     # bad
-      #     foo.try!(:bar)
-      #     foo.try!(:bar, baz)
-      #     foo.try!(:bar) { |e| e.baz }
+      # @example ConvertTry: false (default)
+      #   # bad
+      #   foo.try!(:bar)
+      #   foo.try!(:bar, baz)
+      #   foo.try!(:bar) { |e| e.baz }
       #
-      #     foo.try!(:[], 0)
+      #   foo.try!(:[], 0)
       #
-      #     # good
-      #     foo.try(:bar)
-      #     foo.try(:bar, baz)
-      #     foo.try(:bar) { |e| e.baz }
+      #   # good
+      #   foo.try(:bar)
+      #   foo.try(:bar, baz)
+      #   foo.try(:bar) { |e| e.baz }
       #
-      #     foo&.bar
-      #     foo&.bar(baz)
-      #     foo&.bar { |e| e.baz }
+      #   foo&.bar
+      #   foo&.bar(baz)
+      #   foo&.bar { |e| e.baz }
       #
+      # @example ConvertTry: true
+      #   # bad
+      #   foo.try!(:bar)
+      #   foo.try!(:bar, baz)
+      #   foo.try!(:bar) { |e| e.baz }
+      #   foo.try(:bar)
+      #   foo.try(:bar, baz)
+      #   foo.try(:bar) { |e| e.baz }
       #
-      #   # ConvertTry: true
-      #     # bad
-      #     foo.try!(:bar)
-      #     foo.try!(:bar, baz)
-      #     foo.try!(:bar) { |e| e.baz }
-      #     foo.try(:bar)
-      #     foo.try(:bar, baz)
-      #     foo.try(:bar) { |e| e.baz }
-      #
-      #     # good
-      #     foo&.bar
-      #     foo&.bar(baz)
-      #     foo&.bar { |e| e.baz }
-      class SafeNavigation < Cop
+      #   # good
+      #   foo&.bar
+      #   foo&.bar(baz)
+      #   foo&.bar { |e| e.baz }
+      class SafeNavigation < Base
         include RangeHelp
+        extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.3
 
         MSG = 'Use safe navigation (`&.`) instead of `%<try>s`.'
+        RESTRICT_ON_SEND = %i[try try!].freeze
 
-        def_node_matcher :try_call, <<-PATTERN
-          (send !nil? ${:try :try!} $_ ...)
+        def_node_matcher :try_call, <<~PATTERN
+          (send _ ${:try :try!} $_ ...)
         PATTERN
 
+        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']
-            return unless dispatch.sym_type? && dispatch.value =~ /\w+[=!?]?/
+            return unless dispatch.sym_type? && dispatch.value.match?(/\w+[=!?]?/)
 
-            add_offense(node, message: format(MSG, try: try_method))
+            add_offense(node, message: format(MSG, try: try_method)) do |corrector|
+              autocorrect(corrector, node)
+            end
           end
         end
 
-        def autocorrect(node)
+        private
+
+        def autocorrect(corrector, node)
           method_node, *params = *node.arguments
-          method = method_node.source[1..-1]
+          method = method_node.source[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.source_range.end_pos)
+                  else
+                    corrector.insert_before(node, 'self')
+                    node
+                  end
 
-          lambda do |corrector|
-            corrector.replace(range, replacement(method, params))
-          end
+          corrector.replace(range, replacement(method, params))
         end
 
-        private
-
         def replacement(method, params)
           new_params = params.map(&:source).join(', ')
 

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks to make sure safe navigation isn't used with `blank?` in
+      # a conditional.
+      #
+      # @safety
+      #   While the safe navigation operator is generally a good idea, when
+      #   checking `foo&.blank?` in a conditional, `foo` being `nil` will actually
+      #   do the opposite of what the author intends.
+      #
+      #   For example:
+      #
+      #   [source,ruby]
+      #   ----
+      #   foo&.blank? #=> nil
+      #   foo.blank? #=> true
+      #   ----
+      #
+      # @example
+      #   # bad
+      #   do_something if foo&.blank?
+      #   do_something unless foo&.blank?
+      #
+      #   # good
+      #   do_something if foo.blank?
+      #   do_something unless foo.blank?
+      #
+      class SafeNavigationWithBlank < Base
+        extend AutoCorrector
+
+        MSG = 'Avoid calling `blank?` with the safe navigation operator in conditionals.'
+
+        def_node_matcher :safe_navigation_blank_in_conditional?, <<~PATTERN
+          (if $(csend ... :blank?) ...)
+        PATTERN
+
+        def on_if(node)
+          return unless safe_navigation_blank_in_conditional?(node)
+
+          add_offense(node) do |corrector|
+            corrector.replace(safe_navigation_blank_in_conditional?(node).location.dot, '.')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,18 +3,20 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies possible cases where Active Record save! or related
+      # Identifies possible cases where Active Record save! or related
       # should be used instead of save because the model might have failed to
       # save and an exception is better than unhandled failure.
       #
       # This will allow:
-      # - update or save calls, assigned to a variable,
+      #
+      # * update or save calls, assigned to a variable,
       #   or used as a condition in an if/unless/case statement.
-      # - create calls, assigned to a variable that then has a
-      #   call to `persisted?`.
-      # - calls if the result is explicitly returned from methods and blocks,
+      # * create calls, assigned to a variable that then has a
+      #   call to `persisted?`, or whose return value is checked by
+      #   `persisted?` immediately
+      # * calls if the result is explicitly returned from methods and blocks,
       #   or provided as arguments.
-      # - calls whose signature doesn't look like an ActiveRecord
+      # * calls whose signature doesn't look like an ActiveRecord
       #   persistence method.
       #
       # By default it will also allow implicit returns from methods and blocks.
@@ -23,6 +25,25 @@ module RuboCop
       # You can permit receivers that are giving false positives with
       # `AllowedReceivers: []`
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because a custom `update` method call would be changed to `update!`,
+      #   but the method name in the definition would be unchanged.
+      #
+      #   [source,ruby]
+      #   ----
+      #   # Original code
+      #   def update_attributes
+      #   end
+      #
+      #   update_attributes
+      #
+      #   # After running rubocop --safe-autocorrect
+      #   def update_attributes
+      #   end
+      #
+      #   update
+      #   ----
+      #
       # @example
       #
       #   # bad
@@ -96,26 +117,20 @@ module RuboCop
       #   Services::Service::Mailer.update(message: 'Message')
       #   Service::Mailer::update
       #
-      class SaveBang < Cop
+      class SaveBang < Base
         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`."
+        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
 
-        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
-                                    first_or_create find_or_create_by].freeze
-        MODIFY_PERSIST_METHODS = %i[save
-                                    update update_attributes destroy].freeze
-        PERSIST_METHODS = (CREATE_PERSIST_METHODS +
-                           MODIFY_PERSIST_METHODS).freeze
-
-        def join_force?(force_class)
-          force_class == VariableForce
+        def self.joining_forces
+          VariableForce
         end
 
         def after_leaving_scope(scope, _variable_table)
@@ -133,35 +148,35 @@ module RuboCop
           return unless persist_method?(node, CREATE_PERSIST_METHODS)
           return if persisted_referenced?(assignment)
 
-          add_offense_for_node(node, CREATE_MSG)
+          register_offense(node, CREATE_MSG)
         end
 
-        def on_send(node) # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/CyclomaticComplexity
+        def on_send(node)
           return unless persist_method?(node)
           return if return_value_assigned?(node)
-          return if check_used_in_conditional(node)
-          return if argument?(node)
           return if implicit_return?(node)
+          return if check_used_in_condition_or_compound_boolean(node)
+          return if argument?(node)
           return if explicit_return?(node)
+          return if checked_immediately?(node)
 
-          add_offense_for_node(node)
+          register_offense(node, MSG)
         end
+        # rubocop:enable Metrics/CyclomaticComplexity
         alias on_csend on_send
 
-        def autocorrect(node)
-          save_loc = node.loc.selector
-          new_method = "#{node.method_name}!"
-
-          ->(corrector) { corrector.replace(save_loc, new_method) }
-        end
-
         private
 
-        def add_offense_for_node(node, msg = MSG)
-          name = node.method_name
-          full_message = format(msg, prefer: "#{name}!", current: name.to_s)
+        def register_offense(node, msg)
+          current_method = node.method_name
+          bang_method = "#{current_method}!"
+          full_message = format(msg, prefer: bang_method, current: current_method)
 
-          add_offense(node, location: :selector, message: full_message)
+          range = node.loc.selector
+          add_offense(range, message: full_message) do |corrector|
+            corrector.replace(range, bang_method)
+          end
         end
 
         def right_assignment_node(assignment)
@@ -210,29 +225,37 @@ module RuboCop
           array
         end
 
-        def check_used_in_conditional(node)
-          return false unless conditional?(node)
+        def check_used_in_condition_or_compound_boolean(node)
+          return false unless in_condition_or_compound_boolean?(node)
 
-          unless MODIFY_PERSIST_METHODS.include?(node.method_name)
-            add_offense_for_node(node, CREATE_CONDITIONAL_MSG)
-          end
+          register_offense(node, CREATE_CONDITIONAL_MSG) unless MODIFY_PERSIST_METHODS.include?(node.method_name)
 
           true
         end
 
-        def conditional?(node) # rubocop:disable Metrics/CyclomaticComplexity
+        def in_condition_or_compound_boolean?(node)
           node = node.block_node || node
+          parent = node.parent
+          return false unless parent
 
-          condition = node.parent
-          return false unless condition
+          operator_or_single_negative?(parent) || (conditional?(parent) && node == parent.condition)
+        end
+
+        def operator_or_single_negative?(node)
+          node.or_type? || node.and_type? || single_negative?(node)
+        end
 
-          condition.if_type? || condition.case_type? ||
-            condition.or_type? || condition.and_type? ||
-            single_negative?(condition)
+        def conditional?(parent)
+          parent.if_type? || parent.case_type?
+        end
+
+        def checked_immediately?(node)
+          node.parent && call_to_persisted?(node.parent)
         end
 
         def allowed_receiver?(node)
           return false unless node.receiver
+          return true if node.receiver.const_name == 'ENV'
           return false unless cop_config['AllowedReceivers']
 
           cop_config['AllowedReceivers'].any? do |allowed_receiver|
@@ -248,7 +271,7 @@ module RuboCop
             if node.variable?
               node.node_parts.first == receiver_part.to_sym
             elsif node.send_type?
-              node.method_name == receiver_part.to_sym
+              node.method?(receiver_part.to_sym)
             elsif node.const_type?
               const_matches?(node.const_name, receiver_part)
             end
@@ -264,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
@@ -276,10 +297,18 @@ module RuboCop
           return false unless cop_config['AllowImplicitReturn']
 
           node = assignable_node(node)
-          method = node.parent
+          method, sibling_index = find_method_with_sibling_index(node.parent)
           return unless method && (method.def_type? || method.block_type?)
 
-          method.children.size == node.sibling_index + 1
+          method.children.size == node.sibling_index + sibling_index
+        end
+
+        def find_method_with_sibling_index(node, sibling_index = 1)
+          return node, sibling_index unless node&.or_type?
+
+          sibling_index += 1
+
+          find_method_with_sibling_index(node.parent, sibling_index)
         end
 
         def argument?(node)
@@ -296,10 +325,8 @@ module RuboCop
           assignment&.lvasgn_type?
         end
 
-        def persist_method?(node, methods = PERSIST_METHODS)
-          methods.include?(node.method_name) &&
-            expected_signature?(node) &&
-            !allowed_receiver?(node)
+        def persist_method?(node, methods = RESTRICT_ON_SEND)
+          methods.include?(node.method_name) && expected_signature?(node) && !allowed_receiver?(node)
         end
 
         # Check argument signature as no arguments or one hash
@@ -307,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/schema_comment.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # 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/scope_args.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for scope calls where it was passed
+      # Checks for scope calls where it was passed
       # a method (usually a scope) instead of a lambda/proc.
       #
       # @example
@@ -13,14 +13,19 @@ module RuboCop
       #
       #   # good
       #   scope :something, -> { where(something: true) }
-      class ScopeArgs < Cop
+      class ScopeArgs < Base
+        extend AutoCorrector
+
         MSG = 'Use `lambda`/`proc` instead of a plain method call.'
+        RESTRICT_ON_SEND = %i[scope].freeze
 
         def_node_matcher :scope?, '(send nil? :scope _ $send)'
 
         def on_send(node)
           scope?(node) do |second_arg|
-            add_offense(second_arg)
+            add_offense(second_arg) do |corrector|
+              corrector.replace(second_arg, "-> { #{second_arg.source} }")
+            end
           end
         end
       end