rubocop 0.51.0 → 0.52.0

data/lib/rubocop/comment_config.rb

@@ -144,11 +144,8 @@ module RuboCop
 
     def non_comment_token_line_numbers
       @non_comment_token_line_numbers ||= begin
-        non_comment_tokens = processed_source.tokens.reject do |token|
-          token.type == :tCOMMENT
-        end
-
-        non_comment_tokens.map { |token| token.pos.line }.uniq
+        non_comment_tokens = processed_source.tokens.reject(&:comment?)
+        non_comment_tokens.map(&:line).uniq
       end
     end
   end

data/lib/rubocop/config.rb

@@ -2,14 +2,14 @@
 
 require 'pathname'
 
-# rubocop:disable Metrics/ClassLength
-
 module RuboCop
   # 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
   # during a run of the rubocop program, if files in several
   # directories are inspected.
+
+  # rubocop:disable Metrics/ClassLength
   class Config
     include PathUtil
 
@@ -17,7 +17,7 @@ module RuboCop
                        AutoCorrect StyleGuide Details].freeze
     # 2.1 is the oldest officially supported Ruby version.
     DEFAULT_RUBY_VERSION = 2.1
-    KNOWN_RUBIES = [2.1, 2.2, 2.3, 2.4].freeze
+    KNOWN_RUBIES = [2.1, 2.2, 2.3, 2.4, 2.5].freeze
     OBSOLETE_RUBIES = { 1.9 => '0.50', 2.0 => '0.50' }.freeze
     DEFAULT_RAILS_VERSION = 5.0
     OBSOLETE_COPS = {
@@ -33,6 +33,9 @@ module RuboCop
       'Style/SingleSpaceBeforeFirstArg' =>
         'The `Style/SingleSpaceBeforeFirstArg` cop has been renamed to ' \
         '`Layout/SpaceBeforeFirstArg`.',
+      'Lint/RescueWithoutErrorClass' =>
+        'The `Lint/RescueWithoutErrorClass` cop has been replaced by ' \
+        '`Style/RescueStandardError`.',
       'Lint/SpaceBeforeFirstArg' =>
         'The `Lint/SpaceBeforeFirstArg` cop has been removed, since it was a ' \
         'duplicate of `Layout/SpaceBeforeFirstArg`. Please use ' \
@@ -114,6 +117,13 @@ module RuboCop
         alternative: 'Style/Encoding no longer supports styles. ' \
                      'The "never" behavior is always assumed.'
       },
+      {
+        cop: 'Style/IfUnlessModifier',
+        parameter: 'MaxLineLength',
+        alternative:
+          '`Style/IfUnlessModifier: MaxLineLength` has been removed. Use ' \
+          '`Metrics/LineLength: Max` instead'
+      },
       {
         cop: 'Style/SpaceAroundOperators',
         parameter: 'MultiSpaceAllowedForOperators',
@@ -121,6 +131,13 @@ module RuboCop
                      'for alignment, please use AllowForAlignment: ' \
                      'true instead.'
       },
