rubocop 0.51.0 → 0.52.0

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

@@ -4,12 +4,31 @@ module RuboCop
   module Cop
     module Style
       # Checks for while and until statements that would fit on one line
-      # if written as a modifier while/until.
-      # The maximum line length is configurable.
+      # if written as a modifier while/until. The maximum line length is
+      # configured in the `Metrics/LineLength` cop.
+      #
+      # @example
+      #   # bad
+      #   while x < 10
+      #     x += 1
+      #   end
+      #
+      #   # good
+      #   x += 1 while x < 10
+      #
+      # @example
+      #   # bad
+      #   until x > 10
+      #     x += 1
+      #   end
+      #
+      #   # good
+      #   x += 1 until x > 10
       class WhileUntilModifier < Cop
         include StatementModifier
 
-        MSG = 'Favor modifier `%s` usage when having a single-line body.'.freeze
+        MSG = 'Favor modifier `%<keyword>s` usage when ' \
+              'having a single-line body.'.freeze
 
         def on_while(node)
           check(node)
@@ -19,8 +38,6 @@ module RuboCop
           check(node)
         end
 
-        private
-
         def autocorrect(node)
           oneline = "#{node.body.source} #{node.keyword} " \
                     "#{node.condition.source}"
@@ -30,11 +47,13 @@ module RuboCop
           end
         end
 
+        private
+
         def check(node)
           return unless node.multiline? && single_line_as_modifier?(node)
 
           add_offense(node, location: :keyword,
-                            message: format(MSG, node.keyword))
+                            message: format(MSG, keyword: node.keyword))
         end
       end
     end

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

@@ -14,18 +14,14 @@ module RuboCop
       # cop. For example, a `MinSize` of `3` will not enforce a style on an
       # array of 2 or fewer elements.
       #
-      # @example
-      #   EnforcedStyle: percent (default)
-      #
+      # @example EnforcedStyle: percent (default)
       #   # good
       #   %w[foo bar baz]
       #
       #   # bad
       #   ['foo', 'bar', 'baz']
       #
-      # @example
-      #   EnforcedStyle: brackets
-      #
+      # @example EnforcedStyle: brackets
       #   # good
       #   ['foo', 'bar', 'baz']
       #
@@ -56,8 +52,6 @@ module RuboCop
           end
         end
 
-        private
-
         def autocorrect(node)
           if style == :percent
             correct_percent(node, 'w')
@@ -66,6 +60,8 @@ module RuboCop
           end
         end
 
+        private
+
         def check_bracketed_array(node)
           return if allowed_bracket_array?(node)
 

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

@@ -7,10 +7,7 @@ module RuboCop
       # readability is reduced because the operands are not ordered the same
       # way as they would be ordered in spoken English.
       #
-      # @example
-      #
-      #   # EnforcedStyle: all_comparison_operators
-      #
+      # @example EnforcedStyle: all_comparison_operators (default)
       #   # bad
       #   99 == foo
       #   "bar" != foo
@@ -23,10 +20,7 @@ module RuboCop
       #   foo <= 42
       #   bar > 10
       #
-      # @example
-      #
-      #   # EnforcedStyle: equality_operators_only
-      #
+      # @example EnforcedStyle: equality_operators_only
       #   # bad
       #   99 == foo
       #   "bar" != foo
@@ -37,7 +31,7 @@ module RuboCop
       class YodaCondition < Cop
         include ConfigurableEnforcedStyle
 
-        MSG = 'Reverse the order of the operands `%s`.'.freeze
+        MSG = 'Reverse the order of the operands `%<source>s`.'.freeze
 
         REVERSE_COMPARISON = {
           '<' => '>',
@@ -56,6 +50,12 @@ module RuboCop
           add_offense(node)
         end
 
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(actual_code_range(node), corrected_code(node))
+          end
+        end
+
         private
 
         def yoda_condition?(node)
@@ -72,13 +72,7 @@ module RuboCop
         end
 
         def message(node)
-          format(MSG, node.source)
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(actual_code_range(node), corrected_code(node))
-          end
+          format(MSG, source: node.source)
         end
 
         def corrected_code(node)

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

@@ -10,8 +10,7 @@ module RuboCop
       # replaced by receiver.empty? and !receiver.empty.
       #
       # @example
-      #
-      #   @bad
+      #   # bad
       #   [1, 2, 3].length == 0
       #   0 == "foobar".length
       #   array.length < 1
@@ -19,7 +18,7 @@ module RuboCop
       #   string.length > 0
       #   hash.size > 0
       #
-      #   @good
+      #   # good
       #   [1, 2, 3].empty?
       #   "foobar".empty?
       #   array.empty?
@@ -27,14 +26,21 @@ module RuboCop
       #   !string.empty?
       #   !hash.empty?
       class ZeroLengthPredicate < Cop
-        ZERO_MSG = 'Use `empty?` instead of `%s %s %s`.'.freeze
-        NONZERO_MSG = 'Use `!empty?` instead of `%s %s %s`.'.freeze
+        ZERO_MSG = 'Use `empty?` instead of `%<lhs>s %<opr>s %<rhs>s`.'.freeze
+        NONZERO_MSG = 'Use `!empty?` instead of ' \
+                      '`%<lhs>s %<opr>s %<rhs>s`.'.freeze
 
         def on_send(node)
           check_zero_length_predicate(node)
           check_nonzero_length_predicate(node)
         end
 
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, replacement(node))
+          end
+        end
+
         private
 
         def check_zero_length_predicate(node)
