rubocop 1.9.1 → 1.13.0

data/lib/rubocop/cop/metrics/module_length.rb

@@ -37,21 +37,18 @@ module RuboCop
         end
 
         def on_casgn(node)
-          module_definition?(node) do
-            check_code_length(node)
-          end
+          module_definition?(node) { check_code_length(node) }
         end
 
         private
 
+        # @!method module_definition?(node)
         def_node_matcher :module_definition?, <<~PATTERN
           (casgn nil? _ (block (send (const {nil? cbase} :Module) :new) ...))
         PATTERN
 
         def message(length, max_length)
-          format('Module has too many lines. [%<length>d/%<max>d]',
-                 length: length,
-                 max: max_length)
+          format('Module has too many lines. [%<length>d/%<max>d]', length: length, max: max_length)
         end
       end
     end

data/lib/rubocop/cop/metrics/parameter_lists.rb

@@ -54,8 +54,7 @@ module RuboCop
         exclude_limit 'Max'
         exclude_limit 'MaxOptionalParameters'
 
-        MSG = 'Avoid parameter lists longer than %<max>d parameters. ' \
-              '[%<count>d/%<max>d]'
+        MSG = 'Avoid parameter lists longer than %<max>d parameters. [%<count>d/%<max>d]'
         OPTIONAL_PARAMETERS_MSG = 'Method has too many optional parameters. [%<count>d/%<max>d]'
 
         NAMED_KEYWORD_TYPES = %i[kwoptarg kwarg].freeze
@@ -71,9 +70,7 @@ module RuboCop
             count: optargs.count
           )
 
-          add_offense(node, message: message) do
-            self.max_optional_parameters = optargs.count
-          end
+          add_offense(node, message: message) { self.max_optional_parameters = optargs.count }
         end
         alias on_defs on_def
 
@@ -90,6 +87,7 @@ module RuboCop
 
         private
 
+        # @!method argument_to_lambda_or_proc?(node)
         def_node_matcher :argument_to_lambda_or_proc?, <<~PATTERN
           ^lambda_or_proc?
         PATTERN

data/lib/rubocop/cop/metrics/perceived_complexity.rb

@@ -27,8 +27,7 @@ module RuboCop
       #     end                           # ===
       #   end                             # 7 complexity points
       class PerceivedComplexity < CyclomaticComplexity
-        MSG = 'Perceived complexity for %<method>s is too high. ' \
-              '[%<complexity>d/%<max>d]'
+        MSG = 'Perceived complexity for %<method>s is too high. [%<complexity>d/%<max>d]'
 
         COUNTED_NODES = (CyclomaticComplexity::COUNTED_NODES - [:when] + [:case]).freeze
 

data/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb

@@ -43,9 +43,7 @@ module RuboCop
           end
 
           def calculate
