rubocop 0.52.1 → 0.53.0

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

@@ -7,14 +7,6 @@ module RuboCop
     # available to all `sym` nodes within RuboCop.
     class SymbolNode < Node
       include BasicLiteralNode
-
-      # Custom destructuring method. This can be used to normalize
-      # destructuring for different variations of the node.
-      #
-      # @return [Array] the different parts of the `sym` node
-      def node_parts
-        to_a
-      end
     end
   end
 end

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

@@ -30,14 +30,6 @@ module RuboCop
       def do?
         loc.begin && loc.begin.is?('do')
       end
-
-      # Custom destructuring method. This can be used to normalize
-      # destructuring for different variations of the node.
-      #
-      # @return [Array<Node>] the different parts of the `until` statement
-      def node_parts
-        to_a
-      end
     end
   end
 end

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

@@ -48,14 +48,6 @@ module RuboCop
       def body
         node_parts[-1]
       end
-
-      # Custom destructuring method. This can be used to normalize
-      # destructuring for different variations of the node.
-      #
-      # @return [Array<Node>] the different parts of the `until` statement
-      def node_parts
-        to_a
-      end
     end
   end
 end

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

@@ -30,14 +30,6 @@ module RuboCop
       def do?
         loc.begin && loc.begin.is?('do')
       end
-
-      # Custom destructuring method. This can be used to normalize
-      # destructuring for different variations of the node.
-      #
-      # @return [Array<Node>] the different parts of the `while` statement
-      def node_parts
-        to_a
-      end
     end
   end
 end

data/lib/rubocop/cli.rb

@@ -10,6 +10,9 @@ module RuboCop
     SKIPPED_PHASE_1 = 'Phase 1 of 2: run Metrics/LineLength cop (skipped ' \
                       'because the default Metrics/LineLength:Max is ' \
                       'overridden)'.freeze
+    STATUS_SUCCESS  = 0
+    STATUS_OFFENSES = 1
+    STATUS_ERROR    = 2
 
     class Finished < RuntimeError; end
 
@@ -29,27 +32,30 @@ module RuboCop
     # @param args [Array<String>] command line arguments
     # @return [Integer] UNIX exit code
     #
-    # rubocop:disable Metrics/MethodLength
+    # 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)
+    rescue RuboCop::ConfigNotFoundError => e
+      warn e.message
+      e.status
     rescue RuboCop::Error => e
       warn Rainbow("Error: #{e.message}").red
-      return 2
+      STATUS_ERROR
     rescue Finished
-      return 0
+      STATUS_SUCCESS
     rescue IncorrectCopNameError => e
       warn e.message
-      return 2
+      STATUS_ERROR
     rescue StandardError, SyntaxError, LoadError => e
       warn e.message
       warn e.backtrace
-      return 2
+      STATUS_ERROR
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def trap_interrupt(runner)
       Signal.trap('INT') do
@@ -152,7 +158,11 @@ module RuboCop
       display_error_summary(runner.errors)
       maybe_print_corrected_source
 
-      all_passed && !runner.aborting? && runner.errors.empty? ? 0 : 1
+      if all_passed && !runner.aborting? && runner.errors.empty?
+        STATUS_SUCCESS
+      else
+        STATUS_OFFENSES
+      end
     end
 
     def handle_exiting_options

data/lib/rubocop/comment_config.rb

@@ -4,7 +4,7 @@ module RuboCop
   # This class parses the special `rubocop:disable` comments in a source
   # and provides a way to check if each cop is enabled at arbitrary line.
   class CommentConfig
-    UNNEEDED_DISABLE = 'Lint/UnneededDisable'.freeze
+    UNNEEDED_DISABLE = 'Lint/UnneededCopDisableDirective'.freeze
 
     COP_NAME_PATTERN = '([A-Z]\w+/)?(?:[A-Z]\w+)'.freeze
     COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}".freeze
@@ -34,8 +34,29 @@ module RuboCop
       @cop_disabled_line_ranges ||= analyze
     end
 
