rubocop-rbs_inline 1.6.0 → 1.7.0

data/lib/rubocop/cop/style/rbs_inline/data_class_comment_alignment.rb

@@ -26,106 +26,25 @@ module RuboCop
         #   )
         #
         class DataClassCommentAlignment < Base
-          include ASTUtils
-          include RangeHelp
-          include SourceCodeHelper
+          include ClassCommentAlignment
           extend AutoCorrector
 
-          MSG = 'Misaligned inline type annotation for Data attribute.'
+          MSG = "Misaligned inline type annotation for Data attribute."
 
           # @rbs node: RuboCop::AST::SendNode
           def on_send(node) #: void
-            return unless data_define?(node)
-            return if folded_data_class?(node)
+            return unless struct_like_class?(node)
 
-            check_annotation_alignment(node)
+            check_comment_alignment(node)
           end
 
           private
 
           # @rbs node: RuboCop::AST::SendNode
-          def data_define?(node) #: bool
+          def struct_like_class?(node) #: bool
             return false unless node.method_name == :define
 
-            case (r = node.receiver)
-            when RuboCop::AST::ConstNode
-              r.short_name == :Data
-            else
-              false
-            end
-          end
-
-          # @rbs arg: RuboCop::AST::Node
-          def data_attribute?(arg) #: bool
-            arg.sym_type? || arg.str_type?
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def data_attributes(node) #: Array[RuboCop::AST::Node]
-            node.arguments.select { data_attribute?(_1) }
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def folded_data_class?(node) #: bool
-            args = node.arguments
-            return false if args.empty?
-
-            lines = args.map { _1.location.line }
-            lines.uniq.length < args.length || lines.include?(node.location.line)
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def check_annotation_alignment(node) #: void
-            annotated = data_attributes(node).filter_map do |arg|
-              comment = inline_type_comment(arg.location.line)
-              [arg, comment] if comment #: [RuboCop::AST::Node, Parser::Source::Comment]
-            end
-            return if annotated.size < 2
-
-            expected_col = annotation_column(node)
-            annotated.each do |arg, comment|
-              actual_col = comment.location.column
-              next if actual_col == expected_col
-
-              add_offense(comment.source_range) do |corrector|
-                correct_alignment(corrector, arg, comment, expected_col)
-              end
-            end
-          end
-
-          # @rbs line: Integer
-          def inline_type_comment(line) #: Parser::Source::Comment?
-            comment = comment_at(line)
-            comment if comment&.text&.match?(/\A#:/)
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def annotation_column(node) #: Integer
-            last_arg = node.arguments.last
-            max_end_col = node.arguments.map do |arg|
-              comma_length = arg.equal?(last_arg) ? 0 : 1
-              arg.location.column + source!(arg).length + comma_length
-            end.max || 0
-
-            max_end_col + 2
-          end
-
-          # @rbs corrector: RuboCop::Cop::Corrector
-          # @rbs arg: RuboCop::AST::Node
-          # @rbs comment: Parser::Source::Comment
-          # @rbs expected_col: Integer
-          def correct_alignment(corrector, arg, comment, expected_col) #: void # rubocop:disable Metrics/AbcSize
-            line = arg.location.line
-            line_source = source_code_at(line)
-            source = line_source[...comment.location.column] || raise
-            content_end_col = source.rstrip.length
-            padding = [expected_col - content_end_col, 1].max || raise
-
-            line_begin = processed_source.buffer.line_range(line).begin_pos
-            replace_start = line_begin + content_end_col
-            replace_end = line_begin + comment.location.column
-
-            corrector.replace(range_between(replace_start, replace_end), ' ' * padding)
+            (r = node.receiver).is_a?(RuboCop::AST::ConstNode) && r.short_name == :Data
           end
         end
       end

data/lib/rubocop/cop/style/rbs_inline/data_define_with_block.rb

@@ -28,13 +28,13 @@ module RuboCop
         #   end
         #
         class DataDefineWithBlock < Base
-          MSG = 'Do not use `Data.define` with a block. RBS::Inline does not parse block contents, ' \
-                'so methods defined in the block will not be recognized. ' \
-                'Use a separate class definition instead.'
+          MSG = "Do not use `Data.define` with a block. RBS::Inline does not parse block contents, " \
+                "so methods defined in the block will not be recognized. " \
+                "Use a separate class definition instead."
 
           # @rbs node: RuboCop::AST::SendNode
           def on_send(node) #: void
-            return unless data_define?(node)
+            return unless struct_like_class?(node)
 
             block_node = node.parent
             return unless block_node&.block_type?
@@ -45,11 +45,10 @@ module RuboCop
           private
 
           # @rbs node: RuboCop::AST::SendNode
-          def data_define?(node) #: bool
+          def struct_like_class?(node) #: bool
             return false unless node.method_name == :define
 
-            receiver = node.receiver
-            receiver.is_a?(RuboCop::AST::ConstNode) && receiver.short_name == :Data
+            (r = node.receiver).is_a?(RuboCop::AST::ConstNode) && r.short_name == :Data
           end
         end
       end

data/lib/rubocop/cop/style/rbs_inline/data_struct_helper.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Shared logic for cops that check inline type annotations on struct-like
+        # class definitions such as `Data.define` and `Struct.new`.
+        #
+        # Including cops decide which nodes to check by defining their own matcher
+        # (e.g. `struct_like_class?`); this module only provides helpers that operate
+        # on an already-matched definition node. Cops may override {#attr_argument?}
+        # when the set of attribute arguments differs from the default (e.g.
+        # `Struct.new` treats a leading string argument as the struct name rather than
+        # an attribute).
+        #
+        # @rbs module-self RuboCop::Cop::Base
+        module DataStructHelper
+          include ASTUtils
+          include SourceCodeHelper
+          include RangeHelp
+
+          # @rbs arg: RuboCop::AST::Node
+          def attr_argument?(arg) #: bool
+            arg.sym_type? || arg.str_type?
+          end
+
+          # @rbs node: RuboCop::AST::SendNode
+          def attr_arguments(node) #: Array[RuboCop::AST::Node]
+            node.arguments.select { attr_argument?(_1) }
+          end
+
+          # @rbs node: RuboCop::AST::SendNode
+          def folded?(node) #: bool
+            attrs = attr_arguments(node)
+            return false if attrs.empty?
+
+            lines = attrs.map { _1.location.line }
+            lines.uniq.length < attrs.length || lines.include?(node.location.line)
+          end
+
+          # @rbs line: Integer
+          def inline_type_annotation?(line) #: boolish
+            comment = comment_at(line)
+            comment&.text&.match?(/\A#:/)
+          end
+
+          # @rbs line: Integer
+          def inline_type_comment(line) #: Parser::Source::Comment?
+            comment = comment_at(line)
+            comment if comment&.text&.match?(/\A#:/)
+          end
+
+          # @rbs line: Integer
+          def find_regular_comment(line) #: Parser::Source::Comment?
+            comment = comment_at(line)
+            comment unless comment&.text&.match?(/\A#:/)
+          end
+
+          # @rbs node: RuboCop::AST::SendNode
+          def annotation_column(node) #: Integer
+            last_arg = node.arguments.last
+            max_end_col = node.arguments.map do |arg|
+              comma_length = arg.equal?(last_arg) ? 0 : 1
+              arg.location.column + source!(arg).length + comma_length
+            end.max || 0
+
+            max_end_col + 2
+          end
+
+          # @rbs node: RuboCop::AST::SendNode
+          def longest_argname(node) #: String
+            last_index = node.arguments.size - 1
+            args = node.arguments.each_with_index.map { |a, i| i < last_index ? "#{a.source}," : a.source.to_s }
+            args.max_by(&:length) || ""
+          end
+
+          # @rbs node: RuboCop::AST::SendNode
+          def build_multiline_replacement(node) #: String # rubocop:disable Metrics/AbcSize
+            base_indent = source_code_at(node.location.line)[/\A\s*/]
+            last_index = node.arguments.size - 1
+            longest = longest_argname(node)
+
+            args_source = node.arguments.each_with_index.map do |arg, i|
+              comma = i < last_index ? "," : ""
+              prefix = "#{base_indent}  #{arg.source}#{comma}"
+              padding = " " * (longest.length - source!(arg).length - comma.length + 2)
+              attr_argument?(arg) ? "#{prefix}#{padding}#: untyped" : prefix
+            end.join("\n")
+
+            "(\n#{args_source}\n#{base_indent})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/rbs_inline/embedded_rbs_spacing.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'source_code_helper'
-require_relative 'comment_parser'
+require_relative "source_code_helper"
+require_relative "comment_parser"
 
 module RuboCop
   module Cop
@@ -30,7 +30,7 @@ module RuboCop
           include SourceCodeHelper
           include CommentParser
 
-          MSG = '`@rbs!` comment must be followed by a blank line.'
+          MSG = "`@rbs!` comment must be followed by a blank line."
 
           def on_new_investigation #: void
             check_embedded_rbs_spacing

data/lib/rubocop/cop/style/rbs_inline/invalid_comment.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rbs/inline/annotation_parser/tokenizer'
+require "rbs/inline/annotation_parser/tokenizer"
 
 module RuboCop
   module Cop
@@ -22,11 +22,11 @@ module RuboCop
         class InvalidComment < Base
           extend AutoCorrector
 
-          MSG = 'Invalid RBS annotation comment found.'
+          MSG = "Invalid RBS annotation comment found."
 
           # refs: https://github.com/soutaro/rbs-inline/blob/main/lib/rbs/inline/annotation_parser/tokenizer.rb
           RBS_INLINE_KEYWORDS = %w[inherits override use module-self generic skip module class].freeze #: Array[String]
-          RBS_INLINE_KEYWORD_PATTERN = RBS_INLINE_KEYWORDS.join('|') #: String
+          RBS_INLINE_KEYWORD_PATTERN = RBS_INLINE_KEYWORDS.join("|") #: String
 
           SIGNATURE_PATTERN = '\(.*\)\s*(\??\s*{.*?}\s*)?->\s*.*'
 
@@ -56,10 +56,10 @@ module RuboCop
           # @rbs text: String
           def corrected_text(text) #: String?
             case text
-            when MISSING_HASH_COLON then text.sub(/\A#\s+/, '#: ')
-            when SPACE_BEFORE_COLON then text.sub(/\A#\s+:\s*/, '#: ')
-            when MIXED_ANNOTATION   then text.sub(/\A#:\s+/, '# ')
-            when MISSING_AT_SIGN    then text.sub(/\A#\s*rbs\s+/, '# @rbs ')
+            when MISSING_HASH_COLON then text.sub(/\A#\s+/, "#: ")
+            when SPACE_BEFORE_COLON then text.sub(/\A#\s+:\s*/, "#: ")
+            when MIXED_ANNOTATION   then text.sub(/\A#:\s+/, "# ")
+            when MISSING_AT_SIGN    then text.sub(/\A#\s*rbs\s+/, "# @rbs ")
             end
           end
 

data/lib/rubocop/cop/style/rbs_inline/invalid_types.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rbs/inline'
+require "rbs/inline"
 
 module RuboCop
   module Cop
@@ -27,7 +27,7 @@ module RuboCop
           include RBS::Inline::AST::Annotations
           include RBS::Inline::AST::Members
 
-          MSG = 'Invalid annotation found.'
+          MSG = "Invalid annotation found."
 
           def on_new_investigation #: void
             parse_comments.each do |result|

data/lib/rubocop/cop/style/rbs_inline/keyword_separator.rb

@@ -19,7 +19,7 @@ module RuboCop
           include CommentParser
           include RangeHelp
 
-          MSG = 'Do not use `:` after the keyword.'
+          MSG = "Do not use `:` after the keyword."
 
           # refs: https://github.com/soutaro/rbs-inline/blob/main/lib/rbs/inline/annotation_parser/tokenizer.rb
           RBS_INLINE_KEYWORDS = %w[inherits override use module-self generic skip module class].freeze #: Array[String]
@@ -49,7 +49,7 @@ module RuboCop
 
           def on_investigation_end #: void
             processed_source.comments.each do |comment|
-              matched = comment.text.match(/\A#\s+@rbs\s+(#{RBS_INLINE_KEYWORDS.join('|')}):/)
+              matched = comment.text.match(/\A#\s+@rbs\s+(#{RBS_INLINE_KEYWORDS.join("|")}):/)
               next unless matched
               next if valid_method_annotation?(comment)
 
@@ -86,7 +86,7 @@ module RuboCop
           # followed by `:` but no type.
           # @rbs comment: Parser::Source::Comment
           def no_argument_keyword_without_type?(comment) #: bool
-            comment.text.match?(/\A#\s+@rbs\s+(#{NO_ARGUMENT_KEYWORDS.join('|')}):\s*\z/)
+            comment.text.match?(/\A#\s+@rbs\s+(#{NO_ARGUMENT_KEYWORDS.join("|")}):\s*\z/)
           end
 
           # @rbs comment: Parser::Source::Comment

data/lib/rubocop/cop/style/rbs_inline/method_comment_spacing.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'source_code_helper'
-require_relative 'comment_parser'
+require_relative "source_code_helper"
+require_relative "comment_parser"
 
 module RuboCop
   module Cop
@@ -61,8 +61,8 @@ module RuboCop
           include SourceCodeHelper
           include CommentParser
 
-          MSG = 'Method-related `@rbs` annotation must be immediately before a method definition.'
-          MSG_WITH_BLANK_LINE = 'Remove blank line between method annotation and method definition.'
+          MSG = "Method-related `@rbs` annotation must be immediately before a method definition."
+          MSG_WITH_BLANK_LINE = "Remove blank line between method annotation and method definition."
           METHOD_DEFINITION_PATTERN =
             /\A(?:(?:private|protected|public|private_class_method|module_function)\s+)?def\s/ #: Regexp
 
@@ -115,7 +115,7 @@ module RuboCop
               when RBS::Inline::AST::Annotations::VarType
                 # VarType includes both parameter types and variable types (@ivar, @@cvar)
                 # Only consider it method-related if it's a parameter annotation (name doesn't start with @)
-                return true unless annotation.name.start_with?('@')
+                return true unless annotation.name.start_with?("@")
               when RBS::Inline::AST::Annotations::ReturnType,
                    RBS::Inline::AST::Annotations::BlockType,
                    RBS::Inline::AST::Annotations::Override,
@@ -166,7 +166,7 @@ module RuboCop
           # @rbs comment: RBS::Inline::AnnotationParser::ParsingResult
           def skip_only_annotation?(comment) #: bool
             annotations = [] #: Array[RBS::Inline::AST::Annotations::t]
-            comment.each_annotation { |a| annotations << a }
+            comment.each_annotation { annotations << _1 }
             annotations.any? && annotations.all?(RBS::Inline::AST::Annotations::Skip)
           end
 

data/lib/rubocop/cop/style/rbs_inline/missing_class_annotation.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Shared behavior for cops that ensure struct-like class attributes have
+        # inline type annotations (`Data.define` / `Struct.new`).
+        #
+        # The including cop matches the definition node (e.g. via `struct_like_class?`)
+        # and calls {#check_missing_annotations}.
+        #
+        # @rbs module-self RuboCop::Cop::Base
+        module MissingClassAnnotation
+          include DataStructHelper
+
+          # @rbs node: RuboCop::AST::SendNode
+          def check_missing_annotations(node) #: void
+            if folded?(node)
+              add_offenses_for_folded(node)
+            else
+              check_multiline(node)
+            end
+          end
+
+          private
+
+          # @rbs node: RuboCop::AST::SendNode
+          def add_offenses_for_folded(node) #: void
+            corrected = false
+            attr_arguments(node).each do |arg|
+              if corrected
+                add_offense(arg)
+              else
+                replacement = build_multiline_replacement(node)
+                loc = node.loc
+                if loc.begin && loc.end
+                  add_offense(arg) { _1.replace(loc.begin.join(loc.end), replacement) }
+                  corrected = true
+                end
+              end
+            end
+          end
+
+          # @rbs node: RuboCop::AST::SendNode
+          def check_multiline(node) #: void
+            attr_arguments(node).each do |arg|
+              next if inline_type_annotation?(arg.location.line)
+
+              add_offense(arg) { correct_multiline(_1, node, arg) }
+            end
+          end
+
+          # @rbs corrector: RuboCop::Cop::Corrector
+          # @rbs node: RuboCop::AST::SendNode
+          # @rbs arg: RuboCop::AST::Node
+          def correct_multiline(corrector, node, arg) #: void
+            existing_comment = find_regular_comment(arg.location.line)
+
+            if existing_comment
+              comment_text = existing_comment.text.sub(/\A#\s*/, "")
+              corrector.replace(existing_comment.source_range, "#: untyped -- #{comment_text}")
+            else
+              insert_annotation(corrector, node, arg)
+            end
+          end
+
+          # @rbs corrector: RuboCop::Cop::Corrector
+          # @rbs node: RuboCop::AST::SendNode
+          # @rbs arg: RuboCop::AST::Node
+          def insert_annotation(corrector, node, arg) #: void
+            line = arg.location.line
+            line_source = source_code_at(line)
+            content_end_col = line_source.rstrip.length
+            padding = [annotation_column(node) - content_end_col, 1].max || raise
+            line_begin = processed_source.buffer.line_range(line).begin_pos
+            insert_pos = line_begin + content_end_col
+
+            corrector.insert_before(range_between(insert_pos, insert_pos), "#{" " * padding}#: untyped")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/rbs_inline/missing_data_class_annotation.rb

@@ -20,156 +20,26 @@ module RuboCop
         #     :visibility  #: Symbol
         #   )
         #
-        class MissingDataClassAnnotation < Base # rubocop:disable Metrics/ClassLength
-          include ASTUtils
-          include RangeHelp
-          include SourceCodeHelper
+        class MissingDataClassAnnotation < Base
+          include MissingClassAnnotation
           extend AutoCorrector
 
-          MSG = 'Missing inline type annotation for Data attribute (e.g., `#: Type`).'
+          MSG = "Missing inline type annotation for Data attribute (e.g., `#: Type`)."
 
           # @rbs node: RuboCop::AST::SendNode
           def on_send(node) #: void
-            return unless data_define?(node)
+            return unless struct_like_class?(node)
 
-            if folded_data_class?(node)
-              add_offenses_for_folded_data_class(node)
-            else
-              check_multiline_data_class(node)
-            end
+            check_missing_annotations(node)
           end
 
           private
 
           # @rbs node: RuboCop::AST::SendNode
-          def data_define?(node) #: bool
+          def struct_like_class?(node) #: bool
             return false unless node.method_name == :define
 
-            case (r = node.receiver)
-            when RuboCop::AST::ConstNode
-              r.short_name == :Data
-            else
-              false
-            end
-          end
-
-          # @rbs arg: RuboCop::AST::Node
-          def data_attribute?(arg) #: bool
-            arg.sym_type? || arg.str_type?
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def data_attributes(node) #: Array[RuboCop::AST::Node]
-            node.arguments.select { data_attribute?(_1) }
-          end
-
-          # @rbs line: Integer
-          def inline_type_annotation?(line) #: boolish
-            comment = comment_at(line)
-            comment&.text&.match?(/\A#:/)
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def folded_data_class?(node) #: bool
-            attrs = data_attributes(node)
-            return false if attrs.empty?
-
-            lines = attrs.map { _1.location.line }
-            lines.uniq.length < attrs.length || lines.include?(node.location.line)
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def add_offenses_for_folded_data_class(node) #: void
-            corrected = false
-            data_attributes(node).each do |arg|
-              if corrected
-                add_offense(arg)
-              else
-                replacement = build_multiline_replacement(node)
-                loc = node.loc
-                if loc.begin && loc.end
-                  add_offense(arg) { _1.replace(loc.begin.join(loc.end), replacement) }
-                  corrected = true
-                end
-              end
-            end
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def longest_argname(node) #: String
-            last_index = node.arguments.size - 1
-            args = node.arguments.each_with_index.map { |a, i| i < last_index ? "#{a.source}," : a.source.to_s }
-            args.max_by(&:length) || ''
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def build_multiline_replacement(node) #: String # rubocop:disable Metrics/AbcSize
-            base_indent = source_code_at(node.location.line)[/\A\s*/]
-            last_index = node.arguments.size - 1
-            longest = longest_argname(node)
-
-            args_source = node.arguments.each_with_index.map do |arg, i|
-              comma = i < last_index ? ',' : ''
-              prefix = "#{base_indent}  #{arg.source}#{comma}"
-              padding = ' ' * (longest.length - source!(arg).length - comma.length + 2)
-              data_attribute?(arg) ? "#{prefix}#{padding}#: untyped" : prefix
-            end.join("\n")
-
-            "(\n#{args_source}\n#{base_indent})"
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def check_multiline_data_class(node) #: void
-            data_attributes(node).each do |arg|
-              next if inline_type_annotation?(arg.location.line)
-
-              add_offense(arg) { |corrector| correct_multiline(corrector, node, arg) }
-            end
-          end
-
-          # @rbs corrector: RuboCop::Cop::Corrector
-          # @rbs node: RuboCop::AST::SendNode
-          # @rbs arg: RuboCop::AST::Node
-          def correct_multiline(corrector, node, arg) #: void
-            existing_comment = find_regular_comment(arg.location.line)
-
-            if existing_comment
-              comment_text = existing_comment.text.sub(/\A#\s*/, '')
-              corrector.replace(existing_comment.source_range, "#: untyped -- #{comment_text}")
-            else
-              insert_annotation(corrector, node, arg)
-            end
-          end
-
-          # @rbs corrector: RuboCop::Cop::Corrector
-          # @rbs node: RuboCop::AST::SendNode
-          # @rbs arg: RuboCop::AST::Node
-          def insert_annotation(corrector, node, arg) #: void
-            line = arg.location.line
-            line_source = source_code_at(line)
-            content_end_col = line_source.rstrip.length
-            padding = [annotation_column(node) - content_end_col, 1].max || raise
-            line_begin = processed_source.buffer.line_range(line).begin_pos
-            insert_pos = line_begin + content_end_col
-
-            corrector.insert_before(range_between(insert_pos, insert_pos), "#{' ' * padding}#: untyped")
-          end
-
-          # @rbs node: RuboCop::AST::SendNode
-          def annotation_column(node) #: Integer
-            last_arg = node.arguments.last
-            max_end_col = node.arguments.map do |arg|
-              comma_length = arg.equal?(last_arg) ? 0 : 1
-              arg.location.column + source!(arg).length + comma_length
-            end.max || 0
-
-            max_end_col + 2
-          end
-
-          # @rbs line: Integer
-          def find_regular_comment(line) #: Parser::Source::Comment?
-            comment = comment_at(line)
-            comment unless comment&.text&.match?(/\A#:/)
+            (r = node.receiver).is_a?(RuboCop::AST::ConstNode) && r.short_name == :Data
           end
         end
       end