@@ -42,8 +48,12 @@ module RuboCop
 
           return unless zero_length_predicate
 
-          add_offense(node,
-                      message: format(ZERO_MSG, *zero_length_predicate))
+          lhs, opr, rhs = zero_length_predicate
+
+          add_offense(
+            node,
+            message: format(ZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
+          )
         end
 
         def check_nonzero_length_predicate(node)
@@ -51,8 +61,12 @@ module RuboCop
 
           return unless nonzero_length_predicate
 
-          add_offense(node,
-                      message: format(NONZERO_MSG, *nonzero_length_predicate))
+          lhs, opr, rhs = nonzero_length_predicate
+
+          add_offense(
+            node,
+            message: format(NONZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
+          )
         end
 
         def_node_matcher :zero_length_predicate, <<-PATTERN
@@ -67,12 +81,6 @@ module RuboCop
            (send (int $0) ${:< :!=} (send (...) ${:length :size}))}
         PATTERN
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, replacement(node))
-          end
-        end
-
         def replacement(node)
           receiver = zero_length_receiver(node)
           return "#{receiver.source}.empty?" if receiver

data/lib/rubocop/cop/util.rb

@@ -23,7 +23,7 @@ module RuboCop
       # Backtick is added last just to help editors parse this code.
       OPERATOR_METHODS = %w(
         | ^ & <=> == === =~ > >= < <= << >>
-        + - * / % ** ~ +@ -@ [] []= ! != !~
+        + - * / % ** ~ +@ -@ !@ ~@ [] []= ! != !~
       ).map(&:to_sym).push(:'`').freeze
 
       # Match literal regex characters, not including anchors, character
@@ -48,10 +48,6 @@ module RuboCop
         str
       end
 
-      def block_length(block_node)
-        block_node.loc.end.line - block_node.loc.begin.line
-      end
-
       def comment_line?(line_source)
         line_source =~ /^\s*#/
       end
@@ -137,18 +133,22 @@ module RuboCop
         Parser::Source::Range.new(buffer, begin_pos, end_pos)
       end
 
-      def range_with_surrounding_space(range, side = :both, with_newline = true)
+      def range_with_surrounding_space(range:,
+                                       side: :both,
+                                       newlines: true,
+                                       whitespace: false)
         buffer = @processed_source.buffer
         src = buffer.source
 
         go_left, go_right = directions(side)
 
         begin_pos = range.begin_pos
+        if go_left
+          begin_pos =
+            final_pos(src, begin_pos, -1, newlines, whitespace)
+        end
         end_pos = range.end_pos
-        begin_pos = move_pos(src, begin_pos, -1, go_left, /[ \t]/)
-        begin_pos = move_pos(src, begin_pos, -1, go_left && with_newline, /\n/)
-        end_pos = move_pos(src, end_pos, 1, go_right, /[ \t]/)
-        end_pos = move_pos(src, end_pos, 1, go_right && with_newline, /\n/)
+        end_pos = final_pos(src, end_pos, 1, newlines, whitespace) if go_right
         Parser::Source::Range.new(buffer, begin_pos, end_pos)
       end
 
@@ -168,20 +168,6 @@ module RuboCop
         Parser::Source::Range.new(buffer, begin_of_first_line, end_of_last_line)
       end
 
-      def move_pos(src, pos, step, condition, regexp)
-        offset = step == -1 ? -1 : 0
-        pos += step while condition && src[pos + offset] =~ regexp
-        pos < 0 ? 0 : pos
-      end
-
-      def directions(side)
-        if side == :both
-          [true, true]
-        else
-          [side == :left, side == :right]
-        end
-      end
-
       def begins_its_line?(range)
         (range.source_line =~ /\S/) == range.column
       end
