rubocop-rbs_inline 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8008a16d537a1c97bc627ada003d8b6cb5cf106816d0bdcd7ecb7c49255e941
-  data.tar.gz: 2597b7e5e77c085c887ec295de883451661752847d4e24a2d618625c5abaf341
+  metadata.gz: 47291a6a8258c66f219f4fd57230b47b2c575b3f9dd03001efea0f888207d195
+  data.tar.gz: fdd0bdf3849a20c6cd08dfade8da7a65a2b3b6a728295885c79e868c0f465e8a
 SHA512:
-  metadata.gz: 23b3de5f3348d0a4fd045f4258e7f278832d581cca1404b0ab3196b2a608e3fdb1c3fde594f4d7619b9284846e8f608ba2248c0ac50b7cbd893655263bfb4e1b
-  data.tar.gz: 191da5351ce4d508b7ddc00c00b09b8944005aaf73aa1072bd03d85de6a3d411b9c84eb838161f0e88354a7c796da4027ee218c22b7ed887606de6d2874c6150
+  metadata.gz: ebc94f84cd20a58a90a86dbae1dd76d4500d4d31a2c525823f243c833db301cd9f22f58b23c4c73d85e9096e1ba4c6b40e6c460396d07f47f9f633c2b440209b
+  data.tar.gz: d12b92ebd4cc9acc78c2ee46abf7a55d513dc82de35818ab6ec3d7b0ce6e713a2cf2308bd6f4877f8b3e96fd6ef719cb3213a29ef092047ab1589d747c7ac943

data/.vscode/settings.json

