rubocop-rbs_inline 1.7.0 → 2.0.0

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

@@ -20,12 +20,12 @@ module RuboCop
         #   # @rbs param: String
         #
         class InvalidComment < Base
+          prepend FileFilter
           extend AutoCorrector
+          include AnnotationKeywords
 
           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
 
           SIGNATURE_PATTERN = '\(.*\)\s*(\??\s*{.*?}\s*)?->\s*.*'

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

@@ -21,6 +21,7 @@ module RuboCop
         #   def method(arg); end
         #
         class InvalidTypes < Base
+          prepend FileFilter
           include CommentParser
           include RangeHelp
           include SourceCodeHelper

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

@@ -15,14 +15,14 @@ module RuboCop
         #   # @rbs module-self String
         #
         class KeywordSeparator < Base
+          prepend FileFilter
           extend AutoCorrector
+          include AnnotationKeywords
           include CommentParser
           include RangeHelp
 
           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]
           # `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/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 "mixin/source_code_helper"
+require_relative "mixin/comment_parser"
 
 module RuboCop
   module Cop
@@ -56,6 +56,7 @@ module RuboCop
         #   end
         #
         class MethodCommentSpacing < Base
+          prepend FileFilter
           extend AutoCorrector
           include RangeHelp
           include SourceCodeHelper

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

@@ -21,7 +21,9 @@ module RuboCop
         #   )
         #
         class MissingDataClassAnnotation < Base
+          prepend FileFilter
           include MissingClassAnnotation
+          include DataClassMatcher
           extend AutoCorrector
 
           MSG = "Missing inline type annotation for Data attribute (e.g., `#: Type`)."
@@ -32,15 +34,6 @@ module RuboCop
 
             check_missing_annotations(node)
           end
-
-          private
-
-          # @rbs node: RuboCop::AST::SendNode
-          def struct_like_class?(node) #: bool
-            return false unless node.method_name == :define
-
-            (r = node.receiver).is_a?(RuboCop::AST::ConstNode) && r.short_name == :Data
-          end
         end
       end
     end

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

@@ -22,7 +22,9 @@ module RuboCop
         #   )
         #
         class MissingStructClassAnnotation < Base
+          prepend FileFilter
           include MissingClassAnnotation
+          include StructClassMatcher
           extend AutoCorrector
 
           MSG = "Missing inline type annotation for Struct attribute (e.g., `#: Type`)."
@@ -33,22 +35,6 @@ module RuboCop
 
             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

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

@@ -22,7 +22,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
@@ -116,6 +117,7 @@ module RuboCop
         #   attr_reader :name #: String
         #
         class MissingTypeAnnotation < Base # rubocop:disable Metrics/ClassLength
+          prepend FileFilter
           include ASTUtils
           include CommentParser
           include ConfigurableEnforcedStyle
@@ -347,21 +349,6 @@ module RuboCop
             add_offense(node, message: ATTRIBUTE_METHOD_MESSAGE)
           end
 
-          # 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(node) #: Integer
-            args_node = args_node_for(node)
-            end_line(args_node, default: node.location.line)
-          end
-
-          # @rbs node: RuboCop::AST::DefNode
-          def args_node_for(node) #: RuboCop::AST::Node
-            case node.type
-            when :defs then node.children[2]
-            else node.children[1]
-            end
-          end
-
           # @rbs node: RuboCop::AST::DefNode
           def method_has_arguments?(node) #: bool
             args_node_for(node).children.any?

data/lib/rubocop/cop/style/rbs_inline/mixin/annotation_keywords.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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 = %w[inherits override use module-self generic skip module class].freeze #: Array[String]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/rbs_inline/mixin/ast_utils.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        module ASTUtils
+          # @rbs node: RuboCop::AST::Node
+          # @rbs default: Integer
+          def end_line(node, default:) #: Integer
+            location = node.location #: untyped
+            location.end&.line || default
+          end
+
+          # Returns the arguments node of a method definition.
+          # @rbs node: RuboCop::AST::DefNode
+          def args_node_for(node) #: RuboCop::AST::Node
+            case node.type
+            when :def  then node.children[1]
+            when :defs then node.children[2]
+            else raise
+            end
+          end
+
+          # 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(node) #: Integer
+            end_line(args_node_for(node), default: node.location.line)
+          end
+
+          # @rbs node: RuboCop::AST::Node
+          def name_location(node) #: untyped
+            location = node.location #: untyped
+            location.name
+          end
+
+          # @rbs node: RuboCop::AST::Node
+          def source!(node) #: String
+            node.source || raise
+          end
+
+          # Returns the name of the constant `node` is assigned to, or `nil` when the name
+          # is not statically determinable (e.g. `self::Foo = ...`).
+          # @rbs node: RuboCop::AST::Node
+          def assigned_constant_name(node) #: String?
+            parent = node.parent
+            return nil unless parent.is_a?(RuboCop::AST::CasgnNode)
+            return nil unless parent.each_path.all? { _1.const_type? || _1.cbase_type? }
+
+            # `const_name` drops the leading `::`, which would name a different constant
+            # when the assignment appears inside a namespace.
+            parent.absolute? ? "::#{parent.const_name}" : parent.const_name
+          end
+
+          #: (RuboCop::AST::SymbolNode) -> Symbol
+          #: (RuboCop::AST::StrNode) -> Symbol
+          #: (RuboCop::AST::Node) -> Symbol?
+          def value_to_sym(node)
+            case node
+            when RuboCop::AST::SymbolNode
+              node.value
+            when RuboCop::AST::StrNode
+              case (v = node.value)
+              when String
+                v.to_sym
+              else
+                value_to_sym(v)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/rbs_inline/{comment_parser.rb → mixin/comment_parser.rb}