@@ -282,11 +268,7 @@ module RuboCop
           n1.loc.line == n2.loc.line
       end
 
-      def line_distance(n1, n2)
-        n2.loc.line - n1.loc.line
-      end
-
-      def preceed?(n1, n2)
+      def precede?(n1, n2)
         line_distance(n1, n2) == 1
       end
 
@@ -294,16 +276,43 @@ module RuboCop
         processed_source[0..line].map(&:strip)
       end
 
+      def to_supported_styles(enforced_style)
+        enforced_style
+          .sub(/^Enforced/, 'Supported')
+          .sub('Style', 'Styles')
+      end
+
+      private
+
+      def directions(side)
+        if side == :both
+          [true, true]
+        else
+          [side == :left, side == :right]
+        end
+      end
+
+      def final_pos(src, pos, increment, newlines, whitespace)
+        pos = move_pos(src, pos, increment, true, /[ \t]/)
+        pos = move_pos(src, pos, increment, newlines, /\n/)
+        move_pos(src, pos, increment, whitespace, /\s/)
+      end
+
+      def move_pos(src, pos, step, condition, regexp)
+        offset = step == -1 ? -1 : 0
+        pos += step while condition && src[pos + offset] =~ regexp
+        pos < 0 ? 0 : pos
+      end
+
       def compatible_external_encoding_for?(src)
         src = src.dup if RUBY_VERSION < '2.3' || RUBY_ENGINE == 'jruby'
         src.force_encoding(Encoding.default_external).valid_encoding?
       end
 
-      def to_supported_styles(enforced_style)
-        enforced_style
-          .sub(/^Enforced/, 'Supported')
-          .sub('Style', 'Styles')
+      def line_distance(n1, n2)
+        n2.loc.line - n1.loc.line
       end
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/rubocop/cop/variable_force.rb

@@ -320,7 +320,7 @@ module RuboCop
             next if assignment_nodes_in_loop.none? do |assignment_node|
                       assignment_node.equal?(assignment.node)
                     end
-            assignment.reference!
+            assignment.reference!(node)
           end
         end
       end

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

@@ -9,7 +9,7 @@ module RuboCop
 
         MULTIPLE_LEFT_HAND_SIDE_TYPE = :mlhs
 
-        attr_reader :node, :variable, :referenced
+        attr_reader :node, :variable, :referenced, :references
         alias referenced? referenced
 
         def initialize(node, variable)
@@ -22,6 +22,7 @@ module RuboCop
           @node = node
           @variable = variable
           @referenced = false
+          @references = []
         end
 
         def name
@@ -32,7 +33,8 @@ module RuboCop
           @variable.scope
         end
 
-        def reference!
+        def reference!(node)
+          @references << node
           @referenced = true
         end
 

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

@@ -37,11 +37,7 @@ module RuboCop
         end
 
         def name
-          # TODO: Add an else clause
-          case @node.type
-          when :def  then @node.children[0]
-          when :defs then @node.children[1]
-          end
+          @node.method_name
         end
 
         def body_node

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

@@ -47,7 +47,7 @@ module RuboCop
             next if consumed_branches.include?(assignment.branch)
 
             unless assignment.run_exclusively_with?(reference)
-              assignment.reference!
+              assignment.reference!(node)
             end
 
             break if !assignment.branch || assignment.branch == reference.branch

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -55,8 +55,6 @@ module RuboCop
         output_offenses
 
         puts "Created #{output.path}."
-        puts "Run `rubocop --config #{output.path}`, or add `inherit_from: " \
-             "#{output.path}` in a .rubocop.yml file."
       end
 
       private
@@ -107,7 +105,8 @@ module RuboCop
       end
 
       def output_cop_param_comments(params, default_cfg)
-        output.puts "# Configuration parameters: #{params.join(', ')}."
+        config_params = params.reject { |p| p.start_with?('Supported') }
+        output.puts "# Configuration parameters: #{config_params.join(', ')}."
 
         params.each do |param|
           value = default_cfg[param]

data/lib/rubocop/formatter/formatter_set.rb

@@ -20,7 +20,8 @@ module RuboCop
         'offenses' => OffenseCountFormatter,
         'disabled' => DisabledLinesFormatter,
         'worst'    => WorstOffendersFormatter,
-        'tap'      => TapFormatter
+        'tap'      => TapFormatter,
+        'quiet'    => QuietFormatter
       }.freeze
 
       FORMATTER_APIS = %i[started finished].freeze