rubocop 0.76.0 → 0.77.0

data/lib/rubocop.rb

@@ -118,7 +118,7 @@ require_relative 'rubocop/cop/mixin/end_keyword_alignment'
 require_relative 'rubocop/cop/mixin/enforce_superclass'
 require_relative 'rubocop/cop/mixin/first_element_line_break'
 require_relative 'rubocop/cop/mixin/frozen_string_literal'
-require_relative 'rubocop/cop/mixin/hash_alignment'
+require_relative 'rubocop/cop/mixin/hash_alignment_styles'
 require_relative 'rubocop/cop/mixin/ignored_pattern'
 require_relative 'rubocop/cop/mixin/ignored_methods'
 require_relative 'rubocop/cop/mixin/integer_node'
@@ -144,7 +144,6 @@ require_relative 'rubocop/cop/mixin/preceding_following_alignment'
 require_relative 'rubocop/cop/mixin/preferred_delimiters'
 require_relative 'rubocop/cop/mixin/rescue_node'
 require_relative 'rubocop/cop/mixin/safe_assignment'
-require_relative 'rubocop/cop/mixin/safe_mode'
 require_relative 'rubocop/cop/mixin/space_after_punctuation'
 require_relative 'rubocop/cop/mixin/space_before_punctuation'
 require_relative 'rubocop/cop/mixin/surrounding_space'
@@ -189,10 +188,9 @@ require_relative 'rubocop/cop/gemspec/required_ruby_version'
 require_relative 'rubocop/cop/gemspec/ruby_version_globals_usage'
 
 require_relative 'rubocop/cop/layout/access_modifier_indentation'
-require_relative 'rubocop/cop/layout/align_arguments'
-require_relative 'rubocop/cop/layout/align_array'
-require_relative 'rubocop/cop/layout/align_hash'
-require_relative 'rubocop/cop/layout/align_parameters'
+require_relative 'rubocop/cop/layout/argument_alignment'
+require_relative 'rubocop/cop/layout/array_alignment'
+require_relative 'rubocop/cop/layout/assignment_indentation'
 require_relative 'rubocop/cop/layout/block_alignment'
 require_relative 'rubocop/cop/layout/block_end_newline'
 require_relative 'rubocop/cop/layout/case_indentation'
@@ -220,22 +218,22 @@ require_relative 'rubocop/cop/layout/empty_lines'
 require_relative 'rubocop/cop/layout/end_alignment'
 require_relative 'rubocop/cop/layout/end_of_line'
 require_relative 'rubocop/cop/layout/extra_spacing'
+require_relative 'rubocop/cop/layout/first_argument_indentation'
+require_relative 'rubocop/cop/layout/first_array_element_indentation'
 require_relative 'rubocop/cop/layout/first_array_element_line_break'
+require_relative 'rubocop/cop/layout/first_hash_element_indentation'
 require_relative 'rubocop/cop/layout/first_hash_element_line_break'
 require_relative 'rubocop/cop/layout/first_method_argument_line_break'
 require_relative 'rubocop/cop/layout/first_method_parameter_line_break'
+require_relative 'rubocop/cop/layout/first_parameter_indentation'
+require_relative 'rubocop/cop/layout/hash_alignment'
 require_relative 'rubocop/cop/layout/heredoc_argument_closing_parenthesis'
-require_relative 'rubocop/cop/layout/indent_assignment'
+require_relative 'rubocop/cop/layout/heredoc_indentation'
 require_relative 'rubocop/cop/layout/indentation_consistency'
 require_relative 'rubocop/cop/layout/indentation_width'
-require_relative 'rubocop/cop/layout/indent_first_argument'
-require_relative 'rubocop/cop/layout/indent_first_array_element'
-require_relative 'rubocop/cop/layout/indent_first_hash_element'
-require_relative 'rubocop/cop/layout/indent_first_parameter'
-require_relative 'rubocop/cop/layout/indent_heredoc'
 require_relative 'rubocop/cop/layout/initial_indentation'
-require_relative 'rubocop/cop/layout/leading_blank_lines'
 require_relative 'rubocop/cop/layout/leading_comment_space'
+require_relative 'rubocop/cop/layout/leading_empty_lines'
 require_relative 'rubocop/cop/layout/multiline_array_brace_layout'
 require_relative 'rubocop/cop/layout/multiline_array_line_breaks'
 require_relative 'rubocop/cop/layout/multiline_assignment_layout'
