rubocop-yard 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 903402913fde5bdf6702b4412bc6f1ab07197f5f993039c440ffd1a736b5277c
-  data.tar.gz: 31eeffd0cbd9fd26fe3cf5035784c990bea7e9296e10cbb22a36218c31064db9
+  metadata.gz: 64ff6712be966753c2ddc2510a4a51c1d36488ed302b8fc848f50e8beb6561b5
+  data.tar.gz: a34143c5775f3705adb8bd4aac2837b4c4b2334f7191ccc2c7629b015cd3fe89
 SHA512:
-  metadata.gz: 48d2bd70f00ffd7c31e864039b77b9eabaff53e52b25c8825959c25486f024e3f3d63827ba98dc8ea5f09dd6a964e93700eaa1f88ef1ec6746d46804026bd444
-  data.tar.gz: 7f4e6010137fd5f1c55b70c9c6744f4ca194e6a44078aca0643020bd0ba1c9b43b7cec3cea1790eff025f79990cedb443e75b737d292095fba0896f5b0f17b68
+  metadata.gz: 1bdf6a2b0740459083c5e1b0e93ecab91172b372821168972879f94bb3b59c21706a0eb84895d03cf6ce915ab25b510100c8c84edd7cecd8469d8b6950647cc0
+  data.tar.gz: 89d4dd145df3813f14e4f3fb790e892c1948858843a8ab1b834450c6eac52164f5d222ebc8c8dcd3db3589d23e0b82ae599a9247e60f41d3697b82c8e0157c44

data/config/default.yml

@@ -30,3 +30,8 @@ YARD/MismatchName:
   Description: 'Check @param and @option name and method parameters'
   Enabled: true
   VersionAdded: '0.3.0'
+  EnforcedStylePrototypeName: after
+  SupportedStylesPrototypeName:
+    - before
+    - after
+

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

@@ -102,11 +102,34 @@ module RuboCop
         def tag_prototype(argument)
           case argument.type
           when :kwrestarg
-            "@param [Hash{Symbol => Object}] #{argument.name}"
+            case cop_config_prototype_name
+            when "before"
+              "@param #{argument.name} [Hash{Symbol => Object}]"
+            when "after"
+              "@param [Hash{Symbol => Object}] #{argument.name}"
+            end
           when :restarg
-            "@param [Array<Object>] #{argument.name}"
+            case cop_config_prototype_name
+            when "before"
+              "@param #{argument.name} [Array<Object>]"
+            when "after"
+              "@param [Array<Object>] #{argument.name}"
+            end
           else
-            "@param [Object] #{argument.name}"
+            case cop_config_prototype_name
+            when "before"
+              "@param #{argument.name} [Object]"
+            when "after"
+              "@param [Object] #{argument.name}"
+            end
+          end
+        end
+
+        def cop_config_prototype_name
+          @cop_config_prototype_name ||= cop_config["EnforcedStylePrototypeName"].tap do |c|
+            unless cop_config["SupportedStylesPrototypeName"].include?(c)
+              raise "unsupported style #{c}"
+            end
           end
         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_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.7.0"
+    VERSION = "0.8.1"
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yard
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-14 00:00:00.000000000 Z
+date: 2023-11-22 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