rubocop-rbs_inline 1.7.0 → 1.8.0

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 = "1.8.0"
   end
 end

data/sig/gems/rubocop/rubocop.rbs

@@ -5,3 +5,11 @@ module Parser
     end
   end
 end
+
+module RuboCop
+  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,15 +27,14 @@ module RuboCop
         #     def admin? = role == :admin #: bool
         #   end
         class DataDefineWithBlock < Base
-          MSG: ::String
+          prepend FileFilter
 
-          # @rbs node: RuboCop::AST::SendNode
-          def on_send: (RuboCop::AST::SendNode node) -> void
+          include DataClassMatcher
 
-          private
+          MSG: ::String
 
           # @rbs node: RuboCop::AST::SendNode
-          def struct_like_class?: (RuboCop::AST::SendNode node) -> bool
+          def on_send: (RuboCop::AST::SendNode node) -> void
         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
 

data/sig/rubocop/cop/style/rbs_inline/mixin/annotation_keywords.rbs

@@ -0,0 +1,16 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/annotation_keywords.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Provides the list of keywords that may follow `# @rbs` in an annotation comment.
+        #
+        # refs: https://github.com/soutaro/rbs-inline/blob/main/lib/rbs/inline/annotation_parser/tokenizer.rb
+        module AnnotationKeywords
+          RBS_INLINE_KEYWORDS: Array[String]
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/{ast_utils.rbs → mixin/ast_utils.rbs}

@@ -1,4 +1,4 @@
-# Generated from lib/rubocop/cop/style/rbs_inline/ast_utils.rb with RBS::Inline
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/ast_utils.rb with RBS::Inline
 
 module RuboCop
   module Cop
@@ -9,6 +9,14 @@ module RuboCop
           # @rbs default: Integer
           def end_line: (RuboCop::AST::Node node, default: Integer) -> Integer
 
+          # Returns the arguments node of a method definition.
+          # @rbs node: RuboCop::AST::DefNode
+          def args_node_for: (RuboCop::AST::DefNode node) -> RuboCop::AST::Node
+
+          # 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::Node
           def name_location: (RuboCop::AST::Node node) -> untyped
 

data/sig/rubocop/cop/style/rbs_inline/{class_comment_alignment.rbs → mixin/class_comment_alignment.rbs}

@@ -1,4 +1,4 @@
-# Generated from lib/rubocop/cop/style/rbs_inline/class_comment_alignment.rb with RBS::Inline
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/class_comment_alignment.rb with RBS::Inline
 
 module RuboCop
   module Cop

data/sig/rubocop/cop/style/rbs_inline/{comment_parser.rbs → mixin/comment_parser.rbs}

@@ -1,4 +1,4 @@
-# Generated from lib/rubocop/cop/style/rbs_inline/comment_parser.rb with RBS::Inline
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/comment_parser.rb with RBS::Inline
 
 module RuboCop
   module Cop
@@ -9,6 +9,10 @@ module RuboCop
         module CommentParser : RuboCop::Cop::Base
           attr_reader parsed_comments: Array[RBS::Inline::AnnotationParser::ParsingResult]
 
+          # Fallback for cops that include CommentParser without prepending FileFilter;
+          # `FileFilter` overrides this to return the real per-file decision.
+          def rbs_inline_file_skipped?: () -> bool
+
           # Parse comments from the source code
           def parse_comments: () -> Array[RBS::Inline::AnnotationParser::ParsingResult]
 

data/sig/rubocop/cop/style/rbs_inline/mixin/data_class_matcher.rbs

@@ -0,0 +1,18 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/data_class_matcher.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Matcher for `Data.define` calls, shared by the cops that check
+        # `Data.define` class definitions.
+        module DataClassMatcher
+          private
+
+          # @rbs node: RuboCop::AST::SendNode
+          def struct_like_class?: (RuboCop::AST::SendNode node) -> bool
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/{data_struct_helper.rbs → mixin/data_struct_helper.rbs}