+      {
+        cop: 'Style/WhileUntilModifier',
+        parameter: 'MaxLineLength',
+        alternative:
+          '`Style/WhileUntilModifier: MaxLineLength` has been removed. Use ' \
+          '`Metrics/LineLength: Max` instead'
+      },
       {
         cop: 'AllCops',
         parameter: 'RunRailsCops',
@@ -172,6 +189,19 @@ module RuboCop
       @hash = hash
     end
 
+    def self.create(hash, path)
+      new(hash, path).check
+    end
+
+    def check
+      deprecation_check do |deprecation_message|
+        warn("#{path} - #{deprecation_message}")
+      end
+      validate
+      make_excludes_absolute
+      self
+    end
+
     def [](key)
       @hash[key]
     end
@@ -282,7 +312,7 @@ module RuboCop
       check_target_ruby
       validate_parameter_names(valid_cop_names)
       validate_enforced_styles(valid_cop_names)
-      validate_syntax_cop(valid_cop_names)
+      validate_syntax_cop
       reject_mutually_exclusive_defaults
     end
 
@@ -381,13 +411,16 @@ module RuboCop
       end
     end
 
-    def validate_syntax_cop(valid_cop_names)
-      return unless valid_cop_names.include?('Lint/Syntax') ||
-                    valid_cop_names.include?('Syntax')
+    def validate_syntax_cop
+      syntax_config = self['Lint/Syntax']
+      default_config = ConfigLoader.default_configuration['Lint/Syntax']
+
+      return unless syntax_config &&
+                    default_config.merge(syntax_config) != default_config
 
       raise ValidationError,
             "configuration for Syntax cop found in #{smart_loaded_path}\n" \
-            'This cop cannot be configured.'
+            'It\'s not possible to disable this cop.'
     end
 
     def validate_section_presence(name)
@@ -514,4 +547,5 @@ module RuboCop
       PathUtil.smart_path(@loaded_path)
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/rubocop/config_loader.rb

@@ -16,8 +16,6 @@ module RuboCop
     AUTO_GENERATED_FILE = '.rubocop_todo.yml'.freeze
 
     class << self
-      include ConfigLoaderResolver
-
       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
@@ -32,36 +30,22 @@ module RuboCop
 
       def load_file(file)
         return if file.nil?
-        path = File.absolute_path(
-          file.is_a?(RemoteConfig) ? file.file : file
-        )
+        path = File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
 
         hash = load_yaml_configuration(path)
 
         # Resolve requires first in case they define additional cops
-        resolve_requires(path, hash)
+        resolver.resolve_requires(path, hash)
 
         add_missing_namespaces(path, hash)
         target_ruby_version_to_f!(hash)
 
-        resolve_inheritance_from_gems(hash, hash.delete('inherit_gem'))
-        resolve_inheritance(path, hash, file)
+        resolver.resolve_inheritance_from_gems(hash, hash.delete('inherit_gem'))
+        resolver.resolve_inheritance(path, hash, file)
 
         hash.delete('inherit_from')
 
-        create_config(hash, path)
-      end
-
-      def create_config(hash, path)
-        config = Config.new(hash, path)
-
-        config.deprecation_check do |deprecation_message|
-          warn("#{path} - #{deprecation_message}")
-        end
-
-        config.validate
-        config.make_excludes_absolute
-        config
+        Config.create(hash, path)
       end
 
       # rubocop:disable Performance/HashEachMethods
@@ -79,36 +63,7 @@ module RuboCop
       # 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)
-        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])
-        end
-        result
-      end
-
-      def base_configs(path, inherit_from, file)
-        configs = Array(inherit_from).compact.map do |f|
-          load_file(inherited_file(path, f, file))
-        end
-
-        configs.compact
-      end
-
-      def inherited_file(path, inherit_from, file)
-        regex = URI::DEFAULT_PARSER.make_regexp(%w[http https])
-        if inherit_from =~ /\A#{regex}\z/
-          f = RemoteConfig.new(inherit_from, File.dirname(path))
-        elsif file.is_a?(RemoteConfig)
-          f = file.inherit_from_remote(inherit_from, path)
-        else
-          f = File.expand_path(inherit_from, File.dirname(path))
-
-          return if auto_gen_config? && f.include?(AUTO_GENERATED_FILE)
-          print 'Inheriting ' if debug?
-        end
-        f
+        resolver.merge(base_hash, derived_hash)
       end
 
       # Returns the path of .rubocop.yml searching upwards in the
@@ -153,22 +108,7 @@ module RuboCop
       # so that only cops explicitly disabled in user configuration are
       # disabled.
       def merge_with_default(config, config_file)
-        default_configuration = self.default_configuration
-
-        disabled_by_default = config.for_all_cops['DisabledByDefault']
-        enabled_by_default = config.for_all_cops['EnabledByDefault']
-
-        if disabled_by_default || enabled_by_default
-          default_configuration = transform(default_configuration) do |params|
-            params.merge('Enabled' => !disabled_by_default)
-          end
-        end
-
-        if disabled_by_default
-          config = handle_disabled_by_default(config, default_configuration)
-        end
-
-        Config.new(merge(default_configuration, config), config_file)
+        resolver.merge_with_default(config, config_file)
       end
 
       def target_ruby_version_to_f!(hash)
@@ -178,40 +118,37 @@ module RuboCop
         hash['AllCops'][version] = hash['AllCops'][version].to_f
       end
 
-      private
-
-      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|
-          # Rails is always disabled by default and the department's Enabled
-          # flag works like the --rails command line option, which is that when
-          # AllCops:DisabledByDefault is true, each Rails cop must still be
-          # explicitly mentioned in user configuration in order to be enabled.
-          next if dept == 'Rails'
-
-          next unless dept_params['Enabled']
-
-          new_default_configuration.each do |cop, params|
-            next unless cop.start_with?(dept + '/')
+      def add_inheritance_from_auto_generated_file
+        file_string = " #{AUTO_GENERATED_FILE}"
 
