rubocop-rails 2.4.1

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks for scope calls where it was passed
+      # a method (usually a scope) instead of a lambda/proc.
+      #
+      # @example
+      #
+      #   # bad
+      #   scope :something, where(something: true)
+      #
+      #   # good
+      #   scope :something, -> { where(something: true) }
+      class ScopeArgs < Cop
+        MSG = 'Use `lambda`/`proc` instead of a plain method call.'
+
+        def_node_matcher :scope?, '(send nil? :scope _ $send)'
+
+        def on_send(node)
+          scope?(node) do |second_arg|
+            add_offense(second_arg)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks for the use of methods which skip
+      # validations which are listed in
+      # https://guides.rubyonrails.org/active_record_validations.html#skipping-validations
+      #
+      # Methods may be ignored from this rule by configuring a `Whitelist`.
+      #
+      # @example
+      #   # bad
+      #   Article.first.decrement!(:view_count)
+      #   DiscussionBoard.decrement_counter(:post_count, 5)
+      #   Article.first.increment!(:view_count)
+      #   DiscussionBoard.increment_counter(:post_count, 5)
+      #   person.toggle :active
+      #   product.touch
+      #   Billing.update_all("category = 'authorized', author = 'David'")
+      #   user.update_attribute(:website, 'example.com')
+      #   user.update_columns(last_request_at: Time.current)
+      #   Post.update_counters 5, comment_count: -1, action_count: 1
+      #
+      #   # good
+      #   user.update(website: 'example.com')
+      #   FileUtils.touch('file')
+      #
+      # @example Whitelist: ["touch"]
+      #   # bad
+      #   DiscussionBoard.decrement_counter(:post_count, 5)
+      #   DiscussionBoard.increment_counter(:post_count, 5)
+      #   person.toggle :active
+      #
+      #   # good
+      #   user.touch
+      #
+      class SkipsModelValidations < Cop
+        MSG = 'Avoid using `%<method>s` because it skips validations.'
+
+        METHODS_WITH_ARGUMENTS = %w[decrement!
+                                    decrement_counter
+                                    increment!
+                                    increment_counter
+                                    toggle!
+                                    update_all
+                                    update_attribute
+                                    update_column
+                                    update_columns
+                                    update_counters].freeze
+
+        def_node_matcher :good_touch?, <<~PATTERN
+          (send (const nil? :FileUtils) :touch ...)
+        PATTERN
+
+        def on_send(node)
+          return if whitelist.include?(node.method_name.to_s)
+          return unless blacklist.include?(node.method_name.to_s)
+          return if allowed_method?(node)
+          return if good_touch?(node)
+
+          add_offense(node, location: :selector)
+        end
+        alias on_csend on_send
+
+        private
+
+        def message(node)
+          format(MSG, method: node.method_name)
+        end
+
+        def allowed_method?(node)
+          METHODS_WITH_ARGUMENTS.include?(node.method_name.to_s) &&
+            !node.arguments?
+        end
+
+        def blacklist
+          cop_config['Blacklist'] || []
+        end
+
+        def whitelist
+          cop_config['Whitelist'] || []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks for the use of Time methods without zone.
+      #
+      # Built on top of Ruby on Rails style guide (https://rails.rubystyle.guide#time)
+      # and the article http://danilenko.org/2012/7/6/rails_timezones/
+      #
+      # Two styles are supported for this cop. When EnforcedStyle is 'strict'
+      # then only use of Time.zone is allowed.
+      #
+      # When EnforcedStyle is 'flexible' then it's also allowed
+      # to use Time.in_time_zone.
+      #
+      # @example EnforcedStyle: strict
+      #   # `strict` means that `Time` should be used with `zone`.
+      #
+      #   # bad
+      #   Time.now
+      #   Time.parse('2015-03-02 19:05:37')
+      #
+      #   # bad
+      #   Time.current
+      #   Time.at(timestamp).in_time_zone
+      #
+      #   # good
+      #   Time.zone.now
+      #   Time.zone.parse('2015-03-02 19:05:37')
+      #
+      # @example EnforcedStyle: flexible (default)
+      #   # `flexible` allows usage of `in_time_zone` instead of `zone`.
+      #
+      #   # bad
+      #   Time.now
+      #   Time.parse('2015-03-02 19:05:37')
+      #
+      #   # good
+      #   Time.zone.now
+      #   Time.zone.parse('2015-03-02 19:05:37')
+      #
+      #   # good
+      #   Time.current
+      #   Time.at(timestamp).in_time_zone
+      class TimeZone < Cop
+        include ConfigurableEnforcedStyle
+
+        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_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 current].freeze
+
+        ACCEPTED_METHODS = %i[in_time_zone utc getlocal xmlschema iso8601
+                              jisx0301 rfc3339 httpdate to_i to_f].freeze
+
+        def on_const(node)
+          mod, klass = *node
+          # we should only check core classes
+          # (`Time` or `::Time`)
+          return unless (mod.nil? || mod.cbase_type?) && method_send?(node)
+
+          check_time_node(klass, node.parent) if klass == :Time
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            # add `.zone`: `Time.at` => `Time.zone.at`
+            corrector.insert_after(node.children[0].source_range, '.zone')
+
+            case node.method_name
+            when :current
+              # replace `Time.zone.current` => `Time.zone.now`
+              corrector.replace(node.loc.selector, 'now')
+            when :new
+              autocorrect_time_new(node, corrector)
+            end
+
+            # prefer `Time` over `DateTime` class
+            if strict?
+              corrector.replace(node.children.first.source_range, 'Time')
+            end
+            remove_redundant_in_time_zone(corrector, node)
+          end
+        end
+
+        private
+
+        def autocorrect_time_new(node, corrector)
+          if node.arguments?
+            corrector.replace(node.loc.selector, 'local')
+          else
+            corrector.replace(node.loc.selector, 'now')
+          end
+        end
+
+        # 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)
+
+          while node&.send_type?
+            if node.children.last == :in_time_zone
+              in_time_zone_with_dot =
+                node.loc.selector.adjust(begin_pos: -1)
+              corrector.remove(in_time_zone_with_dot)
+            end
+            node = node.parent
+          end
+        end
+
+        def check_time_node(klass, node)
+          chain = extract_method_chain(node)
+          return if not_danger_chain?(chain)
+
+          return check_localtime(node) if need_check_localtime?(chain)
+
+          method_name = (chain & DANGEROUS_METHODS).join('.')
+
+          return if offset_provided?(node)
+
+          message = build_message(klass, method_name, node)
+
+          add_offense(node, location: :selector, message: message)
+        end
+
+        def build_message(klass, method_name, node)
+          if flexible?
+            format(
+              MSG_ACCEPTABLE,
+              current: "#{klass}.#{method_name}",
+              prefer: acceptable_methods(klass, method_name, node).join(', ')
+            )
+          else
+            safe_method_name = safe_method(method_name, node)
+            format(MSG,
+                   current: "#{klass}.#{method_name}",
+                   prefer: "Time.zone.#{safe_method_name}")
+          end
+        end
+
+        def extract_method_chain(node)
+          chain = []
+          while !node.nil? && node.send_type?
+            chain << node.method_name if method_from_time_class?(node)
+            node = node.parent
+          end
+          chain
+        end
+
+        # Only add the method to the chain if the method being
+        # called is part of the time class.
+        def method_from_time_class?(node)
+          receiver, method_name, *_args = *node
+          if (receiver.is_a? RuboCop::AST::Node) && !receiver.cbase_type?
+            method_from_time_class?(receiver)
+          else
+            method_name == :Time
+          end
+        end
+
+        # checks that parent node of send_type
+        # and receiver is the given node
+        def method_send?(node)
+          return false unless node.parent&.send_type?
+
+          node.parent.receiver == node
+        end
+
+        def safe_method(method_name, node)
+          if %w[new current].include?(method_name)
+            node.arguments? ? 'local' : 'now'
+          else
+            method_name
+          end
+        end
+
+        def check_localtime(node)
+          selector_node = node
+
+          while node&.send_type?
+            break if node.method?(:localtime)
+
+            node = node.parent
+          end
+
+          return if node.arguments?
+
+          add_offense(selector_node,
+                      location: :selector, message: MSG_LOCALTIME)
+        end
+
+        def not_danger_chain?(chain)
+          (chain & DANGEROUS_METHODS).empty? || !(chain & good_methods).empty?
+        end
+
+        def need_check_localtime?(chain)
+          flexible? && chain.include?(:localtime)
+        end
+
+        def flexible?
+          style == :flexible
+        end
+
+        def strict?
+          style == :strict
+        end
+
+        def good_methods
+          if strict?
+            GOOD_METHODS
+          else
+            GOOD_METHODS + [:current] + ACCEPTED_METHODS
+          end
+        end
+
+        def acceptable_methods(klass, method_name, node)
+          acceptable = [
+            "`Time.zone.#{safe_method(method_name, node)}`",
+            "`#{klass}.current`"
+          ]
+
+          ACCEPTED_METHODS.each do |am|
+            acceptable << "`#{klass}.#{method_name}.#{am}`"
+          end
+
+          acceptable
+        end
+
+        # Time.new 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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Prefer the use of uniq (or distinct), before pluck instead of after.
+      #
+      # The use of uniq before pluck is preferred because it executes within
+      # the database.
+      #
+      # This cop has two different enforcement modes. When the EnforcedStyle
+      # is conservative (the default) then only calls to pluck on a constant
+      # (i.e. a model class) before uniq are added as offenses.
+      #
+      # When the EnforcedStyle is aggressive then all calls to pluck before
+      # uniq are added as offenses. This may lead to false positives as the cop
+      # cannot distinguish between calls to pluck on an ActiveRecord::Relation
+      # vs a call to pluck on an ActiveRecord::Associations::CollectionProxy.
+      #
+      # Autocorrect is disabled by default for this cop since it may generate
+      # false positives.
+      #
+      # @example EnforcedStyle: conservative (default)
+      #   # bad
+      #   Model.pluck(:id).uniq
+      #
+      #   # good
+      #   Model.uniq.pluck(:id)
+      #
+      # @example EnforcedStyle: aggressive
+      #   # bad
+      #   # this will return a Relation that pluck is called on
+      #   Model.where(cond: true).pluck(:id).uniq
+      #
+      #   # bad
+      #   # an association on an instance will return a CollectionProxy
+      #   instance.assoc.pluck(:id).uniq
+      #
+      #   # bad
+      #   Model.pluck(:id).uniq
+      #
+      #   # good
+      #   Model.uniq.pluck(:id)
+      #
+      class UniqBeforePluck < RuboCop::Cop::Cop
+        include ConfigurableEnforcedStyle
+        include RangeHelp
+
+        MSG = 'Use `%<method>s` before `pluck`.'
+        NEWLINE = "\n"
+        PATTERN = '[!^block (send (send %<type>s :pluck ...) ' \
+                  '${:uniq :distinct} ...)]'
+
+        def_node_matcher :conservative_node_match,
+                         format(PATTERN, type: 'const')
+
+        def_node_matcher :aggressive_node_match,
+                         format(PATTERN, type: '_')
+
+        def on_send(node)
+          method = if style == :conservative
+                     conservative_node_match(node)
+                   else
+                     aggressive_node_match(node)
+                   end
+
+          return unless method
+
+          add_offense(node, location: :selector,
+                            message: format(MSG, method: method))
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            method = node.method_name
+
+            corrector.remove(dot_method_with_whitespace(method, node))
+            corrector.insert_before(node.receiver.loc.dot.begin, ".#{method}")
+          end
+        end
+
+        private
+
+        def style_parameter_name
+          'EnforcedStyle'
+        end
+
+        def dot_method_with_whitespace(method, node)
+          range_between(dot_method_begin_pos(method, node),
+                        node.loc.selector.end_pos)
+        end
+
+        def dot_method_begin_pos(method, node)
+          lines = node.source.split(NEWLINE)
+
+          if lines.last.strip == ".#{method}"
+            node.source.rindex(NEWLINE)
+          else
+            node.loc.dot.begin_pos
+          end
+        end
+      end
+    end
+  end
+end