rubocop 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f019dc65a23e4fdd32592747afcbee2cf60dff91484b26714f587b9f70a178
-  data.tar.gz: 85f0e9d193e2165646764047f5422cb7942c87a147c96ff8e4a05b186eaea3c5
+  metadata.gz: 580e325f7dc471739e2f4857d82e279776098ae14fff7367eaa803f688c9e58d
+  data.tar.gz: c8331c8b2ebbecb239d4a63dee21375172d1d2939572516bba910109ef5375a1
 SHA512:
-  metadata.gz: 5064fb48121769e10df9fe4dd7295151f15c2a3ae5f67fbb2869302a7ad268dfd3ed20e7a3242bf59ef68c1c6cf4e92452fedab08971702d29dba06516250de8
-  data.tar.gz: 3b01830b9394f8336bdc415d90e2805f2817eb9fa9686a11392ef8009c4a58dd4b04e40c4a8005e90204774e85b38a6885c315581d55c56bf4a847c71c570447
+  metadata.gz: 5f9ecd1e28e7fa7946b22aaecc0d5571337d85ca6b9a198e9542a9d26d05c9d0806597ccd66d0090c4318d349c7023fe201103fa197eaa88d5e98534d25ff755
+  data.tar.gz: 4bc7ec5d20c127826a1761b9495669242d53b740509ca13060c1202d0114062fb73a52738b9fb717f5348fdad7cb2a2fb5ee0ea4cc8a9b5823298908a0ce6a5b

data/README.md

