rubocop-yard 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64ff6712be966753c2ddc2510a4a51c1d36488ed302b8fc848f50e8beb6561b5
-  data.tar.gz: a34143c5775f3705adb8bd4aac2837b4c4b2334f7191ccc2c7629b015cd3fe89
+  metadata.gz: 06747e91e4d94f896cb88e9fb16826b8863afb224451a97a55aedbe0e0c36517
+  data.tar.gz: 8f8eb7d93d78b2f23b356850e346e82f1cdf187b40fc2e17e584751a5929774a
 SHA512:
-  metadata.gz: 1bdf6a2b0740459083c5e1b0e93ecab91172b372821168972879f94bb3b59c21706a0eb84895d03cf6ce915ab25b510100c8c84edd7cecd8469d8b6950647cc0
-  data.tar.gz: 89d4dd145df3813f14e4f3fb790e892c1948858843a8ab1b834450c6eac52164f5d222ebc8c8dcd3db3589d23e0b82ae599a9247e60f41d3697b82c8e0157c44
+  metadata.gz: 7a299956fd71c933d0d4aa59d68c273cd49e481b61be404f1a071b6051d8c874e18f7de1a27b1b3d59b72c6e3ee098ec554d1bb5c06e94971cc4bb04e4890555
+  data.tar.gz: e940c21c3172cc9ba385f16d227418006406af7c44f34a7c1da32ee53dabfa3062d7e83b2a2351671a7a68d9c4457f4672df574e5d71a1e68fcf406fa5da98e2

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
@@ -19,7 +21,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(', '))
@@ -69,6 +71,10 @@ module RuboCop
             raise "#{types_explainer.class} is not supported"
           end
         end
+
+        def inline_comment?(comment)
+          !comment_line?(comment.source_range.source_line)
+        end
       end
     end
   end

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/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

@@ -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(', '))
@@ -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.1"
+    VERSION = "0.9.0"
   end
 end

data/sig/rubocop/yard.rbs

@@ -5,12 +5,44 @@ 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]?
+        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
+        include YARD::Helper
+
+        private
+
+        def check: (::Parser::Source::Comment comment) -> void
+        def check_syntax_error: (::Parser::Source::Comment comment) { () -> void } -> void
+        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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yard
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2023-12-06 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