rubocop 0.84.0 → 0.85.1

data/lib/rubocop/cop/commissioner.rb

@@ -36,7 +36,6 @@ module RuboCop
 
       def investigate(processed_source)
         reset_errors
-        remove_irrelevant_cops(processed_source.file_path)
         reset_callbacks
         prepare(processed_source)
         invoke_custom_processing(@cops, processed_source)
@@ -63,26 +62,6 @@ module RuboCop
         @errors = []
       end
 
-      def remove_irrelevant_cops(filename)
-        @cops.reject! do |cop|
-          cop.excluded_file?(filename) ||
-            !support_target_ruby_version?(cop) ||
-            !support_target_rails_version?(cop)
-        end
-      end
-
-      def support_target_ruby_version?(cop)
-        return true unless cop.class.respond_to?(:support_target_ruby_version?)
-
-        cop.class.support_target_ruby_version?(cop.target_ruby_version)
-      end
-
-      def support_target_rails_version?(cop)
-        return true unless cop.class.respond_to?(:support_target_rails_version?)
-
-        cop.class.support_target_rails_version?(cop.target_rails_version)
-      end
-
       def reset_callbacks
         @callbacks.clear
       end

data/lib/rubocop/cop/cop.rb

@@ -23,7 +23,7 @@ module RuboCop
     #       # Do custom processing
     #     end
     #   end
-    class Cop
+    class Cop # rubocop:disable Metrics/ClassLength
       extend RuboCop::AST::Sexp
       extend NodePattern::Macros
       include RuboCop::AST::Sexp
@@ -44,22 +44,12 @@ module RuboCop
       attr_reader :config, :offenses, :corrections
       attr_accessor :processed_source # TODO: Bad design.
 
-      @registry = Registry.new
-
-      class << self
-        attr_reader :registry
-      end
-
-      def self.all
-        registry.without_department(:Test).cops
-      end
-
-      def self.qualified_cop_name(name, origin)
-        registry.qualified_cop_name(name, origin)
+      def self.inherited(subclass)
+        Registry.global.enlist(subclass)
       end
 
-      def self.inherited(subclass)
-        registry.enlist(subclass)
+      def self.exclude_from_registry
+        Registry.global.dismiss(self)
       end
 
       def self.badge
@@ -146,17 +136,24 @@ module RuboCop
         @offenses.any? { |o| o.location == location }
       end
 
-      def correct(node)
+      def correct(node) # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength
         reason = reason_to_not_correct(node)
         return reason if reason
 
         @corrected_nodes[node] = true
+
         if support_autocorrect?
           correction = autocorrect(node)
-          return :uncorrected unless correction
 
-          @corrections << Correction.new(correction, node, self)
-          :corrected
+          if correction
+            @corrections << Correction.new(correction, node, self)
+            :corrected
+          elsif disable_uncorrectable?
+            disable_uncorrectable(node)
+            :corrected_with_todo
+          else
+            :uncorrected
+          end
         elsif disable_uncorrectable?
           disable_uncorrectable(node)
           :corrected_with_todo
@@ -211,8 +208,9 @@ module RuboCop
       alias name cop_name
 
       def relevant_file?(file)
-        file_name_matches_any?(file, 'Include', true) &&
-          !file_name_matches_any?(file, 'Exclude', false)
+        file == RuboCop::AST::ProcessedSource::STRING_SOURCE_NAME ||
+          file_name_matches_any?(file, 'Include', true) &&
+            !file_name_matches_any?(file, 'Exclude', false)
       end
 
       def excluded_file?(file)
@@ -238,6 +236,23 @@ module RuboCop
         nil
       end
 
+      ### Deprecated registry access
+
+      # @deprecated Use Registry.global
+      def self.registry
+        Registry.global
+      end
+
+      # @deprecated Use Registry.all
+      def self.all
+        Registry.all
+      end
+
+      # @deprecated Use Registry.qualified_cop_name
+      def self.qualified_cop_name(name, origin)
+        Registry.qualified_cop_name(name, origin)
+      end
+
       private
 
       def find_message(node, message)

data/lib/rubocop/cop/corrector.rb

@@ -85,7 +85,9 @@ module RuboCop
       def insert_before(node_or_range, content)
         range = to_range(node_or_range)
         # TODO: Fix Cops using bad ranges instead
-        range = range.with(end_pos: @source_buffer.source.size) if range.end_pos > @source_buffer.source.size
+        if range.end_pos > @source_buffer.source.size
+          range = range.with(end_pos: @source_buffer.source.size)
+        end
 
         @source_rewriter.insert_before(range, content)
       end

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

@@ -129,7 +129,7 @@ module RuboCop
       end
 
       def separating_space?
-        block_begin.source_buffer.source[block_begin.begin_pos + 2].match(/\s/)
+        block_begin.source_buffer.source[block_begin.begin_pos + 2].match?(/\s/)
       end
     end
   end

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

@@ -10,7 +10,9 @@ module RuboCop
             corrector.remove(node.loc.begin)
             corrector.remove(node.loc.end)
 
-            corrector.insert_after(node.loc.end, ' ') if ternary_condition?(node) && next_char_is_question_mark?(node)
+            if ternary_condition?(node) && next_char_is_question_mark?(node)
+              corrector.insert_after(node.loc.end, ' ')
+            end
           end
         end
 

data/lib/rubocop/cop/layout/case_indentation.rb

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks how the *when*s of a *case* expression
-      # are indented in relation to its *case* or *end* keyword.
+      # This cop checks how the ``when``s of a `case` expression
+      # are indented in relation to its `case` or `end` keyword.
       #
-      # It will register a separate offense for each misaligned *when*.
+      # It will register a separate offense for each misaligned `when`.
       #
       # @example
       #   # If Layout/EndAlignment is set to keyword style (default)

data/lib/rubocop/cop/layout/class_structure.rb

@@ -8,22 +8,24 @@ module RuboCop
       # `Categories` allows us to map macro names into a category.
       #
       # Consider an example of code style that covers the following order:
-      # - Module inclusion (include, prepend, extend)
-      # - Constants
-      # - Associations (has_one, has_many)
-      # - Public attribute macros (attr_accessor, attr_writer, attr_reader)
-      # - Other macros (validates, validate)
-      # - Public class methods
-      # - Initializer
-      # - Public instance methods
-      # - Protected attribute macros (attr_accessor, attr_writer, attr_reader)
-      # - Protected instance methods
-      # - Private attribute macros (attr_accessor, attr_writer, attr_reader)
-      # - Private instance methods
+      #
+      # * Module inclusion (include, prepend, extend)
+      # * Constants
+      # * Associations (has_one, has_many)
+      # * Public attribute macros (attr_accessor, attr_writer, attr_reader)
+      # * Other macros (validates, validate)
+      # * Public class methods
+      # * Initializer
+      # * Public instance methods
+      # * Protected attribute macros (attr_accessor, attr_writer, attr_reader)
+      # * Protected instance methods
+      # * Private attribute macros (attr_accessor, attr_writer, attr_reader)
+      # * Private instance methods
       #
       # You can configure the following order:
       #
-      # ```yaml
+      # [source,yaml]
+      # ----
       #  Layout/ClassStructure:
       #    ExpectedOrder:
       #      - module_inclusion
@@ -40,13 +42,14 @@ module RuboCop
       #      - private_attribute_macros
       #      - private_delegate
       #      - private_methods
-      # ```
+      # ----
       #
       # Instead of putting all literals in the expected order, is also
       # possible to group categories of macros. Visibility levels are handled
       # automatically.
       #
-      # ```yaml
+      # [source,yaml]
+      # ----
       #  Layout/ClassStructure:
       #    Categories:
       #      association:
@@ -63,7 +66,7 @@ module RuboCop
       #        - include
       #        - prepend
       #        - extend
-      # ```
+      # ----
       #
       # @example
       #   # bad

data/lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb

@@ -4,8 +4,8 @@ module RuboCop
   module Cop
     module Layout
       # Checks for a newline after an attribute accessor or a group of them.
-      # `alias` syntax and `alias_method`, `public`, `protected`, and `private` methods are allowed by default.
-      # These are customizable with `AllowAliasSyntax` and `AllowedMethods` options.
+      # `alias` syntax and `alias_method`, `public`, `protected`, and `private` methods are allowed
+      # by default. These are customizable with `AllowAliasSyntax` and `AllowedMethods` options.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/layout/end_of_line.rb

@@ -75,8 +75,8 @@ module RuboCop
                               style
                             end
           case effective_style
-          when :lf then MSG_DETECTED if /\r$/.match?(line)
-          else MSG_MISSING unless /\r$/.match?(line)
+          when :lf then MSG_DETECTED if line.end_with?("\r", "\r\n")
+          else MSG_MISSING unless line.end_with?("\r\n")
           end
         end
 

data/lib/rubocop/cop/layout/first_argument_indentation.rb

@@ -7,7 +7,7 @@ module RuboCop
       # Arguments after the first one are checked by Layout/ArgumentAlignment,
       # not by this cop.
       #
-      # For indenting the first parameter of method *definitions*, check out
+      # For indenting the first parameter of method _definitions_, check out
       # Layout/FirstParameterIndentation.
       #
       # @example

data/lib/rubocop/cop/layout/first_array_element_line_break.rb

@@ -37,7 +37,7 @@ module RuboCop
 
         def assignment_on_same_line?(node)
           source = node.source_range.source_line[0...node.loc.column]
-          source =~ /\s*\=\s*$/
+          source =~ /\s*=\s*$/
         end
       end
     end

data/lib/rubocop/cop/layout/first_parameter_indentation.rb

@@ -7,9 +7,9 @@ module RuboCop
       # definition. Parameters after the first one are checked by
       # Layout/ParameterAlignment, not by this cop.
       #
-      # For indenting the first argument of method *calls*, check out
+      # For indenting the first argument of method _calls_, check out
       # Layout/FirstArgumentIndentation, which supports options related to
-      # nesting that are irrelevant for method *definitions*.
+      # nesting that are irrelevant for method _definitions_.
       #
       # @example
       #

data/lib/rubocop/cop/layout/hash_alignment.rb

@@ -7,16 +7,16 @@ module RuboCop
       # literal are aligned according to configuration. The configuration
       # options are:
       #
-      #   - key (left align keys, one space before hash rockets and values)
-      #   - separator (align hash rockets and colons, right align keys)
-      #   - table (left align keys, hash rockets, and values)
+      # * key (left align keys, one space before hash rockets and values)
+      # * separator (align hash rockets and colons, right align keys)
+      # * table (left align keys, hash rockets, and values)
       #
       # The treatment of hashes passed as the last argument to a method call
       # can also be configured. The options are:
       #
-      #   - always_inspect
-      #   - always_ignore
-      #   - ignore_implicit (without curly braces)
+      # * always_inspect
+      # * always_ignore
+      # * ignore_implicit (without curly braces)
       #
       # Alternatively you can specify multiple allowed styles. That's done by
       # passing a list of styles to EnforcedStyles.

data/lib/rubocop/cop/layout/heredoc_argument_closing_parenthesis.rb

@@ -190,7 +190,7 @@ module RuboCop
         def safe_to_remove_line_containing_closing_paren?(node)
           last_line = processed_source[node.loc.end.line - 1]
           # Safe to remove if last line only contains `)`, `,`, and whitespace.
-          last_line.match(/^[ ]*\)[ ]{0,20},{0,1}[ ]*$/)
+          last_line.match?(/^ *\) {0,20},{0,1} *$/)
         end
 
         def incorrect_parenthesis_removal_end(node)

data/lib/rubocop/cop/layout/heredoc_indentation.rb

@@ -5,66 +5,29 @@ module RuboCop
     module Layout
       # This cop checks the indentation of the here document bodies. The bodies
       # are indented one step.
-      # In Ruby 2.3 or newer, squiggly heredocs (`<<~`) should be used. If you
-      # use the older rubies, you should introduce some library to your project
-      # (e.g. ActiveSupport, Powerpack or Unindent).
-      # Note: When `Layout/LineLength`'s `AllowHeredoc` is false (not default),
+      #
+      # Note: When ``Layout/LineLength``'s `AllowHeredoc` is false (not default),
       #       this cop does not add any offenses for long here documents to
       #       avoid `Layout/LineLength`'s offenses.
       #
-      # @example EnforcedStyle: squiggly (default)
+      # @example
       #   # bad
       #   <<-RUBY
       #   something
       #   RUBY
       #
       #   # good
-      #   # When EnforcedStyle is squiggly, bad code is auto-corrected to the
-      #   # following code.
       #   <<~RUBY
       #     something
       #   RUBY
       #
-      # @example EnforcedStyle: active_support
-      #   # good
-      #   # When EnforcedStyle is active_support, bad code is auto-corrected to
-      #   # the following code.
-      #   <<-RUBY.strip_heredoc
-      #     something
-      #   RUBY
-      #
-      # @example EnforcedStyle: powerpack
-      #   # good
-      #   # When EnforcedStyle is powerpack, bad code is auto-corrected to
-      #   # the following code.
-      #   <<-RUBY.strip_indent
-      #     something
-      #   RUBY
-      #
-      # @example EnforcedStyle: unindent
-      #   # good
-      #   # When EnforcedStyle is unindent, bad code is auto-corrected to
-      #   # the following code.
-      #   <<-RUBY.unindent
-      #     something
-      #   RUBY
       #
       class HeredocIndentation < Cop
         include Heredoc
-        include ConfigurableEnforcedStyle
 
-        RUBY23_TYPE_MSG = 'Use %<indentation_width>d spaces for indentation ' \
-                          'in a heredoc by using `<<~` instead of ' \
-                          '`%<current_indent_type>s`.'
-        RUBY23_WIDTH_MSG = 'Use %<indentation_width>d spaces for '\
-                           'indentation in a heredoc.'
-        LIBRARY_MSG = 'Use %<indentation_width>d spaces for indentation in a ' \
-                      'heredoc by using %<method>s.'
-        STRIP_METHODS = {
-          unindent: 'unindent',
-          active_support: 'strip_heredoc',
-          powerpack: 'strip_indent'
-        }.freeze
+        TYPE_MSG = 'Use %<indentation_width>d spaces for indentation in a ' \
+                   'heredoc by using `<<~` instead of `%<current_indent_type>s`.'
+        WIDTH_MSG = 'Use %<indentation_width>d spaces for indentation in a heredoc.'
 
         def on_heredoc(node)
           body = heredoc_body(node)
@@ -85,59 +48,38 @@ module RuboCop
         end
 
         def autocorrect(node)
-          check_style!
-
-          case style
-          when :squiggly
-            correct_by_squiggly(node)
-          else
-            correct_by_library(node)
+          lambda do |corrector|
+            if heredoc_indent_type(node) == '~'
+              adjust_squiggly(corrector, node)
+            else
+              adjust_minus(corrector, node)
+            end
           end
         end
 
         private
 
         def message(node)
-          case style
-          when :squiggly
-            current_indent_type = "<<#{heredoc_indent_type(node)}"
-            ruby23_message(indentation_width, current_indent_type)
-          when nil
-            method = "some library(e.g. ActiveSupport's `String#strip_heredoc`)"
-            library_message(indentation_width, method)
-          else
-            method = "`String##{STRIP_METHODS[style]}`"
-            library_message(indentation_width, method)
-          end
-        end
-
-        def library_message(indentation_width, method)
-          format(
-            LIBRARY_MSG,
-            indentation_width: indentation_width,
-            method: method
-          )
-        end
+          current_indent_type = "<<#{heredoc_indent_type(node)}"
 
-        def ruby23_message(indentation_width, current_indent_type)
           if current_indent_type == '<<~'
-            ruby23_width_message(indentation_width)
+            width_message(indentation_width)
           else
-            ruby23_type_message(indentation_width, current_indent_type)
+            type_message(indentation_width, current_indent_type)
           end
         end
 
-        def ruby23_type_message(indentation_width, current_indent_type)
+        def type_message(indentation_width, current_indent_type)
           format(
-            RUBY23_TYPE_MSG,
+            TYPE_MSG,
             indentation_width: indentation_width,
             current_indent_type: current_indent_type
           )
         end
 
-        def ruby23_width_message(indentation_width)
+        def width_message(indentation_width)
           format(
-            RUBY23_WIDTH_MSG,
+            WIDTH_MSG,
             indentation_width: indentation_width
           )
         end
@@ -166,16 +108,6 @@ module RuboCop
           config.for_cop('Layout/LineLength')['Max']
         end
 
-        def correct_by_squiggly(node)
-          lambda do |corrector|
-            if heredoc_indent_type(node) == '~'
-              adjust_squiggly(corrector, node)
-            else
-              adjust_minus(corrector, node)
-            end
-          end
-        end
-
         def adjust_squiggly(corrector, node)
           corrector.replace(node.loc.heredoc_body, indented_body(node))
           corrector.replace(node.loc.heredoc_end, indented_end(node))
@@ -187,21 +119,6 @@ module RuboCop
           corrector.replace(node, corrected)
         end
 
-        def correct_by_library(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.heredoc_body, indented_body(node))
-            corrected = ".#{STRIP_METHODS[style]}"
-            corrector.insert_after(node, corrected)
-          end
-        end
-
-        def check_style!
-          return if style
-
-          raise Warning, "Auto-correction does not work for #{cop_name}. " \
-                         'Please configure EnforcedStyle.'
-        end
-
         def indented_body(node)
           body = heredoc_body(node)
           body_indent_level = indent_level(body)
@@ -230,7 +147,7 @@ module RuboCop
         def indent_level(str)
           indentations = str.lines
                             .map { |line| line[/^\s*/] }
-                            .reject { |line| line == "\n" }
+                            .reject { |line| line.end_with?("\n") }
           indentations.empty? ? 0 : indentations.min_by(&:size).size
         end