+    def extra_enabled_comments
+      extra_enabled_comments_with_names([], {})
+    end
+
     private
 
+    def extra_enabled_comments_with_names(extras, names)
+      each_directive do |comment, cop_names, disabled|
+        next unless comment_only_line?(comment.loc.expression.line)
+        cop_names.each do |name|
+          names[name] ||= 0
+          if disabled
+            names[name] += 1
+          elsif names[name] > 0
+            names[name] -= 1
+          else
+            extras << [comment, name]
+          end
+        end
+      end
+      extras
+    end
+
     def analyze
       analyses = Hash.new { |hash, key| hash[key] = CopAnalysis.new([], nil) }
 
@@ -106,7 +127,7 @@ module RuboCop
     def each_directive
       return if processed_source.comments.nil?
 
-      processed_source.comments.each do |comment|
+      processed_source.each_comment do |comment|
         directive = directive_parts(comment)
         next unless directive
 
@@ -129,7 +150,7 @@ module RuboCop
     end
 
     def qualified_cop_name(cop_name)
-      Cop::Cop.qualified_cop_name(cop_name.strip, processed_source.buffer.name)
+      Cop::Cop.qualified_cop_name(cop_name.strip, processed_source.file_path)
     end
 
     def all_cop_names

data/lib/rubocop/config.rb

@@ -12,6 +12,7 @@ module RuboCop
   # rubocop:disable Metrics/ClassLength
   class Config
     include PathUtil
+    include FileFinder
 
     COMMON_PARAMS = %w[Exclude Include Severity
                        AutoCorrect StyleGuide Details].freeze
@@ -24,8 +25,13 @@ module RuboCop
     OBSOLETE_COPS = {
       'Style/TrailingComma' =>
         'The `Style/TrailingComma` cop no longer exists. Please use ' \
-        '`Style/TrailingCommaInLiteral` and/or ' \
-        '`Style/TrailingCommaInArguments` instead.',
+        '`Style/TrailingCommaInArguments`, ' \
+        '`Style/TrailingCommaInArrayLiteral`, and/or ' \
+        '`Style/TrailingCommaInHashLiteral` instead.',
+      'Style/TrailingCommaInLiteral' =>
+        'The `Style/TrailingCommaInLiteral` cop no longer exists. Please use ' \
+        '`Style/TrailingCommaInArrayLiteral` and/or ' \
+        '`Style/TrailingCommaInHashLiteral` instead.',
       'Rails/DefaultScope' =>
         'The `Rails/DefaultScope` cop no longer exists.',
       'Lint/InvalidCharacterLiteral' =>
@@ -89,7 +95,20 @@ module RuboCop
           '`Naming/VariableName`.',
       'Style/VariableNumber' =>
         'The `Style/VariableNumber` cop has been renamed to ' \
-          '`Naming/VariableNumber`.'
+          '`Naming/VariableNumber`.',
+      'Lint/BlockAlignment' =>
+        'The `Lint/BlockAlignment` cop has been renamed to ' \
+          '`Layout/BlockAlignment`.',
+      'Lint/EndAlignment' =>
+        'The `Lint/EndAlignment` cop has been renamed to ' \
+          '`Layout/EndAlignment`.',
+      '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.'
     }.freeze
 
     OBSOLETE_PARAMETERS = [
@@ -157,18 +176,36 @@ module RuboCop
         alternative: '`AlignWith` has been renamed to ' \
                      '`EnforcedStyleAlignWith`'
       },
+      {
+        cop: 'Layout/BlockAlignment',
+        parameter: 'AlignWith',
+        alternative: '`AlignWith` has been renamed to ' \
+                     '`EnforcedStyleAlignWith`'
+      },
       {
         cop: 'Lint/EndAlignment',
         parameter: 'AlignWith',
         alternative: '`AlignWith` has been renamed to ' \
                      '`EnforcedStyleAlignWith`'
       },
