rubocop-rbs_inline 1.7.0 → 2.0.0

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

@@ -10,7 +10,7 @@ module RuboCop
         # opt-out (processes all files by default). This cop enforces consistency in which
         # mode your codebase uses.
         #
-        # @example EnforcedStyle: always (default)
+        # @example Mode: opt_in
         #   # bad
         #   # (no rbs_inline comment)
         #   class Foo
@@ -26,7 +26,17 @@ module RuboCop
         #   class Foo
         #   end
         #
-        # @example EnforcedStyle: never
+        # @example Mode: opt_in, AllowMissingComment: true
+        #   # good - the cop does not enforce the magic comment
+        #   class Foo
+        #   end
+        #
+        #   # good
+        #   # rbs_inline: enabled
+        #   class Foo
+        #   end
+        #
+        # @example Mode: opt_out
         #   # bad
         #   # rbs_inline: enabled
         #   class Foo
@@ -43,6 +53,7 @@ module RuboCop
         #   end
         #
         class RequireRbsInlineComment < Base
+          include ModeConfig
           include RangeHelp
           extend AutoCorrector
 
@@ -55,10 +66,9 @@ module RuboCop
             magic_comment = find_rbs_inline_magic_comment
             return if disabled?(magic_comment)
 
-            if style == :always
-              check_always_style(magic_comment)
-            elsif style == :never
-              check_never_style(magic_comment)
+            case configured_mode
+            when :opt_in then check_opt_in(magic_comment)
+            when :opt_out then check_opt_out(magic_comment)
             end
           end
 
@@ -76,41 +86,45 @@ module RuboCop
           end
 
           # @rbs magic_comment: Parser::Source::Comment?
-          def check_always_style(magic_comment) #: void
-            # disabled is already filtered out by early return
-            # magic_comment is either nil or enabled
+          def check_opt_in(magic_comment) #: void
             return if magic_comment
+            return if allow_missing_comment?
 
-            # Insert after the first comment block or at the beginning of the file
             insert_position = find_insert_position
             add_offense(first_line_range, message: MSG_MISSING) do |corrector|
               insert_range = Parser::Source::Range.new(processed_source.buffer, insert_position, insert_position)
-              corrector.insert_before(insert_range, "# rbs_inline: enabled\n")
+              corrector.insert_before(insert_range, insertion_text(insert_position))
             end
           end
 
           # @rbs magic_comment: Parser::Source::Comment?
-          def check_never_style(magic_comment) #: void
-            # disabled is already filtered out by early return
-            # magic_comment is either nil or enabled
+          def check_opt_out(magic_comment) #: void
             return unless magic_comment
 
             add_offense(magic_comment.source_range, message: MSG_FORBIDDEN) do |corrector|
-              # Remove the entire line including newline
               range = range_with_surrounding_space(magic_comment.source_range, side: :right, newlines: true)
               corrector.remove(range)
             end
           end
 
           def find_insert_position #: Integer
-            # Find the end of the first comment block (e.g., magic comments)
-            # and insert after it
             first_comment = processed_source.comments.first
-            # If the first comment doesn't exist or doesn't start at line 1, insert at the beginning
             return 0 unless first_comment&.source_range&.first_line == 1
 
             last_comment_in_block = find_last_comment_in_first_block
-            last_comment_in_block.source_range.end_pos + 1
+            # `end_pos` points at the newline terminating the comment, so `+ 1` moves past it.
+            # A file without a trailing newline has none, so clamp to the end of the buffer.
+            (last_comment_in_block.source_range.end_pos + 1).clamp(0, processed_source.buffer.source.length)
+          end
+
+          # The insert position lands at the end of the buffer when the file has no trailing
+          # newline. The magic comment then needs its own newline to stay on a separate line.
+          # @rbs insert_position: Integer
+          def insertion_text(insert_position) #: String
+            source = processed_source.buffer.source
+            return "# rbs_inline: enabled\n" if insert_position.zero? || source[insert_position - 1] == "\n"
+
+            "\n# rbs_inline: enabled\n"
           end
 
           def find_last_comment_in_first_block #: Parser::Source::Comment
@@ -127,13 +141,11 @@ module RuboCop
             comments[last_idx] || raise
           end
 
