rubocop 1.10.0 → 1.14.0

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

@@ -23,8 +23,7 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        MSG = 'Do not use `unless` with `else`. Rewrite these with the ' \
-              'positive case first.'
+        MSG = 'Do not use `unless` with `else`. Rewrite these with the positive case first.'
 
         def on_if(node)
           return unless node.unless? && node.else?

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for the use of logical operators in an `unless` condition.
+      # It discourages such code, as the condition becomes more difficult
+      # to read and understand.
+      #
+      # This cop supports two styles:
+      # - `forbid_mixed_logical_operators` (default)
+      # - `forbid_logical_operators`
+      #
+      # `forbid_mixed_logical_operators` style forbids the use of more than one type
+      # of logical operators. This makes the `unless` condition easier to read
+      # because either all conditions need to be met or any condition need to be met
+      # in order for the expression to be truthy or falsey.
+      #
+      # `forbid_logical_operators` style forbids any use of logical operator.
+      # This makes it even more easy to read the `unless` condition as
+      # there is only one condition in the expression.
+      #
+      # @example EnforcedStyle: forbid_mixed_logical_operators (default)
+      #   # bad
+      #   return unless a || b && c
+      #   return unless a && b || c
+      #   return unless a && b and c
+      #   return unless a || b or c
+      #   return unless a && b or c
+      #   return unless a || b and c
+      #
+      #   # good
+      #   return unless a && b && c
+      #   return unless a || b || c
+      #   return unless a and b and c
+      #   return unless a or b or c
+      #   return unless a?
+      #
+      # @example EnforcedStyle: forbid_logical_operators
+      #   # bad
+      #   return unless a || b
+      #   return unless a && b
+      #   return unless a or b
+      #   return unless a and b
+      #
+      #   # good
+      #   return unless a
+      #   return unless a?
+      class UnlessLogicalOperators < Base
+        include ConfigurableEnforcedStyle
+
+        FORBID_MIXED_LOGICAL_OPERATORS = 'Do not use mixed logical operators in an `unless`.'
+        FORBID_LOGICAL_OPERATORS = 'Do not use any logical operator in an `unless`.'
+
+        # @!method or_with_and?(node)
+        def_node_matcher :or_with_and?, <<~PATTERN
+          (if (or <`and ...> ) ...)
+        PATTERN
+
+        # @!method and_with_or?(node)
+        def_node_matcher :and_with_or?, <<~PATTERN
+          (if (and <`or ...> ) ...)
+        PATTERN
+
+        # @!method logical_operator?(node)
+        def_node_matcher :logical_operator?, <<~PATTERN
+          (if ({and or} ... ) ...)
+        PATTERN
+
+        def on_if(node)
+          return unless node.unless?
+
+          if style == :forbid_mixed_logical_operators && mixed_logical_operator?(node)
+            add_offense(node, message: FORBID_MIXED_LOGICAL_OPERATORS)
+          elsif style == :forbid_logical_operators && logical_operator?(node)
+            add_offense(node, message: FORBID_LOGICAL_OPERATORS)
+          end
+        end
+
+        private
+
+        def mixed_logical_operator?(node)
+          or_with_and?(node) ||
+            and_with_or?(node) ||
+            mixed_precedence_and?(node) ||
+            mixed_precedence_or?(node)
+        end
+
+        def mixed_precedence_and?(node)
+          and_sources = node.condition.each_descendant(:and).map(&:operator)
+          and_sources << node.condition.operator if node.condition.and_type?
+
+          !(and_sources.all?('&&') || and_sources.all?('and'))
+        end
+
+        def mixed_precedence_or?(node)
+          or_sources = node.condition.each_descendant(:or).map(&:operator)
+          or_sources << node.condition.operator if node.condition.or_type?
+
+          !(or_sources.all?('||') || or_sources.all?('or'))
+        end
+      end
+    end
+  end
+end

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

@@ -24,6 +24,7 @@ module RuboCop
           '`%<receiver>s.unpack(%<format>s)%<method>s`.'
         RESTRICT_ON_SEND = %i[first [] slice at].freeze
 
