rubocop-yard 0.9.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea212d5b8a01f36b28635f8959436cc74fc9946a31cda2a9c0a8657416d0e40
-  data.tar.gz: cc737883475574dde1ac09c73236b3809f0ad4bc2cc3cf23c48fc69ba2af195a
+  metadata.gz: 40bdb35bd0b95a6bc84afcf35b31d27acfb45eba7dae27862fef99b4fb961f29
+  data.tar.gz: 00341d80e3051ed88f0ecc390e463c5a6e2edc25f63a4d00ee1b1fba56d83ce2
 SHA512:
-  metadata.gz: f4ebb19d49340e6404b87dc1348ea96dedbece58551be6fac937ec74877c0724fc8b8ae28bf552090c38adc56006c69d1f6be7eefd93cc00eb0d0685982cb9d0
-  data.tar.gz: 12ded42ee94f5dbcb2f81338fc4b20ce7fdb4f822c59c2f77e175091fde81017ebca2db425da42b792e332d49eb18826db6a52b8a293722f6ced2658c9455776
+  metadata.gz: b63811dcf428762af0afa33d0e237aa44b49846793ab7b19d66d4f5e5c1fd1484081e2b9a1b4ba999b535ea55572704369d484c4266bd28bd77117d9636f3b7c
+  data.tar.gz: a8c37ca47cfd1bd6dcc0a3f7d6e05f198ade8f7f530ba142593aee19be660c233912ff456f261162f9b9b98f2ed648f89b3cfe1ddce7b5e55f28d865e94bc9d8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.10.0] - 2024-11-20
+
+* Guess argument types by @ksss in https://github.com/ksss/rubocop-yard/pull/32
+
+## [0.9.3] - 2024-01-31
+
 - Suppress YARD warning logs
 
 ## [0.9.0] - 2023-11-28

data/README.md

@@ -131,7 +131,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-yard
+plugins:
+  - rubocop-yard
 ```
 
 ## Development

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

@@ -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/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module YARD
+    # A plugin that integrates RuboCop Performance with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-yard',
+          version: VERSION,
+          homepage: 'https://github.com/ksss/rubocop-yard',
+          description: 'Check yardoc format like tag type.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/yard/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module YARD
-    VERSION = "0.9.3"
+    VERSION = "1.0.0"
   end
 end

data/lib/rubocop-yard.rb

@@ -4,8 +4,6 @@ require 'rubocop'
 
 require_relative 'rubocop/yard'
 require_relative 'rubocop/yard/version'
-require_relative 'rubocop/yard/inject'
-
-RuboCop::YARD::Inject.defaults!
+require_relative 'rubocop/yard/plugin'
 
 require_relative 'rubocop/cop/yard_cops'

metadata

@@ -1,29 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yard
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 1.0.0
 platform: ruby
 authors:
 - ksss
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.72'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.72'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +74,7 @@ files:
 - lib/rubocop/cop/yard/tag_type_syntax.rb
 - lib/rubocop/cop/yard_cops.rb
 - lib/rubocop/yard.rb
-- lib/rubocop/yard/inject.rb
+- lib/rubocop/yard/plugin.rb
 - lib/rubocop/yard/version.rb
 - sig/rubocop/yard.rbs
 homepage: https://github.com/ksss/rubocop-yard
@@ -72,7 +85,7 @@ metadata:
   source_code_uri: https://github.com/ksss/rubocop-yard
   changelog_uri: https://github.com/ksss/rubocop-yard
   rubygems_mfa_required: 'true'
-post_install_message:
+  default_lint_roller_plugin: RuboCop::YARD::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: Check yardoc format.
 test_files: []

data/lib/rubocop/yard/inject.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
-module RuboCop
-  module YARD
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path).tap(&:make_excludes_absolute)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end