@@ -1,4 +1,4 @@
-# Generated from lib/rubocop/cop/style/rbs_inline/data_struct_helper.rb with RBS::Inline
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/data_struct_helper.rb with RBS::Inline
 
 module RuboCop
   module Cop
@@ -40,9 +40,14 @@ module RuboCop
           # @rbs line: Integer
           def find_regular_comment: (Integer line) -> Parser::Source::Comment?
 
+          # The column is determined by the attribute arguments only; non-attribute
+          # arguments (e.g. the `Struct.new` name or a `keyword_init:` keyword argument)
+          # never carry an annotation and so must not influence the alignment.
           # @rbs node: RuboCop::AST::SendNode
           def annotation_column: (RuboCop::AST::SendNode node) -> Integer
 
+          # Only attribute arguments are considered, for the same reason as
+          # {#annotation_column}.
           # @rbs node: RuboCop::AST::SendNode
           def longest_argname: (RuboCop::AST::SendNode node) -> String
 

data/sig/rubocop/cop/style/rbs_inline/mixin/file_filter.rbs

@@ -0,0 +1,63 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/file_filter.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Filters files a cop reports offenses on, based on `Mode` configuration.
+        #
+        # When `Mode` is `opt_in`, offenses are only reported for files that contain
+        # a `# rbs_inline: enabled` magic comment. When `Mode` is `opt_out`, all files
+        # are checked unless they contain `# rbs_inline: disabled`. When `Mode` is not
+        # set, all files are checked (legacy behavior).
+        #
+        # This module is designed to be `prepend`ed to a cop so that it can short-circuit
+        # the cop's heavy work (annotation parsing via `parse_comments`) and suppress any
+        # residual offense reporting for files that should be skipped.
+        #
+        # @rbs module-self RuboCop::Cop::Base
+        module FileFilter : RuboCop::Cop::Base
+          type mode = :opt_in | :opt_out
+
+          MAGIC_COMMENT_ENABLED: Regexp
+
+          MAGIC_COMMENT_DISABLED: Regexp
+
+          SUPPORTED_MODES: Array[mode]
+
+          self.@warned_invalid_modes: Hash[String, bool]
+
+          # @rbs raw: untyped
+          def self.warn_invalid_mode: (untyped raw) -> void
+
+          @rbs_inline_skip_file: bool
+
+          def on_new_investigation: () -> void
+
+          # @rbs *args: untyped
+          # @rbs **kwargs: untyped
+          def add_offense: (*untyped args, **untyped kwargs) ?{ (?) -> untyped } -> void
+
+          # Exposes the FileFilter's per-file skip decision as a proper method so
+          # helper modules (e.g. `CommentParser`) can consult it explicitly instead
+          # of poking at `@rbs_inline_skip_file` directly.
+          def rbs_inline_file_skipped?: () -> bool
+
+          private
+
+          def skip_by_mode?: () -> bool
+
+          def configured_mode: () -> mode?
+
+          # Iterate the already-materialized `processed_source.comments` so this
+          # matches RequireRbsInlineComment's detection exactly (line endings,
+          # indented comments, heredoc/string content are all handled correctly
+          # by the parser).
+          def rbs_inline_enabled?: () -> bool
+
+          def rbs_inline_disabled?: () -> bool
+        end
+      end
+    end
+  end
+end

data/sig/rubocop/cop/style/rbs_inline/{missing_class_annotation.rbs → mixin/missing_class_annotation.rbs}

@@ -1,4 +1,4 @@
-# Generated from lib/rubocop/cop/style/rbs_inline/missing_class_annotation.rb with RBS::Inline
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/missing_class_annotation.rb with RBS::Inline
 
 module RuboCop
   module Cop

data/sig/rubocop/cop/style/rbs_inline/{source_code_helper.rbs → mixin/source_code_helper.rbs}