-            # Retain original default configuration for cops in the department.
-            params['Enabled'] = default_configuration[cop]['Enabled']
-          end
+        if File.exist?(DOTFILE)
+          files = Array(load_yaml_configuration(DOTFILE)['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 = IO.read(DOTFILE, encoding: Encoding::UTF_8)
+                                   .sub(/^inherit_from: *[.\w]+/, '')
+                                   .sub(/^inherit_from: *(\n *- *[.\w]+)+/, '')
         end
+        write_dotfile(file_string, rubocop_yml_contents)
+        puts "Added inheritance from `#{AUTO_GENERATED_FILE}` in `#{DOTFILE}`."
+      end
+
+      private
 
-        transform(config) do |params|
-          { 'Enabled' => true }.merge(params) # Set true if not set.
+      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
         end
       end
 
-      # Returns a new hash where the parameters of the given config hash have
-      # been replaced by parameters returned by the given block.
-      def transform(config)
-        Hash[config.map { |cop, params| [cop, yield(params)] }]
+      def resolver
+        @resolver ||= ConfigLoaderResolver.new
       end
 
       def load_yaml_configuration(absolute_path)
-        yaml_code = IO.read(absolute_path, encoding: Encoding::UTF_8)
+        yaml_code = read_file(absolute_path)
         hash = yaml_safe_load(yaml_code, absolute_path) || {}
 
         puts "configuration from #{absolute_path}" if debug?
@@ -223,6 +160,16 @@ module RuboCop
         hash
       end
 
+      # Read the specified file, or exit with a friendly, concise message on
+      # stderr. Care is taken to use the standard OS exit code for a "file not
+      # found" error.
+      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)
+      end
+
       def yaml_safe_load(yaml_code, filename)
         if YAML.respond_to?(:safe_load) # Ruby 2.1+
           if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
@@ -236,14 +183,6 @@ module RuboCop
         end
       end
 
-      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)
-      rescue Gem::LoadError => e
-        raise Gem::LoadError,
-              "Unable to find gem #{gem_name}; is the gem installed? #{e}"
-      end
-
       def config_files_in_path(target)
         possible_config_files = dirs_to_search(target).map do |dir|
           File.join(dir, DOTFILE)

data/lib/rubocop/config_loader_resolver.rb

@@ -4,8 +4,8 @@ require 'yaml'
 require 'pathname'
 
 module RuboCop
-  # A mixin to break up ConfigLoader
-  module ConfigLoaderResolver
+  # A help class for ConfigLoader that handles configuration resolution.
+  class ConfigLoaderResolver
     def resolve_requires(path, hash)
       config_dir = File.dirname(path)
       Array(hash.delete('require')).each do |r|
@@ -40,5 +40,102 @@ module RuboCop
         end
       end
     end
+
+    # Merges the given configuration with the default one. If
+    # AllCops:DisabledByDefault is true, it changes the Enabled params so that
+    # only cops from user configuration are enabled.  If
+    # AllCops::EnabledByDefault is true, it changes the Enabled params so that
+    # only cops explicitly disabled in user configuration are disabled.
+    def merge_with_default(config, config_file)
+      default_configuration = ConfigLoader.default_configuration
+
+      disabled_by_default = config.for_all_cops['DisabledByDefault']
+      enabled_by_default = config.for_all_cops['EnabledByDefault']
+
+      if disabled_by_default || enabled_by_default
+        default_configuration = transform(default_configuration) do |params|
+          params.merge('Enabled' => !disabled_by_default)
+        end
+      end
+
+      if disabled_by_default
+        config = handle_disabled_by_default(config, default_configuration)
+      end
+
+      Config.new(merge(default_configuration, config), config_file)
+    end
+
+    # Returns a new hash where the parameters of the given config hash have
+    # been replaced by parameters returned by the given block.
+    # 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)
+      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])
+      end
+      result
+    end
+
+    private
+
+    def base_configs(path, inherit_from, file)
+      configs = Array(inherit_from).compact.map do |f|
+        ConfigLoader.load_file(inherited_file(path, f, file))
+      end
+
+      configs.compact
+    end
+
+    def inherited_file(path, inherit_from, file)
+      regex = URI::DEFAULT_PARSER.make_regexp(%w[http https])
+      if inherit_from =~ /\A#{regex}\z/
+        RemoteConfig.new(inherit_from, File.dirname(path))
+      elsif file.is_a?(RemoteConfig)
+        file.inherit_from_remote(inherit_from, path)
+      else
+        print 'Inheriting ' if ConfigLoader.debug?
+        File.expand_path(inherit_from, File.dirname(path))
+      end
+    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|
+        # Rails is always disabled by default and the department's Enabled flag
+        # works like the --rails command line option, which is that when
+        # AllCops:DisabledByDefault is true, each Rails cop must still be
+        # explicitly mentioned in user configuration in order to be enabled.
+        next if dept == 'Rails'
+
+        next unless dept_params['Enabled']
+
+        new_default_configuration.each do |cop, params|
+          next unless cop.start_with?(dept + '/')
+
+          # Retain original default configuration for cops in the department.
+          params['Enabled'] = ConfigLoader.default_configuration[cop]['Enabled']
+        end
+      end
+
+      transform(config) do |params|
+        { 'Enabled' => true }.merge(params) # Set true if not set.
+      end
+    end
+
+    def transform(config)
+      Hash[config.map { |cop, params| [cop, yield(params)] }]
+    end
+
+    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)
+    rescue Gem::LoadError => e
+      raise Gem::LoadError,
+            "Unable to find gem #{gem_name}; is the gem installed? #{e}"
+    end
   end
 end

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -13,7 +13,7 @@ module RuboCop
       end
 
       def support_autocorrect?
-        respond_to?(:autocorrect, true)
+        respond_to?(:autocorrect)
       end
 
       def autocorrect_enabled?