rubocop 1.28.2 → 1.29.0

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

@@ -185,7 +185,7 @@ module RuboCop
         end
 
         def end_followed_by_whitespace_only?(source_buffer, end_pos)
-          /\A\s*$/.match?(source_buffer.source[end_pos..-1])
+          /\A\s*$/.match?(source_buffer.source[end_pos..])
         end
 
         def reindentable_lines(node)

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

@@ -8,7 +8,7 @@ module RuboCop
       #
       # @safety
       #   This cop is unsafe because changing a method signature will
-      #   implicitly change behaviour.
+      #   implicitly change behavior.
       #
       # @example
       #   # bad

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

@@ -9,7 +9,7 @@ module RuboCop
       #
       # @safety
       #   This cop is unsafe because changing a method signature will
-      #   implicitly change behaviour.
+      #   implicitly change behavior.
       #
       # @example
       #   # bad

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

@@ -116,7 +116,7 @@ module RuboCop
         def wrong_quotes?(node)
           return super if hash_key?(node)
 
-          super(node.source[1..-1])
+          super(node.source[1..])
         end
       end
     end

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

@@ -80,7 +80,7 @@ module RuboCop
           return node.source if message_nodes.size > 1
 
           argument = message_nodes.first.source
-          exception_class = exception_node.const_name || exception_node.receiver.source
+          exception_class = exception_node.receiver&.source || exception_node.source
 
           if node.parent && requires_parens?(node.parent)
             "#{node.method_name}(#{exception_class}.new(#{argument}))"

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

@@ -73,13 +73,12 @@ module RuboCop
         end
 
         def offense?(node)
-          condition, if_branch, else_branch = *node
+          _condition, _if_branch, else_branch = *node
 
           return false if use_if_branch?(else_branch) || use_hash_key_assignment?(else_branch)
 
-          condition == if_branch && !node.elsif? && (
-            node.ternary? || !else_branch.instance_of?(AST::Node) || else_branch.single_line?
-          )
+          synonymous_condition_and_branch?(node) && !node.elsif? &&
+            (node.ternary? || !else_branch.instance_of?(AST::Node) || else_branch.single_line?)
         end
 
         def use_if_branch?(else_branch)
@@ -90,16 +89,87 @@ module RuboCop
           else_branch&.send_type? && else_branch&.method?(:[]=)
         end
 
+        def synonymous_condition_and_branch?(node)
+          condition, if_branch, _else_branch = *node
+          # e.g.
+          #   if var
+          #     var
+          #   else
+          #     'foo'
+          #   end
+          return true if condition == if_branch
+
+          # e.g.
+          #   if foo
+          #     @value = foo
+          #   else
+          #     @value = another_value?
+          #   end
+          return true if branches_have_assignment?(node) && condition == if_branch.expression
+
+          # e.g.
+          #   if foo
+          #     test.value = foo
+          #   else
+          #     test.value = another_value?
+          #   end
+          branches_have_method?(node) && condition == if_branch.first_argument
+        end
+
+        def branches_have_assignment?(node)
+          _condition, if_branch, else_branch = *node
+
+          return false unless if_branch && else_branch
+
+          asgn_type?(if_branch) && (if_branch_variable_name = if_branch.name) &&
+            asgn_type?(else_branch) && (else_branch_variable_name = else_branch.name) &&
+            if_branch_variable_name == else_branch_variable_name
+        end
+
+        def asgn_type?(node)
+          node.lvasgn_type? || node.ivasgn_type? || node.cvasgn_type? || node.gvasgn_type?
+        end
+
+        def branches_have_method?(node)
+          _condition, if_branch, else_branch = *node
+
+          return false unless if_branch && else_branch
+
+          if_branch.send_type? && if_branch.arguments.count == 1 &&
+            else_branch.send_type? && else_branch.arguments.count == 1 &&
+            if_branch.method?(else_branch.method_name)
+        end
+
         def else_source(else_branch)
-          if require_parentheses?(else_branch)
+          if branches_have_method?(else_branch.parent)
+            else_source_if_has_method(else_branch)
+          elsif require_parentheses?(else_branch)
             "(#{else_branch.source})"
           elsif without_argument_parentheses_method?(else_branch)
             "#{else_branch.method_name}(#{else_branch.arguments.map(&:source).join(', ')})"
+          elsif branches_have_assignment?(else_branch.parent)
+            else_source_if_has_assignment(else_branch)
           else
             else_branch.source
           end
         end
 
+        def else_source_if_has_method(else_branch)
+          if require_parentheses?(else_branch.first_argument)
+            "(#{else_branch.first_argument.source})"
+          else
+            else_branch.first_argument.source
+          end
+        end
+
+        def else_source_if_has_assignment(else_branch)
+          if require_parentheses?(else_branch.expression)
+            "(#{else_branch.expression.source})"
+          else
+            else_branch.expression.source
+          end
+        end
+
         def make_ternary_form(node)
           _condition, if_branch, else_branch = *node
           ternary_form = [if_branch.source, else_source(else_branch)].join(' || ')
@@ -127,8 +197,8 @@ module RuboCop
         end
 
         def without_argument_parentheses_method?(node)