@@ -1,5 +1,12 @@
 {
     "cSpell.words": [
+        "blockarg",
+        "Ivar",
+        "kwarg",
+        "kwoptarg",
+        "kwrestarg",
+        "optarg",
+        "restarg",
         "strscan"
     ],
     "rbs-helper.rbs-inline-on-save": true,

data/Steepfile

@@ -8,4 +8,5 @@ target :lib do
   check 'lib'
 
   configure_code_diagnostics(D::Ruby.strict)
+  implicitly_returns_nil!
 end

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

@@ -30,7 +30,8 @@ module RuboCop
           RBS_INLINE_KEYWORDS = %w[inherits override use module-self generic skip module class].freeze #: Array[String]
 
           def on_new_investigation #: void
-            processed_source.comments.each do |comment|
+            comments = consume_embedded_rbs(processed_source.comments)
+            comments.each do |comment|
               add_offense(comment) if comment.text =~ /\A#\s+#{SIGNATURE_PATTERN}/
               add_offense(comment) if comment.text =~ /\A#\s+:\s*#{SIGNATURE_PATTERN}/
 
@@ -40,6 +41,33 @@ module RuboCop
               end
             end
           end
+
+          private
+
+          def consume_embedded_rbs(comments) # rubocop:disable Metrics/MethodLength
+            in_embedded = false
+            indent = 1
+            line = 0
+            comments.select do |comment|
+              case comment.text
+              when /\A#(\s+)@rbs!(\s+|\Z)/
+                in_embedded = true
+                indent = Regexp.last_match(1).to_s.size
+                line = comment.loc.line
+                false
+              when /\A#(\s{#{indent + 1},}.*|\s*)\Z/
+                if in_embedded && comment.loc.line == line + 1
+                  line += 1
+                  false
+                else
+                  true
+                end
+              else
+                in_embedded = false
+                true
+              end
+            end
+          end
         end
       end
     end

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

@@ -4,16 +4,21 @@ module RuboCop
   module Cop
     module Style
       module RbsInline
-        # IRB::Inline expects annotations comments for parameters are separeted with `:`.
+        # IRB::Inline expects annotations comments for parameters are separeted with `:`or allows annotation comments.
         # This cop checks for comments that do not match the expected pattern.
         #
         # @example
         #   # bad
         #   # @rbs param String
         #
+        #   # bad
+        #   # @rbs :param String
+        #
         #   # good
         #   # @rbs param: String
         #
+        #   # good
+        #   # @rbs %a{pure}
         class ParametersSeparator < Base
           include RangeHelp
 
@@ -21,19 +26,31 @@ module RuboCop
 
           # 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
             processed_source.comments.each do |comment|
               matched = comment.text.match(/\A#\s+@rbs\s+(\S+)/)
+
               next unless matched
-              next if RBS_INLINE_KEYWORDS.include?(matched[1] || '')
+              next if valid_rbs_inline_comment?(matched[1])
 
-              add_offense(invalid_location_for(comment)) unless matched[1]&.include?(':')
+              add_offense(invalid_location_for(comment))
             end
           end
 
           private
 
+          # @rbs matched: String?
+          def valid_rbs_inline_comment?(matched) #: bool
+            return true if matched.nil?
+            return true if RBS_INLINE_KEYWORDS.include?(matched)
+            return true if RBS_INLINE_REGEXP_KEYWORDS.any? { |regexp| matched =~ regexp }
+            return true if matched.end_with?(':')
+
+            false
+          end
+
           # @rbs comment: Parser::Source::Comment
           def invalid_location_for(comment) #: Parser::Source::Range
             range = comment.source_range

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

@@ -141,7 +141,7 @@ module RuboCop
           #                  RBS::Inline::AST::Annotations::VarType
           def add_offense_for(annotation) #: void # rubocop:disable Metrics/AbcSize
             name = annotation_name(annotation)
-            loc = annotation.source.comments.first.location
+            loc = annotation.source.comments.first&.location or raise
             source = processed_source.buffer.source.dup.force_encoding('ASCII')
             text = source[loc.start_offset...loc.end_offset] or raise
             comment = text.force_encoding(processed_source.buffer.source.encoding)

data/lib/rubocop/rbs_inline/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module RbsInline
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
   end
 end

data/rbs_collection.lock.yaml

@@ -6,7 +6,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    revision: 27243a7d18fd7f7333b9daa35eeca2c37472586e
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: dbm
@@ -18,7 +18,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    revision: 27243a7d18fd7f7333b9daa35eeca2c37472586e
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: fileutils
@@ -46,7 +46,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    revision: 27243a7d18fd7f7333b9daa35eeca2c37472586e
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: parser
@@ -54,7 +54,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    revision: 27243a7d18fd7f7333b9daa35eeca2c37472586e
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: pathname
@@ -62,7 +62,7 @@ gems:
   source:
     type: stdlib
 - name: prism
-  version: 1.0.0
+  version: 1.2.0
   source:
     type: rubygems
 - name: pstore
@@ -78,7 +78,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    revision: 27243a7d18fd7f7333b9daa35eeca2c37472586e
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rake
@@ -86,15 +86,15 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    revision: 27243a7d18fd7f7333b9daa35eeca2c37472586e
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rbs
-  version: 3.6.1
+  version: 3.8.1
   source:
     type: rubygems
 - name: rbs-inline
-  version: 0.9.0
+  version: 0.10.0
   source:
     type: rubygems
 - name: rdoc
@@ -106,7 +106,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 218cf130d31f63e110e350efc3fa265311b0f238
+    revision: 27243a7d18fd7f7333b9daa35eeca2c37472586e
     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: 218cf130d31f63e110e350efc3fa265311b0f238
+    revision: 27243a7d18fd7f7333b9daa35eeca2c37472586e
     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: 218cf130d31f63e110e350efc3fa265311b0f238
+    revision: 27243a7d18fd7f7333b9daa35eeca2c37472586e
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: strscan

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

@@ -27,6 +27,10 @@ module RuboCop
           RBS_INLINE_KEYWORDS: Array[String]
 
           def on_new_investigation: () -> void
+
+          private
+
+          def consume_embedded_rbs: (untyped comments) -> untyped
         end
       end
     end

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

@@ -4,15 +4,21 @@ module RuboCop
   module Cop
     module Style
       module RbsInline
-        # IRB::Inline expects annotations comments for parameters are separeted with `:`.
+        # IRB::Inline expects annotations comments for parameters are separeted with `:`or allows annotation comments.
         # This cop checks for comments that do not match the expected pattern.
         #
         # @example
         #   # bad
         #   # @rbs param String
         #
+        #   # bad
+        #   # @rbs :param String
+        #
         #   # good
         #   # @rbs param: String
+        #
+        #   # good
+        #   # @rbs %a{pure}
         class ParametersSeparator < Base
           include RangeHelp
 
@@ -21,10 +27,15 @@ module RuboCop
           # 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
 
           private
 
+          # @rbs matched: String?
+          def valid_rbs_inline_comment?: (String? matched) -> bool
+
           # @rbs comment: Parser::Source::Comment
           def invalid_location_for: (Parser::Source::Comment comment) -> Parser::Source::Range
         end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rbs_inline
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Takeshi KOMIYA
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs-inline
@@ -87,7 +86,6 @@ metadata:
   source_code_uri: https://github.com/tk0miya/rubocop-rbs_inline
   changelog_uri: https://github.com/tk0miya/rubocop-rbs_inline
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -102,8 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: rubocop extension to check RBS annotation comments
 test_files: []