rubocop_todo_corrector 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1725e72b773d02b2b00407840e3cc9c6f1369efa22fc81f335dda6b3959080cd
-  data.tar.gz: 01c22d85c57ea1d2cdfdd692cef1c92764025cacdda049b65d146731a6ed723a
+  metadata.gz: 45d1eb10f7da8503c49e40459f9ad3634be640b16df9cd9d6d39f3a3e1201247
+  data.tar.gz: 6e696ba691aaa2f61946ae58f267ed5de87571199a2a6cd8e7636a7ec2d056a1
 SHA512:
-  metadata.gz: fd2ceb4d8b406bb5e2e03feeb155b46ba8013ca8080d5667379c002b9b56c36473d9d62292b3aedb262ed2ecfb447608903ff704a01ae53a8d2de62a8f785858
-  data.tar.gz: e81181f9fb7919e5066d265ef7250127d99fbf06ef7fc0a0c5c5eb3f5c7c58f25bd7dcb513c4d10742cf63651d6b12d15475744593b66eb0efd457251da7b814
+  metadata.gz: c36fe6f928ecad20c2817c2bc67a232998577b77d233239f1969fccc6381938fd2c6f00453c4c727f747abb276f15ed967871bc93aa29165f1140347e0e854c1
+  data.tar.gz: dca597c40eed65bfcb583b6e6ad219a62b8285ad18009eeb0288a014d27957e70cecc7e0ed98ab6e959106bf9def7f11101d3362754468a789e7091b660b754b

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_todo_corrector (0.11.1)
+    rubocop_todo_corrector (0.12.0)
       bundler
       thor
       yard

data/lib/rubocop_todo_corrector/cop_document_parser.rb

@@ -27,18 +27,40 @@ 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
+      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/version.rb

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

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_todo_corrector
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler