rubocop 0.67.2 → 0.68.0

data/lib/rubocop.rb

@@ -30,12 +30,14 @@ require_relative 'rubocop/ast/node/mixin/modifier_node'
 require_relative 'rubocop/ast/node/mixin/parameterized_node'
 require_relative 'rubocop/ast/node/mixin/predicate_operator_node'
 require_relative 'rubocop/ast/node/mixin/basic_literal_node'
+require_relative 'rubocop/ast/node/alias_node'
 require_relative 'rubocop/ast/node/and_node'
 require_relative 'rubocop/ast/node/args_node'
 require_relative 'rubocop/ast/node/array_node'
 require_relative 'rubocop/ast/node/block_node'
 require_relative 'rubocop/ast/node/break_node'
 require_relative 'rubocop/ast/node/case_node'
+require_relative 'rubocop/ast/node/class_node'
 require_relative 'rubocop/ast/node/def_node'
 require_relative 'rubocop/ast/node/defined_node'
 require_relative 'rubocop/ast/node/ensure_node'
@@ -43,12 +45,14 @@ require_relative 'rubocop/ast/node/for_node'
 require_relative 'rubocop/ast/node/hash_node'
 require_relative 'rubocop/ast/node/if_node'
 require_relative 'rubocop/ast/node/keyword_splat_node'
+require_relative 'rubocop/ast/node/module_node'
 require_relative 'rubocop/ast/node/or_node'
 require_relative 'rubocop/ast/node/pair_node'
 require_relative 'rubocop/ast/node/range_node'
 require_relative 'rubocop/ast/node/regexp_node'
 require_relative 'rubocop/ast/node/resbody_node'
 require_relative 'rubocop/ast/node/retry_node'
+require_relative 'rubocop/ast/node/self_class_node'
 require_relative 'rubocop/ast/node/send_node'
 require_relative 'rubocop/ast/node/str_node'
 require_relative 'rubocop/ast/node/super_node'
@@ -88,11 +92,11 @@ require_relative 'rubocop/cop/variable_force/scope'
 require_relative 'rubocop/cop/variable_force/variable_table'
 
 require_relative 'rubocop/cop/mixin/annotation_comment'
-require_relative 'rubocop/cop/mixin/array_hash_indentation'
 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/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
@@ -118,6 +122,7 @@ require_relative 'rubocop/cop/mixin/match_range'
 require_relative 'rubocop/cop/mixin/method_complexity'
 require_relative 'rubocop/cop/mixin/method_preference'
 require_relative 'rubocop/cop/mixin/min_body_length'
+require_relative 'rubocop/cop/mixin/multiline_element_indentation'
 require_relative 'rubocop/cop/mixin/multiline_element_line_breaks'
 require_relative 'rubocop/cop/mixin/multiline_expression_indentation'
 require_relative 'rubocop/cop/mixin/multiline_literal_brace_layout'
@@ -175,6 +180,7 @@ require_relative 'rubocop/cop/gemspec/ordered_dependencies'
 require_relative 'rubocop/cop/gemspec/required_ruby_version'
 
 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'
@@ -209,12 +215,14 @@ require_relative 'rubocop/cop/layout/first_array_element_line_break'
 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/indent_array'
+require_relative 'rubocop/cop/layout/heredoc_argument_closing_parenthesis'
 require_relative 'rubocop/cop/layout/indent_assignment'
 require_relative 'rubocop/cop/layout/indentation_consistency'
 require_relative 'rubocop/cop/layout/indentation_width'
-require_relative 'rubocop/cop/layout/indent_hash'
+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'
@@ -285,6 +293,7 @@ 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'
 require_relative 'rubocop/cop/lint/ineffective_access_modifier'
@@ -369,32 +378,6 @@ require_relative 'rubocop/cop/naming/uncommunicative_method_param_name'
 require_relative 'rubocop/cop/naming/variable_name'
 require_relative 'rubocop/cop/naming/variable_number'
 
-require_relative 'rubocop/cop/performance/caller'
-require_relative 'rubocop/cop/performance/case_when_splat'
-require_relative 'rubocop/cop/performance/casecmp'
-require_relative 'rubocop/cop/performance/count'
-require_relative 'rubocop/cop/performance/detect'
-require_relative 'rubocop/cop/performance/double_start_end_with'
-require_relative 'rubocop/cop/performance/end_with'
-require_relative 'rubocop/cop/performance/fixed_size'
-require_relative 'rubocop/cop/performance/flat_map'
-require_relative 'rubocop/cop/performance/inefficient_hash_search'
-require_relative 'rubocop/cop/performance/open_struct'
-require_relative 'rubocop/cop/performance/range_include'
-require_relative 'rubocop/cop/performance/redundant_block_call'
-require_relative 'rubocop/cop/performance/redundant_match'
-require_relative 'rubocop/cop/performance/redundant_merge'
-require_relative 'rubocop/cop/performance/regexp_match'
-require_relative 'rubocop/cop/performance/reverse_each'
-require_relative 'rubocop/cop/performance/size'
-require_relative 'rubocop/cop/performance/compare_with_block'
-require_relative 'rubocop/cop/performance/start_with'
-require_relative 'rubocop/cop/performance/string_replacement'
-require_relative 'rubocop/cop/performance/times_map'
-require_relative 'rubocop/cop/performance/unfreeze_string'
-require_relative 'rubocop/cop/performance/uri_default_parser'
-require_relative 'rubocop/cop/performance/chain_array_allocation'
-
 require_relative 'rubocop/cop/style/access_modifier_declarations'
 require_relative 'rubocop/cop/style/alias'
 require_relative 'rubocop/cop/style/and_or'

data/lib/rubocop/ast/builder.rb

@@ -16,11 +16,13 @@ module RuboCop
     class Builder < Parser::Builders::Default
       NODE_MAP = {
         and: AndNode,
+        alias: AliasNode,
         args: ArgsNode,
         array: ArrayNode,
         block: BlockNode,
         break: BreakNode,
         case: CaseNode,
+        class: ClassNode,
         def: DefNode,
         defined?: DefinedNode,
         defs: DefNode,
@@ -31,6 +33,7 @@ module RuboCop
         irange: RangeNode,
         erange: RangeNode,
         kwsplat: KeywordSplatNode,
+        module: ModuleNode,
         or: OrNode,
         pair: PairNode,
         regexp: RegexpNode,
@@ -41,6 +44,7 @@ module RuboCop
         str: StrNode,
         dstr: StrNode,
         xstr: StrNode,
+        sclass: SelfClassNode,
         super: SuperNode,
         zsuper: SuperNode,
         sym: SymbolNode,

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `alias` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available
+    # to all `alias` nodes within RuboCop.
+    class AliasNode < Node
+      # Returns the old identifier as specified by the `alias`.
+      #
+      # @return [SymbolNode] the old identifier
+      def old_identifier
+        node_parts[1]
+      end
+
+      # Returns the new identifier as specified by the `alias`.
+      #
+      # @return [SymbolNode] the new identifier
+      def new_identifier
+        node_parts[0]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `class` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available
+    # to all `class` nodes within RuboCop.
+    class ClassNode < Node
+      # The identifer for this `class` node.
+      #
+      # @return [Node] the identifer of the class
+      def identifier
+        node_parts[0]
+      end
+
+      # The parent class for this `class` node.
+      #
+      # @return [Node, nil] the parent class of the class
+      def parent_class
+        node_parts[1]
+      end
+
+      # The body of this `class` node.
+      #
+      # @return [Node, nil] the body of the class
+      def body
+        node_parts[2]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `module` nodes. This will be used in place of a
+    # plain node when the builder constructs the AST, making its methods
+    # available to all `module` nodes within RuboCop.
+    class ModuleNode < Node
+      # The identifer for this `module` node.
+      #
+      # @return [Node] the identifer of the module
+      def identifier
+        node_parts[0]
+      end
+
+      # The body of this `module` node.
+      #
+      # @return [Node, nil] the body of the module
+      def body
+        node_parts[1]
+      end
+    end
+  end
+end

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

@@ -6,6 +6,13 @@ module RuboCop
     # place of a plain node when the builder constructs the AST, making its
     # methods available to all `irange` and `erange` nodes within RuboCop.
     class RangeNode < Node
+      def begin
+        node_parts[0]
+      end
+
+      def end
+        node_parts[1]
+      end
     end
   end
 end

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

@@ -12,6 +12,18 @@ module RuboCop
       def body
         node_parts[2]
       end
+
+      # Returns the exception variable of the `rescue` clause.
+      #
+      # @return [Node, nil] The exception variable of the `resbody`.
+      def exception_variable
+        variable = node_parts[1]
+        return variable if variable
+
+        # When resbody is an implicit rescue (i.e. `rescue e` style),
+        # the exception variable is descendants[1].
+        descendants[1]
+      end
     end
   end
 end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `sclass` nodes. This will be used in place of a
+    # plain node when the builder constructs the AST, making its methods
+    # available to all `sclass` nodes within RuboCop.
+    class SelfClassNode < Node
+      # The identifer for this `sclass` node. (Always `self`.)
+      #
+      # @return [Node] the identifer of the class
+      def identifier
+        node_parts[0]
+      end
+
+      # The body of this `sclass` node.
+      #
+      # @return [Node, nil] the body of the class
+      def body
+        node_parts[1]
+      end
+    end
+  end
+end

data/lib/rubocop/cli.rb

@@ -41,10 +41,15 @@ module RuboCop
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def run(args = ARGV)
       @options, paths = Options.new.parse(args)
-      validate_options_vs_config
-      act_on_options
-      apply_default_formatter
-      execute_runners(paths)
+
+      if @options[:init]
+        init_dotfile
+      else
+        validate_options_vs_config
+        act_on_options
+        apply_default_formatter
+        execute_runners(paths)
+      end
     rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
       warn e.message
       STATUS_ERROR
@@ -132,6 +137,37 @@ module RuboCop
       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
+      else
+        description = <<-DESC.strip_indent
+          # 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
+      end
+    end
+
     def reset_config_and_auto_gen_file
       @config_store = ConfigStore.new
       @config_store.options_config = @options[:config] if @options[:config]

data/lib/rubocop/config.rb

@@ -26,9 +26,6 @@ module RuboCop
     RUBY_VERSION_FILENAME = '.ruby-version'.freeze
     DEFAULT_RAILS_VERSION = 5.0
     OBSOLETE_COPS = {
-      'Performance/LstripRstrip' =>
-        'The `Performance/LstripRstrip` cop has been moved ' \
-        'to `Style/Strip`',
       'Style/FlipFlop' =>
         'The `Style/FlipFlop` cop has been moved to `Lint/FlipFlop`.',
       'Style/TrailingComma' =>
@@ -55,6 +52,15 @@ module RuboCop
         'The `Lint/SpaceBeforeFirstArg` cop has been removed, since it was a ' \
         'duplicate of `Layout/SpaceBeforeFirstArg`. Please use ' \
         '`Layout/SpaceBeforeFirstArg` instead.',
+      'Layout/FirstParameterIndentation' =>
+        'The `Layout/FirstParameterIndentation` cop has been renamed to ' \
+        '`Layout/IndentFirstArgument`.',
+      'Layout/IndentArray' =>
+        'The `Layout/IndentArray` cop has been renamed to ' \
+        '`Layout/IndentFirstArrayElement`.',
+      'Layout/IndentHash' =>
+        'The `Layout/IndentHash` cop has been renamed to ' \
+        '`Layout/IndentFirstHashElement`.',
       'Layout/SpaceAfterControlKeyword' =>
         'The `Layout/SpaceAfterControlKeyword` cop has been removed. Please ' \
         'use `Layout/SpaceAroundKeyword` instead.',
@@ -113,10 +119,6 @@ module RuboCop
       'Lint/DefEndAlignment' =>
         'The `Lint/DefEndAlignment` cop has been renamed to ' \
           '`Layout/DefEndAlignment`.',
-      'Performance/HashEachMethods' =>
-        'The `Performance/HashEachMethods` cop has been removed ' \
-          'since it no longer provides performance benefits in ' \
-          'modern rubies.',
       'Style/MethodMissing' =>
         'The `Style/MethodMissing` cop has been split into ' \
           '`Style/MethodMissingSuper` and `Style/MissingRespondToMissing`.'

data/lib/rubocop/config_loader.rb

@@ -15,6 +15,7 @@ module RuboCop
   # directories are inspected.
   class ConfigLoader
     DOTFILE = '.rubocop.yml'.freeze
+    XDG_CONFIG = 'config.yml'.freeze
     RUBOCOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
     DEFAULT_FILE = File.join(RUBOCOP_HOME, 'config', 'default.yml')
     AUTO_GENERATED_FILE = '.rubocop_todo.yml'.freeze
@@ -75,7 +76,10 @@ module RuboCop
       # user's home directory is checked. If there's no .rubocop.yml
       # there either, the path to the default file is returned.
       def configuration_file_for(target_dir)
-        find_file_upwards(DOTFILE, target_dir, use_home: true) || DEFAULT_FILE
+        find_project_dotfile(target_dir) ||
+          find_user_dotfile ||
+          find_user_xdg_config ||
+          DEFAULT_FILE
       end
 
       def configuration_from_file(config_file)
@@ -91,7 +95,10 @@ module RuboCop
       end
 
       def add_excludes_from_files(config, config_file)
-        found_files = find_files_upwards(DOTFILE, config_file, use_home: true)
+        found_files =
+          find_files_upwards(DOTFILE, config_file) +
+          [find_user_dotfile, find_user_xdg_config].compact
+
         return if found_files.empty?
         return if PathUtil.relative_path(found_files.last) ==
                   PathUtil.relative_path(config_file)
@@ -139,6 +146,31 @@ module RuboCop
 
       private
 
+      def find_project_dotfile(target_dir)
+        find_file_upwards(DOTFILE, target_dir)
+      end
+
+      def find_user_dotfile
+        return unless ENV.key?('HOME')
+
+        file = File.join(Dir.home, DOTFILE)
+        return file if File.exist?(file)
+      end
+
+      def find_user_xdg_config
+        xdg_config_home = expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config'))
+        xdg_config = File.join(xdg_config_home, 'rubocop', XDG_CONFIG)
+        return xdg_config if File.exist?(xdg_config)
+      end
+
+      def expand_path(path)
+        File.expand_path(path)
+      rescue ArgumentError
+        # Could happen because HOME or ID could not be determined. Fall back on
+        # using the path literally in that case.
+        path
+      end
+
       def existing_configuration(config_file)
         IO.read(config_file, encoding: Encoding::UTF_8)
           .sub(%r{^inherit_from: *[.\/\w]+}, '')
@@ -174,10 +206,16 @@ module RuboCop
         smart_path = PathUtil.smart_path(absolute_path)
         YAMLDuplicationChecker.check(yaml_code, absolute_path) do |key1, key2|
           value = key1.value
-          line1 = key1.start_line + 1
-          line2 = key2.start_line + 1
-          message = "#{smart_path}:#{line1}: " \
-                    "`#{value}` is concealed by line #{line2}"
+          # .start_line is only available since ruby 2.5 / psych 3.0
+          message = if key1.respond_to? :start_line
+                      line1 = key1.start_line + 1
+                      line2 = key2.start_line + 1
+                      "#{smart_path}:#{line1}: " \
+                      "`#{value}` is concealed by line #{line2}"
+                    else
+                      "#{smart_path}: " \
+                        "`#{value}` is concealed by duplicate"
+                    end
           warn Rainbow(message).yellow
         end
       end
@@ -196,7 +234,8 @@ module RuboCop
         if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
           SafeYAML.load(yaml_code, filename,
                         whitelisted_tags: %w[!ruby/regexp])
-        else
+        # Ruby 2.6+
+        elsif Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
           YAML.safe_load(
             yaml_code,
             permitted_classes: [Regexp, Symbol],
@@ -204,6 +243,8 @@ module RuboCop
             aliases: false,
             filename: filename
           )
+        else
+          YAML.safe_load(yaml_code, [Regexp, Symbol], [], false, filename)
         end
       end
     end