rubocop-rbs_inline 1.6.1 → 1.7.0

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

@@ -21,155 +21,25 @@ module RuboCop
         #   )
         #
         class MissingDataClassAnnotation < Base
-          include ASTUtils
-          include RangeHelp
-          include SourceCodeHelper
+          include MissingClassAnnotation
           extend AutoCorrector
 
           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) { 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
-
-          # @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

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Checks that `Struct.new` attributes have inline type annotations.
+        #
+        # Each attribute passed to `Struct.new` should have a trailing `#:` type
+        # annotation comment on the same line. A leading string argument (the struct
+        # name) and the `keyword_init:` keyword argument are not attributes and are
+        # ignored.
+        #
+        # @example
+        #   # bad
+        #   Point = Struct.new(:x, :y)
+        #
+        #   # good
+        #   Point = Struct.new(
+        #     :x,  #: Integer
+        #     :y   #: Integer
+        #   )
+        #
+        class MissingStructClassAnnotation < Base
+          include MissingClassAnnotation
+          extend AutoCorrector
+
+          MSG = "Missing inline type annotation for Struct attribute (e.g., `#: Type`)."
+
+          # @rbs node: RuboCop::AST::SendNode
+          def on_send(node) #: void
+            return unless struct_like_class?(node)
+
+            check_missing_annotations(node)
+          end
+
+          private
+
+          # @rbs node: RuboCop::AST::SendNode
+          def struct_like_class?(node) #: bool
+            return false unless node.method_name == :new
+
+            (r = node.receiver).is_a?(RuboCop::AST::ConstNode) && r.short_name == :Struct
+          end
+
+          # `Struct.new` treats a leading string argument as the struct name, so only
+          # symbol arguments are attributes.
+          # @rbs arg: RuboCop::AST::Node
+          def attr_argument?(arg) #: bool
+            arg.sym_type?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -320,7 +320,7 @@ module RuboCop
 
               candidates = param_candidate_names(argument, name)
               next unless candidates
-              next if candidates.any? { annotated_names.include?(_1) }
+              next if candidates.intersect?(annotated_names)
 
               add_offense(argument, message: format(DOC_STYLE_PARAM_MESSAGE, name: param_display_name(argument)))
             end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Checks that `#:` inline type annotations in `Struct.new` blocks are aligned.
+        #
+        # Each `#:` annotation comment should start at the same column, determined by
+        # the longest attribute name (plus trailing comma). Folded `Struct.new` calls
+        # (where attributes are not one per line) are excluded.
+        #
+        # @example
+        #   # bad
+        #   Point = Struct.new(
+        #     :x, #: Integer
+        #     :y   #: Integer
+        #   )
+        #
+        #   # good
+        #   Point = Struct.new(
+        #     :x,  #: Integer
+        #     :y   #: Integer
+        #   )
+        #
+        class StructClassCommentAlignment < Base
+          include ClassCommentAlignment
+          extend AutoCorrector
+
+          MSG = "Misaligned inline type annotation for Struct attribute."
+
+          # @rbs node: RuboCop::AST::SendNode
+          def on_send(node) #: void
+            return unless struct_like_class?(node)
+
+            check_comment_alignment(node)
+          end
+
+          private
+
+          # @rbs node: RuboCop::AST::SendNode
+          def struct_like_class?(node) #: bool
+            return false unless node.method_name == :new
+
+            (r = node.receiver).is_a?(RuboCop::AST::ConstNode) && r.short_name == :Struct
+          end
+
+          # `Struct.new` treats a leading string argument as the struct name, so only
+          # symbol arguments are attributes.
+          # @rbs arg: RuboCop::AST::Node
+          def attr_argument?(arg) #: bool
+            arg.sym_type?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Checks for `Struct.new` calls with a block.
+        #
+        # RBS::Inline does not parse the contents of `Struct.new` blocks, so any
+        # methods defined inside will not be recognized for type checking. Instead,
+        # call `Struct.new` without a block and define additional methods by
+        # reopening the class separately.
+        #
+        # @example
+        #   # bad
+        #   User = Struct.new(:name, :role) do
+        #     def admin? = role == :admin #: bool
+        #   end
+        #
+        #   # good
+        #   User = Struct.new(:name, :role)
+        #
+        #   class User
+        #     def admin? = role == :admin #: bool
+        #   end
+        #
+        class StructNewWithBlock < Base
+          MSG = "Do not use `Struct.new` 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 struct_like_class?(node)
+
+            block_node = node.parent
+            return unless block_node&.block_type?
+
+            add_offense(node)
+          end
+
+          private
+
+          # @rbs node: RuboCop::AST::SendNode
+          def struct_like_class?(node) #: bool
+            return false unless node.method_name == :new
+
+            (r = node.receiver).is_a?(RuboCop::AST::ConstNode) && r.short_name == :Struct
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rbs_inline/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module RbsInline
-    VERSION = "1.6.1"
+    VERSION = "1.7.0"
   end
 end

data/rbs_collection.lock.yaml

@@ -25,6 +25,10 @@ gems:
   version: '0'
   source:
     type: stdlib
+- name: language_server-protocol
+  version: 3.17.0.6
+  source:
+    type: rubygems
 - name: lint_roller
   version: '1.1'
   source:
@@ -122,7 +126,7 @@ gems:
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rubocop-numbered-params
-  version: 1.0.0
+  version: 1.0.1
   source:
     type: rubygems
 - name: strscan

data/sig/rubocop/cop/style/rbs_inline/class_comment_alignment.rbs

@@ -0,0 +1,34 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/class_comment_alignment.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Shared behavior for cops that ensure `#:` inline type annotations on
+        # struct-like class attributes (`Data.define` / `Struct.new`) are aligned.
+        #
+        # The including cop matches the definition node (e.g. via `struct_like_class?`)
+        # and calls {#check_comment_alignment}.
+        #
+        # @rbs module-self RuboCop::Cop::Base
+        module ClassCommentAlignment : RuboCop::Cop::Base
+          include DataStructHelper
+
+          # @rbs node: RuboCop::AST::SendNode
+          def check_comment_alignment: (RuboCop::AST::SendNode node) -> void
+
+          private
+
+          # @rbs node: RuboCop::AST::SendNode
+          def check_annotation_alignment: (RuboCop::AST::SendNode node) -> void
+
+          # @rbs corrector: RuboCop::Cop::Corrector
+          # @rbs arg: RuboCop::AST::Node
+          # @rbs comment: Parser::Source::Comment
+          # @rbs expected_col: Integer
+          def correct_alignment: (RuboCop::Cop::Corrector corrector, RuboCop::AST::Node arg, Parser::Source::Comment comment, Integer expected_col) -> void
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/data_class_comment_alignment.rbs

@@ -25,11 +25,7 @@ module RuboCop
         #     :visibility  #: Symbol
         #   )
         class DataClassCommentAlignment < Base
-          include ASTUtils
-
-          include RangeHelp
-
-          include SourceCodeHelper
+          include ClassCommentAlignment
 
           extend AutoCorrector
 
@@ -41,31 +37,7 @@ module RuboCop
           private
 
           # @rbs node: RuboCop::AST::SendNode
-          def data_define?: (RuboCop::AST::SendNode node) -> bool
-
-          # @rbs arg: RuboCop::AST::Node
-          def data_attribute?: (RuboCop::AST::Node arg) -> bool
-
-          # @rbs node: RuboCop::AST::SendNode
-          def data_attributes: (RuboCop::AST::SendNode node) -> Array[RuboCop::AST::Node]
-
-          # @rbs node: RuboCop::AST::SendNode
-          def folded_data_class?: (RuboCop::AST::SendNode node) -> bool
-
-          # @rbs node: RuboCop::AST::SendNode
-          def check_annotation_alignment: (RuboCop::AST::SendNode node) -> void
-
-          # @rbs line: Integer
-          def inline_type_comment: (Integer line) -> Parser::Source::Comment?
-
-          # @rbs node: RuboCop::AST::SendNode
-          def annotation_column: (RuboCop::AST::SendNode node) -> Integer
-
-          # @rbs corrector: RuboCop::Cop::Corrector
-          # @rbs arg: RuboCop::AST::Node
-          # @rbs comment: Parser::Source::Comment
-          # @rbs expected_col: Integer
-          def correct_alignment: (RuboCop::Cop::Corrector corrector, RuboCop::AST::Node arg, Parser::Source::Comment comment, Integer expected_col) -> void
+          def struct_like_class?: (RuboCop::AST::SendNode node) -> bool
         end
       end
     end

data/sig/rubocop/cop/style/rbs_inline/data_define_with_block.rbs

@@ -35,7 +35,7 @@ module RuboCop
           private
 
           # @rbs node: RuboCop::AST::SendNode
-          def data_define?: (RuboCop::AST::SendNode node) -> bool
+          def struct_like_class?: (RuboCop::AST::SendNode node) -> bool
         end
       end
     end

data/sig/rubocop/cop/style/rbs_inline/data_struct_helper.rbs

@@ -0,0 +1,55 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/data_struct_helper.rb with RBS::Inline
+
+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 : RuboCop::Cop::Base
+          include ASTUtils
+
+          include SourceCodeHelper
+
+          include RangeHelp
+
+          # @rbs arg: RuboCop::AST::Node
+          def attr_argument?: (RuboCop::AST::Node arg) -> bool
+
+          # @rbs node: RuboCop::AST::SendNode
+          def attr_arguments: (RuboCop::AST::SendNode node) -> Array[RuboCop::AST::Node]
+
+          # @rbs node: RuboCop::AST::SendNode
+          def folded?: (RuboCop::AST::SendNode node) -> bool
+
+          # @rbs line: Integer
+          def inline_type_annotation?: (Integer line) -> boolish
+
+          # @rbs line: Integer
+          def inline_type_comment: (Integer line) -> Parser::Source::Comment?
+
+          # @rbs line: Integer
+          def find_regular_comment: (Integer line) -> Parser::Source::Comment?
+
+          # @rbs node: RuboCop::AST::SendNode
+          def annotation_column: (RuboCop::AST::SendNode node) -> Integer
+
+          # @rbs node: RuboCop::AST::SendNode
+          def longest_argname: (RuboCop::AST::SendNode node) -> String
+
+          # @rbs node: RuboCop::AST::SendNode
+          def build_multiline_replacement: (RuboCop::AST::SendNode node) -> String
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/missing_class_annotation.rbs

@@ -0,0 +1,41 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/missing_class_annotation.rb with RBS::Inline
+
+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 : RuboCop::Cop::Base
+          include DataStructHelper
+
+          # @rbs node: RuboCop::AST::SendNode
+          def check_missing_annotations: (RuboCop::AST::SendNode node) -> void
+
+          private
+
+          # @rbs node: RuboCop::AST::SendNode
+          def add_offenses_for_folded: (RuboCop::AST::SendNode node) -> void
+
+          # @rbs node: RuboCop::AST::SendNode
+          def check_multiline: (RuboCop::AST::SendNode node) -> void
+
+          # @rbs corrector: RuboCop::Cop::Corrector
+          # @rbs node: RuboCop::AST::SendNode
+          # @rbs arg: RuboCop::AST::Node
+          def correct_multiline: (RuboCop::Cop::Corrector corrector, RuboCop::AST::SendNode node, RuboCop::AST::Node arg) -> void
+
+          # @rbs corrector: RuboCop::Cop::Corrector
+          # @rbs node: RuboCop::AST::SendNode
+          # @rbs arg: RuboCop::AST::Node
+          def insert_annotation: (RuboCop::Cop::Corrector corrector, RuboCop::AST::SendNode node, RuboCop::AST::Node arg) -> void
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/missing_data_class_annotation.rbs

@@ -20,11 +20,7 @@ module RuboCop
         #     :visibility  #: Symbol
         #   )
         class MissingDataClassAnnotation < Base
-          include ASTUtils
-
-          include RangeHelp
-
-          include SourceCodeHelper
+          include MissingClassAnnotation
 
           extend AutoCorrector
 
@@ -36,47 +32,7 @@ module RuboCop
           private
 
           # @rbs node: RuboCop::AST::SendNode
-          def data_define?: (RuboCop::AST::SendNode node) -> bool
-
-          # @rbs arg: RuboCop::AST::Node
-          def data_attribute?: (RuboCop::AST::Node arg) -> bool
-
-          # @rbs node: RuboCop::AST::SendNode
-          def data_attributes: (RuboCop::AST::SendNode node) -> Array[RuboCop::AST::Node]
-
-          # @rbs line: Integer
-          def inline_type_annotation?: (Integer line) -> boolish
-
-          # @rbs node: RuboCop::AST::SendNode
-          def folded_data_class?: (RuboCop::AST::SendNode node) -> bool
-
-          # @rbs node: RuboCop::AST::SendNode
-          def add_offenses_for_folded_data_class: (RuboCop::AST::SendNode node) -> void
-
-          # @rbs node: RuboCop::AST::SendNode
-          def longest_argname: (RuboCop::AST::SendNode node) -> String
-
-          # @rbs node: RuboCop::AST::SendNode
-          def build_multiline_replacement: (RuboCop::AST::SendNode node) -> String
-
-          # @rbs node: RuboCop::AST::SendNode
-          def check_multiline_data_class: (RuboCop::AST::SendNode node) -> void
-
-          # @rbs corrector: RuboCop::Cop::Corrector
-          # @rbs node: RuboCop::AST::SendNode
-          # @rbs arg: RuboCop::AST::Node
-          def correct_multiline: (RuboCop::Cop::Corrector corrector, RuboCop::AST::SendNode node, RuboCop::AST::Node arg) -> void
-
-          # @rbs corrector: RuboCop::Cop::Corrector
-          # @rbs node: RuboCop::AST::SendNode
-          # @rbs arg: RuboCop::AST::Node
-          def insert_annotation: (RuboCop::Cop::Corrector corrector, RuboCop::AST::SendNode node, RuboCop::AST::Node arg) -> void
-
-          # @rbs node: RuboCop::AST::SendNode
-          def annotation_column: (RuboCop::AST::SendNode node) -> Integer
-
-          # @rbs line: Integer
-          def find_regular_comment: (Integer line) -> Parser::Source::Comment?
+          def struct_like_class?: (RuboCop::AST::SendNode node) -> bool
         end
       end
     end

data/sig/rubocop/cop/style/rbs_inline/missing_struct_class_annotation.rbs

@@ -0,0 +1,46 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/missing_struct_class_annotation.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Checks that `Struct.new` attributes have inline type annotations.
+        #
+        # Each attribute passed to `Struct.new` should have a trailing `#:` type
+        # annotation comment on the same line. A leading string argument (the struct
+        # name) and the `keyword_init:` keyword argument are not attributes and are
+        # ignored.
+        #
+        # @example
+        #   # bad
+        #   Point = Struct.new(:x, :y)
+        #
+        #   # good
+        #   Point = Struct.new(
+        #     :x,  #: Integer
+        #     :y   #: Integer
+        #   )
+        class MissingStructClassAnnotation < Base
+          include MissingClassAnnotation
+
+          extend AutoCorrector
+
+          MSG: ::String
+
+          # @rbs node: RuboCop::AST::SendNode
+          def on_send: (RuboCop::AST::SendNode node) -> void
+
+          private
+
+          # @rbs node: RuboCop::AST::SendNode
+          def struct_like_class?: (RuboCop::AST::SendNode node) -> bool
+
+          # `Struct.new` treats a leading string argument as the struct name, so only
+          # symbol arguments are attributes.
+          # @rbs arg: RuboCop::AST::Node
+          def attr_argument?: (RuboCop::AST::Node arg) -> bool
+        end
+      end
+    end
+  end
+end