rubocop 1.28.2 → 1.29.1

data/lib/rubocop/cops_documentation_generator.rb

@@ -246,7 +246,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   end
 
   def table_of_content_for_department(department)
-    type_title = department[0].upcase + department[1..-1]
+    type_title = department[0].upcase + department[1..]
     filename = "#{department_to_basename(department)}.adoc"
     content = +"=== Department xref:#{filename}[#{type_title}]\n\n"
     cops_of_department(department).each do |cop|

data/lib/rubocop/formatter/formatter_set.rb

@@ -18,6 +18,7 @@ module RuboCop
         '[h]tml'        => HTMLFormatter,
         '[j]son'        => JSONFormatter,
         '[ju]nit'       => JUnitFormatter,
+        '[m]arkdown'    => MarkdownFormatter,
         '[o]ffenses'    => OffenseCountFormatter,
         '[pa]cman'      => PacmanFormatter,
         '[p]rogress'    => ProgressFormatter,

data/lib/rubocop/formatter/html_formatter.rb

@@ -53,14 +53,7 @@ module RuboCop
         context = ERBContext.new(files, summary)
 
         template = File.read(TEMPLATE_PATH, encoding: Encoding::UTF_8)
-
-        # The following condition is workaround for until Ruby 2.6 is released.
-        # https://github.com/ruby/ruby/commit/cc777d09f44fa909a336ba14f3aa802ffe16e010
-        erb = if RUBY_VERSION >= '2.6'
-                ERB.new(template, trim_mode: '-')
-              else
-                ERB.new(template, nil, '-')
-              end
+        erb = ERB.new(template, trim_mode: '-')
         html = erb.result(context.binding)
 
         output.write html
@@ -119,7 +112,7 @@ module RuboCop
 
         def source_after_highlight(offense)
           source_line = offense.location.source_line
-          escape(source_line[offense.highlighted_area.end_pos..-1])
+          escape(source_line[offense.highlighted_area.end_pos..])
         end
 
         def possible_ellipses(location)

data/lib/rubocop/formatter/markdown_formatter.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This formatter displays the report data in markdown
+    class MarkdownFormatter < BaseFormatter
+      include TextUtil
+      include PathUtil
+      attr_reader :files, :summary
+
+      def initialize(output, options = {})
+        super
+        @files = []
+        @summary = Struct.new(:offense_count, :inspected_files, :target_files).new(0)
+      end
+
+      def started(target_files)
+        summary.target_files = target_files
+      end
+
+      def file_finished(file, offenses)
+        files << Struct.new(:path, :offenses).new(file, offenses)
+        summary.offense_count += offenses.count
+      end
+
+      def finished(inspected_files)
+        summary.inspected_files = inspected_files
+        render_markdown
+      end
+
+      private
+
+      def render_markdown
+        n_files = pluralize(summary.inspected_files.count, 'file')
+        n_offenses = pluralize(summary.offense_count, 'offense', no_for_zero: true)
+
+        output.write "# RuboCop Inspection Report\n\n"
+        output.write "#{n_files} inspected, #{n_offenses} detected:\n\n"
+        write_file_messages
+      end
+
+      def write_file_messages
+        files.each do |file|
+          write_heading(file)
+          file.offenses.each do |offense|
+            write_context(offense)
+            write_code(offense)
+          end
+        end
+      end
+
+      def write_heading(file)
+        filename = relative_path(file.path)
+        n_offenses = pluralize(file.offenses.count, 'offense')
+
+        output.write "### #{filename} - (#{n_offenses})\n"
+      end
+
+      def write_context(offense)
+        output.write(
+          "  * **Line # #{offense.location.line} - #{offense.severity}:** #{offense.message}\n\n"
+        )
+      end
+
+      def write_code(offense)
+        code = offense.location.source_line + possible_ellipses(offense.location)
+
+        output.write "    ```rb\n    #{code}\n    ```\n\n" unless code.blank?
+      end
+
+      def possible_ellipses(location)
+        location.first_line == location.last_line ? '' : ' ...'
+      end
+    end
+  end
+end

data/lib/rubocop/magic_comment.rb

@@ -5,7 +5,8 @@ module RuboCop
   #
   # @abstract parent of three different magic comment handlers
   class MagicComment
