rubocop-rails 2.5.0 → 2.7.1

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}(#{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}: " }

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

@@ -9,11 +9,11 @@ module RuboCop
       #
       # There are two obvious cases where `exit` is particularly harmful:
       #
-      # - Usage in library code for your application. Even though Rails will
+      # * Usage in library code for your application. Even though Rails will
       # rescue from a `SystemExit` and continue on, unit testing that library
       # code will result in specs exiting (potentially silently if `exit(0)`
       # is used.)
-      # - Usage in application code outside of the web process could result in
+      # * Usage in application code outside of the web process could result in
       # the program exiting, which could result in the code failing to run and
       # do its job.
       #

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

@@ -48,6 +48,7 @@ module RuboCop
 
         def on_dstr(node)
           return unless rails_root_nodes?(node)
+          return unless node.children.last.str_type?
           return unless node.children.last.source.start_with?('.') ||
                         node.children.last.source.include?(File::SEPARATOR)
 
@@ -89,7 +90,7 @@ module RuboCop
         end
 
         def string_with_slash?(node)
-          node.str_type? && node.source =~ %r{/}
+          node.str_type? && node.source.match?(%r{/})
         end
 
         def register_offense(node)

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop enforces that `ActiveRecord#find` is used instead of
+      # `where.take!`, `find_by!`, and `find_by_id!` to retrieve a single record
+      # by primary key when you expect it to be found.
+      #
+      # @example
+      #   # bad
+      #   User.where(id: id).take!
+      #   User.find_by_id!(id)
+      #   User.find_by!(id: id)
+      #
+      #   # good
+      #   User.find(id)
+      #
+      class FindById < Cop
+        include RangeHelp
+
+        MSG = 'Use `%<good_method>s` instead of `%<bad_method>s`.'
+
+        def_node_matcher :where_take?, <<~PATTERN
+          (send
+            $(send _ :where
+              (hash
+                (pair (sym :id) $_))) :take!)
+        PATTERN
+
+        def_node_matcher :find_by?, <<~PATTERN
+          {
+            (send _ :find_by_id! $_)
+            (send _ :find_by! (hash (pair (sym :id) $_)))
+          }
+        PATTERN
+
+        def on_send(node)
+          where_take?(node) do |where, id_value|
+            range = where_take_offense_range(node, where)
+
+            good_method = build_good_method(id_value)
+            bad_method = build_where_take_bad_method(id_value)
+            message = format(MSG, good_method: good_method, bad_method: bad_method)
+
+            add_offense(node, location: range, message: message)
+          end
+
+          find_by?(node) do |id_value|
+            range = find_by_offense_range(node)
+
+            good_method = build_good_method(id_value)
+            bad_method = build_find_by_bad_method(node, id_value)
+            message = format(MSG, good_method: good_method, bad_method: bad_method)
+
+            add_offense(node, location: range, message: message)
+          end
+        end
+
+        def autocorrect(node)
+          if (matches = where_take?(node))
+            where, id_value = *matches
+            range = where_take_offense_range(node, where)
+          elsif (id_value = find_by?(node))
+            range = find_by_offense_range(node)
+          end
+
+          lambda do |corrector|
+            replacement = build_good_method(id_value)
+            corrector.replace(range, replacement)
+          end
+        end
+
+        private
+
+        def where_take_offense_range(node, where)
+          range_between(where.loc.selector.begin_pos, node.loc.expression.end_pos)
+        end
+
+        def find_by_offense_range(node)
+          range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+        end
+
+        def build_good_method(id_value)
+          "find(#{id_value.source})"
+        end
+
+        def build_where_take_bad_method(id_value)
+          "where(id: #{id_value.source}).take!"
+        end
+
+        def build_find_by_bad_method(node, id_value)
+          case node.method_name
+          when :find_by_id!
+            "find_by_id!(#{id_value.source})"
+          when :find_by!
+            "find_by!(id: #{id_value.source})"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module RuboCop
       # change them to use keyword args. This cop only applies to Rails >= 5.
       # If you are running Rails < 5 you should disable the
       # Rails/HttpPositionalArguments cop or set your TargetRailsVersion in your
-      # .rubocop.yml file to 4.0, etc.
+      # .rubocop.yml file to 4.2.
       #
       # @example
       #   # bad

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

@@ -83,6 +83,7 @@ module RuboCop
                         'to define HTTP status code.'
 
           attr_reader :node
+
           def initialize(node)
             @node = node
           end
@@ -124,6 +125,7 @@ module RuboCop
           PERMITTED_STATUS = %i[error success missing redirect].freeze
 
           attr_reader :node
+
           def initialize(node)
             @node = node
           end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks that Active Support's `inquiry` method is not used.
+      #
+      # @example
+      #   # bad - String#inquiry
+      #   ruby = 'two'.inquiry
+      #   ruby.two?
+      #
+      #   # good
+      #   ruby = 'two'
+      #   ruby == 'two'
+      #
+      #   # bad - Array#inquiry
+      #   pets = %w(cat dog).inquiry
+      #   pets.gopher?
+      #
+      #   # good
+      #   pets = %w(cat dog)
+      #   pets.include? 'cat'
+      #
+      class Inquiry < Cop
+        MSG = "Prefer Ruby's comparison operators over Active Support's `inquiry`."
+
+        def on_send(node)
+          add_offense(node, location: :selector) if node.method?(:inquiry) && node.arguments.empty?
+        end
+      end
+    end
+  end
+end