@@ -13,8 +13,16 @@ module RuboCop
         module CommentParser
           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
+            false
+          end
+
           # Parse comments from the source code
           def parse_comments #: Array[RBS::Inline::AnnotationParser::ParsingResult]
+            return @parsed_comments = [] if rbs_inline_file_skipped?
+
             parsed_result = Prism.parse(processed_source.buffer.source)
             @parsed_comments = RBS::Inline::AnnotationParser.parse(parsed_result.comments)
           end

data/lib/rubocop/cop/style/rbs_inline/mixin/data_class_matcher.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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?(node) #: bool
+            return false unless node.method_name == :define
+
+            (r = node.receiver).is_a?(RuboCop::AST::ConstNode) && r.short_name == :Data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/rbs_inline/{data_struct_helper.rb → mixin/data_struct_helper.rb}

@@ -57,10 +57,13 @@ module RuboCop
             comment unless comment&.text&.match?(/\A#:/)
           end
 
+          # 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(node) #: Integer
             last_arg = node.arguments.last
-            max_end_col = node.arguments.map do |arg|
+            max_end_col = attr_arguments(node).map do |arg|
               comma_length = arg.equal?(last_arg) ? 0 : 1
               arg.location.column + source!(arg).length + comma_length
             end.max || 0
@@ -68,10 +71,12 @@ module RuboCop
             max_end_col + 2
           end
 
+          # Only attribute arguments are considered, for the same reason as
+          # {#annotation_column}.
           # @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 }
+            last_arg = node.arguments.last
+            args = attr_arguments(node).map { _1.equal?(last_arg) ? _1.source.to_s : "#{_1.source}," }
             args.max_by(&:length) || ""
           end
 
@@ -84,8 +89,12 @@ module RuboCop
             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
+              if attr_argument?(arg)
+                padding = " " * (longest.length - source!(arg).length - comma.length + 2)
+                "#{prefix}#{padding}#: untyped"
+              else
+                prefix
+              end
             end.join("\n")
 
             "(\n#{args_source}\n#{base_indent})"

data/lib/rubocop/cop/style/rbs_inline/mixin/file_filter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+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`.
+        #
+        # 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
+          include ModeConfig
+
+          MAGIC_COMMENT_ENABLED  = /\A# rbs_inline: enabled\R?\z/ #: Regexp
+          MAGIC_COMMENT_DISABLED = /\A# rbs_inline: disabled\R?\z/ #: Regexp
+
+          # @rbs @rbs_inline_skip_file: bool
+
+          def on_new_investigation #: void
+            @rbs_inline_skip_file = skip_by_mode?
+            super
+          end
+
+          # @rbs *args: untyped
+          # @rbs **kwargs: untyped
+          def add_offense(*args, **kwargs, &) #: void
+            return if @rbs_inline_skip_file
+
+            super
+          end
+
+          # 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
+            @rbs_inline_skip_file == true
+          end
+
+          private
+
+          def skip_by_mode? #: bool
+            # `# rbs_inline: disabled` always opts a file out, regardless of Mode
+            # (matches rbs-inline itself: rbs-inline skips disabled files in both
+            # opt_in and opt_out modes).
+            return true if rbs_inline_disabled?
+
+            configured_mode == :opt_in && !rbs_inline_enabled?
+          end
+
+          # 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
+            processed_source.comments.any? { _1.text.match?(MAGIC_COMMENT_ENABLED) }
+          end
+
+          def rbs_inline_disabled? #: bool
+            processed_source.comments.any? { _1.text.match?(MAGIC_COMMENT_DISABLED) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/rbs_inline/mixin/mode_config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      module RbsInline
+        # Resolves the `Mode` setting shared by every cop in the `Style/RbsInline`
+        # department.
+        #
+        # @rbs module-self RuboCop::Cop::Base
+        module ModeConfig
+          # @rbs! type mode = :opt_in | :opt_out
+
+          SUPPORTED_MODES = %i[opt_in opt_out].freeze #: Array[mode]
+
+          # Hook RuboCop calls while mobilizing its cops, so an unsupported `Mode`
+          # fails the run as a config error instead of an error on every file.
+          def validate_config #: void
+            configured_mode
+          end
+
+          private
+
+          def configured_mode #: mode
+            raw = cop_config["Mode"]
+            # `raw.to_s.to_sym` handles YAML-native Integer / Boolean without
+            # raising NoMethodError on the plain `to_sym`.
+            mode = raw.to_s.to_sym
+            return mode if SUPPORTED_MODES.include?(mode)
+
+            raise ValidationError,
+                  "`Style/RbsInline: Mode: #{raw.inspect}` is not supported. " \
+                  "Expected one of: #{SUPPORTED_MODES.join(", ")}."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/rbs_inline/{source_code_helper.rb → mixin/source_code_helper.rb}

@@ -12,11 +12,9 @@ module RuboCop
           # Convert byte offset to character offset
           # @rbs byte_offset: Integer
           def character_offset(byte_offset) #: Integer
-            source = processed_source.buffer.source.dup.force_encoding("ASCII")
-            text = source[...byte_offset] or raise
-            text.force_encoding(processed_source.buffer.source.encoding).size
-          rescue StandardError
-            byte_offset
+            source = processed_source.buffer.source
+            prefix = source.byteslice(0, byte_offset) or raise
+            prefix.size
           end
 
           # @rbs pos: Integer

data/lib/rubocop/cop/style/rbs_inline/mixin/struct_class_matcher.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+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?(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/parameters_separator.rb

@@ -20,13 +20,13 @@ module RuboCop
         #   # good
         #   # @rbs %a{pure}
         class ParametersSeparator < Base
+          prepend FileFilter
           extend AutoCorrector
+          include AnnotationKeywords
           include RangeHelp
 
           MSG = "Use `:` as a separator between parameter name and type."
 
-          # 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_REGEXP_KEYWORDS = [/%a{(\w|-)+}/, /%a\((\w|-)+\)/, /%a\[(\w|-)+\]/].freeze #: Array[Regexp]
 
           def on_new_investigation #: void

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

@@ -58,7 +58,9 @@ module RuboCop
         #   end
         #
         class RedundantAnnotationWithSkip < Base
+          prepend FileFilter
           extend AutoCorrector
+          include ASTUtils
           include CommentParser
           include RangeHelp
           include SourceCodeHelper
@@ -182,17 +184,6 @@ module RuboCop
               corrector.remove(removal_range)
             end
           end
-
-          # 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(node) #: Integer
-            args_node = case node.type
-                        when :def  then node.children[1]
-                        when :defs then node.children[2]
-                        else raise
-                        end
-            args_node.location.end&.line || node.location.line
-          end
         end
       end
     end

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

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

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

@@ -80,7 +80,9 @@ module RuboCop
         #   end
         #
         class RedundantTypeAnnotation < Base
+          prepend FileFilter
           extend AutoCorrector
+          include ASTUtils
           include CommentParser
           include ConfigurableEnforcedStyle
           include RangeHelp
@@ -129,17 +131,6 @@ module RuboCop
             end
           end
 
-          # 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(node) #: Integer
-            args_node = case node.type
-                        when :def  then node.children[1]
-                        when :defs then node.children[2]
-                        else raise
-                        end
-            args_node.location.end&.line || node.location.line
-          end
-
           # @rbs def_line: Integer
           # @rbs parameter_list_end_line: Integer
           def check_return_type_redundancy(def_line, parameter_list_end_line) #: void
@@ -165,7 +156,7 @@ module RuboCop
             last = comments.last or return
             range = first.loc.expression.join(last.loc.expression)
             add_offense(range, message: MSG_METHOD_TYPE_SIGNATURE) do |corrector|
-              unexpected_style_detected(:method_type_signature)
+              no_acceptable_style!
               corrector.remove(range_by_whole_lines(range, include_final_newline: true))
             end
           end
@@ -178,7 +169,7 @@ module RuboCop
           def add_offense_for_doc_style_param(annotation) #: void
             range = annotation_range(annotation) or return
             add_offense(range, message: MSG_DOC_STYLE_PARAM) do |corrector|
-              unexpected_style_detected(:doc_style)
+              no_acceptable_style!
               corrector.remove(range_by_whole_lines(range, include_final_newline: true))
             end
           end
@@ -199,7 +190,7 @@ module RuboCop
           # @rbs comment: Parser::Source::Comment
           def add_offense_for_trailing_return(comment) #: void
             add_offense(comment, message: MSG_TRAILING_RETURN) do |corrector|
-              unexpected_style_detected(:return_type_annotation)
+              no_acceptable_style!
               removal_range = range_with_surrounding_space(range: comment.loc.expression, side: :left, newlines: false)
               corrector.remove(removal_range)
             end
@@ -209,7 +200,7 @@ module RuboCop
           def add_offense_for_doc_style_return(annotation) #: void
             range = annotation_range(annotation) or return
             add_offense(range, message: MSG_DOC_STYLE_RETURN) do |corrector|
-              unexpected_style_detected(:doc_style)
+              no_acceptable_style!
               corrector.remove(range_by_whole_lines(range, include_final_newline: true))
             end
           end