rubocop 0.59.2 → 0.60.0

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

@@ -7,6 +7,8 @@ module RuboCop
       # validations which are listed in
       # http://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)
@@ -23,6 +25,16 @@ module RuboCop
       #   # 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.'.freeze
 
@@ -42,6 +54,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
+          return if whitelist.include?(node.method_name.to_s)
           return unless blacklist.include?(node.method_name.to_s)
 
           _receiver, method_name, *args = *node
@@ -64,6 +77,10 @@ module RuboCop
         def blacklist
           cop_config['Blacklist'] || []
         end
+
+        def whitelist
+          cop_config['Whitelist'] || []
+        end
       end
     end
   end

data/lib/rubocop/cop/registry.rb

@@ -117,9 +117,18 @@ module RuboCop
         @registry.size
       end
 
-      def enabled(config, only)
+      def enabled(config, only, only_safe = false)
         select do |cop|
-          config.for_cop(cop).fetch('Enabled') || only.include?(cop.cop_name)
+          only.include?(cop.cop_name) || enabled?(cop, config, only_safe)
+        end
+      end
+
+      def enabled?(cop, config, only_safe)
+        cfg = config.for_cop(cop)
+        if only_safe
+          cfg.fetch('Enabled') && cfg.fetch('Safe', true)
+        else
+          cfg.fetch('Enabled')
         end
       end
 

data/lib/rubocop/cop/style/and_or.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for uses of `and` and `or`, and suggests using `&&` and
-      # `||` instead. It can be configured to check only in conditions, or in
+      # `||` instead. It can be configured to check only in conditions or in
       # all contexts.
       #
       # @example EnforcedStyle: always (default)
@@ -74,8 +74,8 @@ module RuboCop
         private
 
         def on_conditionals(node)
-          node.condition.each_node(*LOGICAL_OPERATOR_NODES) do |logical_node|
-            process_logical_operator(logical_node)
+          node.condition.each_node(*AST::Node::OPERATOR_KEYWORDS) do |operator|
+            process_logical_operator(operator)
           end
         end
 

data/lib/rubocop/cop/style/collection_methods.rb

@@ -9,6 +9,32 @@ module RuboCop
       # Unfortunately we cannot actually know if a method is from
       # Enumerable or not (static analysis limitation), so this cop
       # can yield some false positives.
+      #
+      # You can customize the mapping from undesired method to desired method.
+      #
+      # e.g. to use `detect` over `find`:
+      #
+      #   Style/CollectionMethods:
+      #     PreferredMethods:
+      #       find: detect
+      #
+      # The default mapping for `PreferredMethods` behaves as follows.
+      #
+      # @example
+      #   # bad
+      #   items.collect
+      #   items.collect!
+      #   items.inject
+      #   items.detect
+      #   items.find_all
+      #
+      #   # good
+      #   items.map
+      #   items.map!
+      #   items.reduce
+      #   items.find
+      #   items.select
+      #
       class CollectionMethods < Cop
         include MethodPreference
 

data/lib/rubocop/cop/style/empty_literal.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for the use of a method, the result of which
-      # would be a literal, like an empty array, hash or string.
+      # would be a literal, like an empty array, hash, or string.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/encoding.rb

@@ -13,7 +13,7 @@ module RuboCop
         include RangeHelp
 
         MSG_UNNECESSARY = 'Unnecessary utf-8 encoding comment.'.freeze
-        ENCODING_PATTERN = /#.*coding\s?[:=]\s?(?:UTF|utf)-8/
+        ENCODING_PATTERN = /#.*coding\s?[:=]\s?(?:UTF|utf)-8/.freeze
         SHEBANG = '#!'.freeze
 
         def investigate(processed_source)

data/lib/rubocop/cop/style/even_odd.rb

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for places where Integer#even? or Integer#odd?
-      # should have been used.
+      # This cop checks for places where `Integer#even?` or `Integer#odd?`
+      # can be used.
       #
       # @example
       #

data/lib/rubocop/cop/style/for.rb

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Style
-      # This cop looks for uses of the *for* keyword, or *each* method. The
+      # This cop looks for uses of the `for` keyword or `each` method. The
       # preferred alternative is set in the EnforcedStyle configuration
-      # parameter. An *each* call with a block on a single line is always
-      # allowed, however.
+      # parameter. An `each` call with a block on a single line is always
+      # allowed.
       #
       # @example EnforcedStyle: each (default)
       #   # bad

data/lib/rubocop/cop/style/global_vars.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cops looks for uses of global variables.
+      # This cop looks for uses of global variables.
       # It does not report offenses for built-in global variables.
       # Built-in global variables are allowed by default. Additionally
       # users can allow additional variables via the AllowedVariables option.

data/lib/rubocop/cop/style/identical_conditional_branches.rb

@@ -71,7 +71,7 @@ module RuboCop
           branches = expand_elses(node.else_branch).unshift(node.if_branch)
 
           # return if any branch is empty. An empty branch can be an `if`
-          # without an `else`, or a branch that contains only comments.
+          # without an `else` or a branch that contains only comments.
           return if branches.any?(&:nil?)
 
           check_branches(branches)