@@ -247,6 +245,7 @@ require_relative 'rubocop/cop/layout/multiline_method_call_brace_layout'
 require_relative 'rubocop/cop/layout/multiline_method_call_indentation'
 require_relative 'rubocop/cop/layout/multiline_method_definition_brace_layout'
 require_relative 'rubocop/cop/layout/multiline_operation_indentation'
+require_relative 'rubocop/cop/layout/parameter_alignment'
 require_relative 'rubocop/cop/layout/rescue_ensure_alignment'
 require_relative 'rubocop/cop/layout/space_after_colon'
 require_relative 'rubocop/cop/layout/space_after_comma'
@@ -273,7 +272,7 @@ require_relative 'rubocop/cop/layout/space_inside_range_literal'
 require_relative 'rubocop/cop/layout/space_inside_reference_brackets'
 require_relative 'rubocop/cop/layout/space_inside_string_interpolation'
 require_relative 'rubocop/cop/layout/tab'
-require_relative 'rubocop/cop/layout/trailing_blank_lines'
+require_relative 'rubocop/cop/layout/trailing_empty_lines'
 require_relative 'rubocop/cop/layout/trailing_whitespace'
 
 require_relative 'rubocop/cop/lint/ambiguous_block_association'
@@ -287,8 +286,8 @@ require_relative 'rubocop/cop/lint/debugger'
 require_relative 'rubocop/cop/lint/deprecated_class_methods'
 require_relative 'rubocop/cop/lint/disjunctive_assignment_in_constructor'
 require_relative 'rubocop/cop/lint/duplicate_case_condition'
+require_relative 'rubocop/cop/lint/duplicate_hash_key'
 require_relative 'rubocop/cop/lint/duplicate_methods'
-require_relative 'rubocop/cop/lint/duplicated_key'
 require_relative 'rubocop/cop/lint/each_with_object_argument'
 require_relative 'rubocop/cop/lint/else_layout'
 require_relative 'rubocop/cop/lint/empty_ensure'
@@ -301,7 +300,6 @@ require_relative 'rubocop/cop/lint/erb_new_arguments'
 require_relative 'rubocop/cop/lint/flip_flop'
 require_relative 'rubocop/cop/lint/float_out_of_range'
 require_relative 'rubocop/cop/lint/format_parameter_mismatch'
-require_relative 'rubocop/cop/lint/handle_exceptions'
 require_relative 'rubocop/cop/lint/heredoc_method_call_position'
 require_relative 'rubocop/cop/lint/implicit_string_concatenation'
 require_relative 'rubocop/cop/lint/inherit_exception'
@@ -311,7 +309,7 @@ require_relative 'rubocop/cop/lint/literal_as_condition'
 require_relative 'rubocop/cop/lint/literal_in_interpolation'
 require_relative 'rubocop/cop/lint/loop'
 require_relative 'rubocop/cop/lint/missing_cop_enable_directive'
-require_relative 'rubocop/cop/lint/multiple_compare'
+require_relative 'rubocop/cop/lint/multiple_comparison'
 require_relative 'rubocop/cop/lint/nested_method_definition'
 require_relative 'rubocop/cop/lint/nested_percent_literal'
 require_relative 'rubocop/cop/lint/next_without_accumulator'
@@ -326,6 +324,7 @@ require_relative 'rubocop/cop/lint/redundant_cop_disable_directive'
 require_relative 'rubocop/cop/lint/redundant_cop_enable_directive'
 require_relative 'rubocop/cop/lint/redundant_require_statement'
 require_relative 'rubocop/cop/lint/redundant_splat_expansion'
+require_relative 'rubocop/cop/lint/redundant_string_coercion'
 require_relative 'rubocop/cop/lint/redundant_with_index'
 require_relative 'rubocop/cop/lint/redundant_with_object'
 require_relative 'rubocop/cop/lint/regexp_as_condition'
@@ -341,7 +340,7 @@ require_relative 'rubocop/cop/lint/send_with_mixin_argument'
 require_relative 'rubocop/cop/lint/shadowed_argument'
 require_relative 'rubocop/cop/lint/shadowed_exception'
 require_relative 'rubocop/cop/lint/shadowing_outer_local_variable'
-require_relative 'rubocop/cop/lint/string_conversion_in_interpolation'
+require_relative 'rubocop/cop/lint/suppressed_exception'
 require_relative 'rubocop/cop/lint/syntax'
 require_relative 'rubocop/cop/lint/to_json'
 require_relative 'rubocop/cop/lint/underscore_prefixed_variable_name'
@@ -373,6 +372,7 @@ require_relative 'rubocop/cop/metrics/perceived_complexity'
 
 require_relative 'rubocop/cop/naming/accessor_method_name'
 require_relative 'rubocop/cop/naming/ascii_identifiers'
+require_relative 'rubocop/cop/naming/block_parameter_name'
 require_relative 'rubocop/cop/naming/class_and_module_camel_case'
 require_relative 'rubocop/cop/naming/constant_name'
 require_relative 'rubocop/cop/naming/file_name'
@@ -380,11 +380,10 @@ require_relative 'rubocop/cop/naming/heredoc_delimiter_case'
 require_relative 'rubocop/cop/naming/heredoc_delimiter_naming'
 require_relative 'rubocop/cop/naming/memoized_instance_variable_name'
 require_relative 'rubocop/cop/naming/method_name'
+require_relative 'rubocop/cop/naming/method_parameter_name'
 require_relative 'rubocop/cop/naming/binary_operator_parameter_name'
 require_relative 'rubocop/cop/naming/predicate_name'
 require_relative 'rubocop/cop/naming/rescued_exceptions_variable_name'
-require_relative 'rubocop/cop/naming/uncommunicative_block_param_name'
-require_relative 'rubocop/cop/naming/uncommunicative_method_param_name'
 require_relative 'rubocop/cop/naming/variable_name'
 require_relative 'rubocop/cop/naming/variable_number'
 
@@ -604,6 +603,14 @@ require_relative 'rubocop/processed_source'
 require_relative 'rubocop/result_cache'
 require_relative 'rubocop/runner'
 require_relative 'rubocop/cli'
+require_relative 'rubocop/cli/command'
+require_relative 'rubocop/cli/environment'
+require_relative 'rubocop/cli/command/base'
+require_relative 'rubocop/cli/command/auto_genenerate_config'
+require_relative 'rubocop/cli/command/execute_runner'
+require_relative 'rubocop/cli/command/init_dotfile'
+require_relative 'rubocop/cli/command/show_cops'
+require_relative 'rubocop/cli/command/version'
 require_relative 'rubocop/options'
 require_relative 'rubocop/remote_config'
 require_relative 'rubocop/yaml_duplication_checker'

data/lib/rubocop/ast/node.rb

@@ -624,7 +624,7 @@ module RuboCop
       end
 
       def parent_module_name_for_block(ancestor)
-        if ancestor.method_name == :class_eval
+        if ancestor.method?(:class_eval)
           # `class_eval` with no receiver applies to whatever module or class
           # we are currently in
           return unless (receiver = ancestor.receiver)

data/lib/rubocop/ast/node/block_node.rb

@@ -9,6 +9,8 @@ module RuboCop
     # A `block` node is essentially a method send with a block. Parser nests
     # the `send` node inside the `block` node.
     class BlockNode < Node
+      include MethodIdentifierPredicates
+
       VOID_CONTEXT_METHODS = %i[each tap].freeze
 
       # The `send` node associated with this block.

data/lib/rubocop/cli.rb

@@ -1,20 +1,9 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ClassLength
 module RuboCop
   # The CLI is a class responsible of handling all the command line interface
   # logic.
   class CLI
-    include Formatter::TextUtil
-
-    PHASE_1 = 'Phase 1 of 2: run Metrics/LineLength cop'
-    PHASE_2 = 'Phase 2 of 2: run all cops'
-
-    PHASE_1_OVERRIDDEN = '(skipped because the default Metrics/LineLength:Max' \
-                         ' is overridden)'
-    PHASE_1_DISABLED   = '(skipped because Metrics/LineLength is ' \
-                         'disabled)'
-
     STATUS_SUCCESS     = 0
     STATUS_OFFENSES    = 1
     STATUS_ERROR       = 2
@@ -41,14 +30,15 @@ module RuboCop
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def run(args = ARGV)
       @options, paths = Options.new.parse(args)
+      @env = Environment.new(@options, @config_store, paths)
 
       if @options[:init]
-        init_dotfile
+        run_command(:init)
       else
         validate_options_vs_config
         act_on_options
         apply_default_formatter
-        execute_runners(paths)
+        execute_runners
       end
     rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
       warn e.message
@@ -71,113 +61,18 @@ module RuboCop
 
     private
 
-    def execute_runners(paths)
-      if @options[:auto_gen_config]
-        reset_config_and_auto_gen_file
-        line_length_contents = maybe_run_line_length_cop(paths)
-        run_all_cops_auto_gen_config(line_length_contents, paths)
-      else
-        execute_runner(paths)
-      end
-    end
-
-    def maybe_run_line_length_cop(paths)
-      if !line_length_enabled?(@config_store.for(Dir.pwd))
-        skip_line_length_cop(PHASE_1_DISABLED)
-      elsif !same_max_line_length?(
-        @config_store.for(Dir.pwd), ConfigLoader.default_configuration
-      )
-        skip_line_length_cop(PHASE_1_OVERRIDDEN)
-      else
-        run_line_length_cop_auto_gen_config(paths)
-      end
-    end
-
-    def skip_line_length_cop(reason)
-      puts Rainbow("#{PHASE_1} #{reason}").yellow
-      ''
-    end
-
-    def line_length_enabled?(config)
-      line_length_cop(config)['Enabled']
-    end
-
-    def same_max_line_length?(config1, config2)
-      max_line_length(config1) == max_line_length(config2)
-    end
-
-    def max_line_length(config)
-      line_length_cop(config)['Max']
-    end
-
-    def line_length_cop(config)
-      config.for_cop('Metrics/LineLength')
+    def run_command(name)
+      @env.run(name)
     end
 
-    # Do an initial run with only Metrics/LineLength so that cops that depend
-    # on Metrics/LineLength:Max get the correct value for that parameter.
-    def run_line_length_cop_auto_gen_config(paths)
-      puts Rainbow(PHASE_1).yellow
-      @options[:only] = ['Metrics/LineLength']
-      execute_runner(paths)
-      @options.delete(:only)
-      @config_store = ConfigStore.new
-      # Save the todo configuration of the LineLength cop.
-      IO.read(ConfigLoader::AUTO_GENERATED_FILE)
-        .lines
-        .drop_while { |line| line.start_with?('#') }
-        .join
-    end
-
-    def run_all_cops_auto_gen_config(line_length_contents, paths)
-      puts Rainbow(PHASE_2).yellow
-      result = execute_runner(paths)
-      # This run was made with the current maximum length allowed, so append
-      # the saved setting for LineLength.
-      File.open(ConfigLoader::AUTO_GENERATED_FILE, 'a') do |f|
-        f.write(line_length_contents)
-      end
-      result
-    end
-
-    def init_dotfile
-      path = File.expand_path(ConfigLoader::DOTFILE)
-
-      if File.exist?(ConfigLoader::DOTFILE)
-        warn Rainbow("#{ConfigLoader::DOTFILE} already exists at #{path}").red
-
-        STATUS_ERROR
+    def execute_runners
+      if @options[:auto_gen_config]
+        run_command(:auto_gen_config)
       else
-        description = <<~DESC
-          # The behavior of RuboCop can be controlled via the .rubocop.yml
-          # configuration file. It makes it possible to enable/disable
-          # certain cops (checks) and to alter their behavior if they accept
-          # any parameters. The file can be placed either in your home
-          # directory or in some project directory.
-          #
-          # RuboCop will start looking for the configuration file in the directory
-          # where the inspected file is and continue its way up to the root directory.
-          #
-          # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
-        DESC
-
-        File.open(ConfigLoader::DOTFILE, 'w') do |f|
-          f.write(description)
-        end
-
-        puts "Writing new #{ConfigLoader::DOTFILE} to #{path}"
-
-        STATUS_SUCCESS
+        run_command(:execute_runner)
       end
     end
 
-    def reset_config_and_auto_gen_file
-      @config_store = ConfigStore.new
-      @config_store.options_config = @options[:config] if @options[:config]
-      File.open(ConfigLoader::AUTO_GENERATED_FILE, 'w') {}
-      ConfigLoader.add_inheritance_from_auto_generated_file
-    end
-
     def validate_options_vs_config
       if @options[:parallel] &&
          !@config_store.for(Dir.pwd).for_all_cops['UseCache']
