rubocop-yard 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14068a711ba5d5d78e4781fcf5c19c0be34a5e606fad28768ea3570f0a9c044d
-  data.tar.gz: c2e62e57a7f060c86976d12aa4f123354e69b4a81d36ac5e6f549b9e3aa63fef
+  metadata.gz: dc21b6abfe7772ded3bcfc7eb7c3db68b8eff3716d15d9442520e8d367c3295f
+  data.tar.gz: c706a4a3c2db6bbf36b22d1810f5ec06b4d7312ee7d2906ee57b8f6f41b40960
 SHA512:
-  metadata.gz: f82cc0691592cd838775d632d2f13631a1c92182afca6442ec9876dad092bea401118272ce4e1031b286466d634583f027256250bab5a6f3dfa3da2ad8eb88ce
-  data.tar.gz: 2a2b413001d70d1450e2ed6c9b07607f1ed82e7bf2790d1e906a272d5c940fb4434117ee75a64a5f7ff70f439c2d0d2b4b5bcd8082588569b1699d353db64d38
+  metadata.gz: ed1ed3631058b5d08ee5d8fc1e90ec7edcf5a5d3d6f9ada711fa9e6719102679156a20e98881337f69cec095810f90183651b7d005c321145ed3bf0cf2e70735
+  data.tar.gz: 5d1963992a5223efbfb696cde08c8428045d004b681ea4a53f5d8e73cd463907e491b3b3ac47aa00251b551aba13dd6232593bd4e472d7be1317cd7c3b75f77d

data/lib/rubocop/cop/yard/helper.rb

@@ -19,7 +19,7 @@ module RuboCop
 
         def each_types_explainer(docstring, &block)
           docstring.tags.each do |tag|
-            types = extract_tag_types(tag)
+            types = extract_tag_types(tag) or next
 
             begin
               types_explainers = parse_type(types.join(', '))

data/lib/rubocop/cop/yard/mismatch_name.rb

@@ -57,6 +57,7 @@ module RuboCop
               end
 
               next unless node.arguments.none? { |arg_node| tag.name.to_sym == arg_node.name }
+              next unless types
 
               begin
                 parse_type(types.join(', '))
@@ -148,8 +149,8 @@ module RuboCop
         end
 
         def add_offense_to_tag(node, comment, tag)
-          tag_name_regexp = Regexp.new("\\b#{Regexp.escape(tag.name)}\\b")
-          start_column = comment.source.index(tag_name_regexp)
+          tag_name_regexp = Regexp.new("\\s#{Regexp.escape(tag.name)}\\s")
+          start_column = comment.source.index(tag_name_regexp) or return
           offense_start = comment.location.column + start_column
           offense_end = offense_start + tag.name.length - 1
           range = source_range(processed_source.buffer, comment.location.line, offense_start..offense_end)

data/lib/rubocop/cop/yard/patch.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Support for rubocop v1.46.0 or under.
+# see also https://github.com/rubocop/rubocop/pull/11630
+return if defined? RuboCop::Ext::Comment
+
+module RuboCop
+  module Ext
+    # Extensions to `Parser::Source::Comment`.
+    module Comment
+      def source
+        loc.expression.source
+      end
+
+      def source_range
+        loc.expression
+      end
+    end
+  end
+end
+
+Parser::Source::Comment.include RuboCop::Ext::Comment

data/lib/rubocop/cop/yard/tag_type_syntax.rb

@@ -27,7 +27,7 @@ module RuboCop
         def check(comment)
           docstring = comment.text.gsub(/\A#\s*/, '')
           ::YARD::DocstringParser.new.parse(docstring).tags.each do |tag|
-            types = extract_tag_types(tag)
+            types = extract_tag_types(tag) or next
 
             check_syntax_error(comment) do
               parse_type(types.join(', '))

data/lib/rubocop/cop/yard_cops.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'yard'
+require_relative 'yard/patch'
 require_relative 'yard/helper'
 require_relative 'yard/collection_style'
 require_relative 'yard/collection_type'

data/lib/rubocop/yard/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module YARD
-    VERSION = "0.8.0"
+    VERSION = "0.8.2"
   end
 end

data/sig/rubocop/yard.rbs

@@ -5,12 +5,36 @@ module RuboCop
   end
   module Cop
     module YARD
+      type tag = ::YARD::Tags::Tag | ::YARD::Tags::OverloadTag | ::YARD::Tags::OptionTag
+      type tag_types = YARD::Tags::TypesExplainer::Type
+                     | ::YARD::Tags::TypesExplainer::CollectionType
+                     | ::YARD::Tags::TypesExplainer::FixedCollectionType
+                     | ::YARD::Tags::TypesExplainer::HashCollectionType
       class CollectionType
-        type t = YARD::Tags::TypesExplainer::Type
-               | ::YARD::Tags::TypesExplainer::CollectionType
-               | ::YARD::Tags::TypesExplainer::FixedCollectionType
-               | ::YARD::Tags::TypesExplainer::HashCollectionType
-        private def check_mismatch_collection_type: (untyped comment, t types_explainer) -> void
+        private def check_mismatch_collection_type: (untyped comment, tag_types types_explainer) -> void
+      end
+
+      module Helper
+        def extract_tag_types: (tag tag) -> Array[String]?
+      end
+
+      class TagTypeSyntax < ::RuboCop::Cop::Base
+        include YARD::Helper
+
+        private
+
+        def check: (::Parser::Source::Comment comment) -> void
+        def check_syntax_error: (::Parser::Source::Comment comment) { () -> void } -> void
+        def inline_comment?: (::Parser::Source::Comment comment) -> bool
+        def include_yard_tag?: (::Parser::Source::Comment comment) -> bool
+        def tag_range_for_comment: (::Parser::Source::Comment comment) -> untyped
+      end
+
+      class MismatchName < ::RuboCop::Cop::Base
+        include YARD::Helper
+
+        def add_offense_to_tag: (untyped node, ::Parser::Source::Comment comment, ::YARD::Tags::Tag tag) -> void
+        def cop_config_prototype_name: () -> ("before" | "after")
       end
     end
   end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yard
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +56,7 @@ files:
 - lib/rubocop/cop/yard/helper.rb
 - lib/rubocop/cop/yard/meaningless_tag.rb
 - lib/rubocop/cop/yard/mismatch_name.rb
+- lib/rubocop/cop/yard/patch.rb
 - lib/rubocop/cop/yard/tag_type_syntax.rb
 - lib/rubocop/cop/yard_cops.rb
 - lib/rubocop/yard.rb