rubocop 0.52.0 → 0.52.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbbe943a5ed0fd35d07ba728c5569d279eaffbb8
-  data.tar.gz: 0fd2d58d865e457479f1d6ce0d8f12c7cda1dba3
+  metadata.gz: 9c220d66052a5e9bbd4c5c4b8152f9eb198def00
+  data.tar.gz: 3b3e355cef47c417d03265e565f7bf1fe94c7b9e
 SHA512:
-  metadata.gz: 4253ebe0cf732ca876078c01852f99cbfb9cc44f8bdb053bc368f6d18839c90152b87322738c052e15b8b128fa4a2e7f85902d8445d961b21df232a3b4fbb184
-  data.tar.gz: 9deb27503042d598d22d3f748a72fea9900b37a4fb95400180fada165e4ee393631d1b53456230d1a0aa1a69b8d26899c2b2e6253363912f2813de1eb6ac9f7b
+  metadata.gz: cba8acef3a405e92862d9ae1e1783bbeb6f9d4675fe978068a519a759598a26b2b79b10e0bc688fe0ee2c1b8a0c640316395c65f94903179b0b45a9b091f63b9
+  data.tar.gz: 3e31e510ef57bd3ccd4b2085398c22b1da1a0a137efa487c4f110b5c1d0d8ad568197d899f05a3b79bd9d281c9933ee8c6d19f134b0d052344ca778e50c07739

data/README.md

