rubocop-rails 2.5.1 → 2.8.0

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks that Active Record callbacks are declared
+      # in the order in which they will be executed.
+      #
+      # @example
+      #   # bad
+      #   class Person < ApplicationRecord
+      #     after_commit :after_commit_callback
+      #     before_validation :before_validation_callback
+      #   end
+      #
+      #   # good
+      #   class Person < ApplicationRecord
+      #     before_validation :before_validation_callback
+      #     after_commit :after_commit_callback
+      #   end
+      #
+      class ActiveRecordCallbacksOrder < Cop
+        MSG = '`%<current>s` is supposed to appear before `%<previous>s`.'
+
+        CALLBACKS_IN_ORDER = %i[
+          after_initialize
+          before_validation
+          after_validation
+          before_save
+          around_save
+          before_create
+          around_create
+          after_create
+          before_update
+          around_update
+          after_update
+          before_destroy
+          around_destroy
+          after_destroy
+          after_save
+          after_commit
+          after_rollback
+          after_find
+          after_touch
+        ].freeze
+
+        CALLBACKS_ORDER_MAP = CALLBACKS_IN_ORDER.each_with_index.to_h.freeze
+
+        def on_class(class_node)
+          previous_index = -1
+          previous_callback = nil
+
+          defined_callbacks(class_node).each do |node|
+            callback = node.method_name
+            index = CALLBACKS_ORDER_MAP[callback]
+
+            if index < previous_index
+              message = format(MSG, current: callback,
+                                    previous: previous_callback)
+              add_offense(node, message: message)
+            end
+            previous_index = index
+            previous_callback = callback
+          end
+        end
+
+        # Autocorrect by swapping between two nodes autocorrecting them
+        def autocorrect(node)
+          previous = left_siblings_of(node).reverse_each.find do |sibling|
+            callback?(sibling)
+          end
+
+          current_range = source_range_with_comment(node)
+          previous_range = source_range_with_comment(previous)
+
+          lambda do |corrector|
+            corrector.insert_before(previous_range, current_range.source)
+            corrector.remove(current_range)
+          end
+        end
+
+        private
+
+        def defined_callbacks(class_node)
+          class_def = class_node.body
+
+          if class_def
+            class_def.each_child_node.select { |c| callback?(c) }
+          else
+            []
+          end
+        end
+
+        def callback?(node)
+          node.send_type? && CALLBACKS_ORDER_MAP.key?(node.method_name)
+        end
+
+        def left_siblings_of(node)
+          siblings_of(node)[0, node.sibling_index]
+        end
+
+        def siblings_of(node)
+          node.parent.children
+        end
+
+        def source_range_with_comment(node)
+          begin_pos = begin_pos_with_comment(node)
+          end_pos = end_position_for(node)
+
+          Parser::Source::Range.new(buffer, begin_pos, end_pos)
+        end
+
+        def end_position_for(node)
+          end_line = buffer.line_for_position(node.loc.expression.end_pos)
+          buffer.line_range(end_line).end_pos
+        end
+
+        def begin_pos_with_comment(node)
+          annotation_line = node.first_line - 1
+          first_comment = nil
+
+          processed_source.comments_before_line(annotation_line)
+                          .reverse_each do |comment|
+            if comment.location.line == annotation_line
+              first_comment = comment
+              annotation_line -= 1
+            end
+          end
+
+          start_line_position(first_comment || node)
+        end
+
+        def start_line_position(node)
+          buffer.line_range(node.loc.line).begin_pos - 1
+        end
+
+        def buffer
+          processed_source.buffer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop enforces that there is only one call to `after_commit`
+      # (and its aliases - `after_create_commit`, `after_update_commit`,
+      # and `after_destroy_commit`) with the same callback name per model.
+      #
+      # @example
+      #   # bad
+      #   # This won't be triggered.
+      #   after_create_commit :log_action
+      #
+      #   # This will override the callback added by
+      #   # after_create_commit.
+      #   after_update_commit :log_action
+      #
+      #   # bad
+      #   # This won't be triggered.
+      #   after_commit :log_action, on: :create
+      #   # This won't be triggered.
+      #   after_update_commit :log_action
+      #   # This will override both previous callbacks.
+      #   after_commit :log_action, on: :destroy
+      #
+      #   # good
+      #   after_save_commit :log_action
+      #
+      #   # good
+      #   after_create_commit :log_create_action
+      #   after_update_commit :log_update_action
+      #
+      class AfterCommitOverride < Cop
+        MSG = 'There can only be one `after_*_commit :%<name>s` hook defined for a model.'
+
+        AFTER_COMMIT_CALLBACKS = %i[
+          after_commit
+          after_create_commit
+          after_update_commit
+          after_save_commit
+          after_destroy_commit
+        ].freeze
+
+        def on_class(class_node)
+          seen_callback_names = {}
+
+          each_after_commit_callback(class_node) do |node|
+            callback_name = node.arguments[0].value
+            if seen_callback_names.key?(callback_name)
+              add_offense(node, message: format(MSG, name: callback_name))
+            else
+              seen_callback_names[callback_name] = true
+            end
+          end
+        end
+
+        private
+
+        def each_after_commit_callback(class_node)
+          class_send_nodes(class_node).each do |node|
+            yield node if after_commit_callback?(node)
+          end
+        end
+
+        def class_send_nodes(class_node)
+          class_def = class_node.body
+
+          return [] unless class_def
+
+          if class_def.send_type?
+            [class_def]
+          else
+            class_def.each_child_node(:send).to_a
+          end
+        end
+
+        def after_commit_callback?(node)
+          AFTER_COMMIT_CALLBACKS.include?(node.method_name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks that `tag` is used instead of `content_tag`
+      # because `content_tag` is legacy syntax.
+      #
+      # NOTE: Allow `content_tag` when the first argument is a variable because
+      #      `content_tag(name)` is simpler rather than `tag.public_send(name)`.
+      #
+      # @example
+      #  # bad
+      #  content_tag(:p, 'Hello world!')
+      #  content_tag(:br)
+      #
+      #  # good
+      #  tag.p('Hello world!')
+      #  tag.br
+      #  content_tag(name, 'Hello world!')
+      class ContentTag < Cop
+        include RangeHelp
+        extend TargetRailsVersion
+
+        minimum_target_rails_version 5.1
+
+        MSG = 'Use `tag` instead of `content_tag`.'
+
+        def on_send(node)
+          return unless node.method?(:content_tag)
+
+          first_argument = node.first_argument
+          return unless first_argument
+
+          return if first_argument.variable? || first_argument.send_type? || first_argument.const_type?
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            if method_name?(node.first_argument)
+              range = correction_range(node)
+
+              rest_args = node.arguments.drop(1)
+              replacement = "tag.#{node.first_argument.value.to_s.underscore}(#{rest_args.map(&:source).join(', ')})"
+
+              corrector.replace(range, replacement)
+            else
+              corrector.replace(node.loc.selector, 'tag')
+            end
+          end
+        end
+
+        private
+
+        def method_name?(node)
+          return false unless node.str_type? || node.sym_type?
+
+          /^[a-zA-Z_][a-zA-Z_\-0-9]*$/.match?(node.value)
+        end
+
+        def correction_range(node)
+          range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+        end
+      end
+    end
+  end
+end

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

@@ -70,9 +70,7 @@ module RuboCop
           parent = node.parent
 
           if create_table_with_block?(parent)
-            if parent.body.nil? || !time_columns_included?(parent.body)
-              add_offense(parent)
-            end
+            add_offense(parent) if parent.body.nil? || !time_columns_included?(parent.body)
           elsif create_table_with_timestamps_proc?(node)
             # nothing to do
           else

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop looks for uses of `default_scope`.
+      #
+      # @example
+      #   # bad
+      #   default_scope -> { where(hidden: false) }
+      #
+      #   # good
+      #   scope :published, -> { where(hidden: false) }
+      #
+      #   # bad
+      #   def self.default_scope
+      #     where(hidden: false)
+      #   end
+      #
+      #   # good
+      #   def self.published
+      #     where(hidden: false)
+      #   end
+      #
+      class DefaultScope < Cop
+        MSG = 'Avoid use of `default_scope`. It is better to use explicitly named scopes.'
+
+        def_node_matcher :method_call?, <<~PATTERN
+          (send nil? :default_scope ...)
+        PATTERN
+
+        def_node_matcher :class_method_definition?, <<~PATTERN
+          (defs _ :default_scope args ...)
+        PATTERN
+
+        def_node_matcher :eigenclass_method_definition?, <<~PATTERN
+          (sclass (self) $(def :default_scope args ...))
+        PATTERN
+
+        def on_send(node)
+          add_offense(node, location: :selector) if method_call?(node)
+        end
+
+        def on_defs(node)
+          add_offense(node, location: :name) if class_method_definition?(node)
+        end
+
+        def on_sclass(node)
+          eigenclass_method_definition?(node) { |default_scope| add_offense(default_scope, location: :name) }
+        end
+      end
+    end
+  end
+end

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

@@ -71,9 +71,7 @@ module RuboCop
           delegation = ["delegate :#{node.body.method_name}",
                         "to: :#{node.body.receiver.method_name}"]
 
-          if node.method?(prefixed_method_name(node.body))
-            delegation << ['prefix: true']
-          end
+          delegation << ['prefix: true'] if node.method?(prefixed_method_name(node.body))
 
           lambda do |corrector|
             corrector.replace(node.source_range, delegation.join(', '))
@@ -124,7 +122,7 @@ module RuboCop
         end
 
         def private_or_protected_inline(line)
-          processed_source[line - 1].strip =~ /\A(private )|(protected )/
+          processed_source[line - 1].strip.match?(/\A(private )|(protected )/)
         end
       end
     end

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

@@ -10,37 +10,41 @@ module RuboCop
       # @example
       #   # bad
       #   User.find_by_name(name)
-      #
-      #   # bad
       #   User.find_by_name_and_email(name)
-      #
-      #   # bad
       #   User.find_by_email!(name)
       #
       #   # good
       #   User.find_by(name: name)
+      #   User.find_by(name: name, email: email)
+      #   User.find_by!(email: email)
+      #
+      # @example AllowedMethods: find_by_sql
+      #   # bad
+      #   User.find_by_query(users_query)
       #
       #   # good
-      #   User.find_by(name: name, email: email)
+      #   User.find_by_sql(users_sql)
+      #
+      # @example AllowedReceivers: Gem::Specification
+      #   # bad
+      #   Specification.find_by_name('backend').gem_dir
       #
       #   # good
-      #   User.find_by!(email: email)
+      #   Gem::Specification.find_by_name('backend').gem_dir
       class DynamicFindBy < Cop
         MSG = 'Use `%<static_name>s` instead of dynamic `%<method>s`.'
         METHOD_PATTERN = /^find_by_(.+?)(!)?$/.freeze
 
         def on_send(node)
-          method_name = node.method_name.to_s
-
-          return if whitelist.include?(method_name)
+          return if allowed_invocation?(node)
 
+          method_name = node.method_name
           static_name = static_method_name(method_name)
-
           return unless static_name
 
           add_offense(node,
                       message: format(MSG, static_name: static_name,
-                                           method: node.method_name))
+                                           method: method_name))
         end
         alias on_csend on_send
 
@@ -57,6 +61,31 @@ module RuboCop
 
         private
 
+        def allowed_invocation?(node)
+          allowed_method?(node) || allowed_receiver?(node) ||
+            whitelisted?(node)
+        end
+
+        def allowed_method?(node)
+          return unless cop_config['AllowedMethods']
+
+          cop_config['AllowedMethods'].include?(node.method_name.to_s)
+        end
+
+        def allowed_receiver?(node)
+          return unless cop_config['AllowedReceivers'] && node.receiver
+
+          cop_config['AllowedReceivers'].include?(node.receiver.source)
+        end
+
+        # config option `WhiteList` will be deprecated soon
+        def whitelisted?(node)
+          whitelist_config = cop_config['Whitelist']
+          return unless whitelist_config
+
+          whitelist_config.include?(node.method_name.to_s)
+        end
+
         def autocorrect_method_name(corrector, node)
           corrector.replace(node.loc.selector,
                             static_method_name(node.method_name.to_s))
@@ -68,10 +97,6 @@ module RuboCop
           end
         end
 
-        def whitelist
-          cop_config['Whitelist']
-        end
-
         def column_keywords(method)
           keyword_string = method.to_s[METHOD_PATTERN, 1]
           keyword_string.split('_and_').map { |keyword| "#{keyword}: " }