-            visit_depth_last(@node) do |child|
-              calculate_node(child)
-            end
+            visit_depth_last(@node) { |child| calculate_node(child) }
 
             [
               Math.sqrt(@assignment**2 + @branch**2 + @condition**2).round(2),
@@ -68,9 +66,7 @@ module RuboCop
           end
 
           def else_branch?(node)
-            %i[case if].include?(node.type) &&
-              node.else? &&
-              node.loc.else.is?('else')
+            %i[case if].include?(node.type) && node.else? && node.loc.else.is?('else')
           end
 
           private
@@ -125,7 +121,8 @@ module RuboCop
           end
 
           def capturing_variable?(name)
-            name && !/^_/.match?(name)
+            # TODO: Remove `Symbol#to_s` after supporting only Ruby >= 2.7.
+            name && !name.to_s.start_with?('_')
           end
 
           def branch?(node)

data/lib/rubocop/cop/metrics/utils/code_length_calculator.rb

@@ -26,10 +26,12 @@ module RuboCop
             return length if @foldable_types.empty?
 
             each_top_level_descendant(@node, @foldable_types) do |descendant|
-              if foldable_node?(descendant)
-                descendant_length = code_length(descendant)
-                length = length - descendant_length + 1
-              end
+              next unless foldable_node?(descendant)
+
+              descendant_length = code_length(descendant)
+              length = length - descendant_length + 1
+              # Subtract 2 length of opening and closing brace if method argument omits hash braces.
+              length -= 2 if descendant.hash_type? && !descendant.braces?
             end
 
             length

data/lib/rubocop/cop/metrics/utils/repeated_attribute_discount.rb

@@ -32,10 +32,7 @@ module RuboCop
             return unless discount_repeated_attributes
 
             self_attributes = {} # Share hash for `(send nil? :foo)` and `(send (self) :foo)`
-            @known_attributes = {
-              s(:self) => self_attributes,
-              nil => self_attributes
-            }
+            @known_attributes = { s(:self) => self_attributes, nil => self_attributes }
             # example after running `obj = foo.bar; obj.baz.qux`
             # { nil => {foo: {bar: {}}},
             #   s(self) => same hash ^,
@@ -60,6 +57,7 @@ module RuboCop
 
           private
 
+          # @!method attribute_call?(node)
           def_node_matcher :attribute_call?, <<~PATTERN
             ( {csend send} _receiver _method # and no parameters
             )
@@ -90,6 +88,7 @@ module RuboCop
             end
           end
 
+          # @!method root_node?(node)
           def_node_matcher :root_node?, <<~PATTERN
             { nil? | self               # e.g. receiver of `my_method` or `self.my_attr`
             | lvar | ivar | cvar | gvar # e.g. receiver of `var.my_method`
@@ -112,9 +111,7 @@ module RuboCop
               return yield nil
             end
 
-            calls.fetch(value) do
-              yield [calls, value]
-            end
+            calls.fetch(value) { yield [calls, value] }
           end
 
           VAR_SETTER_TO_GETTER = {

data/lib/rubocop/cop/migration/department_name.rb

@@ -11,8 +11,7 @@ module RuboCop
 
         MSG = 'Department name is missing.'
 
-        DISABLE_COMMENT_FORMAT =
-          /\A(# *rubocop *: *((dis|en)able|todo) +)(.*)/.freeze
+        DISABLE_COMMENT_FORMAT = /\A(# *rubocop *: *((dis|en)able|todo) +)(.*)/.freeze
 
         # The token that makes up a disable comment.
         # The allowed specification for comments after `# rubocop: disable` is
@@ -62,8 +61,7 @@ module RuboCop
         end
 
         def valid_content_token?(content_token)
-          /\W+/.match?(content_token) ||
-            DISABLING_COPS_CONTENT_TOKEN.match?(content_token)
+          /\W+/.match?(content_token) || DISABLING_COPS_CONTENT_TOKEN.match?(content_token)
         end
 
         def contain_unexpected_character_for_department_name?(name)
@@ -73,9 +71,7 @@ module RuboCop
         def qualified_legacy_cop_name(cop_name)
           legacy_cop_names = RuboCop::ConfigObsoletion.legacy_cop_names
 
-          legacy_cop_names.detect do |legacy_cop_name|
-            legacy_cop_name.split('/')[1] == cop_name
-          end
+          legacy_cop_names.detect { |legacy_cop_name| legacy_cop_name.split('/')[1] == cop_name }
         end
       end
     end

data/lib/rubocop/cop/mixin/alignment.rb

@@ -12,8 +12,7 @@ module RuboCop
       attr_reader :column_delta
 
       def configured_indentation_width
-        cop_config['IndentationWidth'] ||
-          config.for_cop('Layout/IndentationWidth')['Width']
+        cop_config['IndentationWidth'] || config.for_cop('Layout/IndentationWidth')['Width']
       end
 
       def indentation(node)
@@ -29,15 +28,15 @@ module RuboCop
 
         each_bad_alignment(items, base_column) do |current|
           expr = current.source_range
-          if offenses.any? { |o| within?(expr, o.location) }
+          if @current_offenses.any? { |o| within?(expr, o.location) }
             # If this offense is within a line range that is already being
             # realigned by autocorrect, we report the offense without
             # autocorrecting it. Two rewrites in the same area by the same
             # cop cannot be handled. The next iteration will find the
             # offense again and correct it.
-            add_offense(nil, location: expr)
+            register_offense(expr, nil)
           else
-            add_offense(current)
+            register_offense(current, current)
           end
         end
       end
@@ -46,8 +45,7 @@ module RuboCop
       def each_bad_alignment(items, base_column)
         prev_line = -1
         items.each do |current|
-          if current.loc.line > prev_line &&
-             begins_its_line?(current.source_range)
+          if current.loc.line > prev_line && begins_its_line?(current.source_range)
             @column_delta = base_column - display_column(current.source_range)
 
             yield current if @column_delta.nonzero?
@@ -71,6 +69,13 @@ module RuboCop
       def end_of_line_comment(line)
         processed_source.line_with_comment?(line)
       end
+
+      # @api private
+      def register_offense(offense_node, message_node)
+        add_offense(offense_node, message: message(message_node)) do |corrector|
+          autocorrect(corrector, message_node)
+        end
+      end
     end
   end
 end

data/lib/rubocop/cop/mixin/check_line_breakable.rb

@@ -83,7 +83,7 @@ module RuboCop
 
       # @api private
       def within_column_limit?(element, max, line)
-        element && element.loc.column < max && element.loc.line == line
+        element && element.loc.column <= max && element.loc.line == line
       end
 
       # @api private

data/lib/rubocop/cop/mixin/code_length.rb

@@ -38,9 +38,7 @@ module RuboCop
 
         location = node.casgn_type? ? node.loc.name : node.loc.expression
 
-        add_offense(location, message: message(length, max_length)) do
-          self.max = length
-        end
+        add_offense(location, message: message(length, max_length)) { self.max = length }
       end
 
       # Returns true for lines that shall not be included in the count.

data/lib/rubocop/cop/mixin/comments_help.rb

@@ -23,7 +23,11 @@ module RuboCop
       def begin_pos_with_comment(node)
         first_comment = processed_source.ast_with_comments[node].first
 
-        start_line_position(first_comment || node)
+        if first_comment && (first_comment.loc.line < node.loc.line)
+          start_line_position(first_comment)
+        else
+          start_line_position(node)
+        end
       end
 
       def start_line_position(node)

data/lib/rubocop/cop/mixin/configurable_enforced_style.rb

@@ -75,9 +75,9 @@ module RuboCop
 
       def alternative_style
         if supported_styles.size != 2
-          raise 'alternative_style can only be used when there are exactly ' \
-               '2 SupportedStyles'
+          raise 'alternative_style can only be used when there are exactly 2 SupportedStyles'
         end
+
         alternative_styles.first
       end
 

data/lib/rubocop/cop/mixin/configurable_formatting.rb

@@ -10,9 +10,7 @@ module RuboCop
         if valid_name?(node, name)
           correct_style_detected
         else
-          add_offense(name_range, message: message(style)) do
-            report_opposing_styles(node, name)
-          end
+          add_offense(name_range, message: message(style)) { report_opposing_styles(node, name) }
         end
       end
 
@@ -23,8 +21,7 @@ module RuboCop
       end
 
       def valid_name?(node, name, given_style = style)
-        name.match?(self.class::FORMATS.fetch(given_style)) ||
-          class_emitter_method?(node, name)
+        name.match?(self.class::FORMATS.fetch(given_style)) || class_emitter_method?(node, name)
       end
 
       # A class emitter method is a singleton method in a class/module, where
@@ -36,9 +33,7 @@ module RuboCop
         # `def self.extended`, etc.
         node = node.parent while node.parent.defs_type?
 
-        node.parent.each_child_node(:class).any? do |c|
-          c.loc.name.is?(name.to_s)
-        end
+        node.parent.each_child_node(:class).any? { |c| c.loc.name.is?(name.to_s) }
       end
     end
   end

data/lib/rubocop/cop/mixin/def_node.rb

@@ -11,20 +11,18 @@ module RuboCop
       private
 
       def non_public?(node)
-        non_public_modifier?(node.parent) ||
-          preceding_non_public_modifier?(node)
+        non_public_modifier?(node.parent) || preceding_non_public_modifier?(node)
       end
 
       def preceding_non_public_modifier?(node)
-        stripped_source_upto(node.first_line).any? do |line|
-          NON_PUBLIC_MODIFIERS.include?(line)
-        end
+        stripped_source_upto(node.first_line).any? { |line| NON_PUBLIC_MODIFIERS.include?(line) }
       end
 
       def stripped_source_upto(index)
         processed_source[0..index].map(&:strip)
       end
 
+      # @!method non_public_modifier?(node)
       def_node_matcher :non_public_modifier?, <<~PATTERN
         (send nil? {:private :protected} ({def defs} ...))
       PATTERN

data/lib/rubocop/cop/mixin/documentation_comment.rb

@@ -24,8 +24,7 @@ module RuboCop
       # The args node1 & node2 may represent a RuboCop::AST::Node
       # or a Parser::Source::Comment. Both respond to #loc.
       def preceding_comment?(node1, node2)
-        node1 && node2 && precede?(node2, node1) &&
-          comment_line?(node2.loc.expression.source)
+        node1 && node2 && precede?(node2, node1) && comment_line?(node2.loc.expression.source)
       end
 
       # The args node1 & node2 may represent a RuboCop::AST::Node
@@ -35,9 +34,7 @@ module RuboCop
       end
 
       def preceding_lines(node)
-        processed_source.ast_with_comments[node].select do |line|
-          line.loc.line < node.loc.line
-        end
+        processed_source.ast_with_comments[node].select { |line| line.loc.line < node.loc.line }
       end
 
       def interpreter_directive_comment?(comment)
@@ -45,7 +42,7 @@ module RuboCop
       end
 
       def rubocop_directive_comment?(comment)
-        CommentConfig::COMMENT_DIRECTIVE_REGEXP.match?(comment.text)
+        !!DirectiveComment.new(comment).match_captures
       end
     end
   end

data/lib/rubocop/cop/mixin/empty_lines_around_body.rb

@@ -10,15 +10,16 @@ module RuboCop
         include ConfigurableEnforcedStyle
         include RangeHelp
 
-        MSG_EXTRA = 'Extra empty line detected at %<kind>s body ' \
-                    '%<location>s.'
+        MSG_EXTRA = 'Extra empty line detected at %<kind>s body %<location>s.'
         MSG_MISSING = 'Empty line missing at %<kind>s body %<location>s.'
-        MSG_DEFERRED = 'Empty line missing before first %<type>s ' \
-                       'definition'
+        MSG_DEFERRED = 'Empty line missing before first %<type>s definition'
 
         private
 
+        # @!method constant_definition?(node)
         def_node_matcher :constant_definition?, '{class module}'
+
+        # @!method empty_line_required?(node)
         def_node_matcher :empty_line_required?,
                          '{def defs class module (send nil? {:private :protected :public})}'
 
@@ -90,9 +91,7 @@ module RuboCop
           when :no_empty_lines
             check_line(style, line_no, message(MSG_EXTRA, desc), &:empty?)
           when :empty_lines
-            check_line(style, line_no, message(MSG_MISSING, desc)) do |line|
-              !line.empty?
-            end
+            check_line(style, line_no, message(MSG_MISSING, desc)) { |line| !line.empty? }
           end
         end
 

data/lib/rubocop/cop/mixin/empty_parameter.rb

@@ -8,6 +8,7 @@ module RuboCop
 
       private
 
+      # @!method empty_arguments?(node)
       def_node_matcher :empty_arguments?, <<~PATTERN
         (block _ $(args) _)
       PATTERN
@@ -16,9 +17,7 @@ module RuboCop
         empty_arguments?(node) do |args|
           return if args.empty_and_without_delimiters?
 
-          add_offense(args) do |corrector|
-            autocorrect(corrector, args)
-          end
+          add_offense(args) { |corrector| autocorrect(corrector, args) }
         end
       end
     end

data/lib/rubocop/cop/mixin/end_keyword_alignment.rb

@@ -55,9 +55,7 @@ module RuboCop
                           source: align_with.source,
                           align_line: align_with.line,
                           align_col: align_with.column)
-        add_offense(end_loc, message: msg) do |corrector|
-          autocorrect(corrector, node)
-        end
+        add_offense(end_loc, message: msg) { |corrector| autocorrect(corrector, node) }
       end
 
       def accept_end_kw_alignment?(end_loc)

data/lib/rubocop/cop/mixin/enforce_superclass.rb

@@ -13,10 +13,12 @@ module RuboCop
     # @api private
     module EnforceSuperclass
       def self.included(base)
+        # @!method class_definition(node)
         base.def_node_matcher :class_definition, <<~PATTERN
           (class (const _ !:#{base::SUPERCLASS}) #{base::BASE_PATTERN} ...)
         PATTERN
 
+        # @!method class_new_definition(node)
         base.def_node_matcher :class_new_definition, <<~PATTERN
           [!^(casgn {nil? cbase} :#{base::SUPERCLASS} ...)
            !^^(casgn {nil? cbase} :#{base::SUPERCLASS} (block ...))
@@ -25,15 +27,11 @@ module RuboCop
       end
 
       def on_class(node)
-        class_definition(node) do
-          add_offense(node.children[1])
-        end
+        class_definition(node) { add_offense(node.children[1]) }
       end
 
       def on_send(node)
-        class_new_definition(node) do
-          add_offense(node.children.last)
-        end
+        class_new_definition(node) { add_offense(node.children.last) }
       end
     end
   end