rubocop_todo_corrector 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b057086a834c7f6ec21014fae505b444094e01bc4556e47e91c81f387e3239
-  data.tar.gz: 8a56da11f2c70a840097588e539512e06edede97ba9fe185fd8df05096fa734f
+  metadata.gz: 45d1eb10f7da8503c49e40459f9ad3634be640b16df9cd9d6d39f3a3e1201247
+  data.tar.gz: 6e696ba691aaa2f61946ae58f267ed5de87571199a2a6cd8e7636a7ec2d056a1
 SHA512:
-  metadata.gz: f54c8912b371c74034d95f1e46f18c07c9bc5c3544ea07ffdbd37650ac0980cfdf296485a798af14006ceaae2376c669bf53ea9dc64607402d63c91f6754a3c8
-  data.tar.gz: a2ffcc354d8508eb8164b1e45c4e2cd4927758f9963b900e74517a3edf523c00adb4a5235a005016ed486dddbef30be66eea7e8f129ab6496998e6775ac1e38c
+  metadata.gz: c36fe6f928ecad20c2817c2bc67a232998577b77d233239f1969fccc6381938fd2c6f00453c4c727f747abb276f15ed967871bc93aa29165f1140347e0e854c1
+  data.tar.gz: dca597c40eed65bfcb583b6e6ad219a62b8285ad18009eeb0288a014d27957e70cecc7e0ed98ab6e959106bf9def7f11101d3362754468a789e7091b660b754b

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## 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
+
+- Use `rubocop --regenerate-todo` option on `generate` command.
+
 ## 0.10.0 - 2022-07-27
 
 ### Added

data/Gemfile.lock

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

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/commands/generate.rb

@@ -30,33 +30,9 @@ module RubocopTodoCorrector
       def call
         ::Kernel.system(
           { 'BUNDLE_GEMFILE' => @temporary_gemfile_path },
-          "bundle exec #{rubocop_command}"
+          'bundle exec rubocop --regenerate-todo'
         )
       end
-
-      private
-
-      # @return [String]
-      def rubocop_command
-        rubocop_command_from_todo || 'rubocop --auto-gen-config'
-      end
-
-      # @return [String, nil]
-      def rubocop_command_from_todo
-        return unless rubocop_todo_pathname.exist?
-
-        RubocopTodoParser.call(content: rubocop_todo_content)[:previous_rubocop_command]
-      end
-
-      # @return [String]
-      def rubocop_todo_content
-        rubocop_todo_pathname.read
-      end
-
-      # @return [Pathname]
-      def rubocop_todo_pathname
-        @rubocop_todo_pathname ||= ::Pathname.new(@rubocop_todo_path)
-      end
     end
   end
 end

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/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/rubocop_todo_parser.rb

@@ -27,10 +27,7 @@ module RubocopTodoCorrector
 
     # @return [Hash]
     def call
-      {
-        cops:,
-        previous_rubocop_command:
-      }
+      { cops: }
     end
 
     private
@@ -42,13 +39,6 @@ module RubocopTodoCorrector
       end
     end
 
-    def previous_rubocop_command
-      @content[
-        /`(.+)`/,
-        1
-      ]
-    end
-
     # @return [Array<String>]
     def cop_sections
       @content.split("\n\n").grep(COP_NAME_LINE_REGEXP)

data/lib/rubocop_todo_corrector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopTodoCorrector
-  VERSION = '0.10.0'
+  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.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler