rubocop 1.10.0 → 1.14.0

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

@@ -5,28 +5,88 @@ module RuboCop
   # special `rubocop:disable` and `rubocop:enable` comment and exposes what
   # cops it contains.
   class DirectiveComment
-    attr_reader :comment
+    # @api private
+    REDUNDANT_COP = 'Lint/RedundantCopDisableDirective'
+    # @api private
+    COP_NAME_PATTERN = '([A-Z]\w+/)*(?:[A-Z]\w+)'
+    # @api private
+    COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}"
+    # @api private
+    COPS_PATTERN = "(all|#{COP_NAMES_PATTERN})"
+    # @api private
+    DIRECTIVE_COMMENT_REGEXP = Regexp.new(
+      "# rubocop : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
+        .gsub(' ', '\s*')
+    )
+
+    def self.before_comment(line)
+      line.split(DIRECTIVE_COMMENT_REGEXP).first
+    end
+
+    attr_reader :comment, :mode, :cops
 
     def initialize(comment)
       @comment = comment
+      @mode, @cops = match_captures
     end
 
-    # Return all the cops specified in the directive
-    def cops
-      match = comment.text.match(CommentConfig::COMMENT_DIRECTIVE_REGEXP)
-      return unless match
-
-      cops_string = match.captures[1]
-      cops_string.split(/,\s*/).uniq.sort
+    # Checks if this directive relates to single line
+    def single_line?
+      !self.class.before_comment(comment.text).empty?
     end
 
     # Checks if this directive contains all the given cop names
     def match?(cop_names)
-      cops == cop_names.uniq.sort
+      parsed_cop_names.uniq.sort == cop_names.uniq.sort
     end
 
     def range
       comment.location.expression
     end
+
+    # Returns match captures to directive comment pattern
+    def match_captures
+      @match_captures ||= comment.text.match(DIRECTIVE_COMMENT_REGEXP)&.captures
+    end
+
+    # Checks if this directive disables cops
+    def disabled?
+      %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?
+    end
+
+    # Checks if all cops specified in this directive
+    def all_cops?
+      cops == 'all'
+    end
+
+    # Returns array of specified in this directive cop names
+    def cop_names
+      @cop_names ||= all_cops? ? all_cop_names : parsed_cop_names
+    end
+
+    # Returns line number for directive
+    def line_number
+      comment.loc.expression.line
+    end
+
+    private
+
+    def parsed_cop_names
+      (cops || '').split(/,\s*/)
+    end
+
+    def all_cop_names
+      Cop::Registry.global.names - [REDUNDANT_COP]
+    end
   end
 end

data/lib/rubocop/ext/regexp_parser.rb

@@ -39,9 +39,8 @@ module RuboCop
 
             # Shortcut to `loc.expression`
             def expression
-              @expression ||= begin
-                origin.adjust(begin_pos: start_index, end_pos: start_index + full_length)
-              end
+              end_pos = start_index + full_length
+              @expression ||= origin.adjust(begin_pos: start_index, end_pos: end_pos)
             end
           end
 
@@ -60,9 +59,7 @@ module RuboCop
           #
           # Please open issue if you need other locations
           def loc
-            @loc ||= begin
-              Map.new(expression, **build_location)
-            end
+            @loc ||= Map.new(expression, **build_location)
           end
 
           private

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)

data/lib/rubocop/formatter/json_formatter.rb

@@ -13,11 +13,7 @@ module RuboCop
 
       def initialize(output, options = {})
         super
-        @output_hash = {
-          metadata: metadata_hash,
-          files:    [],
-          summary:  { offense_count: 0 }
-        }
+        @output_hash = { metadata: metadata_hash, files: [], summary: { offense_count: 0 } }
       end
 
       def started(target_files)

data/lib/rubocop/formatter/junit_formatter.rb

@@ -18,14 +18,10 @@ module RuboCop
       def initialize(output, options = {})
         super
 
-        @document = REXML::Document.new.tap do |document|
-          document << REXML::XMLDecl.new
-        end
+        @document = REXML::Document.new.tap { |document| document << REXML::XMLDecl.new }
         testsuites = REXML::Element.new('testsuites', @document)
         testsuite = REXML::Element.new('testsuite', testsuites)
-        @testsuite = testsuite.tap do |element|
-          element.add_attributes('name' => 'rubocop')
-        end
+        @testsuite = testsuite.tap { |element| element.add_attributes('name' => 'rubocop') }
       end
 
       def file_finished(file, offenses)
@@ -53,9 +49,7 @@ module RuboCop
       end
 
       def offenses_for_cop(all_offenses, cop)
-        all_offenses.select do |offense|
-          offense.cop_name == cop.cop_name
-        end
+        all_offenses.select { |offense| offense.cop_name == cop.cop_name }
       end
 
       def classname_attribute_value(file)

data/lib/rubocop/formatter/progress_formatter.rb

@@ -38,9 +38,7 @@ module RuboCop
           output.puts 'Offenses:'
           output.puts
 
-          @offenses_for_files.each do |file, offenses|
-            report_file(file, offenses)
-          end
+          @offenses_for_files.each { |file, offenses| report_file(file, offenses) }
         end
 
         report_summary(inspected_files.size,

data/lib/rubocop/formatter/tap_formatter.rb

@@ -37,8 +37,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
 
       def report_offense(file, offense)

data/lib/rubocop/magic_comment.rb

@@ -47,7 +47,7 @@ module RuboCop
     end
 
     def valid_shareable_constant_value?
-      %w[none literal experimental_everything experimental_copy].include?(shareable_constant_values)
+      %w[none literal experimental_everything experimental_copy].include?(shareable_constant_value)
     end
 
     # Was a magic comment for the frozen string literal found?