@@ -6,7 +6,8 @@
 [![Code Climate](https://codeclimate.com/github/bbatsov/rubocop/badges/gpa.svg)](https://codeclimate.com/github/bbatsov/rubocop)
 [![Inline docs](http://inch-ci.org/github/bbatsov/rubocop.svg)](http://inch-ci.org/github/bbatsov/rubocop)
 
-[![Gratipay Team](https://img.shields.io/gratipay/team/rubocop.svg?maxAge=2592000)](https://gratipay.com/rubocop/)
+[![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/bbatsov)
+[![Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/bbatsov/donate)
 [![OpenCollective](https://opencollective.com/rubocop/backers/badge.svg)](#open-collective-backers)
 [![OpenCollective](https://opencollective.com/rubocop/sponsors/badge.svg)](#open-collective-sponsors)
 
@@ -51,7 +52,7 @@ haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
 might want to use a conservative version locking in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.52.0', require: false
+gem 'rubocop', '~> 0.52.1', require: false
 ```
 
 ## Quickstart
@@ -129,9 +130,9 @@ to become a RuboCop sponsor.
 
 You can support the development of RuboCop via
 [Salt](https://salt.bountysource.com/teams/rubocop),
-[Gratipay](https://www.gratipay.com/rubocop) and [Open Collective](https://opencollective.com/rubocop).
-
-[![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.1.3/dist/gratipay.png)](https://gratipay.com/rubocop)
+[Patreon](https://www.patreon.com/bbatsov),
+[Liberapay](https://liberapay.com/bbatsov/donate),
+and [Open Collective](https://opencollective.com/rubocop).
 
 ### Open Collective Backers
 

data/config/default.yml

@@ -490,7 +490,7 @@ Layout/SpaceBeforeBlockBraces:
   SupportedStyles:
     - space
     - no_space
-  EnforcedStyleForEmptyBraces: no_space
+  EnforcedStyleForEmptyBraces: space
   SupportedStylesForEmptyBraces:
     - space
     - no_space
@@ -552,9 +552,6 @@ Layout/SpaceInsideStringInterpolation:
     - no_space
 
 Layout/ClassStructure:
-  Description: 'Enforces a configured order of definitions within a class body.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-classes'
-  Enabled: false
   Categories:
     module_inclusion:
       - include
@@ -930,12 +927,6 @@ Style/EmptyMethod:
     - compact
     - expanded
 
-Style/ExtendSelf:
-  EnforcedStyle: module_function
-  SupportedStyles:
-    - module_function
-    - extend_self
-
 # Checks use of for or each in multiline loops.
 Style/For:
   EnforcedStyle: each
@@ -1003,7 +994,6 @@ Style/HashSyntax:
   PreferHashRocketsForNonAlnumEndingSymbols: false
 
 Style/InverseMethods:
-  Enabled: true
   # `InverseMethods` are methods that can be inverted by a not (`not` or `!`)
   # The relationship of inverse methods only needs to be defined in one direction.
   # Keys and values both need to be defined as symbols.

data/config/disabled.yml

@@ -1,5 +1,10 @@
 # These are all the cops that are disabled in the default configuration.
 
+Layout/ClassStructure:
+  Description: 'Enforces a configured order of definitions within a class body.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-classes'
+  Enabled: false
+
 Layout/FirstArrayElementLineBreak:
   Description: >-
                  Checks for a line break before the first element in a

data/config/enabled.yml

@@ -1327,6 +1327,12 @@ Style/CharacterLiteral:
 Style/ClassAndModuleChildren:
   Description: 'Checks style of children classes and modules.'
   StyleGuide: '#namespace-definition'
+  # Moving from compact to nested children requires knowledge of whether the
+  # outer parent is a module or a class. Moving from nested to compact requires
+  # verification that the outer parent is defined elsewhere. Rubocop does not
+  # have the knowledge to perform either operation safely and thus requires
+  # manual oversight.
+  AutoCorrect: false
   Enabled: true
 
 Style/ClassCheck:
@@ -1459,14 +1465,6 @@ Style/EvenOdd:
   StyleGuide: '#predicate-methods'
   Enabled: true
 
-Style/ExtendSelf:
-  Description: 'Checks for uses of extend self.'
-  StyleGuide: '#module-function'
-  Enabled: true
-  # Using `module_function` results in private visibility scope when the
-  # module is included, so auto-correction is unsafe.
-  Autocorrect: false
-
 Style/FlipFlop:
   Description: 'Checks for flip flops'
   StyleGuide: '#no-flip-flops'

data/lib/rubocop.rb

@@ -74,6 +74,7 @@ require_relative 'rubocop/cop/corrector'
 require_relative 'rubocop/cop/force'
 require_relative 'rubocop/cop/severity'
 require_relative 'rubocop/cop/generator'
+require_relative 'rubocop/cop/generator/require_file_injector'
 
 require_relative 'rubocop/cop/variable_force'
 require_relative 'rubocop/cop/variable_force/branch'
@@ -88,7 +89,7 @@ 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/autocorrect_alignment'
+require_relative 'rubocop/cop/mixin/alignment'
 require_relative 'rubocop/cop/mixin/check_assignment'
 require_relative 'rubocop/cop/mixin/configurable_max'
 require_relative 'rubocop/cop/mixin/code_length' # relies on configurable_max
@@ -139,6 +140,17 @@ require_relative 'rubocop/cop/mixin/too_many_lines'
 require_relative 'rubocop/cop/mixin/trailing_comma'
 require_relative 'rubocop/cop/mixin/unused_argument'
 
+require_relative 'rubocop/cop/correctors/alignment_corrector'
+require_relative 'rubocop/cop/correctors/condition_corrector'
+require_relative 'rubocop/cop/correctors/empty_line_corrector'
+require_relative 'rubocop/cop/correctors/multiline_literal_brace_corrector'
+require_relative 'rubocop/cop/correctors/ordered_gem_corrector'
+require_relative 'rubocop/cop/correctors/parentheses_corrector'
+require_relative 'rubocop/cop/correctors/punctuation_corrector'
+require_relative 'rubocop/cop/correctors/space_corrector'
+require_relative 'rubocop/cop/correctors/string_literal_corrector'
+require_relative 'rubocop/cop/correctors/unused_arg_corrector'
+
 require_relative 'rubocop/cop/bundler/duplicated_gem'
 require_relative 'rubocop/cop/bundler/insecure_protocol_source'
 require_relative 'rubocop/cop/bundler/ordered_gems'
@@ -390,7 +402,6 @@ require_relative 'rubocop/cop/style/encoding'
 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/extend_self'
 require_relative 'rubocop/cop/style/flip_flop'
 require_relative 'rubocop/cop/style/for'
 require_relative 'rubocop/cop/style/format_string'

data/lib/rubocop/ast/node.rb

@@ -259,6 +259,27 @@ module RuboCop
         loc.expression
       end
 
+      def first_line
+        loc.line
+      end
+
+      def last_line
+        loc.last_line
+      end
+
+      def line_count
+        return 0 unless source_range
+        source_range.last_line - source_range.first_line + 1
+      end
+
+      def nonempty_line_count
+        source.lines.grep(/\S/).size
+      end
+
+      def source_length
+        source_range ? source_range.size : 0
+      end
+
       ## Destructuring
 
       def_node_matcher :receiver, <<-PATTERN
@@ -322,21 +343,8 @@ module RuboCop
         line_count == 1
       end
 
-      def line_count
-        return 0 unless source_range
-        source_range.last_line - source_range.first_line + 1
-      end
-
-      def nonempty_line_count
-        source.lines.grep(/\S/).size
-      end
-
-      def empty?
-        length.zero?
-      end
-
-      def length
-        source_range ? source_range.size : 0
+      def empty_source?
+        source_length.zero?
       end
 
       def asgn_method_call?

data/lib/rubocop/cli.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ClassLength
 module RuboCop
   # The CLI is a class responsible of handling all the command line interface
   # logic.
   class CLI
     include Formatter::TextUtil
 
+    SKIPPED_PHASE_1 = 'Phase 1 of 2: run Metrics/LineLength cop (skipped ' \
+                      'because the default Metrics/LineLength:Max is ' \
+                      'overridden)'.freeze
+
     class Finished < RuntimeError; end
 
     attr_reader :options, :config_store
@@ -23,6 +28,8 @@ module RuboCop
     #
     # @param args [Array<String>] command line arguments
     # @return [Integer] UNIX exit code
+    #
+    # rubocop:disable Metrics/MethodLength
     def run(args = ARGV)
       @options, paths = Options.new.parse(args)
       validate_options_vs_config
@@ -34,11 +41,15 @@ module RuboCop
       return 2
     rescue Finished
       return 0
+    rescue IncorrectCopNameError => e
+      warn e.message
+      return 2
     rescue StandardError, SyntaxError, LoadError => e
       warn e.message
       warn e.backtrace
       return 2
     end
+    # rubocop:enable Metrics/MethodLength
 
     def trap_interrupt(runner)
       Signal.trap('INT') do
@@ -54,13 +65,24 @@ module RuboCop
     def execute_runners(paths)
       if @options[:auto_gen_config]
         reset_config_and_auto_gen_file
-        line_length_contents = run_line_length_cop_auto_gen_config(paths)
+        line_length_contents =
+          if max_line_length(@config_store.for(Dir.pwd)) ==
+             max_line_length(ConfigLoader.default_configuration)
+            run_line_length_cop_auto_gen_config(paths)
+          else
+            puts Rainbow(SKIPPED_PHASE_1).yellow
+            ''
+          end
         run_all_cops_auto_gen_config(line_length_contents, paths)
       else
         execute_runner(paths)
       end
     end
 
+    def max_line_length(config)
+      config.for_cop('Metrics/LineLength')['Max']
+    end
+
     # Do an initial run with only Metrics/LineLength so that cops that depend
     # on Metrics/LineLength:Max get the correct value for that parameter.
     def run_line_length_cop_auto_gen_config(paths)
@@ -89,7 +111,7 @@ module RuboCop
 
     def reset_config_and_auto_gen_file
       @config_store = ConfigStore.new
-      File.open(ConfigLoader::AUTO_GENERATED_FILE, 'w'){}
+      File.open(ConfigLoader::AUTO_GENERATED_FILE, 'w') {}
       ConfigLoader.add_inheritance_from_auto_generated_file
     end
 
@@ -243,3 +265,4 @@ module RuboCop
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/rubocop/config.rb

@@ -19,6 +19,7 @@ module RuboCop
     DEFAULT_RUBY_VERSION = 2.1
     KNOWN_RUBIES = [2.1, 2.2, 2.3, 2.4, 2.5].freeze
     OBSOLETE_RUBIES = { 1.9 => '0.50', 2.0 => '0.50' }.freeze
+    RUBY_VERSION_FILENAME = '.ruby-version'.freeze
     DEFAULT_RAILS_VERSION = 5.0
     OBSOLETE_COPS = {
       'Style/TrailingComma' =>
@@ -195,7 +196,7 @@ module RuboCop
 
     def check
       deprecation_check do |deprecation_message|
-        warn("#{path} - #{deprecation_message}")
+        warn("#{loaded_path} - #{deprecation_message}")
       end
       validate
       make_excludes_absolute
@@ -383,12 +384,10 @@ module RuboCop
           @target_ruby_version_source = :rubocop_yml
 
           for_all_cops['TargetRubyVersion']
-        elsif File.file?('.ruby-version') &&
-              /\A(ruby-)?(?<version>\d+\.\d+)/ =~ File.read('.ruby-version')
+        elsif target_ruby_version_from_version_file
+          @target_ruby_version_source = :ruby_version_file
 
-          @target_ruby_version_source = :dot_ruby_version
-
-          version.to_f
+          target_ruby_version_from_version_file
         else
           DEFAULT_RUBY_VERSION
         end
@@ -513,13 +512,29 @@ module RuboCop
 
     def target_ruby_source
       case @target_ruby_version_source
-      when :dot_ruby_version
-        '`.ruby-version`'
+      when :ruby_version_file
+        "`#{RUBY_VERSION_FILENAME}`"
       when :rubocop_yml
         "`TargetRubyVersion` parameter (in #{smart_loaded_path})"
       end
     end
 
+    def ruby_version_file
+      @ruby_version_file ||=
+        PathUtil.find_file_upwards(RUBY_VERSION_FILENAME,
+                                   base_dir_for_path_parameters)
+    end
+
+    def target_ruby_version_from_version_file
+      file = ruby_version_file
+      return unless file && File.file?(file)
+
+      @target_ruby_version_from_version_file ||=
+        File.read(file).match(/\A(ruby-)?(?<version>\d+\.\d+)/) do |md|
+          md[:version].to_f
+        end
+    end
+
     def reject_mutually_exclusive_defaults
       disabled_by_default = for_all_cops['DisabledByDefault']
       enabled_by_default = for_all_cops['EnabledByDefault']

data/lib/rubocop/cop/bundler/duplicated_gem.rb

@@ -37,7 +37,7 @@ module RuboCop
               register_offense(
                 node,
                 node.first_argument.to_a.first,
-                nodes.first.loc.line
+                nodes.first.first_line
               )
             end
           end
@@ -57,7 +57,7 @@ module RuboCop
         def register_offense(node, gem_name, line_of_first_occurrence)
           line_range = node.loc.column...node.loc.last_column
           offense_location =
-            source_range(processed_source.buffer, node.loc.line, line_range)
+            source_range(processed_source.buffer, node.first_line, line_range)
           message = format(
             MSG,
             gem_name: gem_name,

data/lib/rubocop/cop/bundler/ordered_gems.rb

@@ -45,6 +45,15 @@ module RuboCop
           end
         end
 
+        def autocorrect(node)
+          OrderedGemCorrector.correct(
+            processed_source,
+            node,
+            previous_declaration(node),
+            treat_comments_as_separators
+          )
+        end
+
         private
 
         def previous_declaration(node)

data/lib/rubocop/cop/commissioner.rb

@@ -110,7 +110,7 @@ module RuboCop
       rescue StandardError => e
         raise e if @options[:raise_error]
         if node
-          line = node.loc.line
+          line = node.first_line
           column = node.loc.column
         end
         error = CopError.new(e, line, column)

data/lib/rubocop/cop/correctors/alignment_corrector.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # This class does auto-correction of nodes that should just be moved to
+    # the left or to the right, amount being determined by the instance
+    # variable column_delta.
+    class AlignmentCorrector
+      extend Util
+      extend Alignment
+
+      class << self
+        attr_reader :processed_source
+
+        def correct(processed_source, node, column_delta)
+          return unless node
+          @processed_source = processed_source
+          expr = node.respond_to?(:loc) ? node.loc.expression : node
+          return if block_comment_within?(expr)
+
+          lambda do |corrector|
+            each_line(expr) do |line_begin_pos|
+              autocorrect_line(corrector, line_begin_pos, expr, column_delta,
+                               heredoc_ranges(node))
+            end
+          end
+        end
+
+        def align_end(processed_source, node, align_to)
+          @processed_source = processed_source
+          whitespace = whitespace_range(node)
+          return false unless whitespace.source.strip.empty?
+
+          column = alignment_column(align_to)
+          ->(corrector) { corrector.replace(whitespace, ' ' * column) }
+        end
+
+        private
+
+        def autocorrect_line(corrector, line_begin_pos, expr, column_delta,
+                             heredoc_ranges)
+          range = calculate_range(expr, line_begin_pos, column_delta)
+          # We must not change indentation of heredoc strings.
+          return if heredoc_ranges.any? { |h| within?(range, h) }
+
+          if column_delta > 0
+            unless range.source == "\n"
+              corrector.insert_before(range, ' ' * column_delta)
+            end
+          elsif range.source =~ /\A[ \t]+\z/
+            remove(range, corrector)
+          end
+        end
+
+        def heredoc_ranges(node)
+          return [] unless node.is_a?(Parser::AST::Node)
+
+          node.each_node(:dstr)
+              .select { |n| n.loc.respond_to?(:heredoc_body) }
+              .map { |n| n.loc.heredoc_body.join(n.loc.heredoc_end) }
+        end
+
+        def block_comment_within?(expr)
+          processed_source.comments.select(&:document?).any? do |c|
+            within?(c.loc.expression, expr)
+          end
+        end
+
+        def calculate_range(expr, line_begin_pos, column_delta)
+          starts_with_space = expr.source_buffer.source[line_begin_pos] =~ / /
+          pos_to_remove = if column_delta > 0 || starts_with_space
+                            line_begin_pos
+                          else
+                            line_begin_pos - column_delta.abs
+                          end
+
+          range_between(pos_to_remove, pos_to_remove + column_delta.abs)
+        end
+
+        def remove(range, corrector)
+          original_stderr = $stderr
+          $stderr = StringIO.new # Avoid error messages on console
+          corrector.remove(range)
+        rescue RuntimeError
+          range = range_between(range.begin_pos + 1, range.end_pos + 1)
+          retry if range.source =~ /^ +$/
+        ensure
+          $stderr = original_stderr
+        end
+
+        def each_line(expr)
+          line_begin_pos = expr.begin_pos
+          expr.source.each_line do |line|
+            yield line_begin_pos
+            line_begin_pos += line.length
+          end
+        end
+
+        def begins_its_line?(range)
+          (range.source_line =~ /\S/) == range.column
+        end
+
+        def whitespace_range(node)
+          begin_pos = node.loc.end.begin_pos
+
+          range_between(begin_pos - node.loc.end.column, begin_pos)
+        end
+
+        def alignment_column(align_to)
+          if !align_to
+            0
+          elsif align_to.respond_to?(:loc)
+            align_to.source_range.column
+          else
+            align_to.column
+          end
+        end
+      end
+    end
+  end
+end