rubocop 0.85.1 → 0.89.0

data/lib/rubocop.rb

@@ -23,6 +23,7 @@ require_relative 'rubocop/string_interpreter'
 require_relative 'rubocop/error'
 require_relative 'rubocop/warning'
 
+require_relative 'rubocop/cop/tokens_util'
 require_relative 'rubocop/cop/util'
 require_relative 'rubocop/cop/offense'
 require_relative 'rubocop/cop/message_annotator'
@@ -30,6 +31,7 @@ require_relative 'rubocop/cop/ignored_node'
 require_relative 'rubocop/cop/autocorrect_logic'
 require_relative 'rubocop/cop/badge'
 require_relative 'rubocop/cop/registry'
+require_relative 'rubocop/cop/base'
 require_relative 'rubocop/cop/cop'
 require_relative 'rubocop/cop/commissioner'
 require_relative 'rubocop/cop/corrector'
@@ -52,11 +54,12 @@ require_relative 'rubocop/cop/mixin/annotation_comment'
 require_relative 'rubocop/cop/mixin/array_min_size'
 require_relative 'rubocop/cop/mixin/array_syntax'
 require_relative 'rubocop/cop/mixin/alignment'
+require_relative 'rubocop/cop/mixin/allowed_methods'
+require_relative 'rubocop/cop/mixin/auto_corrector'
 require_relative 'rubocop/cop/mixin/check_assignment'
 require_relative 'rubocop/cop/mixin/check_line_breakable'
 require_relative 'rubocop/cop/mixin/configurable_max'
 require_relative 'rubocop/cop/mixin/code_length' # relies on configurable_max
-require_relative 'rubocop/cop/mixin/classish_length' # relies on code_length
 require_relative 'rubocop/cop/mixin/configurable_enforced_style'
 require_relative 'rubocop/cop/mixin/configurable_formatting'
 require_relative 'rubocop/cop/mixin/configurable_naming'
@@ -79,6 +82,7 @@ require_relative 'rubocop/cop/mixin/integer_node'
 require_relative 'rubocop/cop/mixin/interpolation'
 require_relative 'rubocop/cop/mixin/line_length_help'
 require_relative 'rubocop/cop/mixin/match_range'
+require_relative 'rubocop/cop/metrics/utils/repeated_csend_discount'
 require_relative 'rubocop/cop/mixin/method_complexity'
 require_relative 'rubocop/cop/mixin/method_preference'
 require_relative 'rubocop/cop/mixin/min_body_length'
@@ -92,7 +96,6 @@ require_relative 'rubocop/cop/mixin/nil_methods'
 require_relative 'rubocop/cop/mixin/on_normal_if_unless'
 require_relative 'rubocop/cop/mixin/ordered_gem_node'
 require_relative 'rubocop/cop/mixin/parentheses'
-require_relative 'rubocop/cop/mixin/parser_diagnostic'
 require_relative 'rubocop/cop/mixin/percent_array'
 require_relative 'rubocop/cop/mixin/percent_literal'
 require_relative 'rubocop/cop/mixin/preceding_following_alignment'
@@ -108,11 +111,11 @@ require_relative 'rubocop/cop/mixin/statement_modifier'
 require_relative 'rubocop/cop/mixin/string_help'
 require_relative 'rubocop/cop/mixin/string_literals_help'
 require_relative 'rubocop/cop/mixin/target_ruby_version'
-require_relative 'rubocop/cop/mixin/too_many_lines'
 require_relative 'rubocop/cop/mixin/trailing_body'
 require_relative 'rubocop/cop/mixin/trailing_comma'
 require_relative 'rubocop/cop/mixin/uncommunicative_name'
 require_relative 'rubocop/cop/mixin/unused_argument'
+require_relative 'rubocop/cop/mixin/visibility_help'
 
 require_relative 'rubocop/cop/utils/format_string'
 
@@ -240,17 +243,22 @@ require_relative 'rubocop/cop/lint/ambiguous_operator'
 require_relative 'rubocop/cop/lint/ambiguous_regexp_literal'
 require_relative 'rubocop/cop/lint/assignment_in_condition'
 require_relative 'rubocop/cop/lint/big_decimal_new'
+require_relative 'rubocop/cop/lint/binary_operator_with_identical_operands'
 require_relative 'rubocop/cop/lint/boolean_symbol'
 require_relative 'rubocop/cop/lint/circular_argument_reference'
+require_relative 'rubocop/cop/lint/constant_resolution'
 require_relative 'rubocop/cop/lint/debugger'
 require_relative 'rubocop/cop/lint/deprecated_class_methods'
 require_relative 'rubocop/cop/lint/deprecated_open_ssl_constant'
 require_relative 'rubocop/cop/lint/disjunctive_assignment_in_constructor'
 require_relative 'rubocop/cop/lint/duplicate_case_condition'
+require_relative 'rubocop/cop/lint/duplicate_elsif_condition'
 require_relative 'rubocop/cop/lint/duplicate_hash_key'
 require_relative 'rubocop/cop/lint/duplicate_methods'
+require_relative 'rubocop/cop/lint/duplicate_rescue_exception'
 require_relative 'rubocop/cop/lint/each_with_object_argument'
 require_relative 'rubocop/cop/lint/else_layout'
+require_relative 'rubocop/cop/lint/empty_conditional_body'
 require_relative 'rubocop/cop/lint/empty_ensure'
 require_relative 'rubocop/cop/lint/empty_expression'
 require_relative 'rubocop/cop/lint/empty_interpolation'
@@ -258,6 +266,7 @@ require_relative 'rubocop/cop/lint/empty_when'
 require_relative 'rubocop/cop/lint/ensure_return'
 require_relative 'rubocop/cop/lint/erb_new_arguments'
 require_relative 'rubocop/cop/lint/flip_flop'
+require_relative 'rubocop/cop/lint/float_comparison'
 require_relative 'rubocop/cop/lint/float_out_of_range'
 require_relative 'rubocop/cop/lint/format_parameter_mismatch'
 require_relative 'rubocop/cop/lint/heredoc_method_call_position'
@@ -269,6 +278,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/missing_super'
 require_relative 'rubocop/cop/lint/mixed_regexp_capture_types'
 require_relative 'rubocop/cop/lint/multiple_comparison'
 require_relative 'rubocop/cop/lint/nested_method_definition'
@@ -278,6 +288,7 @@ require_relative 'rubocop/cop/lint/non_deterministic_require_order'
 require_relative 'rubocop/cop/lint/non_local_exit_from_iterator'
 require_relative 'rubocop/cop/lint/number_conversion'
 require_relative 'rubocop/cop/lint/ordered_magic_comments'
+require_relative 'rubocop/cop/lint/out_of_range_regexp_ref'
 require_relative 'rubocop/cop/lint/parentheses_as_grouped_expression'
 require_relative 'rubocop/cop/lint/percent_string_array'
 require_relative 'rubocop/cop/lint/percent_symbol_array'
@@ -299,6 +310,7 @@ require_relative 'rubocop/cop/lint/safe_navigation_consistency'
 require_relative 'rubocop/cop/lint/safe_navigation_chain'
 require_relative 'rubocop/cop/lint/safe_navigation_with_empty'
 require_relative 'rubocop/cop/lint/script_permission'
+require_relative 'rubocop/cop/lint/self_assignment'
 require_relative 'rubocop/cop/lint/send_with_mixin_argument'
 require_relative 'rubocop/cop/lint/shadowed_argument'
 require_relative 'rubocop/cop/lint/shadowed_exception'
@@ -307,23 +319,26 @@ require_relative 'rubocop/cop/lint/struct_new_override'
 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/top_level_return_with_argument'
 require_relative 'rubocop/cop/lint/underscore_prefixed_variable_name'
 require_relative 'rubocop/cop/lint/unified_integer'
 require_relative 'rubocop/cop/lint/unreachable_code'
+require_relative 'rubocop/cop/lint/unreachable_loop'
 require_relative 'rubocop/cop/lint/unused_block_argument'
 require_relative 'rubocop/cop/lint/unused_method_argument'
 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_comparison'
 require_relative 'rubocop/cop/lint/useless_else_without_rescue'
 require_relative 'rubocop/cop/lint/useless_setter_call'
 require_relative 'rubocop/cop/lint/void'
 
+require_relative 'rubocop/cop/metrics/utils/iterating_block'
 require_relative 'rubocop/cop/metrics/cyclomatic_complexity'
 # relies on cyclomatic_complexity
 require_relative 'rubocop/cop/metrics/utils/abc_size_calculator'
+require_relative 'rubocop/cop/metrics/utils/code_length_calculator'
 require_relative 'rubocop/cop/metrics/abc_size'
 require_relative 'rubocop/cop/metrics/block_length'
 require_relative 'rubocop/cop/metrics/block_nesting'
@@ -351,17 +366,21 @@ require_relative 'rubocop/cop/naming/variable_name'
 require_relative 'rubocop/cop/naming/variable_number'
 
 require_relative 'rubocop/cop/style/access_modifier_declarations'
+require_relative 'rubocop/cop/style/accessor_grouping'
 require_relative 'rubocop/cop/style/alias'
 require_relative 'rubocop/cop/style/and_or'
+require_relative 'rubocop/cop/style/array_coercion'
 require_relative 'rubocop/cop/style/array_join'
 require_relative 'rubocop/cop/style/ascii_comments'
 require_relative 'rubocop/cop/style/attr'
 require_relative 'rubocop/cop/style/auto_resource_cleanup'
 require_relative 'rubocop/cop/style/bare_percent_literals'
 require_relative 'rubocop/cop/style/begin_block'
+require_relative 'rubocop/cop/style/bisected_attr_accessor'
 require_relative 'rubocop/cop/style/block_comments'
 require_relative 'rubocop/cop/style/block_delimiters'
 require_relative 'rubocop/cop/style/case_equality'
+require_relative 'rubocop/cop/style/case_like_if'
 require_relative 'rubocop/cop/style/character_literal'
 require_relative 'rubocop/cop/style/class_and_module_children'
 require_relative 'rubocop/cop/style/class_check'
@@ -397,15 +416,19 @@ require_relative 'rubocop/cop/style/end_block'
 require_relative 'rubocop/cop/style/eval_with_location'
 require_relative 'rubocop/cop/style/even_odd'
 require_relative 'rubocop/cop/style/expand_path_arguments'
+require_relative 'rubocop/cop/style/explicit_block_argument'
 require_relative 'rubocop/cop/style/exponential_notation'
 require_relative 'rubocop/cop/style/float_division'
 require_relative 'rubocop/cop/style/for'
 require_relative 'rubocop/cop/style/format_string'
 require_relative 'rubocop/cop/style/format_string_token'
 require_relative 'rubocop/cop/style/frozen_string_literal_comment'
+require_relative 'rubocop/cop/style/global_std_stream'
 require_relative 'rubocop/cop/style/global_vars'
 require_relative 'rubocop/cop/style/guard_clause'
+require_relative 'rubocop/cop/style/hash_as_last_array_item'
 require_relative 'rubocop/cop/style/hash_each_methods'
+require_relative 'rubocop/cop/style/hash_like_case'
 require_relative 'rubocop/cop/style/hash_syntax'
 require_relative 'rubocop/cop/style/hash_transform_keys'
 require_relative 'rubocop/cop/style/hash_transform_values'
@@ -424,11 +447,13 @@ require_relative 'rubocop/cop/style/lambda_call'
 require_relative 'rubocop/cop/style/line_end_concatenation'
 require_relative 'rubocop/cop/style/method_call_without_args_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
+require_relative 'rubocop/cop/style/redundant_assignment'
+require_relative 'rubocop/cop/style/redundant_fetch_block'
+require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses/require_parentheses'
 require_relative 'rubocop/cop/style/method_called_on_do_end_block'
 require_relative 'rubocop/cop/style/method_def_parentheses'
-require_relative 'rubocop/cop/style/method_missing_super'
 require_relative 'rubocop/cop/style/min_max'
 require_relative 'rubocop/cop/style/missing_else'
 require_relative 'rubocop/cop/style/missing_respond_to_missing'
@@ -461,6 +486,7 @@ require_relative 'rubocop/cop/style/one_line_conditional'
 require_relative 'rubocop/cop/style/or_assignment'
 require_relative 'rubocop/cop/style/option_hash'
 require_relative 'rubocop/cop/style/optional_arguments'
+require_relative 'rubocop/cop/style/optional_boolean_parameter'
 require_relative 'rubocop/cop/style/parallel_assignment'
 require_relative 'rubocop/cop/style/parentheses_around_condition'
 require_relative 'rubocop/cop/style/percent_literal_delimiters'
@@ -495,12 +521,14 @@ require_relative 'rubocop/cop/style/self_assignment'
 require_relative 'rubocop/cop/style/semicolon'
 require_relative 'rubocop/cop/style/send'
 require_relative 'rubocop/cop/style/signal_exception'
+require_relative 'rubocop/cop/style/single_argument_dig'
 require_relative 'rubocop/cop/style/single_line_block_params'
 require_relative 'rubocop/cop/style/single_line_methods'
 require_relative 'rubocop/cop/style/slicing_with_range'
 require_relative 'rubocop/cop/style/special_global_vars'
 require_relative 'rubocop/cop/style/stabby_lambda_parentheses'
 require_relative 'rubocop/cop/style/stderr_puts'
+require_relative 'rubocop/cop/style/string_concatenation'
 require_relative 'rubocop/cop/style/string_hash_keys'
 require_relative 'rubocop/cop/style/string_literals'
 require_relative 'rubocop/cop/style/string_literals_in_interpolation'

data/lib/rubocop/cli.rb

@@ -75,7 +75,7 @@ module RuboCop
 
     def validate_options_vs_config
       if @options[:parallel] &&
-         !@config_store.for_dir(Dir.pwd).for_all_cops['UseCache']
+         !@config_store.for_pwd.for_all_cops['UseCache']
         raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
                                    'execution, so combining with AllCops: ' \
                                    'UseCache: false is not allowed.'
@@ -101,11 +101,9 @@ module RuboCop
 
     def set_options_to_config_loader
       ConfigLoader.debug = @options[:debug]
-      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
       ConfigLoader.disable_pending_cops = @options[:disable_pending_cops]
       ConfigLoader.enable_pending_cops = @options[:enable_pending_cops]
       ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
-      ConfigLoader.options_config = @options[:config]
     end
 
     def handle_exiting_options
@@ -123,7 +121,7 @@ module RuboCop
         if @options[:auto_gen_config]
           formatter = 'autogenconf'
         else
-          cfg = @config_store.for_dir(Dir.pwd).for_all_cops
+          cfg = @config_store.for_pwd.for_all_cops
           formatter = cfg['DefaultFormatter'] || 'progress'
         end
         [[formatter, @options[:output_path]]]

data/lib/rubocop/cli/command/auto_genenerate_config.rb

@@ -7,6 +7,8 @@ module RuboCop
       class AutoGenerateConfig < Base
         self.command_name = :auto_gen_config
 
+        AUTO_GENERATED_FILE = '.rubocop_todo.yml'
+
         PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
         PHASE_2 = 'Phase 2 of 2: run all cops'
 
@@ -25,10 +27,10 @@ module RuboCop
         private
 
         def maybe_run_line_length_cop
-          if !line_length_enabled?(@config_store.for_dir(Dir.pwd))
+          if !line_length_enabled?(@config_store.for_pwd)
             skip_line_length_cop(PHASE_1_DISABLED)
           elsif !same_max_line_length?(
-            @config_store.for_dir(Dir.pwd), ConfigLoader.default_configuration
+            @config_store.for_pwd, ConfigLoader.default_configuration
           )
             skip_line_length_cop(PHASE_1_OVERRIDDEN)
           else
@@ -67,7 +69,7 @@ module RuboCop
           @options.delete(:only)
           @config_store = ConfigStore.new
           # Save the todo configuration of the LineLength cop.
-          IO.read(ConfigLoader::AUTO_GENERATED_FILE)
+          IO.read(AUTO_GENERATED_FILE)
             .lines
             .drop_while { |line| line.start_with?('#') }
             .join
@@ -78,7 +80,7 @@ module RuboCop
           result = execute_runner
           # 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|
+          File.open(AUTO_GENERATED_FILE, 'a') do |f|
             f.write(line_length_contents)
           end
           result
@@ -87,18 +89,51 @@ module RuboCop
         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
+          File.open(AUTO_GENERATED_FILE, 'w') {}
+          add_inheritance_from_auto_generated_file(@options[:config])
         end
 
         def add_formatter
           @options[:formatters] << [Formatter::DisabledConfigFormatter,
-                                    ConfigLoader::AUTO_GENERATED_FILE]
+                                    AUTO_GENERATED_FILE]
         end
 
         def execute_runner
           Environment.new(@options, @config_store, @paths).run(:execute_runner)
         end
+
+        def add_inheritance_from_auto_generated_file(config_file)
+          file_string = " #{AUTO_GENERATED_FILE}"
+
+          config_file ||= ConfigLoader::DOTFILE
+
+          if File.exist?(config_file)
+            files = Array(ConfigLoader.load_yaml_configuration(config_file)['inherit_from'])
+
+            return if files.include?(AUTO_GENERATED_FILE)
+
+            files.unshift(AUTO_GENERATED_FILE)
+            file_string = "\n  - #{files.join("\n  - ")}" if files.size > 1
+            rubocop_yml_contents = existing_configuration(config_file)
+          end
+
+          write_config_file(config_file, file_string, rubocop_yml_contents)
+
+          puts "Added inheritance from `#{AUTO_GENERATED_FILE}` in `#{ConfigLoader::DOTFILE}`."
+        end
+
+        def existing_configuration(config_file)
+          IO.read(config_file, encoding: Encoding::UTF_8)
+            .sub(/^inherit_from: *[^\n]+/, '')
+            .sub(/^inherit_from: *(\n *- *[^\n]+)+/, '')
+        end
+
+        def write_config_file(file_name, file_string, rubocop_yml_contents)
+          File.open(file_name, 'w') do |f|
+            f.write "inherit_from:#{file_string}\n"
+            f.write "\n#{rubocop_yml_contents}" if /\S/.match?(rubocop_yml_contents)
+          end
+        end
       end
     end
   end

data/lib/rubocop/cli/command/base.rb

@@ -13,6 +13,7 @@ module RuboCop
           attr_accessor :command_name
 
           def inherited(subclass)
+            super
             @subclasses << subclass
           end
 

data/lib/rubocop/cli/command/execute_runner.rb

@@ -55,7 +55,7 @@ module RuboCop
             #{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}
 
             Mention the following information in the issue report:
-            #{RuboCop::Version.version(true)}
+            #{RuboCop::Version.version(debug: true)}
           WARNING
         end
 

data/lib/rubocop/cli/command/init_dotfile.rb

@@ -27,7 +27,7 @@ module RuboCop
               # 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
+              # See https://docs.rubocop.org/rubocop/configuration
             DESC
 
             File.open(DOTFILE, 'w') do |f|

data/lib/rubocop/cli/command/show_cops.rb

@@ -49,7 +49,7 @@ module RuboCop
 
         def print_cop_details(cops)
           cops.each do |cop|
-            puts '# Supports --auto-correct' if cop.new(@config).support_autocorrect?
+            puts '# Supports --auto-correct' if cop.support_autocorrect?
             puts "#{cop.cop_name}:"
             puts config_lines(cop)
             puts
@@ -68,7 +68,7 @@ module RuboCop
 
         def config_lines(cop)
           cnf = @config.for_cop(cop)
-          cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
+          cnf.to_yaml.lines.to_a.drop(1).map { |line| "  #{line}" }
         end
       end
     end

data/lib/rubocop/cli/command/version.rb

@@ -8,8 +8,8 @@ module RuboCop
         self.command_name = :version
 
         def run
-          puts RuboCop::Version.version(false) if @options[:version]
-          puts RuboCop::Version.version(true) if @options[:verbose_version]
+          puts RuboCop::Version.version(debug: false) if @options[:version]
+          puts RuboCop::Version.version(debug: true) if @options[:verbose_version]
         end
       end
     end

data/lib/rubocop/comment_config.rb

@@ -11,7 +11,7 @@ module RuboCop
     COPS_PATTERN = "(all|#{COP_NAMES_PATTERN})"
 
     COMMENT_DIRECTIVE_REGEXP = Regexp.new(
-      ('# rubocop : ((?:disable|enable|todo))\b ' + COPS_PATTERN)
+      "# rubocop : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
         .gsub(' ', '\s*')
     )
 
@@ -55,7 +55,7 @@ module RuboCop
       extras
     end
 
-    def analyze
+    def analyze # rubocop:todo Metrics/AbcSize
       analyses = Hash.new { |hash, key| hash[key] = CopAnalysis.new([], nil) }
 
       each_mentioned_cop do |cop_name, disabled, line, single_line|

data/lib/rubocop/config.rb

@@ -47,7 +47,7 @@ module RuboCop
     end
 
     def_delegators :@hash, :[], :[]=, :delete, :each, :key?, :keys, :each_key,
-                   :map, :merge, :to_h, :to_hash, :transform_values
+                   :fetch, :map, :merge, :to_h, :to_hash, :transform_values
     def_delegators :@validator, :validate, :target_ruby_version
 
     def to_s
@@ -104,12 +104,29 @@ module RuboCop
       end
     end
 
+    # @return [Config] for the given cop / cop name.
+    # Note: the 'Enabled' attribute is calculated according to the department's
+    # and 'AllCops' configuration; other attributes are not inherited.
     def for_cop(cop)
       @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : cop]
     end
 
+    # @return [Config] for the given cop merged with that of its department (if any)
+    # Note: the 'Enabled' attribute is same as that returned by `for_cop`
+    def for_badge(badge)
+      cop_config = for_cop(badge.to_s)
+      fetch(badge.department.to_s) { return cop_config }
+        .merge(cop_config)
+    end
+
+    # @return [Config] for the given department name.
+    # Note: the 'Enabled' attribute will be present only if specified
+    # at the department's level
     def for_department(department_name)
-      @for_cop[department_name]
+      @for_department ||= Hash.new do |h, dept|
+        h[dept] = self[dept] || {}
+      end
+      @for_department[department_name.to_s]
     end
 
     def for_all_cops
@@ -152,7 +169,7 @@ module RuboCop
       return true if File.extname(file) == '.gemspec'
 
       file_to_include?(file) do |pattern, relative_path, absolute_path|
-        pattern.to_s =~ /[A-Z]/ &&
+        /[A-Z]/.match?(pattern.to_s) &&
           (match_path?(pattern, relative_path) ||
            match_path?(pattern, absolute_path))
       end