-          node.send_type? &&
-            !node.arguments.empty? && !node.parenthesized? && !node.operator_method?
+          node.send_type? && !node.arguments.empty? &&
+            !node.parenthesized? && !node.operator_method? && !node.assignment_method?
         end
       end
     end

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

@@ -99,7 +99,7 @@ module RuboCop
         end
 
         def backslash_b?(elem)
-          # \b's behaviour is different inside and outside of a character class, matching word
+          # \b's behavior is different inside and outside of a character class, matching word
           # boundaries outside but backspace (0x08) when inside.
           elem == '\b'
         end

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

@@ -59,7 +59,7 @@ module RuboCop
         def allowed_escape?(node, char, within_character_class)
           # Strictly speaking a few single-letter metachars are currently
           # unnecessary to "escape", e.g. i, E, F, but enumerating them is
-          # rather difficult, and their behaviour could change over time with
+          # rather difficult, and their behavior could change over time with
           # different versions of Ruby so that e.g. /\i/ != /i/
           return true if /[[:alnum:]]/.match?(char)
           return true if ALLOWED_ALWAYS_ESCAPES.include?(char) || delimiter?(node, char)

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

@@ -67,8 +67,7 @@ module RuboCop
         alias on_gvasgn on_lvasgn
 
         def on_send(node)
-          # TODO: Remove `Symbol#to_s` after supporting only Ruby >= 2.7.
-          return unless node.method_name.to_s.end_with?('=')
+          return unless node.assignment_method?
           return unless redundant_assignment?(node)
 
           message = format(MSG, method_name: node.first_argument.method_name)

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

@@ -23,7 +23,7 @@ module RuboCop
       #
       # @safety
       #   Autocorrection is unsafe because if a value is `false`, the resulting
-      #   code will have different behaviour or raise an error.
+      #   code will have different behavior or raise an error.
       #
       #   [source,ruby]
       #   ----

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

@@ -27,9 +27,6 @@ module RuboCop
       #   items[1..]
       class SlicingWithRange < Base
         extend AutoCorrector
-        extend TargetRubyVersion
-
-        minimum_target_ruby_version 2.6
 
         MSG = 'Prefer ary[n..] over ary[n..-1].'
         RESTRICT_ON_SEND = %i[[]].freeze

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

@@ -8,7 +8,7 @@ module RuboCop
       # @safety
       #   This cop is unsafe because it cannot be guaranteed that the receiver
       #   is actually a string. If another class has a `split` method with
-      #   different behaviour, it would be registered as a false positive.
+      #   different behavior, it would be registered as a false positive.
       #
       # @example
       #   # bad

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

@@ -167,8 +167,8 @@ module RuboCop
           allowed_methods.map(&:to_sym) + [:initialize]
         end
 
-        def dsl_writer?(method_name)
-          !method_name.to_s.end_with?('=')
+        def dsl_writer?(node)
+          !node.assignment_method?
         end
 
         def trivial_reader?(node)
@@ -180,8 +180,7 @@ module RuboCop
         end
 
         def trivial_writer?(node)
-          looks_like_trivial_writer?(node) &&
-            !allowed_method_name?(node) && !allowed_writer?(node.method_name)
+          looks_like_trivial_writer?(node) && !allowed_method_name?(node) && !allowed_writer?(node)
         end
 
         # @!method looks_like_trivial_writer?(node)
@@ -195,8 +194,8 @@ module RuboCop
             (exact_name_match? && !names_match?(node))
         end
 
-        def allowed_writer?(method_name)
-          allow_dsl_writers? && dsl_writer?(method_name)
+        def allowed_writer?(node)
+          allow_dsl_writers? && dsl_writer?(node)
         end
 
         def allowed_reader?(node)
@@ -206,11 +205,11 @@ module RuboCop
         def names_match?(node)
           ivar_name, = *node.body
 
-          node.method_name.to_s.sub(/[=?]$/, '') == ivar_name[1..-1]
+          node.method_name.to_s.sub(/[=?]$/, '') == ivar_name[1..]
         end
 
         def trivial_accessor_kind(node)
-          if trivial_writer?(node) && !dsl_writer?(node.method_name)
+          if trivial_writer?(node) && !dsl_writer?(node)
             'writer'
           elsif trivial_reader?(node)
             'reader'

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
@@ -116,10 +116,6 @@ RSpec.shared_context 'mock console output' do
   end
 end
 
-RSpec.shared_context 'ruby 2.5', :ruby25 do
-  let(:ruby_version) { 2.5 }
-end
-
 RSpec.shared_context 'ruby 2.6', :ruby26 do
   let(:ruby_version) { 2.6 }
 end

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

@@ -4,11 +4,17 @@ module RuboCop
   # The kind of Ruby that code inspected by RuboCop is written in.
   # @api private
   class TargetRuby
-    KNOWN_RUBIES = [2.5, 2.6, 2.7, 3.0, 3.1, 3.2].freeze
+    KNOWN_RUBIES = [2.6, 2.7, 3.0, 3.1, 3.2].freeze
     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.0'
 
     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'