rubocop-rbs_inline 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 330ffc2d84cf5c15d64d2922c93eb97017e4dd585cf52dea2e05ac2ec2ed60ab
-  data.tar.gz: 7c550b9d63d636cd52d8ddf285e1dd9220b2764425ef59784685777c38f82963
+  metadata.gz: a8008a16d537a1c97bc627ada003d8b6cb5cf106816d0bdcd7ecb7c49255e941
+  data.tar.gz: 2597b7e5e77c085c887ec295de883451661752847d4e24a2d618625c5abaf341
 SHA512:
-  metadata.gz: 1365b8c968cbd7341a8f685cdadc7334ac9d53ba78662af77522097df9440b8092821ef30c3445992809f71aedad50d45764a9a1a0e0baf54133d9cf029bc87b
-  data.tar.gz: abc24e1e6df83cb0c24ddac363ed1e7b7b623cd9d528c59cc9869715ecf7cb01430f25b3681b8f64d22ebd8c3b94ab2595cfe7710bad6be70897a2676aeea783
+  metadata.gz: 23b3de5f3348d0a4fd045f4258e7f278832d581cca1404b0ab3196b2a608e3fdb1c3fde594f4d7619b9284846e8f608ba2248c0ac50b7cbd893655263bfb4e1b
+  data.tar.gz: 191da5351ce4d508b7ddc00c00b09b8944005aaf73aa1072bd03d85de6a3d411b9c84eb838161f0e88354a7c796da4027ee218c22b7ed887606de6d2874c6150

data/.vscode/settings.json

@@ -1,5 +1,7 @@
 {
     "cSpell.words": [
         "strscan"
-    ]
+    ],
+    "rbs-helper.rbs-inline-on-save": true,
+    "rbs-helper.rbs-inline-signature-directory": "sig/"
 }

data/README.md

@@ -1,38 +1,37 @@
-# Rubocop::RbsInline
+# rubocop-rbs_inline
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/rbs_inline`. To experiment with that code, run `bin/console` for an interactive prompt.
+rubocop-rbs_inline is a RuboCop extension that checks for [RBS::Inline](https://github.com/soutaro/rbs-inline) annotation comments in Ruby code.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add rubocop-rbs_inline
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install rubocop-rbs_inline
 ```
 
-## Usage
+Add the following to your `.rubocop.yml`:
 
