rubocop-yard 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4dd27dab805f9450c5043686ad6a530235d31e2a148e1913db76288fa51a39e
-  data.tar.gz: 2820aa0509d5ff6ef0adecbc772168cd8f2b64650109feb4bfb38e810625812a
+  metadata.gz: e5f138fd3b5b0c5eb5550b368164986ba104280ebb40af21d7b8fe843105dad3
+  data.tar.gz: 2a237052e98046b9ac7ffcd72100fd1d96ad90164d8075e8f997981c73a78f98
 SHA512:
-  metadata.gz: be2c582e52297d345a8d09f413d98e15c7724b4adbd288fa5bfa38b280e9b5c752dd549885e6ec521bcd4c9dd335a71a9210475ef585d472332c2dd30066350c
-  data.tar.gz: c239f115e44518f79edb4da03cbf54c4c3e6d66659e1ff51ede40047fb5d7af6944dd4a0e08cc8e9bad53c88ae0d7869a4071655105c40704cab44a7eda10620
+  metadata.gz: fe3818daae4c2d4597a86ad8f1e1e6785a56e5c34e5e96b0b78be0b52b7cb219ce4d9f390ebac30af9ec844d5f2add8f4c7dfa7d5d4e6496543a0ab6a880980d
+  data.tar.gz: fd20c16153f50987d92fe2c5a6af00ecf1fd274d29205d57e63c8c176a314555de9f9e926ae1bad5b7c5b18bf3d1e7adcca26e8ead35b0f8eacc55744fb4cabb

data/CHANGELOG.md

@@ -1,8 +1,6 @@
 ## [Unreleased]
 
-## [0.5.0] - 2023-10-9
-
-- Add new cop `YARD/CollectionStyle`
+## [0.6.0] - 2023-10-10
 
 - Split cop from `YARD/TagType` to
     - `YARD/TagTypeSyntax`

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

@@ -42,7 +42,7 @@ module RuboCop
       #   # good
       #   # @param [Array<String>]
       class CollectionStyle < Base
-        include YARD::CollectionHelper
+        include YARD::Helper
         include RangeHelp
         include ConfigurableEnforcedStyle
         extend AutoCorrector
