rubocop-yard 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73d535218dd794bf83475348f09a8da8b8805ceb425081562a090d83aeed607f
-  data.tar.gz: 6c4ed5fabe09c75e6b8200c0113bf3eed53fd870dee20a74cd4f340aec8fda4f
+  metadata.gz: 6d73eb7a62e64e94aab37b8d19cb293aec7fbbaca2d3031cb88d082c75ed2d5e
+  data.tar.gz: e931eefce19747f89cb1a363dc56e6e5fb042a5ac6080823ec2655f17366a8eb
 SHA512:
-  metadata.gz: 2c69daea85b80551835a17b161dbde8afebe62fa6b303bed7f3d95de81e1b0de6791509226c18babfa24690ec962b245a4b652e5899a3dd96704a387e109f56c
-  data.tar.gz: eaad4088a01acb5946fa57ab1c393a2ed07d65b1ca1dfd76984889973e4448a9cd0c773d400624932f40116ba5c085b57397f23f73e4ccd5d18ebadcfe625804
+  metadata.gz: f02715af7b1f91e6a38bdc0fa265501cd1a2c47f5d2bde95ec0396ac97af2810e9deb2fcb740b1e326ba279dbfc062d27e2b34c0487e9b3624be14c88bc8142b
+  data.tar.gz: c1f6e29fb749cb49090e8b362333958e3b6192e02fc1375eb772e346cfaba6d4f631936e02b97d143f1839a0a441843ba0b5683e6e74fa298ceece3f22fc955e

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 
+- Suppress YARD warning logs
+
 ## [0.9.0] - 2023-11-28
 
 - Add `YARD/TagTypePosition`

data/README.md

@@ -136,7 +136,7 @@ require: rubocop-yard
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests. 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).
 

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

@@ -81,7 +81,9 @@ module RuboCop
           minimum_space = comment_texts.map { |t| t.index(/[^\s]/) }.compact.min
           yard_docstring = comment_texts.map { |t| t[minimum_space..-1] }.join("\n")
           begin
-            ::YARD::DocstringParser.new.parse(yard_docstring)
+            ::YARD::Logger.instance.enter_level(::YARD::Logger::ERROR) do
+              ::YARD::DocstringParser.new.parse(yard_docstring)
+            end
           rescue
             nil
           end

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

@@ -67,7 +67,7 @@ module RuboCop
 
           # Documentation only or just `@return` is a common form of documentation.
           # The subsequent features will be limited to cases where both `@param` and `@option` are present.
-          unless docstring.tags.find { |tag| (tag.tag_name == 'param' && !tag.instance_of?(::YARD::Tags::RefTagList)) || tag.tag_name == 'option' }
+          unless docstring.tags.find { |tag| (tag.tag_name == 'param' && !(tag.instance_of?(::YARD::Tags::RefTagList) && tag.name.nil?)) || tag.tag_name == 'option' }
             return false
           end
           node.arguments.each do |argument|
@@ -97,28 +97,53 @@ module RuboCop
 
         # @param [RuboCop::AST::ArgNode] argument
         def tag_prototype(argument)
-          case argument.type
-          when :kwrestarg
-            case cop_config_prototype_name
-            when "before"
-              "@param #{argument.name} [Hash{Symbol => Object}]"
-            when "after"
-              "@param [Hash{Symbol => Object}] #{argument.name}"
-            end
-          when :restarg
-            case cop_config_prototype_name
-            when "before"
-              "@param #{argument.name} [Array<Object>]"
-            when "after"
-              "@param [Array<Object>] #{argument.name}"
-            end
+          type = case argument.type
+                 when :kwrestarg
+                   "Hash{Symbol => Object}"
+                 when :restarg
+                   "Array<Object>"
+                 when :optarg, :kwoptarg
+                   literal_to_yard_type(argument.children.last)
+                 else
+                   "Object"
+                 end
+
+          case cop_config_prototype_name
+          when "before"
+            "@param #{argument.name} [#{type}]"
+          when "after"
+            "@param [#{type}] #{argument.name}"
+          end
+        end
+
+        def literal_to_yard_type(node)
+          case node.type
+          when :int
+            "Integer"
+          when :float
+            "Float"
+          when :rational
+            "Rational"
+          when :complex
+            "Complex"
+          when :str
+            "String"
+          when :true, :false
+            "Boolean"
+          when :sym
+            "Symbol"
+          when :array
+            "Array<Object>"
+          when :hash
+            "Hash{Symbol => Object}"
+          when :regexp
+            "Regexp"
+          when :irange, :erange
+            "Range[Object]"
+          when :nil
+            "Object, nil"
           else
-            case cop_config_prototype_name
-            when "before"
-              "@param #{argument.name} [Object]"
-            when "after"
-              "@param [Object] #{argument.name}"
-            end
+            "Object"
           end
         end
 

data/lib/rubocop/yard/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module YARD
-    VERSION = "0.9.2"
+    VERSION = "0.10.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yard
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-09 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Check yardoc format.