-          def style #: Symbol
-            cop_config["EnforcedStyle"]&.to_sym || :always
+          def allow_missing_comment? #: bool
+            cop_config["AllowMissingComment"] == true
           end
 
           def first_line_range #: Parser::Source::Range
-            # Find the first line of actual code (not comment-only lines)
-            # If there's no AST (e.g., file with only comments), use the first line
             first_line = processed_source.ast&.source_range&.first_line || 1
             processed_source.buffer.line_range(first_line)
           end

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

@@ -24,7 +24,9 @@ module RuboCop
         #   )
         #
         class StructClassCommentAlignment < Base
+          prepend FileFilter
           include ClassCommentAlignment
+          include StructClassMatcher
           extend AutoCorrector
 
           MSG = "Misaligned inline type annotation for Struct attribute."
@@ -35,22 +37,6 @@ module RuboCop
 
             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

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

@@ -25,9 +25,13 @@ module RuboCop
         #   end
         #
         class StructNewWithBlock < Base
+          prepend FileFilter
+          include StructClassMatcher
+          include ASTUtils
+
           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."
+                "so methods defined in the block will not be recognized. Keep the `Struct.new` call " \
+                "and move the methods into %<destination>s."
 
           # @rbs node: RuboCop::AST::SendNode
           def on_send(node) #: void
@@ -36,16 +40,18 @@ module RuboCop
             block_node = node.parent
             return unless block_node&.block_type?
 
-            add_offense(node)
+            add_offense(node, message: format(MSG, destination: destination(block_node)))
           end
 
           private
 
-          # @rbs node: RuboCop::AST::SendNode
-          def struct_like_class?(node) #: bool
-            return false unless node.method_name == :new
+          # The constant the definition is assigned to is the class to reopen.
+          # @rbs node: RuboCop::AST::Node
+          def destination(node) #: String
+            class_name = assigned_constant_name(node)
+            return "a `class` that reopens it" unless class_name
 
-            (r = node.receiver).is_a?(RuboCop::AST::ConstNode) && r.short_name == :Struct
+            "`class #{class_name} ... end` written after it"
           end
         end
       end

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

@@ -18,14 +18,18 @@ module RuboCop
         #   def method(arg); end
         #
         class UnmatchedAnnotations < Base
+          prepend FileFilter
           include CommentParser
           include RangeHelp
           include SourceCodeHelper
 
           MSG = "target parameter not found."
 
+          attr_reader :processed_comments #: Set[RBS::Inline::AnnotationParser::ParsingResult] -- matched to a def node
+
           def on_new_investigation #: void
             super
+            @processed_comments = Set.new
             parse_comments
           end
 
@@ -41,6 +45,8 @@ module RuboCop
 
           def on_investigation_end #: void
             parsed_comments.each do |comment|
+              next if processed?(comment)
+
               comment.each_annotation do |annotation|
                 case annotation
                 when RBS::Inline::AST::Annotations::BlockType,
@@ -57,15 +63,13 @@ module RuboCop
           private
 
           # @rbs node: RuboCop::AST::DefNode
-          def process(node) #: void # rubocop:disable Metrics/CyclomaticComplexity
+          def process(node) #: void
             arguments = arguments_for(node)
 
-            comment = parsed_comments.find do |r|
-              r.comments.map(&:location).map(&:start_line).include?(node.location.line - 1)
-            end
+            comment = leading_comment_for(node)
             return unless comment
 
-            parsed_comments.delete(comment)
+            mark_processed(comment)
             comment.each_annotation do |annotation|
               case annotation
               when RBS::Inline::AST::Annotations::IvarType
@@ -76,6 +80,25 @@ module RuboCop
             end
           end
 
+          # @rbs node: RuboCop::AST::DefNode
+          def leading_comment_for(node) #: RBS::Inline::AnnotationParser::ParsingResult?
+            parsed_comments.find do |comment|
+              next if processed?(comment)
+
+              comment.comments.map(&:location).map(&:start_line).include?(node.location.line - 1)
+            end
+          end
+
+          # @rbs comment: RBS::Inline::AnnotationParser::ParsingResult
+          def mark_processed(comment) #: void
+            processed_comments << comment
+          end
+
+          # @rbs comment: RBS::Inline::AnnotationParser::ParsingResult
+          def processed?(comment) #: bool
+            processed_comments.include?(comment)
+          end
+
           # @rbs node: RuboCop::AST::DefNode
           def arguments_for(node) #: Array[String] # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
             args_for(node).children.flat_map do |argument| # rubocop:disable Metrics/BlockLength
@@ -104,7 +127,9 @@ module RuboCop
               when :forward_arg
                 ["..."]
               else
-                raise
+                # Unnamed parameters (ex. destructuring arguments; `def foo((a, b))`) are not
+                # annotatable because RBS::Inline does not generate types for them.
+                []
               end
             end
           end

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

@@ -59,6 +59,7 @@ module RuboCop
         #   end
         #
         class UntypedInstanceVariable < Base
+          prepend FileFilter
           include ASTUtils
           include CommentParser
           include RangeHelp
@@ -185,12 +186,21 @@ module RuboCop
           def collect_typed_ivars_for_scope(node) #: void
             class_start = node.location.line
             class_end = end_line(node, default: class_start)
-            ivar_type_annotations.reject! do |line, name|
-              current_scope[:typed_ivars] << name if line.between?(class_start, class_end)
-            end
-            civar_type_annotations.reject! do |line, name|
-              current_scope[:typed_class_ivars] << name if line.between?(class_start, class_end)
-            end
+            lines = class_start..class_end
+            move_annotations(ivar_type_annotations, current_scope[:typed_ivars], lines)
+            move_annotations(civar_type_annotations, current_scope[:typed_class_ivars], lines)
+          end
+
+          # Moves the annotations placed within +lines+ from +annotations+ into +typed+
+          # so that outer scopes no longer see them.
+          #
+          # @rbs annotations: Hash[Integer, Symbol]
+          # @rbs typed: Set[Symbol]
+          # @rbs lines: Range[Integer]
+          def move_annotations(annotations, typed, lines) #: void
+            inside, outside = annotations.partition { |line, _name| lines.cover?(line) }
+            typed.merge(inside.map { |_line, name| name })
+            annotations.replace(outside.to_h)
           end
 
           def collect_ivar_type_annotations #: [Hash[Integer, Symbol], Hash[Integer, Symbol]]

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "source_code_helper"
-require_relative "comment_parser"
+require_relative "mixin/source_code_helper"
+require_relative "mixin/comment_parser"
 
 module RuboCop
   module Cop
@@ -31,6 +31,7 @@ module RuboCop
         #   end
         #
         class VariableCommentSpacing < Base
+          prepend FileFilter
           extend AutoCorrector
           include SourceCodeHelper
           include CommentParser

data/lib/rubocop/rbs_inline/version.rb

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

data/rbs_collection.lock.yaml

@@ -6,7 +6,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: diff-lcs
@@ -14,7 +14,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: fileutils
@@ -34,7 +34,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: logger
@@ -42,7 +42,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: monitor
@@ -58,7 +58,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: parser
@@ -66,7 +66,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: prism
@@ -78,7 +78,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rake
@@ -86,7 +86,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rbs
@@ -106,7 +106,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rubocop
@@ -114,7 +114,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rubocop-ast
@@ -122,7 +122,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: ea56a88d1c0ac98e79f8ea5bb19a139da768ba10
+    revision: 82762423fc5694b82888ea89a972847cf19838c2
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rubocop-numbered-params

data/sig/gems/rubocop/rubocop.rbs

@@ -5,3 +5,17 @@ module Parser
     end
   end
 end
+
+module RuboCop
+  class Error < StandardError
+  end
+
+  class ValidationError < Error
+  end
+
+  module Cop
+    module ConfigurableEnforcedStyle
+      def no_acceptable_style!: () -> void
+    end
+  end
+end

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

@@ -25,19 +25,18 @@ module RuboCop
         #     :visibility  #: Symbol
         #   )
         class DataClassCommentAlignment < Base
+          prepend FileFilter
+
           include ClassCommentAlignment
 
+          include DataClassMatcher
+
           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
         end
       end
     end

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

@@ -27,6 +27,12 @@ module RuboCop
         #     def admin? = role == :admin #: bool
         #   end
         class DataDefineWithBlock < Base
+          prepend FileFilter
+
+          include DataClassMatcher
+
+          include ASTUtils
+
           MSG: ::String
 
           # @rbs node: RuboCop::AST::SendNode
@@ -34,8 +40,9 @@ module RuboCop
 
           private
 
