rubocop_todo_corrector 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a5761497cb2e78d59de2fed8ce2abc7edd84bc318f6d70483ea1f4f9363a4a4
-  data.tar.gz: 1f310cfb7f1479f454914e3cbe1e40b065851c4e6978b484f2d617cd69df7d6c
+  metadata.gz: 3e370ea5e7275cba3675a1e5ebae1aababaddb87917bb7ac5507efb6b3e5fb79
+  data.tar.gz: 5a235861dbdf945bf4fd1a3c271cedb2f08e76397706d2f48e16adec0e94e8a4
 SHA512:
-  metadata.gz: 227d12206f9b090ba98cae89ac3e960c1f6e1d61a8bcffe501c093ccffca1dd68b7121659977bc7835f1270994c3f63914f0e14bcd5cd040b66d699926339620
-  data.tar.gz: d88f4a1733519d7e0f5659ae62474bd0c37c2b06d0284b64fdd94d3a210ac99655a666ce3ab8bdb67cce6118c7f57edcaba7f83cb5de13e52a30523c4b9957b7
+  metadata.gz: 55cd6960281b726f3cd5ab258d112c2fbbe8d589fd57045ce1186b06af17502883a591709fcc40f7ac773b785f05a01784a35f6a641d21de01f6334d0cef829a
+  data.tar.gz: a05b1ca686adb83f7eae952c0357109b0f18973f0e85965468518264b89b1a531a071d387a7209226837f66abef89680c2b43fac90daa1aa181f2cd63fae6da1

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Unreleased
 
+## 0.12.0 - 2022-08-08
+
+### Added
+
+- Add Safety section if `@safety` YARD tag is written in Cop class.
+
+## 0.11.1 - 2022-08-03
+
+### Fixed
+
+- Fix `describe` command on more than three nested cop class.
+
 ## 0.11.0 - 2022-07-29
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rubocop_todo_corrector (0.11.0)
+    rubocop_todo_corrector (0.13.0)
+      asciidoctor
       bundler
       thor
       yard
@@ -9,6 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    asciidoctor (2.0.17)
     ast (2.4.2)
     diff-lcs (1.5.0)
     parallel (1.22.1)

data/README.md

@@ -3,7 +3,9 @@
 [![test](https://github.com/r7kamura/rubocop_todo_corrector/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/rubocop_todo_corrector/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/rubocop_todo_corrector.svg)](https://rubygems.org/gems/rubocop_todo_corrector)
 
-Auto-correct offenses defined in .rubocop_todo.yml.
+Auto-correct offenses defined in `.rubocop_todo.yml`.
+
+This is an internal implementation of [rubocop-todo-corrector](https://github.com/r7kamura/rubocop-todo-corrector) action. See its README for more information about this action.
 
 ## Installation
 

data/lib/rubocop_todo_corrector/cop_document_parser.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'asciidoctor'
 require 'yard'
 
 module RubocopTodoCorrector
@@ -27,18 +28,48 @@ module RubocopTodoCorrector
       return unless yard_class_object
 
       {
-        description: yard_class_object.docstring,
-        examples: yard_class_object.tags('example').map do |tag|
-          {
-            name: tag.name,
-            text: tag.text
-          }
-        end
+        description:,
+        examples:,
+        safety:
       }
     end
 
     private
 
+    # @return [String]
+    def description
+      ::Asciidoctor.convert(
+        docstring,
+        safe: :safe
+      )
+    end
+
+    # @return [String]
+    def docstring
+      yard_class_object.docstring
+    end
+
+    # @return [Array<Hash>]
+    def examples
+      yard_class_object.tags('example').map do |tag|
+        {
+          name: tag.name,
+          text: tag.text
+        }
+      end
+    end
+
+    # @return [Hash, nil]
+    def safety
+      tag = yard_class_object.tag('safety')
+      return unless tag
+
+      {
+        name: tag.name,
+        text: tag.text
+      }
+    end
+
     # @return [YARD::CodeObjects::ClassObject]
     def yard_class_object
       @yard_class_object ||= begin

data/lib/rubocop_todo_corrector/cop_source_detector.rb

@@ -45,7 +45,7 @@ module RubocopTodoCorrector
 
     # @return [String]
     def cop_class_name
-      "RuboCop::Cop::#{@cop_name.sub('/', '::')}"
+      "RuboCop::Cop::#{@cop_name.gsub('/', '::')}"
     end
   end
 end

data/lib/rubocop_todo_corrector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopTodoCorrector
-  VERSION = '0.11.0'
+  VERSION = '0.13.0'
 end

data/rubocop_todo_corrector.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'asciidoctor'
   spec.add_dependency 'bundler'
   spec.add_dependency 'thor'
   spec.add_dependency 'yard'

data/templates/description.md.erb

@@ -11,6 +11,12 @@ Auto-corrected [<%= @cop_name %>](<%= cop_url %>).
 <% @cop_document[:description].each_line do |line| -%>
 <%= "> #{line}".strip %>
 <% end -%>
+<% if @cop_document[:safety] -%>
+>
+> #### Safety
+>
+> <%= @cop_document[:safety][:text].gsub("\n", " ").strip %>
+<% end -%>
 <% unless @cop_document[:examples].empty? -%>
 >
 > #### Examples

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_todo_corrector
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  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: bundler
   requirement: !ruby/object:Gem::Requirement