rubocop 1.12.0 → 1.13.0

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
 
@@ -100,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)
@@ -127,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
 

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?, :==

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

@@ -8,9 +8,7 @@ module RuboCop
         include Branchable
 
         VARIABLE_REFERENCE_TYPES = (
-          [VARIABLE_REFERENCE_TYPE] +
-          OPERATOR_ASSIGNMENT_TYPES +
-          [ZERO_ARITY_SUPER_TYPE, SEND_TYPE]
+          [VARIABLE_REFERENCE_TYPE] + OPERATOR_ASSIGNMENT_TYPES + [ZERO_ARITY_SUPER_TYPE, SEND_TYPE]
         ).freeze
 
         attr_reader :node, :scope

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

@@ -23,10 +23,9 @@ module RuboCop
           unless SCOPE_TYPES.include?(node.type)
             # Accept any node type for top level scope
             if node.parent
-              raise ArgumentError,
-                    "Node type must be any of #{SCOPE_TYPES}, " \
-                    "passed #{node.type}"
+              raise ArgumentError, "Node type must be any of #{SCOPE_TYPES}, passed #{node.type}"
             end
+
             @naked_top_level = true
           end
           @node = node
@@ -56,8 +55,7 @@ module RuboCop
         end
 
         def include?(target_node)
-          !belong_to_outer_scope?(target_node) &&
-            !belong_to_inner_scope?(target_node)
+          !belong_to_outer_scope?(target_node) && !belong_to_inner_scope?(target_node)
         end
 
         def each_node(&block)
@@ -100,9 +98,7 @@ module RuboCop
         end
 
         def ancestor_node?(target_node)
-          node.each_ancestor.any? do |ancestor_node|
-            ancestor_node.equal?(target_node)
-          end
+          node.each_ancestor.any? { |ancestor_node| ancestor_node.equal?(target_node) }
         end
       end
     end

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

@@ -6,11 +6,9 @@ module RuboCop
       # A Variable represents existence of a local variable.
       # This holds a variable declaration node and some states of the variable.
       class Variable
-        VARIABLE_DECLARATION_TYPES =
-          (VARIABLE_ASSIGNMENT_TYPES + ARGUMENT_DECLARATION_TYPES).freeze
+        VARIABLE_DECLARATION_TYPES = (VARIABLE_ASSIGNMENT_TYPES + ARGUMENT_DECLARATION_TYPES).freeze
 
-        attr_reader :name, :declaration_node, :scope,
-                    :assignments, :references, :captured_by_block
+        attr_reader :name, :declaration_node, :scope, :assignments, :references, :captured_by_block
 
         alias captured_by_block? captured_by_block
 

data/lib/rubocop/cops_documentation_generator.rb

@@ -18,9 +18,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
   def call
     YARD::Registry.load!
-    departments.each do |department|
-      print_cops_of_department(department)
-    end
+    departments.each { |department| print_cops_of_department(department) }
 
     print_table_of_contents
   ensure
@@ -105,8 +103,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
   def code_example(ruby_code)
     content = +"[source,ruby]\n----\n"
-    content << ruby_code.text.gsub('@good', '# good')
-                        .gsub('@bad', '# bad').strip
+    content << ruby_code.text.gsub('@good', '# good').gsub('@bad', '# bad').strip
     content << "\n----\n"
     content
   end
@@ -158,10 +155,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   # rubocop:enable Metrics/CyclomaticComplexity,Metrics/MethodLength
 
   def to_table(header, content)
-    table = [
-      '|===',
-      "| #{header.join(' | ')}\n\n"
-    ].join("\n")
+    table = ['|===', "| #{header.join(' | ')}\n\n"].join("\n")
     marked_contents = content.map do |plain_content|
       plain_content.map { |c| "| #{c}" }.join("\n")
     end
@@ -195,9 +189,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
   def references(cop)
     cop_config = config.for_cop(cop)
-    urls = RuboCop::Cop::MessageAnnotator.new(
-      config, cop.name, cop_config, {}
-    ).urls
+    urls = RuboCop::Cop::MessageAnnotator.new(config, cop.name, cop_config, {}).urls
     return '' if urls.empty?
 
     content = h3('References')
@@ -209,9 +201,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   def print_cops_of_department(department)
     selected_cops = cops_of_department(department)
     content = +"= #{department}\n"
-    selected_cops.each do |cop|
-      content << print_cop_with_doc(cop)
-    end
+    selected_cops.each { |cop| content << print_cop_with_doc(cop) }
     file_name = "#{Dir.pwd}/docs/modules/ROOT/pages/#{department_to_basename(department)}.adoc"
     File.open(file_name, 'w') do |file|
       puts "* generated #{file_name}"
@@ -264,16 +254,12 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
     content << "\n// END_COP_LIST"
 