@@ -62,7 +62,7 @@ module RuboCop
           docstring = ::YARD::DocstringParser.new.parse(comment.text.gsub(/\A#\s*/, ''))
           each_types_explainer(docstring) do |type, types_explainer|
             correct_type = styled_string(types_explainer)
-            unless type == correct_type
+            unless ignore_whitespace(type) == ignore_whitespace(correct_type)
               add_offense(comment, message: "`#{type}` is using #{bad_style} style syntax") do |corrector|
                 corrector.replace(comment, comment.source.sub(/\[(.*)\]/) { "[#{correct_type}]" })
               end
@@ -70,6 +70,10 @@ module RuboCop
           end
         end
 
+        def ignore_whitespace(str)
+          str.tr(' ', '')
+        end
+
         def bad_style
           if style == :long
             :short

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

@@ -22,7 +22,7 @@ module RuboCop
       #   # good
       #   # @param [Hash{Symbol => String}]
       class CollectionType < Base
-        include YARD::CollectionHelper
+        include YARD::Helper
         include RangeHelp
         include ConfigurableEnforcedStyle
         extend AutoCorrector
@@ -86,8 +86,7 @@ module RuboCop
             case types_explainer.name
             when 'Hash'
               if types_explainer.types.length == 2
-                # `Hash<Key, Value>` pattern is the documented hash specific syntax.
-                message = "`Hash<Key, Value>` is the documented hash specific syntax"
+                message = "`Hash<Key, Value>` is ambiguous syntax"
                 add_offense(tag_range_for_comment(comment), message: message) do |corrector|
                   hash_type = ::YARD::Tags::TypesExplainer::HashCollectionType.new(
                     'Hash',

data/lib/rubocop/cop/yard/{collection_helper.rb → helper.rb}

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module YARD
-      module CollectionHelper
+      module Helper
         def extract_tag_types(tag)
           case tag
           when ::YARD::Tags::OptionTag
@@ -13,12 +13,16 @@ module RuboCop
           end
         end
 
+        def parse_type(type)
+          ::YARD::Tags::TypesExplainer::Parser.parse(type)
+        end
+
         def each_types_explainer(docstring, &block)
           docstring.tags.each do |tag|
             types = extract_tag_types(tag)
 
             begin
-              types_explainers = ::YARD::Tags::TypesExplainer::Parser.parse(types.join(', '))
+              types_explainers = parse_type(types.join(', '))
               types.zip(types_explainers).each do |type, types_explainer|
                 block.call(type, types_explainer)
               end

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

@@ -17,6 +17,7 @@ module RuboCop
       #   def foo(bar, opts = {}, *arg)
       #   end
       class MismatchName < Base
+        include YARD::Helper
         include RangeHelp
         include DocumentationComment
 
@@ -28,31 +29,49 @@ module RuboCop
 
           yard_docstring = preceding_lines.map { |line| line.text.gsub(/\A#\s*/, '') }.join("\n")
           docstring = ::YARD::DocstringParser.new.parse(yard_docstring)
-          docstring.tags.each_with_index do |tag, i|
-            next unless tag.tag_name == 'param' || tag.tag_name == 'option'
+          return false if include_overload_tag?(docstring)
 
-            comment = find_by_tag(preceding_lines, tag, i)
-            next unless comment
+          each_tags_by_docstring(['param', 'option'], docstring) do |tags|
+            tags.each_with_index do |tag, i|
+              comment = find_by_tag(preceding_lines, tag, i)
+              next unless comment
 
-            unless tag.name && tag.types
-              if tag.name.nil?
-                add_offense(comment, message: "No tag name is supplied in `@#{tag.tag_name}`")
-              elsif tag.types.nil?
-                add_offense(comment, message: "No types are associated with the tag in `@#{tag.tag_name}`")
+              # YARD::Tags::RefTagList is not has name and types
+              next if tag.instance_of?(::YARD::Tags::RefTagList)
+
+              types = extract_tag_types(tag)
+              unless tag.name && types
+                if tag.name.nil?
+                  add_offense(comment, message: "No tag name is supplied in `@#{tag.tag_name}`")
+                elsif types.nil?
+                  add_offense(comment, message: "No types are associated with the tag in `@#{tag.tag_name}`")
+                end
+
+                next
               end
 
-              next
-            end
+              next unless node.arguments.none? { |arg_node| tag.name.to_sym == arg_node.name }
 
-            next unless node.arguments.none? { |arg_node| tag.name.to_sym == arg_node.name }
+              begin
+                parse_type(types.join(', '))
+              rescue SyntaxError
+                next
+              end
 
-            add_offense_to_tag(comment, tag)
+              add_offense_to_tag(comment, tag)
+            end
           end
         end
         alias on_defs on_def
 
         private
 
+        def each_tags_by_docstring(tag_names, docstring)
+          tag_names.each do |tag_name|
+            yield docstring.tags.select { |tag| tag.tag_name == tag_name }
+          end
+        end
+
         def find_by_tag(preceding_lines, tag, i)
           count = -1
           preceding_lines.find do |line|
@@ -69,6 +88,10 @@ module RuboCop
           range = source_range(processed_source.buffer, comment.location.line, offense_start..offense_end)
           add_offense(range, message: "`#{tag.name}` is not found in method arguments")
         end
+
+        def include_overload_tag?(docstring)
+          docstring.tags.any? { |tag| tag.tag_name == "overload" }
+        end
       end
     end
   end

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

@@ -10,6 +10,7 @@ module RuboCop
       #   # good
       #   # @param [Integer, String]
       class TagTypeSyntax < Base
+        include YARD::Helper
         include RangeHelp
 
         def on_new_investigation
@@ -26,10 +27,10 @@ module RuboCop
         def check(comment)
           docstring = comment.text.gsub(/\A#\s*/, '')
           ::YARD::DocstringParser.new.parse(docstring).tags.each do |tag|
-            types = extract_tag_type(tag)
+            types = extract_tag_types(tag)
 
             check_syntax_error(comment) do
-              ::YARD::Tags::TypesExplainer::Parser.parse(types.join(', '))
+              parse_type(types.join(', '))
             end
           end
         end
@@ -42,15 +43,6 @@ module RuboCop
           end
         end
 
-        def extract_tag_type(tag)
-          case tag
-          when ::YARD::Tags::OptionTag
-            tag.pair.types
-          else
-            tag.types
-          end
-        end
-
         def inline_comment?(comment)
           !comment_line?(comment.source_range.source_line)
         end

data/lib/rubocop/cop/yard_cops.rb

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

data/lib/rubocop/yard/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module YARD
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yard
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-08 00:00:00.000000000 Z
+date: 2023-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -51,9 +51,9 @@ files:
 - README.md
 - config/default.yml
 - lib/rubocop-yard.rb
-- lib/rubocop/cop/yard/collection_helper.rb
 - lib/rubocop/cop/yard/collection_style.rb
 - lib/rubocop/cop/yard/collection_type.rb
+- lib/rubocop/cop/yard/helper.rb
 - lib/rubocop/cop/yard/meaningless_tag.rb
 - lib/rubocop/cop/yard/mismatch_name.rb
 - lib/rubocop/cop/yard/tag_type_syntax.rb