rubocop-rails 2.6.0 → 2.9.0

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop enforces that mailer names end with `Mailer` suffix.
+      #
+      # Without the `Mailer` suffix it isn't immediately apparent what's a mailer
+      # and which views are related to the mailer.
+      #
+      # @example
+      #   # bad
+      #   class User < ActionMailer::Base
+      #   end
+      #
+      #   class User < ApplicationMailer
+      #   end
+      #
+      #   # good
+      #   class UserMailer < ActionMailer::Base
+      #   end
+      #
+      #   class UserMailer < ApplicationMailer
+      #   end
+      #
+      class MailerName < Base
+        extend AutoCorrector
+
+        MSG = 'Mailer should end with `Mailer` suffix.'
+
+        def_node_matcher :mailer_base_class?, <<~PATTERN
+          {
+            (const (const nil? :ActionMailer) :Base)
+            (const nil? :ApplicationMailer)
+          }
+        PATTERN
+
+        def_node_matcher :class_definition?, <<~PATTERN
+          (class $(const _ !#mailer_suffix?) #mailer_base_class? ...)
+        PATTERN
+
+        def_node_matcher :class_new_definition?, <<~PATTERN
+          (send (const nil? :Class) :new #mailer_base_class?)
+        PATTERN
+
+        def on_class(node)
+          class_definition?(node) do |name_node|
+            add_offense(name_node) do |corrector|
+              autocorrect(corrector, name_node)
+            end
+          end
+        end
+
+        def on_send(node)
+          return unless class_new_definition?(node)
+
+          casgn_parent = node.each_ancestor(:casgn).first
+          return unless casgn_parent
+
+          name = casgn_parent.children[1]
+          return if mailer_suffix?(name)
+
+          add_offense(casgn_parent.loc.name) do |corrector|
+            autocorrect(corrector, casgn_parent)
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          if node.casgn_type?
+            name = node.children[1]
+            corrector.replace(node.loc.name, "#{name}Mailer")
+          else
+            name = node.children.last
+            corrector.replace(node.source_range, "#{name}Mailer")
+          end
+        end
+
+        def mailer_suffix?(mailer_name)
+          mailer_name.to_s.end_with?('Mailer')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop identifies places where defining routes with `match`
+      # can be replaced with a specific HTTP method.
+      #
+      # Don't use `match` to define any routes unless there is a need to map multiple request types
+      # among [:get, :post, :patch, :put, :delete] to a single action using the `:via` option.
+      #
+      # @example
+      #   # bad
+      #   match ':controller/:action/:id'
+      #   match 'photos/:id', to: 'photos#show', via: :get
+      #
+      #   # good
+      #   get ':controller/:action/:id'
+      #   get 'photos/:id', to: 'photos#show'
+      #   match 'photos/:id', to: 'photos#show', via: [:get, :post]
+      #   match 'photos/:id', to: 'photos#show', via: :all
+      #
+      class MatchRoute < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<http_method>s` instead of `match` to define a route.'
+        RESTRICT_ON_SEND = %i[match].freeze
+        HTTP_METHODS = %i[get post put patch delete].freeze
+
+        def_node_matcher :match_method_call?, <<~PATTERN
+          (send nil? :match $_ $(hash ...) ?)
+        PATTERN
+
+        def on_send(node)
+          match_method_call?(node) do |path_node, options_node|
+            return unless within_routes?(node)
+
+            options_node = path_node.hash_type? ? path_node : options_node.first
+
+            if options_node.nil?
+              register_offense(node, 'get')
+            else
+              via = extract_via(options_node)
+              return unless via.size == 1 && http_method?(via.first)
+
+              register_offense(node, via.first)
+            end
+          end
+        end
+
+        private
+
+        def register_offense(node, http_method)
+          add_offense(node, message: format(MSG, http_method: http_method)) do |corrector|
+            match_method_call?(node) do |path_node, options_node|
+              options_node = options_node.first
+
+              corrector.replace(node, replacement(path_node, options_node))
+            end
+          end
+        end
+
+        def_node_matcher :routes_draw?, <<~PATTERN
+          (send (send _ :routes) :draw)
+        PATTERN
+
+        def within_routes?(node)
+          node.each_ancestor(:block).any? { |a| routes_draw?(a.send_node) }
+        end
+
+        def extract_via(node)
+          via_pair = via_pair(node)
+          return %i[get] unless via_pair
+
+          _, via = *via_pair
+
+          if via.basic_literal?
+            [via.value]
+          elsif via.array_type?
+            via.values.map(&:value)
+          else
+            []
+          end
+        end
+
+        def via_pair(node)
+          node.pairs.find { |p| p.key.value == :via }
+        end
+
+        def http_method?(method)
+          HTTP_METHODS.include?(method.to_sym)
+        end
+
+        def replacement(path_node, options_node)
+          if path_node.hash_type?
+            http_method, options = *http_method_and_options(path_node)
+            "#{http_method} #{options.map(&:source).join(', ')}"
+          elsif options_node.nil?
+            "get #{path_node.source}"
+          else
+            http_method, options = *http_method_and_options(options_node)
+
+            if options.any?
+              "#{http_method} #{path_node.source}, #{options.map(&:source).join(', ')}"
+            else
+              "#{http_method} #{path_node.source}"
+            end
+          end
+        end
+
+        def http_method_and_options(node)
+          via_pair = via_pair(node)
+          http_method = extract_via(node).first
+          rest_pairs = node.pairs - [via_pair]
+          [http_method, rest_pairs]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop enforces the use of `collection.exclude?(obj)`
+      # over `!collection.include?(obj)`.
+      #
+      # It is marked as unsafe by default because false positive will occur for
+      # a receiver object that do not have `exclude?` method. (e.g. `IPAddr`)
+      #
+      # @example
+      #   # bad
+      #   !array.include?(2)
+      #   !hash.include?(:key)
+      #
+      #   # good
+      #   array.exclude?(2)
+      #   hash.exclude?(:key)
+      #
+      class NegateInclude < Base
+        extend AutoCorrector
+
+        MSG = 'Use `.exclude?` and remove the negation part.'
+        RESTRICT_ON_SEND = %i[!].freeze
+
+        def_node_matcher :negate_include_call?, <<~PATTERN
+          (send (send $_ :include? $_) :!)
+        PATTERN
+
+        def on_send(node)
+          return unless (receiver, obj = negate_include_call?(node))
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, "#{receiver.source}.exclude?(#{obj.source})")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,8 +16,9 @@ module RuboCop
       #   add_column :users, :name, :string, null: false, default: ''
       #   add_reference :products, :category
       #   add_reference :products, :category, null: false, default: 1
-      class NotNullColumn < Cop
+      class NotNullColumn < Base
         MSG = 'Do not add a NOT NULL column without a default value.'
+        RESTRICT_ON_SEND = %i[add_column add_reference].freeze
 
         def_node_matcher :add_not_null_column?, <<~PATTERN
           (send nil? :add_column _ _ _ (hash $...))

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks for places where ordering by `id` column is used.
+      #
+      # Don't use the `id` column for ordering. The sequence of ids is not guaranteed
+      # to be in any particular order, despite often (incidentally) being chronological.
+      # Use a timestamp column to order chronologically. As a bonus the intent is clearer.
+      #
+      # NOTE: Make sure the changed order column does not introduce performance
+      # bottlenecks and appropriate database indexes are added.
+      #
+      # @example
+      #   # bad
+      #   scope :chronological, -> { order(id: :asc) }
+      #   scope :chronological, -> { order(primary_key => :asc) }
+      #
+      #   # good
+      #   scope :chronological, -> { order(created_at: :asc) }
+      #
+      class OrderById < Base
+        include RangeHelp
+
+        MSG = 'Do not use the `id` column for ordering. '\
+              'Use a timestamp column to order chronologically.'
+        RESTRICT_ON_SEND = %i[order].freeze
+
+        def_node_matcher :order_by_id?, <<~PATTERN
+          (send _ :order
+            {
+              (sym :id)
+              (hash (pair (sym :id) _))
+              (send _ :primary_key)
+              (hash (pair (send _ :primary_key) _))
+            })
+        PATTERN
+
+        def on_send(node)
+          add_offense(offense_range(node)) if order_by_id?(node)
+        end
+
+        private
+
+        def offense_range(node)
+          range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
+        end
+      end
+    end
+  end
+end

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

@@ -13,9 +13,12 @@ module RuboCop
       #
       #   # good
       #   Rails.logger.debug 'A debug message'
-      class Output < Cop
+      class Output < Base
         MSG = 'Do not write to stdout. ' \
               "Use Rails's logger if you want to log."
+        RESTRICT_ON_SEND = %i[
+          ap p pp pretty_print print puts binwrite syswrite write write_nonblock
+        ].freeze
 
         def_node_matcher :output?, <<~PATTERN
           (send nil? {:ap :p :pp :pretty_print :print :puts} ...)
@@ -35,7 +38,7 @@ module RuboCop
           return unless (output?(node) || io_output?(node)) &&
                         node.arguments?
 
-          add_offense(node, location: :selector)
+          add_offense(node.loc.selector)
         end
 
         private

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

@@ -62,8 +62,9 @@ module RuboCop
       #   safe_join([user_content, " ", content_tag(:span, user_content)])
       #   # => ActiveSupport::SafeBuffer
       #   #    "&lt;b&gt;hi&lt;/b&gt; <span>&lt;b&gt;hi&lt;/b&gt;</span>"
-      class OutputSafety < Cop
+      class OutputSafety < Base
         MSG = 'Tagging a string as html safe may be a security risk.'
+        RESTRICT_ON_SEND = %i[html_safe raw safe_concat].freeze
 
         def on_send(node)
           return if non_interpolated_string?(node)
@@ -72,7 +73,7 @@ module RuboCop
                         looks_like_rails_raw?(node) ||
                         looks_like_rails_safe_concat?(node)
 
-          add_offense(node, location: :selector)
+          add_offense(node.loc.selector)
         end
         alias on_csend on_send
 

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

@@ -3,20 +3,26 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use `pick` over `pluck(...).first`.
+      # This cop enforces the use of `pick` over `pluck(...).first`.
+      #
+      # Using `pluck` followed by `first` creates an intermediate array, which
+      # `pick` avoids. When called on an Active Record relation, `pick` adds a
+      # limit to the query so that only one value is fetched from the database.
       #
       # @example
       #   # bad
       #   Model.pluck(:a).first
-      #   Model.pluck(:a, :b).first
+      #   [{ a: :b, c: :d }].pluck(:a, :b).first
       #
       #   # good
       #   Model.pick(:a)
-      #   Model.pick(:a, :b)
-      class Pick < Cop
+      #   [{ a: :b, c: :d }].pick(:a, :b)
+      class Pick < Base
+        extend AutoCorrector
         extend TargetRailsVersion
 
         MSG = 'Prefer `pick(%<args>s)` over `pluck(%<args>s).first`.'
+        RESTRICT_ON_SEND = %i[first].freeze
 
         minimum_target_rails_version 6.0
 
@@ -26,24 +32,24 @@ module RuboCop
 
         def on_send(node)
           pick_candidate?(node) do
-            range = node.receiver.loc.selector.join(node.loc.selector)
-            add_offense(node, location: range)
-          end
-        end
+            receiver = node.receiver
+            receiver_selector = receiver.loc.selector
+            node_selector = node.loc.selector
+            range = receiver_selector.join(node_selector)
 
-        def autocorrect(node)
-          first_range = node.receiver.source_range.end.join(node.loc.selector)
+            add_offense(range, message: message(receiver)) do |corrector|
+              first_range = receiver.source_range.end.join(node_selector)
 
-          lambda do |corrector|
-            corrector.remove(first_range)
-            corrector.replace(node.receiver.loc.selector, 'pick')
+              corrector.remove(first_range)
+              corrector.replace(receiver_selector, 'pick')
+            end
           end
         end
 
         private
 
-        def message(node)
-          format(MSG, args: node.receiver.arguments.map(&:source).join(', '))
+        def message(receiver)
+          format(MSG, args: receiver.arguments.map(&:source).join(', '))
         end
       end
     end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop enforces the use of `pluck` over `map`.
+      #
+      # `pluck` can be used instead of `map` to extract a single key from each
+      # element in an enumerable. When called on an Active Record relation, it
+      # results in a more efficient query that only selects the necessary key.
+      #
+      # @example
+      #   # bad
+      #   Post.published.map { |post| post[:title] }
+      #   [{ a: :b, c: :d }].collect { |el| el[:a] }
+      #
+      #   # good
+      #   Post.published.pluck(:title)
+      #   [{ a: :b, c: :d }].pluck(:a)
+      class Pluck < Base
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        MSG = 'Prefer `pluck(:%<value>s)` over `%<method>s { |%<argument>s| %<element>s[:%<value>s] }`.'
+
+        minimum_target_rails_version 5.0
+
+        def_node_matcher :pluck_candidate?, <<~PATTERN
+          (block (send _ ${:map :collect}) (args (arg $_argument)) (send (lvar $_element) :[] (sym $_value)))
+        PATTERN
+
+        def on_block(node)
+          pluck_candidate?(node) do |method, argument, element, value|
+            next unless argument == element
+
+            message = message(method, argument, element, value)
+
+            add_offense(offense_range(node), message: message) do |corrector|
+              corrector.replace(offense_range(node), "pluck(:#{value})")
+            end
+          end
+        end
+
+        private
+
+        def offense_range(node)
+          node.send_node.loc.selector.join(node.loc.end)
+        end
+
+        def message(method, argument, element, value)
+          format(MSG, method: method, argument: argument, element: element, value: value)
+        end
+      end
+    end
+  end
+end