-    content = original.sub(
-      %r{// START_COP_LIST.+// END_COP_LIST}m, content
-    )
+    content = original.sub(%r{// START_COP_LIST.+// END_COP_LIST}m, content)
     File.write(path, content)
   end
 
   def table_contents
-    departments
-      .map { |department| table_of_content_for_department(department) }
-      .join("\n")
+    departments.map { |department| table_of_content_for_department(department) }.join("\n")
   end
 
   def cop_status(status)

data/lib/rubocop/directive_comment.rb

@@ -54,6 +54,11 @@ module RuboCop
       %w[disable todo].include?(mode)
     end
 
+    # Checks if this directive enables cops
+    def enabled?
+      mode == 'enable'
+    end
+
     # Checks if this directive enables all cops
     def enabled_all?
       !disabled? && all_cops?

data/lib/rubocop/file_finder.rb

@@ -23,9 +23,7 @@ module RuboCop
 
     def find_last_file_upwards(filename, start_dir, stop_dir = nil)
       last_file = nil
-      traverse_files_upwards(filename, start_dir, stop_dir) do |file|
-        last_file = file
-      end
+      traverse_files_upwards(filename, start_dir, stop_dir) { |file| last_file = file }
       last_file
     end
 

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -49,8 +49,10 @@ module RuboCop
       end
 
       def report_highlighted_area(highlighted_area)
-        output.puts("#{' ' * highlighted_area.begin_pos}" \
-                    "#{'^' * highlighted_area.size}")
+        space_area  = highlighted_area.source_buffer.slice(0...highlighted_area.begin_pos)
+        source_area = highlighted_area.source
+        output.puts("#{' ' * Unicode::DisplayWidth.of(space_area)}" \
+                    "#{'^' * Unicode::DisplayWidth.of(source_area)}")
       end
     end
   end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -71,9 +71,7 @@ module RuboCop
         command += ' --auto-gen-only-exclude' if @options[:auto_gen_only_exclude]
 
         if @exclude_limit_option
-          command +=
-            format(' --exclude-limit %<limit>d',
-                   limit: Integer(@exclude_limit_option))
+          command += format(' --exclude-limit %<limit>d', limit: Integer(@exclude_limit_option))
         end
         command += ' --no-offense-counts' unless show_offense_counts?
 
@@ -111,8 +109,7 @@ module RuboCop
 
         # In case auto_gen_only_exclude is set, only modify the maximum if the
         # files are not excluded one by one.
-        if !@options[:auto_gen_only_exclude] ||
-           @files_with_offenses[cop_name].size > @exclude_limit
+        if !@options[:auto_gen_only_exclude] || @files_with_offenses[cop_name].size > @exclude_limit
           cfg.merge!(cfg[:exclude_limit])
         end
 
@@ -144,9 +141,7 @@ module RuboCop
 
       def output_cop_param_comments(output_buffer, params, default_cfg)
         config_params = params.reject { |p| p.start_with?('Supported') }
-        output_buffer.puts(
-          "# Configuration parameters: #{config_params.join(', ')}."
-        )
+        output_buffer.puts("# Configuration parameters: #{config_params.join(', ')}.")
 
         params.each do |param|
           value = default_cfg[param]

data/lib/rubocop/formatter/git_hub_actions_formatter.rb

@@ -5,11 +5,7 @@ module RuboCop
     # This formatter formats report data as GitHub Workflow commands resulting
     # in GitHub check annotations when run within GitHub Actions.
     class GitHubActionsFormatter < BaseFormatter
-      ESCAPE_MAP = {
-        '%' => '%25',
-        "\n" => '%0A',
-        "\r" => '%0D'
-      }.freeze
+      ESCAPE_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
 
       def file_finished(file, offenses)
         offenses.each { |offense| report_offense(file, offense) }

data/lib/rubocop/formatter/html_formatter.rb

@@ -11,8 +11,7 @@ module RuboCop
     # This formatter saves the output as an html file.
     class HTMLFormatter < BaseFormatter
       ELLIPSES = '<span class="extra-code">...</span>'
-      TEMPLATE_PATH =
-        File.expand_path('../../../assets/output.html.erb', __dir__)
+      TEMPLATE_PATH = File.expand_path('../../../assets/output.html.erb', __dir__)
 
       Color = Struct.new(:red, :green, :blue, :alpha) do
         def to_s
@@ -20,9 +19,7 @@ module RuboCop
         end
 
         def fade_out(amount)
-          dup.tap do |color|
-            color.alpha -= amount
-          end
+          dup.tap { |color| color.alpha -= amount }
         end
       end
 
@@ -79,8 +76,7 @@ module RuboCop
           fatal:      Color.new(0xD2, 0x32, 0x2D, 1.0)
         }.freeze
 
-        LOGO_IMAGE_PATH =
-          File.expand_path('../../../assets/logo.png', __dir__)
+        LOGO_IMAGE_PATH = File.expand_path('../../../assets/logo.png', __dir__)
 
         attr_reader :files, :summary
 
@@ -97,9 +93,7 @@ module RuboCop
         # rubocop:enable Lint/UselessMethodDefinition
 
         def decorated_message(offense)
-          offense.message.gsub(/`(.+?)`/) do
-            "<code>#{Regexp.last_match(1)}</code>"
-          end
+          offense.message.gsub(/`(.+?)`/) { "<code>#{Regexp.last_match(1)}</code>" }
         end
 
         def highlighted_source_line(offense)