@@ -1,4 +1,4 @@
-# Generated from lib/rubocop/cop/style/rbs_inline/source_code_helper.rb with RBS::Inline
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/source_code_helper.rb with RBS::Inline
 
 module RuboCop
   module Cop

data/sig/rubocop/cop/style/rbs_inline/mixin/struct_class_matcher.rbs

@@ -0,0 +1,26 @@
+# Generated from lib/rubocop/cop/style/rbs_inline/mixin/struct_class_matcher.rb with RBS::Inline
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Matcher for `Struct.new` calls, shared by the cops that check `Struct.new`
+        # class definitions.
+        #
+        # Also overrides {DataStructHelper#attr_argument?} for `Struct.new` semantics,
+        # so cops that include both must include this module last.
+        module StructClassMatcher
+          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

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

@@ -20,15 +20,16 @@ module RuboCop
         #   # good
         #   # @rbs %a{pure}
         class ParametersSeparator < Base
+          prepend FileFilter
+
           extend AutoCorrector
 
+          include AnnotationKeywords
+
           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]
-
           RBS_INLINE_REGEXP_KEYWORDS: Array[Regexp]
 
           def on_new_investigation: () -> void

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

@@ -55,8 +55,12 @@ module RuboCop
         #   def method(a)
         #   end
         class RedundantAnnotationWithSkip < Base
+          prepend FileFilter
+
           extend AutoCorrector
 
+          include ASTUtils
+
           include CommentParser
 
           include RangeHelp
@@ -105,10 +109,6 @@ module RuboCop
 
           # @rbs param_list_end_line: Integer
           def check_trailing_return: (Integer param_list_end_line) -> 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
         end
       end
     end

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

@@ -25,6 +25,8 @@ module RuboCop
         #
         #   attr_reader :foo
         class RedundantInstanceVariableAnnotation < Base
+          prepend FileFilter
+
           extend AutoCorrector
 
           include ASTUtils

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

@@ -77,8 +77,12 @@ module RuboCop
         #   def method(a) #: String
         #   end
         class RedundantTypeAnnotation < Base
+          prepend FileFilter
+
           extend AutoCorrector
 
+          include ASTUtils
+
           include CommentParser
 
           include ConfigurableEnforcedStyle
@@ -110,10 +114,6 @@ module RuboCop
           # @rbs def_line: Integer
           def check_parameter_redundancy: (Integer def_line) -> 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 def_line: Integer
           # @rbs parameter_list_end_line: Integer
           def check_return_type_redundancy: (Integer def_line, Integer parameter_list_end_line) -> void

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

@@ -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
@@ -50,6 +60,12 @@ module RuboCop
 
           MSG_FORBIDDEN: ::String
 
+          self.@enforced_style_deprecation_warned: bool
+
+          def self.enforced_style_deprecation_warned?: () -> bool
+
+          def self.mark_enforced_style_deprecation_warned!: () -> void
+
           def on_new_investigation: () -> void
 
           private
@@ -60,16 +76,25 @@ module RuboCop
           def disabled?: (Parser::Source::Comment? magic_comment) -> bool
 
           # @rbs magic_comment: Parser::Source::Comment?
-          def check_always_style: (Parser::Source::Comment? magic_comment) -> void
+          def check_opt_in: (Parser::Source::Comment? magic_comment) -> void
 
           # @rbs magic_comment: Parser::Source::Comment?
-          def check_never_style: (Parser::Source::Comment? magic_comment) -> void
+          def check_opt_out: (Parser::Source::Comment? magic_comment) -> void
 
           def find_insert_position: () -> Integer
 
+          # 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: (Integer insert_position) -> String
+
           def find_last_comment_in_first_block: () -> Parser::Source::Comment
 
-          def style: () -> Symbol
+          def effective_mode: () -> FileFilter::mode
+
+          def allow_missing_comment?: () -> bool
+
+          def warn_deprecated_enforced_style: () -> void
 
           def first_line_range: () -> Parser::Source::Range
         end