@@ -207,31 +102,11 @@ module RuboCop
       end
     end
 
-    def execute_runner(paths)
-      runner = Runner.new(@options, @config_store)
-
-      all_passed = runner.run(paths)
-      display_warning_summary(runner.warnings)
-      display_error_summary(runner.errors)
-      maybe_print_corrected_source
-
-      all_pass_or_excluded = all_passed || @options[:auto_gen_config]
-
-      if runner.aborting?
-        STATUS_INTERRUPTED
-      elsif all_pass_or_excluded && runner.errors.empty?
-        STATUS_SUCCESS
-      else
-        STATUS_OFFENSES
-      end
-    end
-
     def handle_exiting_options
       return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
 
-      puts RuboCop::Version.version(false) if @options[:version]
-      puts RuboCop::Version.version(true) if @options[:verbose_version]
-      print_available_cops if @options[:show_cops]
+      run_command(:version) if @options[:version] || @options[:verbose_version]
+      run_command(:show_cops) if @options[:show_cops]
       raise Finished
     end
 
@@ -247,100 +122,6 @@ module RuboCop
         end
         [[formatter, @options[:output_path]]]
       end
-
-      return unless @options[:auto_gen_config]
-
-      @options[:formatters] << [Formatter::DisabledConfigFormatter,
-                                ConfigLoader::AUTO_GENERATED_FILE]
-    end
-
-    def print_available_cops
-      # Load the configs so the require()s are done for custom cops
-      @config_store.for(Dir.pwd)
-      registry = Cop::Cop.registry
-      show_all = @options[:show_cops].empty?
-
-      if show_all
-        puts "# Available cops (#{registry.length}) + config for #{Dir.pwd}: "
-      end
-
-      registry.departments.sort!.each do |department|
-        print_cops_of_department(registry, department, show_all)
-      end
-    end
-
-    def print_cops_of_department(registry, department, show_all)
-      selected_cops = if show_all
-                        cops_of_department(registry, department)
-                      else
-                        selected_cops_of_department(registry, department)
-                      end
-
-      puts "# Department '#{department}' (#{selected_cops.length}):" if show_all
-
-      print_cop_details(selected_cops)
-    end
-
-    def print_cop_details(cops)
-      cops.each do |cop|
-        puts '# Supports --auto-correct' if cop.new.support_autocorrect?
-        puts "#{cop.cop_name}:"
-        puts config_lines(cop)
-        puts
-      end
-    end
-
-    def selected_cops_of_department(cops, department)
-      cops_of_department(cops, department).select do |cop|
-        @options[:show_cops].include?(cop.cop_name)
-      end
-    end
-
-    def cops_of_department(cops, department)
-      cops.with_department(department).sort!
-    end
-
-    def config_lines(cop)
-      cnf = @config_store.for(Dir.pwd).for_cop(cop)
-      cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
-    end
-
-    def display_warning_summary(warnings)
-      return if warnings.empty?
-
-      warn Rainbow("\n#{pluralize(warnings.size, 'warning')}:").yellow
-
-      warnings.each { |warning| warn warning }
-    end
-
-    def display_error_summary(errors)
-      return if errors.empty?
-
-      warn Rainbow("\n#{pluralize(errors.size, 'error')} occurred:").red
-
-      errors.each { |error| warn error }
-
-      warn <<~WARNING
-        Errors are usually caused by RuboCop bugs.
-        Please, report your problems to RuboCop's issue tracker.
-        #{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}
-
-        Mention the following information in the issue report:
-        #{RuboCop::Version.version(true)}
-      WARNING
-    end
-
-    def maybe_print_corrected_source
-      # If we are asked to autocorrect source code read from stdin, the only
-      # reasonable place to write it is to stdout
-      # Unfortunately, we also write other information to stdout
-      # So a delimiter is needed for tools to easily identify where the
-      # autocorrected source begins
-      return unless @options[:stdin] && @options[:auto_correct]
-
-      puts '=' * 20
-      print @options[:stdin]
     end
   end
 end
-# rubocop:enable Metrics/ClassLength