@@ -10,6 +10,7 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/d2d67f728e88ea84ac69/test_coverage)](https://codeclimate.com/github/rubocop/rubocop/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/d2d67f728e88ea84ac69/maintainability)](https://codeclimate.com/github/rubocop/rubocop/maintainability)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)
+[![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/wJjWvGRDmm)
 
 > Role models are important. <br/>
 > -- Officer Alex J. Murphy / RoboCop
@@ -51,7 +52,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.12', require: false
+gem 'rubocop', '~> 1.13', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.
@@ -73,7 +74,7 @@ You can read a lot more about RuboCop in its [official docs](https://docs.ruboco
 
 RuboCop officially supports the following Ruby implementations:
 
-* MRI 2.4+
+* MRI 2.5+
 * JRuby 9.2+
 
 See the [compatibility documentation](https://docs.rubocop.org/rubocop/compatibility.html) for further details.

data/config/default.yml

@@ -1101,6 +1101,14 @@ Layout/ParameterAlignment:
   # But it can be overridden by setting this parameter
   IndentationWidth: ~
 
+Layout/RedundantLineBreak:
+  Description: >-
+                 Do not break up an expression into multiple lines when it fits
+                 on a single line.
+  Enabled: false
+  InspectBlocks: false
+  VersionAdded: '1.13'
+
 Layout/RescueEnsureAlignment:
   Description: 'Align rescues and ensures correctly.'
   Enabled: true
@@ -1380,6 +1388,8 @@ Lint/AmbiguousBlockAssociation:
   StyleGuide: '#syntax'
   Enabled: true
   VersionAdded: '0.48'
+  VersionChanged: '1.13'
+  IgnoredMethods: []
 
 Lint/AmbiguousOperator:
   Description: >-

data/exe/rubocop

@@ -9,9 +9,7 @@ require 'benchmark'
 cli = RuboCop::CLI.new
 result = 0
 
-time = Benchmark.realtime do
-  result = cli.run
-end
+time = Benchmark.realtime { result = cli.run }
 
 puts "Finished in #{time} seconds" if cli.options[:debug] || cli.options[:display_time]
 exit result

data/lib/rubocop.rb

@@ -18,7 +18,6 @@ require_relative 'rubocop/ext/regexp_node'
 require_relative 'rubocop/ext/regexp_parser'
 
 require_relative 'rubocop/core_ext/string'
-require_relative 'rubocop/core_ext/hash'
 require_relative 'rubocop/ext/processed_source'
 
 require_relative 'rubocop/path_util'
@@ -222,6 +221,7 @@ 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/redundant_line_break'
 require_relative 'rubocop/cop/layout/rescue_ensure_alignment'
 require_relative 'rubocop/cop/layout/space_after_colon'
 require_relative 'rubocop/cop/layout/space_after_comma'

data/lib/rubocop/cached_data.rb

@@ -51,9 +51,7 @@ module RuboCop
         location = Parser::Source::Range.new(source_buffer,
                                              o['location']['begin_pos'],
                                              o['location']['end_pos'])
-        Cop::Offense.new(o['severity'], location,
-                         o['message'],
-                         o['cop_name'], o['status'].to_sym)
+        Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym)
       end
     end
   end

data/lib/rubocop/cli.rb

@@ -78,12 +78,10 @@ module RuboCop
     end
 
     def validate_options_vs_config
-      if @options[:parallel] &&
-         !@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.'
-      end
+      return unless @options[:parallel] && !@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.'
     end
 
     def act_on_options

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

@@ -14,10 +14,8 @@ module RuboCop
         PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
         PHASE_2 = 'Phase 2 of 2: run all cops'
 
-        PHASE_1_OVERRIDDEN =
-          '(skipped because the default Layout/LineLength:Max is overridden)'
-        PHASE_1_DISABLED =
-          '(skipped because Layout/LineLength is disabled)'
+        PHASE_1_OVERRIDDEN = '(skipped because the default Layout/LineLength:Max is overridden)'
+        PHASE_1_DISABLED = '(skipped because Layout/LineLength is disabled)'
 
         def run
           add_formatter
@@ -31,9 +29,7 @@ module RuboCop
         def maybe_run_line_length_cop
           if !line_length_enabled?(@config_store.for_pwd)
             skip_line_length_cop(PHASE_1_DISABLED)
-          elsif !same_max_line_length?(
-            @config_store.for_pwd, ConfigLoader.default_configuration
-          )
+          elsif !same_max_line_length?(@config_store.for_pwd, ConfigLoader.default_configuration)
             skip_line_length_cop(PHASE_1_OVERRIDDEN)
           else
             run_line_length_cop
@@ -71,10 +67,7 @@ module RuboCop
           @options.delete(:only)
           @config_store = ConfigStore.new
           # Save the todo configuration of the LineLength cop.
-          IO.read(AUTO_GENERATED_FILE)
-            .lines
-            .drop_while { |line| line.start_with?('#') }
-            .join
+          File.read(AUTO_GENERATED_FILE).lines.drop_while { |line| line.start_with?('#') }.join
         end
 
         def run_all_cops(line_length_contents)
@@ -82,9 +75,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(AUTO_GENERATED_FILE, 'a') do |f|
-            f.write(line_length_contents)
-          end
+          File.open(AUTO_GENERATED_FILE, 'a') { |f| f.write(line_length_contents) }
           result
         end
 
@@ -96,8 +87,7 @@ module RuboCop
         end
 
         def add_formatter
-          @options[:formatters] << [Formatter::DisabledConfigFormatter,
-                                    AUTO_GENERATED_FILE]
+          @options[:formatters] << [Formatter::DisabledConfigFormatter, AUTO_GENERATED_FILE]
         end
 
         def execute_runner
@@ -125,9 +115,9 @@ module RuboCop
         end
 
         def existing_configuration(config_file)
-          IO.read(config_file, encoding: Encoding::UTF_8)
-            .sub(/^inherit_from: *[^\n]+/, '')
-            .sub(/^inherit_from: *(\n *- *[^\n]+)+/, '')
+          File.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)

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

@@ -31,9 +31,7 @@ module RuboCop
               # See https://docs.rubocop.org/rubocop/configuration
             DESC
 
-            File.open(DOTFILE, 'w') do |f|
-              f.write(description)
-            end
+            File.open(DOTFILE, 'w') { |f| f.write(description) }
 
             puts "Writing new #{DOTFILE} to #{path}"
 

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

@@ -26,10 +26,7 @@ module RuboCop
           registry = Cop::Registry.global
           show_all = @options[:show_cops].empty?
 
-          if show_all
-            puts "# Available cops (#{registry.length}) " \
-                 "+ config for #{Dir.pwd}: "
-          end
+          puts "# Available cops (#{registry.length}) + config for #{Dir.pwd}: " if show_all
 
           registry.departments.sort!.each do |department|
             print_cops_of_department(registry, department, show_all)

data/lib/rubocop/comment_config.rb

@@ -25,16 +25,11 @@ module RuboCop
     end
 
     def extra_enabled_comments
-      extra_enabled_comments_with_names(
-        extras: Hash.new { |h, k| h[k] = [] },
-        names: Hash.new(0)
-      )
+      extra_enabled_comments_with_names(extras: Hash.new { |h, k| h[k] = [] }, names: Hash.new(0))
     end
 
     def comment_only_line?(line_number)
-      non_comment_token_line_numbers.none? do |non_comment_line_number|
-        non_comment_line_number == line_number
-      end
+      non_comment_token_line_numbers.none?(line_number)
     end
 
     private

data/lib/rubocop/config.rb

@@ -45,9 +45,7 @@ module RuboCop
     end
 
     def check
-      deprecation_check do |deprecation_message|
-        warn("#{loaded_path} - #{deprecation_message}")
-      end
+      deprecation_check { |deprecation_message| warn("#{loaded_path} - #{deprecation_message}") }
       @validator.validate
       make_excludes_absolute
       self
@@ -67,8 +65,7 @@ module RuboCop
 
     # True if this is a config file that is shipped with RuboCop
     def internal?
-      base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME,
-                                                    'config'))
+      base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME, 'config'))
       File.expand_path(loaded_path).start_with?(base_config_path)
     end
 
@@ -79,8 +76,7 @@ module RuboCop
 
         self[key]['Exclude'].map! do |exclude_elem|
           if exclude_elem.is_a?(String) && !absolute?(exclude_elem)
-            File.expand_path(File.join(base_dir_for_path_parameters,
-                                       exclude_elem))
+            File.expand_path(File.join(base_dir_for_path_parameters, exclude_elem))
           else
             exclude_elem
           end
@@ -122,17 +118,14 @@ module RuboCop
     # 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)
+      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_department ||= Hash.new do |h, dept|
-        h[dept] = self[dept] || {}
-      end
+      @for_department ||= Hash.new { |h, dept| h[dept] = self[dept] || {} }
       @for_department[department_name.to_s]
     end
 
@@ -153,8 +146,7 @@ module RuboCop
 
       # Optimization to quickly decide if the given file is hidden (on the top
       # level) and cannot be matched by any pattern.
-      is_hidden = relative_file_path.start_with?('.') &&
-                  !relative_file_path.start_with?('..')
+      is_hidden = relative_file_path.start_with?('.') && !relative_file_path.start_with?('..')
       return false if is_hidden && !possibly_include_hidden?
 
       absolute_file_path = File.expand_path(file)
@@ -163,8 +155,7 @@ module RuboCop
         if block_given?
           yield pattern, relative_file_path, absolute_file_path
         else
-          match_path?(pattern, relative_file_path) ||
-            match_path?(pattern, absolute_file_path)
+          match_path?(pattern, relative_file_path) || match_path?(pattern, absolute_file_path)
         end
       end
     end
@@ -177,8 +168,7 @@ module RuboCop
 
       file_to_include?(file) do |pattern, relative_path, absolute_path|
         /[A-Z]/.match?(pattern.to_s) &&
-          (match_path?(pattern, relative_path) ||
-           match_path?(pattern, absolute_path))
+          (match_path?(pattern, relative_path) || match_path?(pattern, absolute_path))
       end
     end
 
@@ -194,9 +184,7 @@ module RuboCop
 
     def file_to_exclude?(file)
       file = File.expand_path(file)
-      patterns_to_exclude.any? do |pattern|
-        match_path?(pattern, file)
-      end
+      patterns_to_exclude.any? { |pattern| match_path?(pattern, file) }
     end
 
     def patterns_to_include
@@ -267,8 +255,7 @@ module RuboCop
     private
 
     def target_rails_version_from_bundler_lock_file
-      @target_rails_version_from_bundler_lock_file ||=
-        read_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
@@ -288,9 +275,7 @@ module RuboCop
       return true if cop_options['Enabled'] == true
 
       department = department_of(qualified_cop_name)
-      cop_enabled = cop_options.fetch('Enabled') do
-        !for_all_cops['DisabledByDefault']
-      end
+      cop_enabled = cop_options.fetch('Enabled') { !for_all_cops['DisabledByDefault'] }
       return true if cop_enabled == 'override_department'
       return false if department && department['Enabled'] == false
 

data/lib/rubocop/config_loader.rb

@@ -22,8 +22,7 @@ module RuboCop
     class << self
       include FileFinder
 
-      attr_accessor :debug, :ignore_parent_exclusion,
-                    :disable_pending_cops, :enable_pending_cops
+      attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops
       attr_writer :default_configuration, :project_root
       attr_reader :loaded_features
 
@@ -58,9 +57,7 @@ module RuboCop
 
       def load_yaml_configuration(absolute_path)
         file_contents = read_file(absolute_path)