-          # @rbs node: RuboCop::AST::SendNode
-          def struct_like_class?: (RuboCop::AST::SendNode node) -> bool
+          # The constant the definition is assigned to is the class to reopen.
+          # @rbs node: RuboCop::AST::Node
+          def destination: (RuboCop::AST::Node node) -> String
         end
       end
     end

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

@@ -22,6 +22,8 @@ module RuboCop
         #   def method
         #   end
         class EmbeddedRbsSpacing < Base
+          prepend FileFilter
+
           extend AutoCorrector
 
           include SourceCodeHelper

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

@@ -17,12 +17,13 @@ module RuboCop
         #   #: () -> void
         #   # @rbs param: String
         class InvalidComment < Base
+          prepend FileFilter
+
           extend AutoCorrector
 
-          MSG: ::String
+          include AnnotationKeywords
 
-          # refs: https://github.com/soutaro/rbs-inline/blob/main/lib/rbs/inline/annotation_parser/tokenizer.rb
-          RBS_INLINE_KEYWORDS: Array[String]
+          MSG: ::String
 
           RBS_INLINE_KEYWORD_PATTERN: String
 

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

@@ -18,6 +18,8 @@ module RuboCop
         #   # @rbs &block: () -> void
         #   def method(arg); end
         class InvalidTypes < Base
+          prepend FileFilter
+
           include CommentParser
 
           include RangeHelp

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

@@ -14,17 +14,18 @@ module RuboCop
         #   # good
         #   # @rbs module-self String
         class KeywordSeparator < Base
+          prepend FileFilter
+
           extend AutoCorrector
 
+          include AnnotationKeywords
+
           include CommentParser
 
           include RangeHelp
 
           MSG: ::String
 
-          # refs: https://github.com/soutaro/rbs-inline/blob/main/lib/rbs/inline/annotation_parser/tokenizer.rb
-          RBS_INLINE_KEYWORDS: Array[String]
-
           # `override` and `skip` are standalone markers that take no arguments.
           # Even before a method definition they may not be followed by `:` alone,
           # because `# @rbs override:` (no type) is not a valid parameter annotation.

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

@@ -52,6 +52,8 @@ module RuboCop
         #   private def method(x)
         #   end
         class MethodCommentSpacing < Base
+          prepend FileFilter
+
           extend AutoCorrector
 
           include RangeHelp

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

@@ -20,19 +20,18 @@ module RuboCop
         #     :visibility  #: Symbol
         #   )
         class MissingDataClassAnnotation < Base
+          prepend FileFilter
+
           include MissingClassAnnotation
 
+          include DataClassMatcher
+
           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
         end
       end
     end

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

@@ -21,24 +21,18 @@ module RuboCop
         #     :y   #: Integer
         #   )
         class MissingStructClassAnnotation < Base
+          prepend FileFilter
+
           include MissingClassAnnotation
 
+          include StructClassMatcher
+
           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

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

@@ -20,7 +20,8 @@ module RuboCop
         # - `all`: Checks all methods regardless of visibility (default)
         # - `public`: Only checks public methods and `attr_*` declarations
         #
-        # Methods annotated with `# @rbs skip` are always excluded from inspection.
+        # Methods annotated with `# @rbs skip` or `# @rbs override`, parameters with a leading
+        # `_`, and the `...` parameter are always excluded.
         #
         # @example EnforcedStyle: doc_style
         #   # bad
@@ -113,6 +114,8 @@ module RuboCop
         #   # good - attr with trailing type
         #   attr_reader :name #: String
         class MissingTypeAnnotation < Base
+          prepend FileFilter
+
           include ASTUtils
 
           include CommentParser
@@ -227,13 +230,6 @@ module RuboCop
           # @rbs node: RuboCop::AST::SendNode
           def check_attribute_method: (RuboCop::AST::SendNode node) -> void
 
-          # Returns the last line of the method parameter list (the closing ) line, or the def line if no parens).
-          # @rbs node: RuboCop::AST::DefNode
-          def method_parameter_list_end_line: (RuboCop::AST::DefNode node) -> Integer
-
-          # @rbs node: RuboCop::AST::DefNode
-          def args_node_for: (RuboCop::AST::DefNode node) -> RuboCop::AST::Node
-
           # @rbs node: RuboCop::AST::DefNode
           def method_has_arguments?: (RuboCop::AST::DefNode node) -> bool