data/lib/rubocop/cop/style/if_unless_modifier.rb

@@ -31,8 +31,6 @@ module RuboCop
         ASSIGNMENT_TYPES = %i[lvasgn casgn cvasgn
                               gvasgn ivasgn masgn].freeze
 
-        NAMED_CAPTURE = /\?<.+>/
-
         def on_if(node)
           return unless eligible_node?(node)
           return if named_capture_in_condition?(node)
@@ -69,17 +67,7 @@ module RuboCop
           return false if node.parent.nil?
           return true if ASSIGNMENT_TYPES.include?(node.parent.type)
 
-          if node.parent.send_type?
-            _receiver, _name, *args = *node.parent
-            return !method_uses_parens?(node.parent, args.first)
-          end
-
-          false
-        end
-
-        def method_uses_parens?(node, limit)
-          source = node.source_range.source_line[0...limit.loc.column]
-          source =~ /\s*\(\s*$/
+          node.parent.send_type? && !node.parent.parenthesized?
         end
 
         def to_modifier_form(node)

data/lib/rubocop/cop/style/infinite_loop.rb

@@ -16,7 +16,7 @@ module RuboCop
       #     work
       #   end
       class InfiniteLoop < Cop
-        LEADING_SPACE = /\A(\s*)/
+        LEADING_SPACE = /\A(\s*)/.freeze
 
         MSG = 'Use `Kernel#loop` for infinite loops.'.freeze
 

data/lib/rubocop/cop/style/inverse_methods.rb

@@ -35,7 +35,7 @@ module RuboCop
         CLASS_COMPARISON_METHODS = %i[<= >= < >].freeze
         EQUALITY_METHODS = %i[== != =~ !~ <= >= < >].freeze
         NEGATED_EQUALITY_METHODS = %i[!= !~].freeze
-        CAMEL_CASE = /[A-Z]+[a-z]+/
+        CAMEL_CASE = /[A-Z]+[a-z]+/.freeze
 
         def_node_matcher :inverse_candidate?, <<-PATTERN
           {

data/lib/rubocop/cop/style/method_call_without_args_parentheses.rb

@@ -17,15 +17,13 @@ module RuboCop
         MSG = 'Do not use parentheses for method calls with ' \
               'no arguments.'.freeze
 
-        ASGN_NODES = %i[lvasgn masgn] + SHORTHAND_ASGN_NODES
-
         def on_send(node)
           return if ineligible_node?(node)
           return unless !node.arguments? && node.parenthesized?
           return if ignored_method?(node.method_name)
           return if same_name_assignment?(node)
 
-          add_offense(node, location: :begin)
+          add_offense(node, location: node.loc.begin.join(node.loc.end))
         end
 
         def autocorrect(node)
@@ -52,14 +50,13 @@ module RuboCop
         end
 
         def any_assignment?(node)
-          node.each_ancestor(*ASGN_NODES).any? do |asgn_node|
+          node.each_ancestor(*AST::Node::ASSIGNMENTS).any? do |asgn_node|
             # `obj.method = value` parses as (send ... :method= ...), and will
             # not be returned as an `asgn_node` here, however,
             # `obj.method ||= value` parses as (or-asgn (send ...) ...)
             # which IS an `asgn_node`. Similarly, `obj.method += value` parses
             # as (op-asgn (send ...) ...), which is also an `asgn_node`.
-            if asgn_node.or_asgn_type? || asgn_node.and_asgn_type? ||
-               asgn_node.op_asgn_type?
+            if asgn_node.shorthand_asgn?
               asgn_node, _value = *asgn_node
               next if asgn_node.send_type?
             end
@@ -72,7 +69,7 @@ module RuboCop
           mlhs_node, _mrhs_node = *node
           var_nodes = *mlhs_node
 
-          var_nodes.map { |n| n.to_a.first }.include?(variable_name)
+          var_nodes.any? { |n| n.to_a.first == variable_name }
         end
       end
     end

data/lib/rubocop/cop/style/method_def_parentheses.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cops checks for parentheses around the arguments in method
+      # This cop checks for parentheses around the arguments in method
       # definitions. Both instance and class/singleton methods are checked.
       #
       # @example EnforcedStyle: require_parentheses (default)

data/lib/rubocop/cop/style/module_function.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cops checks for use of `extend self` or `module_function` in a
+      # This cop checks for use of `extend self` or `module_function` in a
       # module.
       #
       # Supported styles are: module_function, extend_self.

data/lib/rubocop/cop/style/multiline_if_then.rb

@@ -20,7 +20,7 @@ module RuboCop
         include OnNormalIfUnless
         include RangeHelp
 
-        NON_MODIFIER_THEN = /then\s*(#.*)?$/
+        NON_MODIFIER_THEN = /then\s*(#.*)?$/.freeze
 
         MSG = 'Do not use `then` for multi-line `%<keyword>s`.'.freeze
 

data/lib/rubocop/cop/style/mutable_constant.rb

@@ -42,6 +42,9 @@ module RuboCop
             if node.array_type? && !node.bracketed?
               corrector.insert_before(expr, '[')
               corrector.insert_after(expr, '].freeze')
+            elsif node.irange_type? || node.erange_type?
+              corrector.insert_before(expr, '(')
+              corrector.insert_after(expr, ').freeze')
             else
               corrector.insert_after(expr, '.freeze')
             end
@@ -51,18 +54,29 @@ module RuboCop
         private
 
         def on_assignment(value)
+          range_enclosed_in_parentheses = range_enclosed_in_parentheses?(value)
+
           value = splat_value(value) if splat_value(value)
 
-          return unless value && value.mutable_literal?
+          return unless mutable_literal?(value) ||
+                        range_enclosed_in_parentheses
           return if FROZEN_STRING_LITERAL_TYPES.include?(value.type) &&
                     frozen_string_literals_enabled?
 
           add_offense(value)
         end
 
+        def mutable_literal?(value)
+          value && value.mutable_literal?
+        end
+
         def_node_matcher :splat_value, <<-PATTERN
           (array (splat $_))
         PATTERN
+
+        def_node_matcher :range_enclosed_in_parentheses?, <<-PATTERN
+          (begin ({irange erange} _ _))
+        PATTERN
       end
     end
   end

data/lib/rubocop/cop/style/nested_modifier.rb

@@ -39,7 +39,7 @@ module RuboCop
         end
 
         def modifier?(node)
-          node && MODIFIER_NODES.include?(node.type) && node.modifier_form?
+          node && node.basic_conditional? && node.modifier_form?
         end
 
         def autocorrect(node)

data/lib/rubocop/cop/style/not.rb

@@ -53,7 +53,8 @@ module RuboCop
         end
 
         def requires_parens?(child)
-          child.and_type? || child.or_type? || child.binary_operation? ||
+          child.and_type? || child.or_type? ||
+            child.send_type? && child.binary_operation? ||
             child.if_type? && child.ternary?
         end
 

data/lib/rubocop/cop/style/numeric_literal_prefix.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for octal, hex, binary and decimal literals using
+      # This cop checks for octal, hex, binary, and decimal literals using
       # uppercase prefixes and corrects them to lowercase prefix
       # or no prefix (in case of decimals).
       #
@@ -36,11 +36,11 @@ module RuboCop
       class NumericLiteralPrefix < Cop
         include IntegerNode
 
-        OCTAL_ZERO_ONLY_REGEX = /^0[Oo][0-7]+$/
-        OCTAL_REGEX = /^0O?[0-7]+$/
-        HEX_REGEX = /^0X[0-9A-F]+$/
-        BINARY_REGEX = /^0B[01]+$/
-        DECIMAL_REGEX = /^0[dD][0-9]+$/
+        OCTAL_ZERO_ONLY_REGEX = /^0[Oo][0-7]+$/.freeze
+        OCTAL_REGEX = /^0O?[0-7]+$/.freeze
+        HEX_REGEX = /^0X[0-9A-F]+$/.freeze
+        BINARY_REGEX = /^0B[01]+$/.freeze
+        DECIMAL_REGEX = /^0[dD][0-9]+$/.freeze
 
         OCTAL_ZERO_ONLY_MSG = 'Use 0 for octal literals.'.freeze
         OCTAL_MSG = 'Use 0o for octal literals.'.freeze

data/lib/rubocop/cop/style/numeric_literals.rb

@@ -30,7 +30,7 @@ module RuboCop
         include ConfigurableMax
         include IntegerNode
 
-        MSG = 'Use underscores(_) as decimal mark and ' \
+        MSG = 'Use underscores(_) as thousands separator and ' \
               'separate every 3 digits with them.'.freeze
 
         def on_int(node)

data/lib/rubocop/cop/style/numeric_predicate.rb

@@ -109,7 +109,7 @@ module RuboCop
         end
 
         def require_parentheses?(node)
-          node.binary_operation? && node.source !~ /^\(.*\)$/
+          node.send_type? && node.binary_operation? && !node.parenthesized?
         end
 
         def replacement_supported?(operator)

data/lib/rubocop/cop/style/one_line_conditional.rb

@@ -53,7 +53,7 @@ module RuboCop
             return "(#{to_ternary(node)})"
           end
 
-          if node.parent.send_type? && operator?(node.parent.method_name)
+          if node.parent.send_type? && node.parent.operator_method?
             return "(#{to_ternary(node)})"
           end
 
@@ -82,7 +82,7 @@ module RuboCop
           return false unless node.send_type? && node.arguments?
           return false if node.parenthesized_call?
 
-          !operator?(node.method_name)
+          !node.operator_method?
         end
 
         def keyword_with_changed_precedence?(node)

data/lib/rubocop/cop/style/parentheses_around_condition.rb

@@ -79,7 +79,7 @@ module RuboCop
           return false if node.if_type? && node.ternary?
           return true if node.rescue_type?
 
-          MODIFIER_NODES.include?(node.type) && node.modifier_form?
+          node.basic_conditional? && node.modifier_form?
         end
 
         def message(node)

data/lib/rubocop/cop/style/proc.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cops checks for uses of Proc.new where Kernel#proc
+      # This cop checks for uses of Proc.new where Kernel#proc
       # would be more appropriate.
       #
       # @example