-    # @see https://git.io/vMC1C IRB's pattern for matching magic comment tokens
+    # IRB's pattern for matching magic comment tokens.
+    # @see https://github.com/ruby/ruby/blob/b4a55c1/lib/irb/magic-file.rb#L5
     TOKEN = /[[:alnum:]\-_]+/.freeze
     KEYWORDS = {
       encoding: '(?:en)?coding',
@@ -170,7 +171,7 @@ module RuboCop
     #   comment.encoding # => 'ascii-8bit'
     #
     # @see https://www.gnu.org/software/emacs/manual/html_node/emacs/Specify-Coding.html
-    # @see https://git.io/vMCXh Emacs handling in Ruby's parse.y
+    # @see https://github.com/ruby/ruby/blob/3f306dc/parse.y#L6873-L6892 Emacs handling in parse.y
     class EmacsComment < EditorComment
       REGEXP    = /-\*-(.+)-\*-/.freeze
       FORMAT    = '# -*- %s -*-'
@@ -259,7 +260,7 @@ module RuboCop
       # is the only text in the comment.
       #
       # Case-insensitive and dashes/underscores are acceptable.
-      # @see https://git.io/vM7Mg
+      # @see https://github.com/ruby/ruby/blob/78b95b4/parse.y#L7134-L7138
       def extract_frozen_string_literal
         extract(/\A\s*#\s*#{KEYWORDS[:frozen_string_literal]}:\s*(#{TOKEN})\s*\z/io)
       end

data/lib/rubocop/options.rb

@@ -239,7 +239,7 @@ module RuboCop
     # e.g. [..., '--auto-correct', ...] to :auto_correct.
     def long_opt_symbol(args)
       long_opt = args.find { |arg| arg.start_with?('--') }
-      long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '').tr('-', '_').gsub(/[\[\]]/, '').to_sym
+      long_opt[2..].sub('[no-]', '').sub(/ .*/, '').tr('-', '_').gsub(/[\[\]]/, '').to_sym
     end
 
     def require_feature(file)
@@ -309,7 +309,7 @@ module RuboCop
       end
 
       if display_only_fail_level_offenses_with_autocorrect?
-        raise OptionArgumentError, '--autocorrect cannot be used with ' \
+        raise OptionArgumentError, '--auto-correct cannot be used with ' \
                                    '--display-only-fail-level-offenses'
       end
 
@@ -402,7 +402,8 @@ module RuboCop
     end
 
     def display_only_fail_level_offenses_with_autocorrect?
-      @options[:display_only_fail_level_offenses] && @options[:autocorrect]
+      @options[:display_only_fail_level_offenses] &&
+        (@options.key?(:auto_correct) || @options.key?(:safe_auto_correct))
     end
 
     def except_syntax?

data/lib/rubocop/result_cache.rb

@@ -81,7 +81,7 @@ module RuboCop
                  #
                  # To avoid raising warn log messages on FreeBSD, we retrieve
                  # the real path of the home folder.
-                 File.join(File.realpath(ENV.fetch('HOME')), '.cache')
+                 File.join(File.realpath(Dir.home), '.cache')
                end
       File.join(root, 'rubocop_cache')
     end

data/lib/rubocop/rspec/cop_helper.rb

@@ -6,7 +6,7 @@ require 'tempfile'
 module CopHelper
   extend RSpec::SharedContext
 
-  let(:ruby_version) { 2.5 }
+  let(:ruby_version) { 2.6 }
   let(:rails_version) { false }
 
   def inspect_source(source, file = nil)

data/lib/rubocop/rspec/parallel_formatter.rb

@@ -65,7 +65,7 @@ module RuboCop
       # removed!
       def output_rerun_commands(summary)
         output.puts '# RERUN BEGIN'
-        output.puts summary.colorized_rerun_commands.lines[3..-1].join
+        output.puts summary.colorized_rerun_commands.lines[3..].join
         output.puts '# RERUN END'
       end
 

data/lib/rubocop/rspec/shared_contexts.rb

@@ -5,7 +5,7 @@ require 'tmpdir'
 RSpec.shared_context 'isolated environment', :isolated_environment do
   around do |example|
     Dir.mktmpdir do |tmpdir|
-      original_home = ENV.fetch('HOME', nil)
+      original_home = Dir.home
       original_xdg_config_home = ENV.fetch('XDG_CONFIG_HOME', nil)
 
       # Make sure to expand all symlinks in the path first. Otherwise we may

data/lib/rubocop/runner.rb

@@ -13,7 +13,7 @@ module RuboCop
 
       def initialize(path, offenses_by_iteration, loop_start: -1)
         @offenses = offenses_by_iteration.flatten.uniq
-        root_cause = offenses_by_iteration[loop_start..-1]
+        root_cause = offenses_by_iteration[loop_start..]
                      .map { |x| x.map(&:cop_name).uniq.join(', ') }
                      .join(' -> ')
 

data/lib/rubocop/string_interpreter.rb

@@ -42,18 +42,18 @@ module RuboCop
 
       def interpret_unicode(escape)
         if escape[2] == '{'
-          escape[3..-1].split(/\s+/).map(&:hex).pack('U*')
+          escape[3..].split(/\s+/).map(&:hex).pack('U*')
         else
-          [escape[2..-1].hex].pack('U')
+          [escape[2..].hex].pack('U')
         end
       end
 
       def interpret_hex(escape)
-        [escape[2..-1].hex].pack('C')
+        [escape[2..].hex].pack('C')
       end
 
       def interpret_octal(escape)
-        [escape[1..-1].to_i(8)].pack('C')
+        [escape[1..].to_i(8)].pack('C')
       end
     end
   end

data/lib/rubocop/target_ruby.rb

@@ -8,7 +8,13 @@ module RuboCop
     DEFAULT_VERSION = KNOWN_RUBIES.first
 
     OBSOLETE_RUBIES = {
-      1.9 => '0.41', 2.0 => '0.50', 2.1 => '0.57', 2.2 => '0.68', 2.3 => '0.81', 2.4 => '1.12'
+      1.9 => '0.41',
+      2.0 => '0.50',
+      2.1 => '0.57',
+      2.2 => '0.68',
+      2.3 => '0.81',
+      2.4 => '1.12',
+      2.5 => '1.28'
     }.freeze
     private_constant :KNOWN_RUBIES, :OBSOLETE_RUBIES
 

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.28.2'
+    STRING = '1.29.1'
 
     MSG = '%<version>s (using Parser %<parser_version>s, '\
           'rubocop-ast %<rubocop_ast_version>s, ' \

data/lib/rubocop.rb

@@ -161,6 +161,7 @@ require_relative 'rubocop/cop/bundler/insecure_protocol_source'
 require_relative 'rubocop/cop/bundler/ordered_gems'
 
 require_relative 'rubocop/cop/gemspec/date_assignment'
+require_relative 'rubocop/cop/gemspec/dependency_version'
 require_relative 'rubocop/cop/gemspec/duplicated_assignment'
 require_relative 'rubocop/cop/gemspec/ordered_dependencies'
 require_relative 'rubocop/cop/gemspec/require_mfa'
@@ -385,7 +386,6 @@ require_relative 'rubocop/cop/lint/uri_escape_unescape'
 require_relative 'rubocop/cop/lint/uri_regexp'
 require_relative 'rubocop/cop/lint/useless_access_modifier'
 require_relative 'rubocop/cop/lint/useless_assignment'
-require_relative 'rubocop/cop/lint/useless_else_without_rescue'
 require_relative 'rubocop/cop/lint/useless_method_definition'
 require_relative 'rubocop/cop/lint/useless_ruby2_keywords'
 require_relative 'rubocop/cop/lint/useless_setter_call'
@@ -480,6 +480,7 @@ require_relative 'rubocop/cop/style/empty_method'
 require_relative 'rubocop/cop/style/endless_method'
 require_relative 'rubocop/cop/style/encoding'
 require_relative 'rubocop/cop/style/end_block'
+require_relative 'rubocop/cop/style/env_home'
 require_relative 'rubocop/cop/style/eval_with_location'
 require_relative 'rubocop/cop/style/even_odd'
 require_relative 'rubocop/cop/style/expand_path_arguments'
@@ -675,6 +676,7 @@ require_relative 'rubocop/formatter/git_hub_actions_formatter'
 require_relative 'rubocop/formatter/html_formatter'
 require_relative 'rubocop/formatter/json_formatter'
 require_relative 'rubocop/formatter/junit_formatter'
+require_relative 'rubocop/formatter/markdown_formatter'
 require_relative 'rubocop/formatter/offense_count_formatter'
 require_relative 'rubocop/formatter/progress_formatter'
 require_relative 'rubocop/formatter/quiet_formatter'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.28.2
+  version: 1.29.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-25 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -86,14 +86,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-ast
   requirement: !ruby/object:Gem::Requirement
@@ -250,6 +256,7 @@ files:
 - lib/rubocop/cop/exclude_limit.rb
 - lib/rubocop/cop/force.rb
 - lib/rubocop/cop/gemspec/date_assignment.rb
+- lib/rubocop/cop/gemspec/dependency_version.rb
 - lib/rubocop/cop/gemspec/duplicated_assignment.rb
 - lib/rubocop/cop/gemspec/ordered_dependencies.rb
 - lib/rubocop/cop/gemspec/require_mfa.rb
@@ -264,6 +271,7 @@ files:
 - lib/rubocop/cop/internal_affairs/example_description.rb
 - lib/rubocop/cop/internal_affairs/inherit_deprecated_cop_class.rb
 - lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
+- lib/rubocop/cop/internal_affairs/method_name_end_with.rb
 - lib/rubocop/cop/internal_affairs/method_name_equal.rb
 - lib/rubocop/cop/internal_affairs/node_destructuring.rb
 - lib/rubocop/cop/internal_affairs/node_matcher_directive.rb
@@ -497,7 +505,6 @@ files:
 - lib/rubocop/cop/lint/uri_regexp.rb
 - lib/rubocop/cop/lint/useless_access_modifier.rb
 - lib/rubocop/cop/lint/useless_assignment.rb
-- lib/rubocop/cop/lint/useless_else_without_rescue.rb
 - lib/rubocop/cop/lint/useless_method_definition.rb
 - lib/rubocop/cop/lint/useless_ruby2_keywords.rb
 - lib/rubocop/cop/lint/useless_setter_call.rb
@@ -674,6 +681,7 @@ files:
 - lib/rubocop/cop/style/encoding.rb
 - lib/rubocop/cop/style/end_block.rb
 - lib/rubocop/cop/style/endless_method.rb
+- lib/rubocop/cop/style/env_home.rb
 - lib/rubocop/cop/style/eval_with_location.rb
 - lib/rubocop/cop/style/even_odd.rb
 - lib/rubocop/cop/style/expand_path_arguments.rb
@@ -880,6 +888,7 @@ files:
 - lib/rubocop/formatter/html_formatter.rb
 - lib/rubocop/formatter/json_formatter.rb
 - lib/rubocop/formatter/junit_formatter.rb
+- lib/rubocop/formatter/markdown_formatter.rb
 - lib/rubocop/formatter/offense_count_formatter.rb
 - lib/rubocop/formatter/pacman_formatter.rb
 - lib/rubocop/formatter/progress_formatter.rb
@@ -918,7 +927,7 @@ metadata:
   homepage_uri: https://rubocop.org/
   changelog_uri: https://github.com/rubocop/rubocop/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop/
-  documentation_uri: https://docs.rubocop.org/rubocop/1.28/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.29/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
 post_install_message: 
@@ -929,7 +938,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/rubocop/cop/lint/useless_else_without_rescue.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Lint
-      # This cop checks for useless `else` in `begin..end` without `rescue`.
-      #
-      # NOTE: This syntax is no longer valid on Ruby 2.6 or higher and
-      # this cop is going to be removed at some point the future.
-      #
-      # @example
-      #
-      #   # bad
-      #
-      #   begin
-      #     do_something
-      #   else
-      #     do_something_else # This will never be run.
-      #   end
-      #
-      # @example
-      #
-      #   # good
-      #
-      #   begin
-      #     do_something
-      #   rescue
-      #     handle_errors
-      #   else
-      #     do_something_else
-      #   end
-      class UselessElseWithoutRescue < Base
-        MSG = '`else` without `rescue` is useless.'
-
-        def on_new_investigation
-          processed_source.diagnostics.each do |diagnostic|
-            next unless diagnostic.reason == :useless_else
-
-            add_offense(diagnostic.location, severity: diagnostic.level)
-          end
-        end
-      end
-    end
-  end
-end