rubocop-publicdoc2 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f47572451602f0cb28be0997c1626c0fcd218a60dbad8c0ca5edcd97ab093500
-  data.tar.gz: 071c9289b76dd2a4fb9cbb1cbfd979e664c52dd6e0926943549f7d86e104c691
+  metadata.gz: 834d819dc85bf442a24ad2b911701413dd126f7fec7e9fcc44345ae68ec254a1
+  data.tar.gz: 3d79c19d27543a51871337737d238f71cf9c59baa1e57d2689192f468b81bddd
 SHA512:
-  metadata.gz: 626e6be5fa81324b512397956b27659b66d8fff181d86dbaefeec6ec661ffd2779f28613124a42d9d91394508555af5ca15a27b912c634376557e58f95dbbc78
-  data.tar.gz: b00f1afad0dc06c87b3caa7bfc35fc253da7768aae1a2d0256b9f736233f97275eb120958efb6f3bf1ac642221a9df8ab4bba7e84308c2ad4308a2e5e360e208
+  metadata.gz: bb764c614208969c5772685631e569f5b4195a471c08026949e2c10979ac6aaf4a8cf23d66479658d35a9929164d15af966301a9c823db0746f02cd5acbec286
+  data.tar.gz: 374e7fd0a4183c6241044270909030eaf4ef280cac58cea226b71721d63af973332daed2dacc49af398fc4ad475e038cbe9e225f259973841ea0c16700147ecb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-publicdoc2 (0.1.2)
+    rubocop-publicdoc2 (0.1.3)
       rubocop
 
 GEM

data/lib/rubocop/cop/style/public_method_documentation.rb

@@ -39,6 +39,8 @@ module RuboCop
 
         MSG_ATTRIBUTES_AND_PARAMETERS_NO_COEXIST = 'Attributes and Parameters should not exist on same method.'
         MSG_DESCRIPTION_SHOULD_END_WITH_BLANK_COMMENT = 'Description should end with blank comment.'
+        MSG_ILLEGAL_RANGE_BODY_FORMAT = "Illegal %s format: '# * <tt>:{argument}</tt> {description}'."
+        MSG_ILLEGAL_RANGE_RET_BODY_FORMAT = "Illegal %s format: '# * <tt>{CLASS}</tt> {description}'."
         MSG_MISSING_DOCUMENTATION = 'Missing public method documentation comment for `%s`.'
         MSG_MISSING_PARAMETERS = 'Parameter is missing for `%s`.'
         MSG_PARAMETERS_ARG_NAME_MISMATCH = 'Parameter name `%s` does not match argument name `%s`.'
@@ -46,11 +48,13 @@ module RuboCop
         MSG_PARAMETERS_SHOULD_BE_BEFORE_RETURNS = 'Parameters should be before Returns.'
         MSG_RANGE_BODY_EMPTY = '%s body is empty.'
         MSG_RETURNS_SHOULD_BE_LAST = 'Returns should be last.'
+        MSG_UNNECESSARY_PARAMETERS = 'Unnecessary Parameter documentation for `%s`.'
 
         #   https://regex101.com/
         ATTR_REGEXP = /^ *# *=== *Attributes:/.freeze
         DOC_PARM_REGEXP = %r{^# \* <tt>:(\w+)</tt>}.freeze
         DOC_RET_REGEXP = %r{^# \* <tt>([:\w]+)</tt>}.freeze
+        DOC_SUB_PARM_REGEXP = %r{^# \** <code>([.:\w ]+-*[.:\w ]+)</code>([.:\w ]*-*[.:\w ]*)}.freeze
         PARMS_REGEXP = /^ *# *=== *Parameters:/.freeze
         RETURNS_REGEXP = /^ *# *=== *Returns: */.freeze
 
@@ -120,6 +124,7 @@ module RuboCop
           grd = attrs_range.missing? || parameters_range.missing?
           add_offense(attrs_range.start_comment, message: MSG_ATTRIBUTES_AND_PARAMETERS_NO_COEXIST) unless grd
 
+          # copied from documentation_comment.rb
           special_comm = preceding_lines.any? do |comment|
             !AnnotationComment.new(comment, annotation_keywords).annotation? &&
               !interpreter_directive_comment?(comment) &&

data/lib/rubocop/publicdoc2/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Publicdoc2
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-publicdoc2
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Paul Kristoff
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler