rubocop-yard 0.8.2 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc21b6abfe7772ded3bcfc7eb7c3db68b8eff3716d15d9442520e8d367c3295f
-  data.tar.gz: c706a4a3c2db6bbf36b22d1810f5ec06b4d7312ee7d2906ee57b8f6f41b40960
+  metadata.gz: 2b240277d34c92f69d7a7b3bf0cc2de5e6db342a668dd2b3426faad8f693b36d
+  data.tar.gz: d682c69f314766eb8e6ba49ac5ebb6d1c4dbe2cd3bed4c8e9d675ba49e347533
 SHA512:
-  metadata.gz: ed1ed3631058b5d08ee5d8fc1e90ec7edcf5a5d3d6f9ada711fa9e6719102679156a20e98881337f69cec095810f90183651b7d005c321145ed3bf0cf2e70735
-  data.tar.gz: 5d1963992a5223efbfb696cde08c8428045d004b681ea4a53f5d8e73cd463907e491b3b3ac47aa00251b551aba13dd6232593bd4e472d7be1317cd7c3b75f77d
+  metadata.gz: c02ef119ea3d56b064ffc1770ae0abc28d8e519eef44516b1ae5e14bb34347b494782d0e0d7a32d9db996d271513ae234e06234e85d61e8175efd0a7a7397162
+  data.tar.gz: 162842c1675a778c33063ead865a10515c4665821751e3d05f222b5437369d06a62837ddcf1950bdc18775be4a46b8864e94489287464835d9db221d01557350

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.9.0] - 2023-11-28
+
+- Add `YARD/TagTypePosition`
+
+## [0.8.0] - 2023-11-6
+
+- Support EnforcedStylePrototypeName
+
 ## [0.7.0] - 2023-10-14
 
 - New feature

data/README.md

@@ -15,6 +15,15 @@ Check tag type syntax error.
           ^^^^^^^^^^^^^ (SyntaxError) invalid character at |
 ```
 
+### `YARD/TagTypePosition`
+
+Notice tag type position.
+
+```
+# @option [Integer] opts foo
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This docs found `[Integer]`, but parser of YARD can't found types. Please check syntax of YARD.
+```
+
 ### `YARD/CollectionStyle`
 
 `EnforcedStyle long (default)`

data/config/default.yml

@@ -35,3 +35,7 @@ YARD/MismatchName:
     - before
     - after
 
+YARD/TagTypePosition:
+  Description: 'Notice tag type position'
+  Enabled: true
+  VersionAdded: '0.9.0'

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

@@ -82,10 +82,6 @@ module RuboCop
           end
         end
 
-        def inline_comment?(comment)
-          !comment_line?(comment.source_range.source_line)
-        end
-
         def include_yard_tag?(comment)
           comment.source.match?(/@(?:param|return|option|raise|yieldparam|yieldreturn)\s+.*\[.*\]/)
         end

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

@@ -112,10 +112,6 @@ module RuboCop
           corrector.replace(comment, comment.source.sub(/\[(.*)\]/) { "[#{styled_string(types_explainer)}]" })
         end
 
-        def inline_comment?(comment)
-          !comment_line?(comment.source_range.source_line)
-        end
-
         def include_yard_tag?(comment)
           comment.source.match?(/@(?:param|return|option|raise|yieldparam|yieldreturn)\s+.*\[.*\]/)
         end

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

@@ -8,6 +8,8 @@ module RuboCop
           case tag
           when ::YARD::Tags::OptionTag
             tag.pair.types
+          when ::YARD::Tags::OverloadTag
+            tag.types
           else
             tag.types
           end
@@ -69,6 +71,21 @@ module RuboCop
             raise "#{types_explainer.class} is not supported"
           end
         end
+
+        def inline_comment?(comment)
+          !comment_line?(comment.source_range.source_line)
+        end
+
+        def build_docstring(preceding_lines)
+          comment_texts = preceding_lines.map { |l| l.text.gsub(/\A#/, '') }
+          minimum_space = comment_texts.map { |t| t.index(/[^\s]/) }.min
+          yard_docstring = comment_texts.map { |t| t[minimum_space..-1] }.join("\n")
+          begin
+            ::YARD::DocstringParser.new.parse(yard_docstring)
+          rescue
+            nil
+          end
+        end
       end
     end
   end

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

@@ -20,6 +20,7 @@ module RuboCop
       #   # good
       #   CONST = 1
       class MeaninglessTag < Base
+        include YARD::Helper
         include RangeHelp
         include DocumentationComment
         extend AutoCorrector
@@ -34,8 +35,9 @@ module RuboCop
           preceding_lines = preceding_lines(node)
           return false unless preceding_comment?(node, preceding_lines.last)
 
-          yard_docstring = preceding_lines.map { |line| line.text.gsub(/\A#\s*/, '') }.join("\n")
-          docstring = ::YARD::DocstringParser.new.parse(yard_docstring)
+          docstring = build_docstring(preceding_lines)
+          return false unless docstring
+
           docstring.tags.each do |tag|
             next unless tag.tag_name == 'param' || tag.tag_name == 'option'
 

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

@@ -28,12 +28,8 @@ module RuboCop
           preceding_lines = preceding_lines(node)
           return false unless preceding_comment?(node, preceding_lines.last)
 
-          yard_docstring = preceding_lines.map { |line| line.text.gsub(/\A#\s*/, '') }.join("\n")
-          docstring = begin
-            ::YARD::DocstringParser.new.parse(yard_docstring)
-          rescue
-            return false
-          end
+          docstring = build_docstring(preceding_lines)
+          return false unless docstring
 
           return false if include_overload_tag?(docstring)
 

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module YARD
+      class TagTypePosition < Base
+        include YARD::Helper
+        include RangeHelp
+
+        def on_new_investigation
+          processed_source.comments.each do |comment|
+            next if inline_comment?(comment)
+            next unless include_yard_tag?(comment)
+            next unless include_yard_tag_type?(comment)
+
+            check(comment)
+          end
+        end
+
+        private
+
+        def check(comment)
+          docstring = comment.text.gsub(/\A#\s*/, '')
+          ::YARD::DocstringParser.new.parse(docstring).tags.each do |tag|
+            types = extract_tag_types(tag)
+            if types.nil?
+              match = comment.source.match(/(?<type>\[.+\])/)
+              add_offense(comment, message: "This docs found `#{match[:type]}`, but parser of YARD can't found types. Please check syntax of YARD.")
+            end
+          end
+        end
+
+        def include_yard_tag?(comment)
+          comment.source.match?(/@(?:param|return|option|raise|yieldparam|yieldreturn)\s+.*\[.*\]/)
+        end
+
+        def include_yard_tag_type?(comment)
+          comment.source.match?(/\[.+\]/)
+        end
+      end
+    end
+  end
+end

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

@@ -43,10 +43,6 @@ module RuboCop
           end
         end
 
-        def inline_comment?(comment)
-          !comment_line?(comment.source_range.source_line)
-        end
-
         def include_yard_tag?(comment)
           comment.source.match?(/@(?:param|return|option|raise|yieldparam|yieldreturn)\s+.*\[.*\]/)
         end

data/lib/rubocop/cop/yard_cops.rb

@@ -7,4 +7,5 @@ require_relative 'yard/collection_style'
 require_relative 'yard/collection_type'
 require_relative 'yard/meaningless_tag'
 require_relative 'yard/mismatch_name'
+require_relative 'yard/tag_type_position'
 require_relative 'yard/tag_type_syntax'

data/lib/rubocop/yard/version.rb

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

data/sig/rubocop/yard.rbs

@@ -16,6 +16,15 @@ module RuboCop
 
       module Helper
         def extract_tag_types: (tag tag) -> Array[String]?
+        def inline_comment?: (::Parser::Source::Comment comment) -> bool
+      end
+
+      class TagTypePosition < ::RuboCop::Cop::Base
+        include YARD::Helper
+
+        def check: (::Parser::Source::Comment comment) -> void
+        def include_yard_tag?: (::Parser::Source::Comment comment) -> bool
+        def include_yard_tag_type?: (::Parser::Source::Comment comment) -> bool
       end
 
       class TagTypeSyntax < ::RuboCop::Cop::Base
@@ -25,7 +34,6 @@ module RuboCop
 
         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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yard
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.1
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -57,6 +57,7 @@ files:
 - 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_position.rb
 - lib/rubocop/cop/yard/tag_type_syntax.rb
 - lib/rubocop/cop/yard_cops.rb
 - lib/rubocop/yard.rb