-TODO: Write usage instructions here
+```
+require:
+  - rubocop-rbs_inline
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and add Git tag named `vX.Y.Z` and push it to the GitHub.  Then GitHub Actions will be release the package to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-rbs_inline. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rubocop-rbs_inline/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/tk0miya/rubocop-rbs_inline. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tk0miya/rubocop-rbs_inline/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +39,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rubocop::RbsInline project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubocop-rbs_inline/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the rubocop-rbs_inline project's codebases and issue trackers is expected to follow the [code of conduct](https://github.com/tk0miya/rubocop-rbs_inline/blob/main/CODE_OF_CONDUCT.md).

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

@@ -23,10 +23,11 @@ module RuboCop
         class InvalidTypes < Base
           include RangeHelp
           include RBS::Inline::AST::Annotations
+          include RBS::Inline::AST::Members
 
           MSG = 'Invalid annotation found.'
 
-          def on_new_investigation #: void # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          def on_new_investigation #: void # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
             results = parse_comments
             results.each do |result|
               result.each_annotation do |annotation|
@@ -44,6 +45,11 @@ module RuboCop
                   add_offense(range) if annotation.self_types.empty?
                 when SyntaxErrorAssertion
                   add_offense(range)
+                when Embedded
+                  comment = annotation.source.comments.fetch(0)
+                  parsing_result = RBS::Inline::AnnotationParser::ParsingResult.new(comment)
+                  embedded = RBSEmbedded.new(parsing_result, annotation)
+                  add_offense(range) if embedded.members.is_a?(RBS::ParsingError)
                 end
               end
             end

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

@@ -43,9 +43,9 @@ module RuboCop
             result.each do |comment|
               comment.each_annotation do |annotation|
                 case annotation
-                when RBS::Inline::AST::Annotations::VarType
-                  add_offense_for(annotation) unless annotation.name.start_with?('@')
-                when RBS::Inline::AST::Annotations::BlockType, RBS::Inline::AST::Annotations::ReturnType
+                when RBS::Inline::AST::Annotations::BlockType,
+                     RBS::Inline::AST::Annotations::ReturnType,
+                     RBS::Inline::AST::Annotations::VarType
                   add_offense_for(annotation)
                 end
               end
@@ -57,7 +57,7 @@ module RuboCop
           private
 
           # @rbs node: Parser::AST::Node
-          def process(node) #: void
+          def process(node) #: void # rubocop:disable Metrics/CyclomaticComplexity
             arguments = arguments_for(node)
 
             comment = result.find { |r| r.comments.map(&:location).map(&:start_line).include? node.location.line - 1 }
@@ -66,6 +66,8 @@ module RuboCop
             result.delete(comment)
             comment.each_annotation do |annotation|
               case annotation
+              when RBS::Inline::AST::Annotations::IvarType
+                add_offense_for(annotation)
               when RBS::Inline::AST::Annotations::VarType, RBS::Inline::AST::Annotations::BlockType
                 add_offense_for(annotation) unless arguments.include?(annotation_name(annotation))
               end
@@ -119,6 +121,7 @@ module RuboCop
           end
 
           # @rbs annotation: RBS::Inline::AST::Annotations::BlockType |
+          #                  RBS::Inline::AST::Annotations::IvarType |
           #                  RBS::Inline::AST::Annotations::ReturnType |
           #                  RBS::Inline::AST::Annotations::VarType
           def annotation_name(annotation) #: String
@@ -133,6 +136,7 @@ module RuboCop
           end
 
           # @rbs annotation: RBS::Inline::AST::Annotations::BlockType |
+          #                  RBS::Inline::AST::Annotations::IvarType |
           #                  RBS::Inline::AST::Annotations::ReturnType |
           #                  RBS::Inline::AST::Annotations::VarType
           def add_offense_for(annotation) #: void # rubocop:disable Metrics/AbcSize

data/lib/rubocop/rbs_inline/version.rb

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

data/rbs_collection.lock.yaml

@@ -6,7 +6,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
     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: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
     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: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
     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: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: pathname
@@ -78,7 +78,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
     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: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rbs
-  version: 3.5.3
+  version: 3.6.1
   source:
     type: rubygems
 - name: rbs-inline
-  version: 0.8.0
+  version: 0.9.0
   source:
     type: rubygems
 - name: rdoc
@@ -106,7 +106,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
     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: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
     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: 7ae9e3cf731a9628e0cc39064ed6e2cf51d822da
+    revision: 218cf130d31f63e110e350efc3fa265311b0f238
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: strscan

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

@@ -22,6 +22,8 @@ module RuboCop
 
           include RBS::Inline::AST::Annotations
 
+          include RBS::Inline::AST::Members
+
           MSG: ::String
 
           def on_new_investigation: () -> void

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

@@ -45,14 +45,16 @@ module RuboCop
           def parse_comments: () -> Array[RBS::Inline::AnnotationParser::ParsingResult]
 
           # @rbs annotation: RBS::Inline::AST::Annotations::BlockType |
+          #                  RBS::Inline::AST::Annotations::IvarType |
           #                  RBS::Inline::AST::Annotations::ReturnType |
           #                  RBS::Inline::AST::Annotations::VarType
-          def annotation_name: (RBS::Inline::AST::Annotations::BlockType | RBS::Inline::AST::Annotations::ReturnType | RBS::Inline::AST::Annotations::VarType annotation) -> String
+          def annotation_name: (RBS::Inline::AST::Annotations::BlockType | RBS::Inline::AST::Annotations::IvarType | RBS::Inline::AST::Annotations::ReturnType | RBS::Inline::AST::Annotations::VarType annotation) -> String
 
           # @rbs annotation: RBS::Inline::AST::Annotations::BlockType |
+          #                  RBS::Inline::AST::Annotations::IvarType |
           #                  RBS::Inline::AST::Annotations::ReturnType |
           #                  RBS::Inline::AST::Annotations::VarType
-          def add_offense_for: (RBS::Inline::AST::Annotations::BlockType | RBS::Inline::AST::Annotations::ReturnType | RBS::Inline::AST::Annotations::VarType annotation) -> void
+          def add_offense_for: (RBS::Inline::AST::Annotations::BlockType | RBS::Inline::AST::Annotations::IvarType | RBS::Inline::AST::Annotations::ReturnType | RBS::Inline::AST::Annotations::VarType annotation) -> void
 
           # @rbs byte_offset: Integer
           def character_offset: (Integer byte_offset) -> Integer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rbs_inline
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Takeshi KOMIYA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-05 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs-inline