+      {
+        cop: 'Layout/EndAlignment',
+        parameter: 'AlignWith',
+        alternative: '`AlignWith` has been renamed to ' \
+                     '`EnforcedStyleAlignWith`'
+      },
       {
         cop: 'Lint/DefEndAlignment',
         parameter: 'AlignWith',
         alternative: '`AlignWith` has been renamed to ' \
                      '`EnforcedStyleAlignWith`'
       },
+      {
+        cop: 'Layout/DefEndAlignment',
+        parameter: 'AlignWith',
+        alternative: '`AlignWith` has been renamed to ' \
+                     '`EnforcedStyleAlignWith`'
+      },
       {
         cop: 'Rails/UniqBeforePluck',
         parameter: 'EnforcedMode',
@@ -395,7 +432,13 @@ module RuboCop
 
     def target_rails_version
       @target_rails_version ||=
-        for_all_cops.fetch('TargetRailsVersion', DEFAULT_RAILS_VERSION)
+        if for_all_cops['TargetRailsVersion']
+          for_all_cops['TargetRailsVersion'].to_f
+        elsif target_rails_version_from_bundler_lock_file
+          target_rails_version_from_bundler_lock_file
+        else
+          DEFAULT_RAILS_VERSION
+        end
     end
 
     private
@@ -521,8 +564,7 @@ module RuboCop
 
     def ruby_version_file
       @ruby_version_file ||=
-        PathUtil.find_file_upwards(RUBY_VERSION_FILENAME,
-                                   base_dir_for_path_parameters)
+        find_file_upwards(RUBY_VERSION_FILENAME, base_dir_for_path_parameters)
     end
 
     def target_ruby_version_from_version_file
@@ -535,6 +577,33 @@ module RuboCop
         end
     end
 
+    def target_rails_version_from_bundler_lock_file
+      @target_rails_version_from_bundler_lock_file ||=
+        read_rails_version_from_bundler_lock_file
+    end
+
+    def read_rails_version_from_bundler_lock_file
+      lock_file_path = bundler_lock_file_path
+      return nil unless lock_file_path
+
+      File.foreach(lock_file_path) do |line|
+        # If rails is in the Gemfile, the lock file should have a line like:
+        #         rails (X.X.X)
+        result = line.match(/^\s+rails\s+\((\d\.\d\.\d)/)
+        return result.captures.first.to_f if result
+      end
+    end
+
+    def bundler_lock_file_path
+      return nil unless loaded_path
+      base_path = base_dir_for_path_parameters
+      ['gems.locked', 'Gemfile.lock'].each do |file_name|
+        path = File.join(base_path, file_name)
+        return path if File.file?(path)
+      end
+      nil
+    end
+
     def reject_mutually_exclusive_defaults
       disabled_by_default = for_all_cops['DisabledByDefault']
       enabled_by_default = for_all_cops['EnabledByDefault']

data/lib/rubocop/config_loader.rb

@@ -4,6 +4,10 @@ require 'yaml'
 require 'pathname'
 
 module RuboCop
+  # Raised when a RuboCop configuration file is not found.
+  class ConfigNotFoundError < Error
+  end
+
   # This class represents the configuration of the RuboCop application
   # and all its cops. A Config is associated with a YAML configuration
   # file from which it was read. Several different Configs can be used
@@ -16,8 +20,9 @@ module RuboCop
     AUTO_GENERATED_FILE = '.rubocop_todo.yml'.freeze
 
     class << self
+      include FileFinder
+
       attr_accessor :debug, :auto_gen_config, :ignore_parent_exclusion
-      attr_writer :root_level # The upwards search is stopped at this level.
       attr_writer :default_configuration
 
       alias debug? debug
@@ -25,7 +30,8 @@ module RuboCop
       alias ignore_parent_exclusion? ignore_parent_exclusion
 
       def clear_options
-        @debug = @auto_gen_config = @root_level = nil
+        @debug = @auto_gen_config = nil
+        FileFinder.root_level = nil
       end
 
       def load_file(file)
@@ -44,11 +50,11 @@ module RuboCop
         resolver.resolve_inheritance(path, hash, file)
 
         hash.delete('inherit_from')
+        hash.delete('inherit_mode')
 
         Config.create(hash, path)
       end
 
-      # rubocop:disable Performance/HashEachMethods
       def add_missing_namespaces(path, hash)
         hash.keys.each do |key|
           q = Cop::Cop.qualified_cop_name(key, path)
@@ -57,7 +63,6 @@ module RuboCop
           hash[q] = hash.delete(key)
         end
       end
-      # rubocop:enable Performance/HashEachMethods
 
       # Return a recursive merge of two hashes. That is, a normal hash merge,
       # with the addition that any value that is a hash, and occurs in both
@@ -72,7 +77,7 @@ 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)
-        config_files_in_path(target_dir).first || DEFAULT_FILE
+        find_file_upwards(DOTFILE, target_dir, use_home: true) || DEFAULT_FILE
       end
 
       def configuration_from_file(config_file)
@@ -88,8 +93,10 @@ module RuboCop
       end
 
       def add_excludes_from_files(config, config_file)
-        found_files = config_files_in_path(config_file)
-        return unless found_files.any? && found_files.last != config_file
+        found_files = find_files_upwards(DOTFILE, config_file, use_home: true)
+        return if found_files.empty?
+        return if PathUtil.relative_path(found_files.last) ==
+                  PathUtil.relative_path(config_file)
         print 'AllCops/Exclude ' if debug?
         config.add_excludes_from_higher_level(load_file(found_files.last))
       end
@@ -138,8 +145,8 @@ module RuboCop
 
       def write_dotfile(file_string, rubocop_yml_contents)
         File.open(DOTFILE, 'w') do |f|
-          f.write "inherit_from:#{file_string}\n\n"
-          f.write rubocop_yml_contents if rubocop_yml_contents
+          f.write "inherit_from:#{file_string}\n"
+          f.write "\n#{rubocop_yml_contents}" if rubocop_yml_contents
         end
       end
 
@@ -166,8 +173,8 @@ module RuboCop
       def read_file(absolute_path)
         IO.read(absolute_path, encoding: Encoding::UTF_8)
       rescue Errno::ENOENT
-        warn(format('Configuration file not found: %s', absolute_path))
-        exit(Errno::ENOENT::Errno)
+        raise ConfigNotFoundError,
+              "Configuration file not found: #{absolute_path}"
       end
 
       def yaml_safe_load(yaml_code, filename)
@@ -182,23 +189,6 @@ module RuboCop
           YAML.load(yaml_code, filename) # rubocop:disable Security/YAMLLoad
         end
       end
-
-      def config_files_in_path(target)
-        possible_config_files = dirs_to_search(target).map do |dir|
-          File.join(dir, DOTFILE)
-        end
-        possible_config_files.select { |config_file| File.exist?(config_file) }
-      end
-
-      def dirs_to_search(target_dir)
-        dirs_to_search = []
-        Pathname.new(File.expand_path(target_dir)).ascend do |dir_pathname|
-          break if dir_pathname.to_s == @root_level
-          dirs_to_search << dir_pathname.to_s
-        end
-        dirs_to_search << Dir.home if ENV.key? 'HOME'
-        dirs_to_search
-      end
     end
 
     # Initializing class ivars

data/lib/rubocop/config_loader_resolver.rb

@@ -18,10 +18,18 @@ module RuboCop
     end
 
     def resolve_inheritance(path, hash, file)
-      base_configs(path, hash['inherit_from'], file)
-        .reverse_each do |base_config|
+      inherited_files = Array(hash['inherit_from'])
+      base_configs(path, inherited_files, file)
+        .reverse.each_with_index do |base_config, index|
         base_config.each do |k, v|
-          hash[k] = hash.key?(k) ? merge(v, hash[k]) : v if v.is_a?(Hash)
+          next unless v.is_a?(Hash)
+          if hash.key?(k)
+            v = merge(v, hash[k],
+                      cop_name: k, file: file,
+                      inherited_file: inherited_files[index],
+                      inherit_mode: determine_inherit_mode(hash, k))
+          end
+          hash[k] = v
         end
       end
     end
@@ -70,18 +78,58 @@ module RuboCop
     # Return a recursive merge of two hashes. That is, a normal hash merge,
     # with the addition that any value that is a hash, and occurs in both
     # arguments, will also be merged. And so on.
-    def merge(base_hash, derived_hash)
+    def merge(base_hash, derived_hash, **opts)
       result = base_hash.merge(derived_hash)
       keys_appearing_in_both = base_hash.keys & derived_hash.keys
       keys_appearing_in_both.each do |key|
-        next unless base_hash[key].is_a?(Hash)
-        result[key] = merge(base_hash[key], derived_hash[key])
+        if base_hash[key].is_a?(Hash)
+          result[key] = merge(base_hash[key], derived_hash[key])
+        elsif should_union?(base_hash, key, opts[:inherit_mode])
+          result[key] = base_hash[key] | derived_hash[key]
+        else
+          warn_on_duplicate_setting(base_hash, derived_hash, key, opts)
+        end
       end
       result
     end
 
     private
 
+    def duplicate_setting?(base_hash, derived_hash, key, inherited_file)
+      return false if inherited_file.nil? # Not inheritance resolving merge
+      return false if inherited_file.start_with?('..') # Legitimate override
+      return false if base_hash[key] == derived_hash[key] # Same value
+      return false if remote_file?(inherited_file) # Can't change
+      Gem.path.none? { |dir| inherited_file.start_with?(dir) } # Can change?
+    end
+
+    def warn_on_duplicate_setting(base_hash, derived_hash, key, **opts)
+      return unless duplicate_setting?(base_hash, derived_hash,
+                                       key, opts[:inherited_file])
+
+      inherit_mode = opts[:inherit_mode]['merge'] ||
+                     opts[:inherit_mode]['override']
+      return if base_hash[key].is_a?(Array) &&
+                inherit_mode && inherit_mode.include?(key)
+
+      warn("#{PathUtil.smart_path(opts[:file])}: " \
+           "#{opts[:cop_name]}:#{key} overrides " \
+           "the same parameter in #{opts[:inherited_file]}")
+    end
+
+    def determine_inherit_mode(hash, key)
+      cop_cfg = hash[key]
+      local_inherit = cop_cfg.delete('inherit_mode') if cop_cfg.is_a?(Hash)
+      local_inherit || hash['inherit_mode'] || {}
+    end
+
+    def should_union?(base_hash, key, inherit_mode)
+      base_hash[key].is_a?(Array) &&
+        inherit_mode &&
+        inherit_mode['merge'] &&
+        inherit_mode['merge'].include?(key)
+    end
+
     def base_configs(path, inherit_from, file)
       configs = Array(inherit_from).compact.map do |f|
         ConfigLoader.load_file(inherited_file(path, f, file))
@@ -91,8 +139,7 @@ module RuboCop
     end
 
     def inherited_file(path, inherit_from, file)
-      regex = URI::DEFAULT_PARSER.make_regexp(%w[http https])
-      if inherit_from =~ /\A#{regex}\z/
+      if remote_file?(inherit_from)
         RemoteConfig.new(inherit_from, File.dirname(path))
       elsif file.is_a?(RemoteConfig)
         file.inherit_from_remote(inherit_from, path)
@@ -102,6 +149,11 @@ module RuboCop
       end
     end
 
+    def remote_file?(uri)
+      regex = URI::DEFAULT_PARSER.make_regexp(%w[http https])
+      uri =~ /\A#{regex}\z/
+    end
+
     def handle_disabled_by_default(config, new_default_configuration)
       department_config = config.to_hash.reject { |cop| cop.include?('/') }
       department_config.each do |dept, dept_params|
@@ -132,7 +184,7 @@ module RuboCop
 
     def gem_config_path(gem_name, relative_config_path)
       spec = Gem::Specification.find_by_name(gem_name)
-      return File.join(spec.gem_dir, relative_config_path)
+      File.join(spec.gem_dir, relative_config_path)
     rescue Gem::LoadError => e
       raise Gem::LoadError,
             "Unable to find gem #{gem_name}; is the gem installed? #{e}"