+        # @!method unpack_and_first_element?(node)
         def_node_matcher :unpack_and_first_element?, <<~PATTERN
           {
             (send $(send (...) :unpack $(...)) :first)

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

@@ -20,7 +20,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Replace interpolated variable `%<variable>s` ' \
-              'with expression `#{%<variable>s}`.'
+              'with expression `#{%<variable>s}`.' # rubocop:disable Lint/InterpolationCheck
 
         def on_node_with_interpolations(node)
           var_nodes(node.children).each do |var_node|

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

@@ -25,9 +25,7 @@ module RuboCop
         def on_when(node)
           return if node.multiline? || node.then? || !node.body
 
-          add_offense(node.loc.begin) do |corrector|
-            corrector.replace(node.loc.begin, ' then')
-          end
+          add_offense(node.loc.begin) { |corrector| corrector.replace(node.loc.begin, ' then') }
         end
       end
     end

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

@@ -37,8 +37,7 @@ module RuboCop
         include StatementModifier
         extend AutoCorrector
 
-        MSG = 'Favor modifier `%<keyword>s` usage when ' \
-              'having a single-line body.'
+        MSG = 'Favor modifier `%<keyword>s` usage when having a single-line body.'
 
         def on_while(node)
           return unless single_line_as_modifier?(node)

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

@@ -56,8 +56,7 @@ module RuboCop
         def complex_content?(strings)
           strings.any? do |s|
             string = s.str_content.dup.force_encoding(::Encoding::UTF_8)
-            !string.valid_encoding? ||
-              !word_regex.match?(string) || / /.match?(string)
+            !string.valid_encoding? || !word_regex.match?(string) || / /.match?(string)
           end
         end
 

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

@@ -59,12 +59,7 @@ module RuboCop
 
         MSG = 'Reverse the order of the operands `%<source>s`.'
 
-        REVERSE_COMPARISON = {
-          '<' => '>',
-          '<=' => '>=',
-          '>' => '<',
-          '>=' => '<='
-        }.freeze
+        REVERSE_COMPARISON = { '<' => '>', '<=' => '>=', '>' => '<', '>=' => '<=' }.freeze
 
         EQUALITY_OPERATORS = %i[== !=].freeze
 
@@ -72,6 +67,7 @@ module RuboCop
 
         PROGRAM_NAMES = %i[$0 $PROGRAM_NAME].freeze
 
+        # @!method file_constant_equal_program_name?(node)
         def_node_matcher :file_constant_equal_program_name?, <<~PATTERN
           (send #source_file_path_constant? {:== :!=} (gvar #program_name?))
         PATTERN
@@ -99,8 +95,7 @@ module RuboCop
         end
 
         def yoda_compatible_condition?(node)
-          node.comparison_method? &&
-            !noncommutative_operator?(node)
+          node.comparison_method? && !noncommutative_operator?(node)
         end
 
         def valid_yoda?(node)
@@ -126,9 +121,7 @@ module RuboCop
         end
 
         def actual_code_range(node)
-          range_between(
-            node.loc.expression.begin_pos, node.loc.expression.end_pos
-          )
+          range_between(node.loc.expression.begin_pos, node.loc.expression.end_pos)
         end
 
         def reverse_comparison(operator)

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

@@ -29,8 +29,7 @@ module RuboCop
         extend AutoCorrector
 
         ZERO_MSG = 'Use `empty?` instead of `%<lhs>s %<opr>s %<rhs>s`.'
-        NONZERO_MSG = 'Use `!empty?` instead of ' \
-                      '`%<lhs>s %<opr>s %<rhs>s`.'
+        NONZERO_MSG = 'Use `!empty?` instead of `%<lhs>s %<opr>s %<rhs>s`.'
 
         RESTRICT_ON_SEND = %i[size length].freeze
 
@@ -71,6 +70,7 @@ module RuboCop
           end
         end
 
+        # @!method zero_length_predicate(node)
         def_node_matcher :zero_length_predicate, <<~PATTERN
           {(send (send (...) ${:length :size}) $:== (int $0))
            (send (int $0) $:== (send (...) ${:length :size}))
@@ -78,6 +78,7 @@ module RuboCop
            (send (int $1) $:> (send (...) ${:length :size}))}
         PATTERN
 
+        # @!method nonzero_length_predicate(node)
         def_node_matcher :nonzero_length_predicate, <<~PATTERN
           {(send (send (...) ${:length :size}) ${:> :!=} (int $0))
            (send (int $0) ${:< :!=} (send (...) ${:length :size}))}
@@ -90,6 +91,7 @@ module RuboCop
           "!#{other_receiver(node).source}.empty?"
         end
 
+        # @!method zero_length_receiver(node)
         def_node_matcher :zero_length_receiver, <<~PATTERN
           {(send (send $_ _) :== (int 0))
            (send (int 0) :== (send $_ _))
@@ -97,6 +99,7 @@ module RuboCop
            (send (int 1) :> (send $_ _))}
         PATTERN
 
+        # @!method other_receiver(node)
         def_node_matcher :other_receiver, <<~PATTERN
           {(send (send $_ _) _ _)
            (send _ _ (send $_ _))}
@@ -105,6 +108,7 @@ module RuboCop
         # Some collection like objects in the Ruby standard library
         # implement `#size`, but not `#empty`. We ignore those to
         # reduce false positives.
+        # @!method non_polymorphic_collection?(node)
         def_node_matcher :non_polymorphic_collection?, <<~PATTERN
           {(send (send (send (const {nil? cbase} :File) :stat _) ...) ...)
            (send (send (send (const {nil? cbase} {:Tempfile :StringIO}) {:new :open} ...) ...) ...)}

data/lib/rubocop/cop/team.rb

@@ -107,9 +107,7 @@ module RuboCop
           end
         end
 
-        needed.map do |force_class, joining_cops|
-          force_class.new(joining_cops)
-        end
+        needed.map { |force_class, joining_cops| force_class.new(joining_cops) }
       end
 
       def external_dependency_checksum
@@ -247,8 +245,7 @@ module RuboCop
       end
 
       def handle_error(error, location, cop)
-        message = Rainbow("An error occurred while #{cop.name}" \
-                           " cop was inspecting #{location}.").red
+        message = Rainbow("An error occurred while #{cop.name} cop was inspecting #{location}.").red
         @errors << message
         warn message
         if debug?

data/lib/rubocop/cop/util.rb

@@ -8,8 +8,7 @@ module RuboCop
 
       # Match literal regex characters, not including anchors, character
       # classes, alternatives, groups, repetitions, references, etc
-      LITERAL_REGEX =
-        %r{[\w\s\-,"'!#%&<>=;:`~/]|\\[^AbBdDgGhHkpPRwWXsSzZ0-9]}.freeze
+      LITERAL_REGEX = %r{[\w\s\-,"'!#%&<>=;:`~/]|\\[^AbBdDgGhHkpPRwWXsSzZ0-9]}.freeze
 
       module_function
 
@@ -28,8 +27,7 @@ module RuboCop
       end
 
       def parentheses?(node)
-        node.loc.respond_to?(:end) && node.loc.end &&
-          node.loc.end.is?(')')
+        node.loc.respond_to?(:end) && node.loc.end && node.loc.end.is?(')')
       end
 
       def add_parentheses(node, corrector)
@@ -38,7 +36,10 @@ module RuboCop
         elsif node.arguments.empty?
           corrector.insert_after(node, '()')
         else
-          corrector.replace(args_begin(node), '(')
+          args_begin = args_begin(node)
+
+          corrector.remove(args_begin)
+          corrector.insert_before(args_begin, '(')
           corrector.insert_after(args_end(node), ')')
         end
       end
@@ -120,9 +121,7 @@ module RuboCop
       end
 
       def same_line?(node1, node2)
-        node1.respond_to?(:loc) &&
-          node2.respond_to?(:loc) &&
-          node1.loc.line == node2.loc.line
+        node1.respond_to?(:loc) && node2.respond_to?(:loc) && node1.loc.line == node2.loc.line
       end
 
       def indent(node)
@@ -130,9 +129,7 @@ module RuboCop
       end
 
       def to_supported_styles(enforced_style)
-        enforced_style
-          .sub(/^Enforced/, 'Supported')
-          .sub('Style', 'Styles')
+        enforced_style.sub(/^Enforced/, 'Supported').sub('Style', 'Styles')
       end
 
       private

data/lib/rubocop/cop/utils/format_string.rb

@@ -72,9 +72,7 @@ module RuboCop
           end
 
           def max_digit_dollar_num
-            @source.scan(DIGIT_DOLLAR).map do |(digit_dollar_num)|
-              digit_dollar_num.to_i
-            end.max
+            @source.scan(DIGIT_DOLLAR).map { |(digit_dollar_num)| digit_dollar_num.to_i }.max
           end
 
           def style

data/lib/rubocop/cop/variable_force.rb

@@ -27,8 +27,7 @@ module RuboCop
     class VariableForce < Force # rubocop:disable Metrics/ClassLength
       VARIABLE_ASSIGNMENT_TYPE = :lvasgn
       REGEXP_NAMED_CAPTURE_TYPE = :match_with_lvasgn
-      VARIABLE_ASSIGNMENT_TYPES =
-        [VARIABLE_ASSIGNMENT_TYPE, REGEXP_NAMED_CAPTURE_TYPE].freeze
+      VARIABLE_ASSIGNMENT_TYPES = [VARIABLE_ASSIGNMENT_TYPE, REGEXP_NAMED_CAPTURE_TYPE].freeze
 
       ARGUMENT_DECLARATION_TYPES = [
         :arg, :optarg, :restarg,
@@ -38,8 +37,7 @@ module RuboCop
       ].freeze
 
       LOGICAL_OPERATOR_ASSIGNMENT_TYPES = %i[or_asgn and_asgn].freeze
-      OPERATOR_ASSIGNMENT_TYPES =
-        (LOGICAL_OPERATOR_ASSIGNMENT_TYPES + [:op_asgn]).freeze
+      OPERATOR_ASSIGNMENT_TYPES = (LOGICAL_OPERATOR_ASSIGNMENT_TYPES + [:op_asgn]).freeze
 
       MULTIPLE_ASSIGNMENT_TYPE = :masgn
 
@@ -182,9 +180,7 @@ module RuboCop
         process_node(rhs_node)
         process_node(regexp_node)
 
-        variable_names.each do |name|
-          variable_table.assign_to_variable(name, node)
-        end
+        variable_names.each { |name| variable_table.assign_to_variable(name, node) }
 
         skip_children!
       end
@@ -304,17 +300,14 @@ module RuboCop
         return unless method_name == :binding
         return if args && !args.children.empty?
 
-        variable_table.accessible_variables.each do |variable|
-          variable.reference!(node)
-        end
+        variable_table.accessible_variables.each { |variable| variable.reference!(node) }
       end
 
       # Mark all assignments which are referenced in the same loop
       # as referenced by ignoring AST order since they would be referenced
       # in next iteration.
       def mark_assignments_as_referenced_in_loop(node)
-        referenced_variable_names_in_loop, assignment_nodes_in_loop =
-          find_variables_in_loop(node)
+        referenced_variable_names_in_loop, assignment_nodes_in_loop = find_variables_in_loop(node)
 
         referenced_variable_names_in_loop.each do |name|
           variable = variable_table.find_variable(name)
@@ -371,9 +364,7 @@ module RuboCop
 
       # Use Node#equal? for accurate check.
       def scanned_node?(node)
-        scanned_nodes.any? do |scanned_node|
-          scanned_node.equal?(node)
-        end
+        scanned_nodes.any? { |scanned_node| scanned_node.equal?(node) }
       end
 
       def scanned_nodes

data/lib/rubocop/cop/variable_force/assignment.rb

@@ -66,8 +66,7 @@ module RuboCop
 
         def meta_assignment_node
           unless instance_variable_defined?(:@meta_assignment_node)
-            @meta_assignment_node =
-              operator_assignment_node || multiple_assignment_node
+            @meta_assignment_node = operator_assignment_node || multiple_assignment_node
           end
 
           @meta_assignment_node

data/lib/rubocop/cop/variable_force/branch.rb

@@ -121,8 +121,7 @@ module RuboCop
           def ==(other)
             return false unless other
 
-            control_node.equal?(other.control_node) &&
-              child_node.equal?(other.child_node)
+            control_node.equal?(other.control_node) && child_node.equal?(other.child_node)
           end
 
           alias_method :eql?, :==
@@ -227,6 +226,21 @@ module RuboCop
           end
         end
 
+        # case target
+        # in pattern # in_pattern
+        # else
+        #   else_body
+        # end
+        class CaseMatch < Base
+          define_predicate :target?,     child_index: 0
+          define_predicate :in_pattern?, child_index: 1..-2
+          define_predicate :else_body?,  child_index: -1
+
+          def always_run?
+            target?
+          end
+        end
+
         # for element in collection
         #   loop_body
         # end