-        yaml_code = Dir.chdir(File.dirname(absolute_path)) do
-          ERB.new(file_contents).result
-        end
+        yaml_code = Dir.chdir(File.dirname(absolute_path)) { ERB.new(file_contents).result }
         check_duplication(yaml_code, absolute_path)
         hash = yaml_safe_load(yaml_code, absolute_path) || {}
 
@@ -156,9 +153,7 @@ module RuboCop
 
         warn Rainbow(PENDING_BANNER).yellow
 
-        pending_cops.each do |cop|
-          warn_pending_cop cop
-        end
+        pending_cops.each { |cop| warn_pending_cop cop }
 
         warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
       end
@@ -246,10 +241,9 @@ module RuboCop
       # 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)
+        File.read(absolute_path, encoding: Encoding::UTF_8)
       rescue Errno::ENOENT
-        raise ConfigNotFoundError,
-              "Configuration file not found: #{absolute_path}"
+        raise ConfigNotFoundError, "Configuration file not found: #{absolute_path}"
       end
 
       def yaml_safe_load(yaml_code, filename)

data/lib/rubocop/config_loader_resolver.rb

@@ -37,16 +37,30 @@ module RuboCop
                       inherit_mode: determine_inherit_mode(hash, k))
           end
           hash[k] = v
+          fix_include_paths(base_config.loaded_path, hash, path, k, v) if v.key?('Include')
         end
       end
     end
 
+    # When one .rubocop.yml file inherits from another .rubocop.yml file, the Include paths in the
+    # base configuration are relative to the directory where the base configuration file is. For the
+    # derived configuration, we need to make those paths relative to where the derived configuration
+    # file is.
+    def fix_include_paths(base_config_path, hash, path, key, value)
+      return unless File.basename(base_config_path).start_with?('.rubocop')
+
+      base_dir = File.dirname(base_config_path)
+      derived_dir = File.dirname(path)
+      hash[key]['Include'] = value['Include'].map do |include_path|
+        PathUtil.relative_path(File.join(base_dir, include_path), derived_dir)
+      end
+    end
+
     def resolve_inheritance_from_gems(hash)
       gems = hash.delete('inherit_gem')
       (gems || {}).each_pair do |gem_name, config_path|
         if gem_name == 'rubocop'
-          raise ArgumentError,
-                "can't inherit configuration from the rubocop gem"
+          raise ArgumentError, "can't inherit configuration from the rubocop gem"
         end
 
         hash['inherit_from'] = Array(hash['inherit_from'])
@@ -77,8 +91,7 @@ module RuboCop
       config = handle_disabled_by_default(config, default_configuration) if disabled_by_default
       override_enabled_for_disabled_departments(default_configuration, config)
 
-      opts = { inherit_mode: config['inherit_mode'] || {},
-               unset_nil: unset_nil }
+      opts = { inherit_mode: config['inherit_mode'] || {}, unset_nil: unset_nil }
       Config.new(merge(default_configuration, config, **opts), config_file)
     end
 
@@ -112,8 +125,7 @@ module RuboCop
         next unless key =~ %r{(.*)/.*}
 
         department = Regexp.last_match(1)
-        next unless disabled?(derived_hash, department) ||
-                    disabled?(base_hash, department)
+        next unless disabled?(derived_hash, department) || disabled?(base_hash, department)
 
         # The `override_department` setting for the `Enabled` parameter is an
         # internal setting that's not documented in the manual. It will cause a
@@ -155,13 +167,10 @@ module RuboCop
     end
 
     def warn_on_duplicate_setting(base_hash, derived_hash, key, **opts)
-      return unless duplicate_setting?(base_hash, derived_hash,
-                                       key, opts[:inherited_file])
+      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)
+      inherit_mode = opts[:inherit_mode]['merge'] || opts[:inherit_mode]['override']
+      return if base_hash[key].is_a?(Array) && inherit_mode && inherit_mode.include?(key)
 
       puts "#{PathUtil.smart_path(opts[:file])}: " \
            "#{opts[:cop_name]}:#{key} overrides " \
@@ -251,8 +260,7 @@ module RuboCop
 
       File.join(gem_path, relative_config_path)
     rescue Gem::LoadError => e
-      raise Gem::LoadError,
-            "Unable to find gem #{gem_name}; is the gem installed? #{e}"
+      raise Gem::LoadError, "Unable to find gem #{gem_name}; is the gem installed? #{e}"
     end
   end
 end